| 1 | bundle.*:: |
| 2 | The `bundle.*` keys may appear in a bundle list file found via the |
| 3 | `git clone --bundle-uri` option. These keys currently have no effect |
| 4 | if placed in a repository config file, though this will change in the |
| 5 | future. See link:technical/bundle-uri.html[the bundle URI design |
| 6 | document] for more details. |
| 7 | |
| 8 | bundle.version:: |
| 9 | This integer value advertises the version of the bundle list format |
| 10 | used by the bundle list. Currently, the only accepted value is `1`. |
| 11 | |
| 12 | bundle.mode:: |
| 13 | This string value should be either `all` or `any`. This value describes |
| 14 | whether all of the advertised bundles are required to unbundle a |
| 15 | complete understanding of the bundled information (`all`) or if any one |
| 16 | of the listed bundle URIs is sufficient (`any`). |
| 17 | |
| 18 | bundle.heuristic:: |
| 19 | If this string-valued key exists, then the bundle list is designed to |
| 20 | work well with incremental `git fetch` commands. The heuristic signals |
| 21 | that there are additional keys available for each bundle that help |
| 22 | determine which subset of bundles the client should download. The |
| 23 | only value currently understood is `creationToken`. |
| 24 | |
| 25 | bundle.<id>.*:: |
| 26 | The `bundle.<id>.*` keys are used to describe a single item in the |
| 27 | bundle list, grouped under `<id>` for identification purposes. |
| 28 | |
| 29 | bundle.<id>.uri:: |
| 30 | This string value defines the URI by which Git can reach the contents |
| 31 | of this `<id>`. This URI may be a bundle file or another bundle list. |