Re: [PATCH 2/4] doc: convert git-format-patch synopsis and options to new style
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jul 19, 2026, 23:40 UTC
- Message-ID
- <xmqqldb6lfa6.fsf@gitster.g>
- In-Reply-To
- <e1ed85e3f2733f0f1cc46416903d1e0c8b4c1856.1784490878.git.gitgitgadget@gmail.com>
"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.
Show 9 quoted lines
> @@ -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?
Show 5 quoted lines
> +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.