Re: [PATCH 2/3] doc: update the guidelines to reflect the current formatting rules

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 23, 2024, 23:37 UTC
Message-ID: <xmqqjzhbznmm.fsf@gitster.g>
In-Reply-To: <b0547422e5cf31c1141f2b6078a43e5bc60cb652.1721774680.git.gitgitgadget@gmail.com>

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

Show 18 quoted lines

> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
> ---
>  Documentation/CodingGuidelines | 34 +++++++++++++++++++---------------
>  1 file changed, 19 insertions(+), 15 deletions(-)
>
> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> index 1d92b2da03e8..4d59e8f89ec8 100644
> --- a/Documentation/CodingGuidelines
> +++ b/Documentation/CodingGuidelines
> @@ -760,56 +760,60 @@ Markup:
>  
>  Synopsis Syntax
>  
> - Syntax grammar is formatted neither as literal nor as placeholder.
> + The synopsis (a paragraph with [synopsis] attribute) is automatically
> + formatted by the toolchain and does not need typesetting.

How pleasant ;-)

Show 6 quoted lines

>   And a somewhat more contrived example:
> -   `--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]`
> +   --diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]
>     Here "=" is outside the brackets, because "--diff-filter=" is a
>     valid usage.  "*" has its own pair of brackets, because it can
>     (optionally) be specified only when one or more of the letters is