clone: support --inbox-config option

[public-inbox.git] / Documentation / public-inbox-clone.pod

diff --git a/Documentation/public-inbox-clone.pod b/Documentation/public-inbox-clone.pod
index 178d952ad8fb1089ff09d4cc4d8abdc718341013..52c89cfd1d97bffc5e7a6ecf892cb408aa08c457 100644 (file)
--- a/Documentation/public-inbox-clone.pod
+++ b/Documentation/public-inbox-clone.pod
@@ -65,6 +65,17 @@ When cloning a top-level with multiple inboxes, ignore inboxes and
 repositories matching the given wildcard pattern.  Supports the same
 wildcards as L</--include>
 
+=item --inbox-config=always|v2|v1|never
+
+Whether or not to retrieve the C<$INBOX/_/text/config/raw> HTTP(S)
+endpoint when cloning.
+
+Since we can't deduce v1 inboxes from code repositories, setting this
+to C<v2> or C<never> can allow faster clones of code repositories if
+no v1 inboxes are present.
+
+Default: C<always>
+
 =item -n
 
 =item --dry-run