mirror of
https://github.com/git/git
synced 2024-09-12 21:04:12 +00:00
bff03c47f7
There will be two primary ways to advertise a bundle list: as a list of packet lines in Git's protocol v2 and as a config file served from a bundle URI. Both of these fundamentally use a list of key-value pairs. We will use the same set of key-value pairs across these formats. Create a new bundle_list_update() method that is currently unusued, but will be used in the next change. It inspects each key to see if it is understood and then applies it to the given bundle_list. Here are the keys that we teach Git to understand: * bundle.version: This value should be an integer. Git currently understands only version 1 and will ignore the list if the version is any other value. This version can be increased in the future if we need to add new keys that Git should not ignore. We can add new "heuristic" keys without incrementing the version. * bundle.mode: This value should be one of "all" or "any". If this mode is not understood, then Git will ignore the list. This mode indicates whether Git needs all of the bundle list items to make a complete view of the content or if any single item is sufficient. The rest of the keys use a bundle identifier "<id>" as part of the key name. Keys using the same "<id>" describe a single bundle list item. * bundle.<id>.uri: This stores the URI of the bundle item. This currently is expected to be an absolute URI, but will be relaxed to be a relative URI in the future. While parsing, return an error if a URI key is repeated, since we can make that restriction with bundle lists. Make the git_parse_int() method global so we can parse the integer version value carefully. Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
25 lines
1 KiB
Plaintext
25 lines
1 KiB
Plaintext
bundle.*::
|
|
The `bundle.*` keys may appear in a bundle list file found via the
|
|
`git clone --bundle-uri` option. These keys currently have no effect
|
|
if placed in a repository config file, though this will change in the
|
|
future. See link:technical/bundle-uri.html[the bundle URI design
|
|
document] for more details.
|
|
|
|
bundle.version::
|
|
This integer value advertises the version of the bundle list format
|
|
used by the bundle list. Currently, the only accepted value is `1`.
|
|
|
|
bundle.mode::
|
|
This string value should be either `all` or `any`. This value describes
|
|
whether all of the advertised bundles are required to unbundle a
|
|
complete understanding of the bundled information (`all`) or if any one
|
|
of the listed bundle URIs is sufficient (`any`).
|
|
|
|
bundle.<id>.*::
|
|
The `bundle.<id>.*` keys are used to describe a single item in the
|
|
bundle list, grouped under `<id>` for identification purposes.
|
|
|
|
bundle.<id>.uri::
|
|
This string value defines the URI by which Git can reach the contents
|
|
of this `<id>`. This URI may be a bundle file or another bundle list.
|