Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, "Jean-Noël Avila" <jn.avila@free.fr>
Subject: Re: [PATCH 2/4] doc: convert git-format-patch synopsis and options to new style
Date: Sun, 19 Jul 2026 16:40:17 -0700	[thread overview]
Message-ID: <xmqqldb6lfa6.fsf@gitster.g> (raw)
In-Reply-To: <e1ed85e3f2733f0f1cc46416903d1e0c8b4c1856.1784490878.git.gitgitgadget@gmail.com> ("Jean-Noël Avila via GitGitGadget"'s message of "Sun, 19 Jul 2026 19:54:35 +0000")

"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:

> Backtick-quote all option terms in the OPTIONS section, convert
> standalone placeholders to _<placeholder>_ form, and convert
> single-quoted commands and tools in prose to backtick form.

OK.

> @@ -708,15 +708,15 @@ BASE TREE INFORMATION
>  
>  The base tree information block is used for maintainers or third party
>  testers to know the exact state the patch series applies to. It consists
> +of the "base commit", which is a well-known commit that is part of the
>  stable part of the project history everybody else works off of, and zero
> +or more "prerequisite patches", which are well-known patches in flight
> +that is not yet part of the "base commit" that need to be applied on top
> +of "base commit" in topological order before the patches can be applied.

GIven that the last part of this hunk below uses backtick-quoting
for `prerequisite patch` and `patch id`, shouldn't the references to
`base commit`, and `prerequisite patch(es)` in the above also be
backtick quoted for consistency?

> +The "base commit" is shown as "base-commit: " followed by the 40-hex of
> +the commit object name.  A `prerequisite patch` is shown as
> +"prerequisite-patch-id: " followed by the 40-hex `patch id`, which can
>  be obtained by passing the patch through the `git patch-id --stable`
>  command.


  reply	other threads:[~2026-07-19 23:40 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-19 19:54 [PATCH 0/4] A new batch of synopsis conversion Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` [PATCH 1/4] doc: convert git-imap-send synopsis and options to new style Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` [PATCH 2/4] doc: convert git-format-patch " Jean-Noël Avila via GitGitGadget
2026-07-19 23:40   ` Junio C Hamano [this message]
2026-07-20 20:09     ` Jean-Noël AVILA
2026-07-19 19:54 ` [PATCH 3/4] doc: convert git-send-email " Jean-Noël Avila via GitGitGadget
2026-07-19 19:54 ` [PATCH 4/4] doc: convert git-request-pull " Jean-Noël Avila via GitGitGadget
2026-07-19 23:47   ` Junio C Hamano
2026-07-20 20:39     ` Jean-Noël AVILA
2026-07-20 21:26       ` Junio C Hamano

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=xmqqldb6lfa6.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=jn.avila@free.fr \
    /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