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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <a5b57022-b7e1-436f-9830-e3825d5f5295@intel.com>
Date: Thu, 13 Nov 2025 14:21:36 -0800
From: Dave Hansen <dave.hansen@...el.com>
To: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>,
 Dave Hansen <dave.hansen@...ux.intel.com>
Cc: linux-kernel@...r.kernel.org, Steven Rostedt <rostedt@...dmis.org>,
 Dan Williams <dan.j.williams@...el.com>, Theodore Ts'o <tytso@....edu>,
 Sasha Levin <sashal@...nel.org>, Jonathan Corbet <corbet@....net>,
 Kees Cook <kees@...nel.org>, Greg Kroah-Hartman
 <gregkh@...uxfoundation.org>, Miguel Ojeda <ojeda@...nel.org>,
 Shuah Khan <shuah@...nel.org>
Subject: Re: [PATCH] [v2] Documentation: Provide guidelines for tool-generated
 content

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.