@matheusbsbs / matheus-bagliano / commits / 7190b7ebf9

bundle-uri: fix technical doc issues

Two documentation issues exist in the technical docs for the bundle URI feature. First, there is an extraneous "the" across a linebreak, making the nonsensical phrase "the bundle the list" which should just be "the bundle list". Secondly, the asciidoc update treats the string "`have`s" as starting a "<code>" block, but the second tick is interpreted as an apostrophe instead of a closing "</code>" tag. This causes entire sentences to be formatted as code until the next one comes along. Simply adding a space here does not work properly as the rendered HTML keeps that space. Instead, restructure the sentence slightly to avoid using a plural, allowing the HTML to render correctly. Reported-by: Philip Oakley <philipoakley@iee.email> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Derrick Stolee committed Oct 7, 2022 at 15:50 UTC 7190b7ebf9c535a8248b5201a0e03bdb1107fcc4

1 file changed +4 -4

Documentation/technical/bundle-uri.txt

+4 -4

@@ -153,8 +153,8 @@ bundle.<id>.filter::

153

154 bundle.<id>.creationToken::

155 This value is a nonnegative 64-bit integer used for sorting the bundles

156 - the list. This is used to download a subset of bundles during a fetch

157 - when `bundle.heuristic=creationToken`.

156 + list. This is used to download a subset of bundles during a fetch when

157 + `bundle.heuristic=creationToken`.

158

159 bundle.<id>.location::

160 This string value advertises a real-world location from where the bundle

@@ -234,8 +234,8 @@ will interact with bundle URIs according to the following flow:

234 making those OIDs present. When all required OIDs are present, the

235 client unbundles that data using a refspec. The default refspec is

236 `+refs/heads/*:refs/bundles/*`, but this can be configured. These refs

237 - are stored so that later `git fetch` negotiations can communicate the

238 - bundled refs as `have`s, reducing the size of the fetch over the Git

237 + are stored so that later `git fetch` negotiations can communicate each

238 + bundled ref as a `have`, reducing the size of the fetch over the Git

239 protocol. To allow pruning refs from this ref namespace, Git may

240 introduce a numbered namespace (such as `refs/bundles/<i>/*`) such that

241 stale bundle refs can be deleted.