linux-kernel - Re: [PATCH v4] README: restructure with role-based documentation and guidelines

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <aR3m1YdtiylRf0Td@laps>
Date: Wed, 19 Nov 2025 10:48:37 -0500
From: Sasha Levin <sashal@...nel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: corbet@....net, linux-doc@...r.kernel.org, josh@...htriplett.org,
	kees@...nel.org, konstantin@...uxfoundation.org,
	linux-kernel@...r.kernel.org, rostedt@...dmis.org,
	workflows@...r.kernel.org, joe@...ches.com, rdunlap@...radead.org
Subject: Re: [PATCH v4] README: restructure with role-based documentation and
 guidelines

On Wed, Nov 19, 2025 at 08:43:53AM +0100, Mauro Carvalho Chehab wrote:
>Em Tue, 18 Nov 2025 21:38:32 -0500
>Sasha Levin <sashal@...nel.org> escreveu:
>> +Quick Start
>> +-----------
>>
>> -    https://www.kernel.org/doc/html/latest/
>> +* Report a bug: See Documentation/admin-guide/reporting-issues.rst
>
>Perhaps you might add a link to Documentation/process/security-bugs.rst
>as well, although it is already there at reporting-issues.rst.

I prefer to leave it in the security researcher section below to keep the quick
start "quick" :)

>> +* Get the latest kernel: https://kernel.org
>> +* Build the kernel: See Documentation/admin-guide/quickly-build-trimmed-linux.rst
>> +* Join the community: https://lore.kernel.org/
>>
>> -There are various text files in the Documentation/ subdirectory,
>> -several of them using the reStructuredText markup notation.
>> +Essential Documentation
>> +-----------------------
>>
>> -Please read the Documentation/process/changes.rst file, as it contains the
>> -requirements for building and running the kernel, and information about
>> -the problems which may result by upgrading your kernel.
>> +All users should be familiar with:
>> +
>> +* Building requirements: Documentation/process/changes.rst
>> +* Code of Conduct: Documentation/process/code-of-conduct.rst
>> +* License: COPYING (GPLv2)
>
>Hmm... "GPLv2" doesn't fit all, as it is GPL-2.0 WITH Linux-syscall-note,
>plus, as stated on COPYING:

Heh, I wanted to avoid sounding too SPDX-y and stole it from
Documentation/process/1.Intro.rst:

	Code is contributed to the Linux kernel under a number of licenses, but
	all code must be compatible with version 2 of the GNU General Public License
	(GPLv2), which is the license covering the kernel distribution as a whole.

>As we don't want to repeat the entire COPYING text here, better
>to just point to the file, e.g.
>
>	License: see COPYING

This makes sense.

-- 
Thanks,
Sasha