X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Fpublic-inbox-clone.pod;h=7498aed9f46ad93c48279e45c8d4626300579794;hb=HEAD;hp=cee9f76eec04cf39868a9d1a6719ed784ff5fc86;hpb=3c499dbc312a7cd32da4664a3cfad6500ab98e8d;p=public-inbox.git diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod index cee9f76e..7498aed9 100644 --- a/Documentation/public-inbox-clone.pod +++ b/Documentation/public-inbox-clone.pod @@ -84,15 +84,69 @@ Force a remote public-inbox version (must be C<1> or C<2>). This is auto-detected by default, and this option exists mainly for testing. -=item --objstore[=DIR] +=item --objstore=DIR Enables space savings when the remote C includes C entries as generated by grokmirror 2.x. -If C is not an absolute path, it is relative to the -C directory. If only C<--objstore> is specified -without C, then C (C<$DESTINATION/objstore>) -is the implied value of C. +If C does not start with C, C<./>, or C<../>, it is treated +as relative to the C directory. If only C<--objstore=> +is specified where C is an empty string (C<"">), then C +(C<$DESTINATION/objstore>) is the implied value of C. + +=item --manifest=FILE + +When incrementally updating an existing mirror, load the given +manifest (typically C) to speed up updates. + +By default, public-inbox writes the retrieved manifest to +C<$DESTINATION/manifest.js.gz>, this directive also +changes the destination to the specified C + +If C does not start with C, C<./>, or C<../>, it is treated +as relative to the C directory. If only C<--manifest=> +is specified where C is an empty string (C<"">), then C +(C<$DESTINATION/manifest.js.gz>) is the implied value of C. + +=item --project-list=FILE + +When cloning code repos from a manifest, generate a cgit-compatible +project list. + +If C does not start with C, C<./>, or C<../>, it is treated +as relative to the C directory. If only C<--project-list=> +is specified where C is an empty string (C<"">), then C +(C<$DESTINATION/projects.list>) is the implied value of C. + +=item --post-update-hook=COMMAND + +Hooks to run after a repository is cloned or updated, C 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 + +Pass the C<--prune> and C<--prune-tags> flags to L +calls on incremental clones. + +=item --exit-code + +Exit with C<127> if no updates are done when relying on a manifest. +Updates include fingerprint mismatches in the manifest, new symlinks, +new repositories, and removed repositories from the L<--project-list> + +=item -k + +=item --keep-going + +Continue as much as possible after an error. =item -n