From: Stephen Kitt <steve@sk2.org>
To: Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Stephen Kitt <steve@sk2.org>
Subject: [PATCH v2 0/8] docs: sysctl/kernel.rst rework
Date: Tue, 18 Feb 2020 13:59:15 +0100 [thread overview]
Message-ID: <20200218125923.685-1-steve@sk2.org> (raw)
Hi,
A recent discussion about differences in the "panic" description in
sysctl/kernel.rst led me to look into completing that file, and it
turned out that more work was needed than documenting "panic". This
patch series is the first batch, making the resulting documentation
hopefully nicer and more accurate. It doesn't add fields that are
present in 5.5 but not documented; I've started adding these, but I'd
rather submit them individually once the basic kernel.rst is
committed, to make it easier to request review from the appropriate
maintainers (each patch adding documentation should be mergeable
separately, without needing a patch series).
Regards,
Stephen
Changes in v2:
* in the first patch, drop the first kernel version mention, leave the
copyright lines alone;
* in the second patch, merge : and ::, drop a smartquote in favour of
a plain quote;
* in commit messages, give the references used for the documentation;
* add a script to check the documentation against the code;
* drop the rtsig entries which are not relevant now (as revealed by
the check script).
Stephen Kitt (8):
docs: pretty up sysctl/kernel.rst
docs: merge debugging-modules.txt into sysctl/kernel.rst
docs: drop l2cr from sysctl/kernel.rst
docs: add missing IPC documentation in sysctl/kernel.rst
docs: document stop-a in sysctl/kernel.rst
docs: document panic fully in sysctl/kernel.rst
docs: add a script to check sysctl docs
docs: sysctl/kernel: remove rtsig entries
Documentation/admin-guide/sysctl/kernel.rst | 1029 ++++++++++---------
Documentation/debugging-modules.txt | 22 -
scripts/check-sysctl-docs | 181 ++++
3 files changed, 707 insertions(+), 525 deletions(-)
delete mode 100644 Documentation/debugging-modules.txt
create mode 100755 scripts/check-sysctl-docs
base-commit: 359c92c02bfae1a6f1e8e37c298e518fd256642c
--
2.20.1
next reply other threads:[~2020-02-18 13:05 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-18 12:59 Stephen Kitt [this message]
2020-02-18 12:59 ` [PATCH v2 1/8] docs: pretty up sysctl/kernel.rst Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 2/8] docs: merge debugging-modules.txt into sysctl/kernel.rst Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 3/8] docs: drop l2cr from sysctl/kernel.rst Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 4/8] docs: add missing IPC documentation in sysctl/kernel.rst Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 5/8] docs: document stop-a " Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 6/8] docs: document panic fully " Stephen Kitt
2020-02-18 12:59 ` [PATCH v2 7/8] docs: add a script to check sysctl docs Stephen Kitt
2020-02-19 10:44 ` Jonathan Corbet
2020-02-19 15:25 ` Stephen Kitt
2020-02-19 17:33 ` Jonathan Corbet
2020-02-18 12:59 ` [PATCH v2 8/8] docs: sysctl/kernel: remove rtsig entries Stephen Kitt
2020-02-19 10:45 ` [PATCH v2 0/8] docs: sysctl/kernel.rst rework 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=20200218125923.685-1-steve@sk2.org \
--to=steve@sk2.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@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;
as well as URLs for NNTP newsgroup(s).