public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: LorenzoPegorari <lorenzo.pegorari2002@gmail.com>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [GSoC PATCH v2 0/3] doc: improve gitprotocol-pack
Date: Tue, 3 Mar 2026 02:34:10 +0100	[thread overview]
Message-ID: <cover.1772500189.git.lorenzo.pegorari2002@gmail.com> (raw)
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


  parent reply	other threads:[~2026-03-03  1:34 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-02 16:09 [GSoC PATCH 0/3] doc: improve gitprotocol-pack LorenzoPegorari
2026-03-02 16:10 ` [GSoC PATCH 1/3] doc: gitprotocol-pack: fix pronoun-antecedent agreement LorenzoPegorari
2026-03-02 16:10 ` [GSoC PATCH 2/3] doc: gitprotocol-pack: improve paragraphs structure LorenzoPegorari
2026-03-02 16:10 ` [GSoC PATCH 3/3] doc: gitprotocol-pack: normalize inline code formatting LorenzoPegorari
2026-03-02 23:01   ` Junio C Hamano
2026-03-03  1:26     ` Lorenzo Pegorari
2026-03-03  1:48       ` Junio C Hamano
2026-03-03  1:34 ` LorenzoPegorari [this message]
2026-03-03  1:34   ` [GSoC PATCH v2 1/3] doc: gitprotocol-pack: fix pronoun-antecedent agreement LorenzoPegorari
2026-03-03  1:35   ` [GSoC PATCH v2 2/3] doc: gitprotocol-pack: improve paragraphs structure LorenzoPegorari
2026-03-03  1:38   ` [GSoC PATCH v2 3/3] doc: gitprotocol-pack: normalize italic formatting LorenzoPegorari
2026-03-03  1:45   ` [GSoC PATCH v3 0/3] doc: improve gitprotocol-pack LorenzoPegorari
2026-03-03  1:45     ` [GSoC PATCH v3 1/3] doc: gitprotocol-pack: fix pronoun-antecedent agreement LorenzoPegorari
2026-03-03  1:46     ` [GSoC PATCH v3 2/3] doc: gitprotocol-pack: improve paragraphs structure LorenzoPegorari
2026-03-03  1:46     ` [GSoC PATCH v3 3/3] doc: gitprotocol-pack: normalize italic formatting LorenzoPegorari

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1772500189.git.lorenzo.pegorari2002@gmail.com \
    --to=lorenzo.pegorari2002@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox