Re: [PATCH] [v2] Documentation: Provide guidelines for tool-generated content

From: Dave Hansen

Date: Thu Nov 13 2025 - 17:21:37 EST


On 11/7/25 17:52, Miguel Ojeda wrote:
>> + - The input to the tools you used, like the coccinelle source script.
> It seems there are still some bullets with periods and others without,
> but no big deal.

I went looking for some guidelines in the area. One thing that made
sense to me was that when you say:

* Something
* A thing
* More things

You avoid periods because they're not sentences. But, if you have:

* A real sentence that means something.
* It should have a period.

I tried to do that in here. So the bullets might not consistently end
with periods, but the sentences should.

Does that make sense to folks as a convention? I didn't see any official
guidance in the docs.