]> Sergey Matveev's repositories - public-inbox.git/commitdiff
clone: document --project-list and --post-update-hook
authorEric Wong <e@80x24.org>
Thu, 5 Jan 2023 11:41:56 +0000 (11:41 +0000)
committerEric Wong <e@80x24.org>
Fri, 6 Jan 2023 03:30:03 +0000 (03:30 +0000)
I forgot to document these when I implemented them :x

Documentation/public-inbox-clone.pod

index 2a7081acbf71f77f5beaffe0055a32846c25c537..53acf35698fd78c97710d461614eed01e9495dcf 100644 (file)
@@ -108,6 +108,27 @@ as relative to the C<DESTINATION> directory.  If only C<--manifest=>
 is specified where C<FILE> is an empty string (C<"">), then C<manifest.js.gz>
 (C<$DESTINATION/manifest.js.gz>) is the implied value of C<FILE>.
 
+=item --project-list=FILE
+
+When cloning code repos from a manifest, generate a cgit-compatible
+project list.
+
+If C<FILE> does not start with C</>, C<./>, or C<../>, it is treated
+as relative to the C<DESTINATION> directory.  If only C<--project-list=>
+is specified where C<FILE> is an empty string (C<"">), then C<projects.list>
+(C<$DESTINATION/projects.list>) is the implied value of C<FILE>.
+
+=item --post-update-hook=COMMAND
+
+Hooks to run after a repository is cloned or updated, C<COMMAND> will
+have the bare git repository destination given as its first and only
+argument.
+
+For v2 inboxes, this operates on a per-epoch basis.
+
+May be specified multiple times to run multiple commands in the
+order specified on the command-line.
+
 =item -p
 
 =item --prune