From: Jonathan Corbet <corbet@lwn.net>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Thorsten Leemhuis <linux@leemhuis.info>,
Linus Torvalds <torvalds@linux-foundation.org>,
linux-doc@vger.kernel.org
Cc: kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [RFC PATCH 0/2] Rework the kernel's README.rst
Date: Thu, 28 Jul 2022 09:56:19 -0600 [thread overview]
Message-ID: <87czdpb598.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220720041325.15693-1-lukas.bulwahn@gmail.com>
Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:
> As far as I see, the README.rst file in Documentation/admin-guide/ covers
> three rather outdated (or subsumed) aspects:
>
> 1. mentioning that it is possible to "run a.out user programs with this kernel"
>
> 2. how to report a kernel bug
>
> 3. the explanations around the use of LILO as a boot loader
>
> This patch series addressed the first two aspects; the third one simply
> first needs some more experimenting/experience on my side to update
> the description of the setup with a GRUB boot loader.
>
> I am happy if anyone else contributes or helps with this rework task on
> the third aspect.
>
> I am also adding Linus as recipient, as he seems to be the original author,
> i.e., in the text, 'me' refers to Linus.
>
> Please let me know if you are generally fine with this approach, and
> if there is something on the other documentation to be done to get this
> patch accepted.
The changes seem fine to me; I'll apply them after the merge window if
nobody objects.
Longer term it's probably worth thinking about what the README.rst file
is for. It seems like we should have one starting point for somebody's
first encounter with the docs; that would likely either be this file or
Documentation/index.rst but not both. I keep meaning to try to improve
the initial documentation experience, but haven't found the time yet...
Thanks,
jon
next prev parent reply other threads:[~2022-07-28 15:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-07-20 4:13 [RFC PATCH 0/2] Rework the kernel's README.rst Lukas Bulwahn
2022-07-20 4:13 ` [RFC PATCH 1/2] docs: admin-guide: do not mention the 'run a.out user programs' feature Lukas Bulwahn
2022-07-20 4:13 ` [RFC PATCH 2/2] docs: admin-guide: for kernel bugs refer to other kernel documentation Lukas Bulwahn
2022-07-28 15:56 ` Jonathan Corbet [this message]
2022-08-29 17:10 ` [RFC PATCH 0/2] Rework the kernel's README.rst Jonathan Corbet
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=87czdpb598.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@leemhuis.info \
--cc=lukas.bulwahn@gmail.com \
--cc=torvalds@linux-foundation.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;
as well as URLs for NNTP newsgroup(s).