Derrick Stolee [off-list ref] writes:
On 8/22/2022 2:20 PM, Junio C Hamano wrote:
quoted
"Derrick Stolee via GitGitGadget" [off-list ref] writes:
quoted
diff --git a/Documentation/config.txt b/Documentation/config.txt
index e376d547ce0..4280af6992e 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -387,6 +387,8 @@ include::config/branch.txt[]
include::config/browser.txt[]
+include::config/bundle.txt[]
+
The file that records a list of bundles may borrow the format of git
config files, but will we store their contents in configuration
files in the receiving (or originating) repository? With the
presence of fields like "bundle.version", I somehow doubt it.
Should "git config --help" list them?
I suppose that at this point, they should be left out, since
writing them to your Git config does nothing.
In the future, having these config values present will advertise
the bundle list during the 'bundle-uri' protocol v2 command. That
could use some clarification in the documentation, too, perhaps
with a "bundle.*" item discussing how all of the other items are
related to that advertisement.
I think the main point of confusion is that these config variables
currently do nothing when in a repo config, but they will be
subsequently used once we implement advertising them, and it is
convenient that these configs delegate to other files that have the same
format (and that we can specify, at the CLI, a file of the same format).
Maybe documentation like this would clear up the confusion:
bundle.*::
The `bundle.*` keys may appear in a repo's config, in a file
linked by bundle.<id>.uri, or in a file passed to "clone
--bundle-uri".
+
NEEDSWORK: Currently, only the latter 2 situations work. `bundle.*` keys
appearing in a repo's config will take effect once support for
advertising bundles in fetch protocol v2 is implemented.
+
See link:technical/bundle-uri.html[the bundle URI design document] for
more details.