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

From: Jean-Noël Avila <jean-noel.avila@scantech.com>
Date: Aug 12, 2024, 06:18 UTC
Message-ID: <71b427c1-55a3-4f61-bfcb-65f7fe1a02cd@scantech.com>
In-Reply-To: <CAPig+cSGeExca0d=o0jewFERTx30+EgR5HccTO_gOsKtnXxuwA@mail.gmail.com>

Le 12/08/2024 à 01:56, Eric Sunshine a écrit :

Show 18 quoted lines

> On Sun, Aug 11, 2024 at 11:20 AM Jean-Noël Avila via GitGitGadget
> <gitgitgadget@gmail.com> wrote:
>> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
>> ---
>> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
>> @@ -746,70 +746,72 @@ Markup:
>>   When literal and placeholders are mixed, each markup is applied for
>> + each sub-entity. If the formatting is becoming too hairy, you can use the
>> + s:["foo"] formatting macro and let it format the groups for you.
>> +   `--jobs` _<n>_ or s:["--jobs <n>"]
>> +   s:["--sort=<key>
>> +   s:["<directory>/.git"]
>> +   s:["remote.<name>.mirror"]
>> +   s:["ssh://[<user>@]<host>[:<port>]/<path-to-git-repo>"]
>> +
>> +Note that the double-quotes are required by the macro.
> 
> The closing `"]` is missing from the --sort example. Is that intentional?

Not at all. Will fix it.

Thanks

begin:vcard fn;quoted-printable:Jean-No=C3=ABl Avila n;quoted-printable:Avila;Jean-No=C3=ABl org:Scantech S.A. adr;quoted-printable:Savoie Technolac BP 244;;B=C3=A2timent Androm=C3=A8de - 108 Avenue du Lac L=C3=A9man ; LA MOTTE SERVOLEX;;73290;France email;internet:jean-noel.avila@scantech.com title:Embedded systems manager tel;work:+33 479 25 54 50 tel;cell:+33 633 04 64 18 x-mozilla-html:FALSE url:http://www.scantech.com version:2.1 end:vcard