{"thread":{"id":"58582","subject":"[PATCH] bundle-uri: fix technical doc issues","startedAt":"2022-10-07T15:50:23Z","lastAt":"2022-10-07T15:50:23Z","messageCount":1,"participants":["Derrick Stolee via GitGitGadget"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"464382","messageId":"pull.1377.git.1665157810025.gitgitgadget@gmail.com","threadId":"58582","inReplyTo":null,"subject":"[PATCH] bundle-uri: fix technical doc issues","fromName":"Derrick Stolee via GitGitGadget","fromEmail":"gitgitgadget@gmail.com","sentAt":"2022-10-07T15:50:09Z","receivedAt":"2022-10-07T15:50:23Z","isPatch":true,"sender":{"key":"stolee@gmail.com","avatar":"https://avatars.githubusercontent.com/u/570044?v=4"},"body":"From: Derrick Stolee <derrickstolee@github.com>\n\nTwo documentation issues exist in the technical docs for the bundle URI\nfeature.\n\nFirst, there is an extraneous \"the\" across a linebreak, making the\nnonsensical phrase \"the bundle the list\" which should just be \"the\nbundle list\".\n\nSecondly, the asciidoc update treats the string \"`have`s\" as starting a\n\"<code>\" block, but the second tick is interpreted as an apostrophe\ninstead of a closing \"</code>\" tag. This causes entire sentences to be\nformatted as code until the next one comes along. Simply adding a space\nhere does not work properly as the rendered HTML keeps that space.\nInstead, restructure the sentence slightly to avoid using a plural,\nallowing the HTML to render correctly.\n\nReported-by: Philip Oakley <philipoakley@iee.email>\nSigned-off-by: Derrick Stolee <derrickstolee@github.com>\n---\n    bundle-uri: fix technical doc issues\n    \n    Thanks, Philip, for bringing this to my attention [1]\n    \n    [1]\n    https://lore.kernel.org/git/fb8172a1-004c-1316-7a26-f030d377c141@iee.email/\n    \n    Thanks,\n    \n     * Stolee\n\nPublished-As: https://github.com/gitgitgadget/git/releases/tag/pr-1377%2Fderrickstolee%2Fbundle-uri-tech-doc-fix-v1\nFetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1377/derrickstolee/bundle-uri-tech-doc-fix-v1\nPull-Request: https://github.com/gitgitgadget/git/pull/1377\n\n Documentation/technical/bundle-uri.txt | 8 ++++----\n 1 file changed, 4 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/technical/bundle-uri.txt b/Documentation/technical/bundle-uri.txt\nindex 18f2dedd400..b78d01d9adf 100644\n--- a/Documentation/technical/bundle-uri.txt\n+++ b/Documentation/technical/bundle-uri.txt\n@@ -153,8 +153,8 @@ bundle.<id>.filter::\n \n bundle.<id>.creationToken::\n \tThis value is a nonnegative 64-bit integer used for sorting the bundles\n-\tthe list. This is used to download a subset of bundles during a fetch\n-\twhen `bundle.heuristic=creationToken`.\n+\tlist. This is used to download a subset of bundles during a fetch when\n+\t`bundle.heuristic=creationToken`.\n \n bundle.<id>.location::\n \tThis string value advertises a real-world location from where the bundle\n@@ -234,8 +234,8 @@ will interact with bundle URIs according to the following flow:\n    making those OIDs present. When all required OIDs are present, the\n    client unbundles that data using a refspec. The default refspec is\n    `+refs/heads/*:refs/bundles/*`, but this can be configured. These refs\n-   are stored so that later `git fetch` negotiations can communicate the\n-   bundled refs as `have`s, reducing the size of the fetch over the Git\n+   are stored so that later `git fetch` negotiations can communicate each\n+   bundled ref as a `have`, reducing the size of the fetch over the Git\n    protocol. To allow pruning refs from this ref namespace, Git may\n    introduce a numbered namespace (such as `refs/bundles/<i>/*`) such that\n    stale bundle refs can be deleted.\n\nbase-commit: 3dcec76d9df911ed8321007b1d197c1a206dc164\n-- \ngitgitgadget\n"}]}