about summary refs log tree commit homepage
path: root/Documentation/public-inbox-clone.pod
diff options
authorEric Wong <e@80x24.org>2021-09-24 10:56:41 +0000
committerEric Wong <e@80x24.org>2021-09-24 23:22:05 +0000
commit69b5ab18a594fa434d79cacee35c4d9a0df7b55c (patch)
tree051f0118b39ff5e5f59c177e7cde5c936eb90513 /Documentation/public-inbox-clone.pod
parentb319bb7276457d01ab4bc779d867368f884bd522 (diff)
Partial (v2) clones should be useful addition for users wanting
to conserve storage while having fast access to recent messages.

Continuing work started in 876e74283ff3 (fetch: ignore
non-writable epoch dirs, 2021-09-17), this creates bare,
read-only epoch git repos.  These git repos have the remotes
pre-configured, but does not fetch any objects.

The goal is to allow users to set the writable bit on a
previously-skipped epoch and start fetching it.

Shell completion support may not be necessary given how short
the epoch ranges are, here.

Cc: Luis Chamberlain <mcgrof@kernel.org>
Link: https://public-inbox.org/meta/20210917002204.GA13112@dcvr/T/#u
Diffstat (limited to 'Documentation/public-inbox-clone.pod')
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod
index fdb57663..efee01ee 100644
--- a/Documentation/public-inbox-clone.pod
+++ b/Documentation/public-inbox-clone.pod
@@ -31,6 +31,21 @@ file to speed up subsequent L<public-inbox-fetch(1)>.
+=item --epoch=RANGE
+Restrict clones of L<public-inbox-v2-format(5)> inboxes to the
+given range of epochs.  The range may be a single non-negative
+integer or a (possibly open-ended) C<LOW..HIGH> range of
+non-negative integers.  C<~> may be prefixed to either (or both)
+integer values to represent the offset from the maximum possible
+For example, C<--epoch=~0> alone clones only the latest epoch,
+C<--epoch=~2..> clones the three latest epochs.
+Default: C<0..~0> or C<0..> or C<..~0>
+(all epochs, all three examples are equivalent)
 =item -q
 =item --quiet