[GSoC PATCH v2 0/3] doc: improve gitprotocol-pack
- From
LorenzoPegorari <lorenzo.pegorari2002@gmail.com>
- Date
- Mar 3, 2026, 01:34 UTC
- Message-ID
- <cover.1772500189.git.lorenzo.pegorari2002@gmail.com>
- In-Reply-To
- <cover.1772467050.git.lorenzo.pegorari2002@gmail.com>
While studying the `gitprotocol-pack` documentation, I found various small style inconsistencies.
These patches are just tiny, simple improvements, mostly to improve the clarity of the documentation.
V2 DIFF: * Fixed final patch to properly conform command and process names to italic format, instead of the inline code format
LorenzoPegorari (3): doc: gitprotocol-pack: fix pronoun-antecedent agreement doc: gitprotocol-pack: improve paragraphs structure doc: gitprotocol-pack: normalize italic formatting
Documentation/gitprotocol-pack.adoc | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-)
Range-diff against v1:
1: 0d679e5eb5 = 1: 0d679e5eb5 doc: gitprotocol-pack: fix pronoun-antecedent agreement
2: 8a6b5d4c98 = 2: 8a6b5d4c98 doc: gitprotocol-pack: improve paragraphs structure
3: e0e4ea3d22 ! 3: 6410967d65 doc: gitprotocol-pack: normalize inline code formatting
@@ Metadata
Author: LorenzoPegorari <lorenzo.pegorari2002@gmail.com>
## Commit message ##
- doc: gitprotocol-pack: normalize inline code formatting
+ doc: gitprotocol-pack: normalize italic formatting
- Uniform inline code usage for command and process names.
+ Uniform italic style usage for command and process names.
Signed-off-by: LorenzoPegorari <lorenzo.pegorari2002@gmail.com>
@@ Documentation/gitprotocol-pack.adoc: supports passing environment variables as a
A few things to remember here:
-- The "command name" is spelled with dash (e.g. git-upload-pack), but
-+- The "command name" is spelled with dash (e.g. `git-upload-pack`), but
++- The "command name" is spelled with dash (e.g. 'git-upload-pack'), but
this can be overridden by the client;
- The repository path is always quoted with single quotes.
@@ Documentation/gitprotocol-pack.adoc: In multi_ack_detailed mode:
Without either multi_ack or multi_ack_detailed:
- * upload-pack sends "ACK obj-id" on the first common object it finds.
-+ * `upload-pack` sends "ACK obj-id" on the first common object it finds.
++ * 'upload-pack' sends "ACK obj-id" on the first common object it finds.
After that it says nothing until the client gives it a "done".
- * upload-pack sends "NAK" on a flush-pkt if no common object
-+ * `upload-pack` sends "NAK" on a flush-pkt if no common object
++ * 'upload-pack' sends "NAK" on a flush-pkt if no common object
has been found yet. If one has been found, and thus an ACK
was already sent, it's silent on the flush-pkt.
-- 2.43.0