[PATCH v2 0/8] docs: sysctl/kernel.rst rework

From: Stephen Kitt
Date: Tue Feb 18 2020 - 08:16:52 EST


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).



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