From: Sasha Levin <sashal@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: corbet@lwn.net, linux-doc@vger.kernel.org, josh@joshtriplett.org,
kees@kernel.org, konstantin@linuxfoundation.org,
linux-kernel@vger.kernel.org, rostedt@goodmis.org,
workflows@vger.kernel.org, joe@perches.com,
rdunlap@infradead.org
Subject: Re: [PATCH v4] README: restructure with role-based documentation and guidelines
Date: Wed, 19 Nov 2025 10:48:37 -0500 [thread overview]
Message-ID: <aR3m1YdtiylRf0Td@laps> (raw)
In-Reply-To: <20251119084353.658db390@foz.lan>
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@kernel.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
next prev parent reply other threads:[~2025-11-19 15:48 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-19 2:38 Sasha Levin
2025-11-19 6:10 ` Randy Dunlap
2025-11-19 7:43 ` Mauro Carvalho Chehab
2025-11-19 15:48 ` Sasha Levin [this message]
2025-11-19 22:34 ` Kees Cook
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aR3m1YdtiylRf0Td@laps \
--to=sashal@kernel.org \
--cc=corbet@lwn.net \
--cc=joe@perches.com \
--cc=josh@joshtriplett.org \
--cc=kees@kernel.org \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=rdunlap@infradead.org \
--cc=rostedt@goodmis.org \
--cc=workflows@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox