Re: [PATCH v2 1/2] cocci: add headings to and reword README

From: Glen Choo <chooglen@google.com>
Date: May 9, 2023, 17:54 UTC
Message-ID: <kl6l8rdx1jbt.fsf@chooglen-macbookpro.roam.corp.google.com>
In-Reply-To: <230501.86h6swjp3r.gmgdl@evledraar.gmail.com>

Ævar Arnfjörð Bjarmason <avarab@gmail.com> writes:

Show 14 quoted lines

> On Thu, Apr 27 2023, Glen Choo via GitGitGadget wrote:
>
> Re subject: I don't per-se mind the "add headings" formatting change,
> but doesn't it have headings already? I.e.:
>
>> -Git-specific tips & things to know about how we run "spatch":
>> +== Git-specific tips & things to know about how we run "spatch":
>>  
>>   * The "make coccicheck" will piggy-back on
>>     "COMPUTE_HEADER_DEPENDENCIES". If you've built a given object file
>
> I think it was clear before that that was a "heading", at least in the
> sense that it summarized what the indented part that followed was
> discussing.

As Junio guessed downthread, I was primarily aiming to heading-ify the other parts of the doc.

> I think what this is really doing is converting this part of the doc to
> asciidoc, but is anything actually rendering it as asciidoc?

And as Felipe mentioned downthread, I chose to author it as asciidoc because I also find structured docs easier to read, and asciidoc seems to be the closest thing to a standardized format we have. You're right that nothing renders this as asciidoc.

Thanks, all :)

> If we are converting it to asciidoc shouldn't the bullet-points be
> un-indented too? (I'm not sure, but couldn't find a part of our build
> that actually feeds this through asciidoc, so spot-checking that wasn't
> trivial...)

Thanks Felipe for checking.