]> asedeno.scripts.mit.edu Git - linux.git/commit
docs: Revamp tainted-kernels.rst to make it more comprehensible
authorThorsten Leemhuis <linux@leemhuis.info>
Tue, 8 Jan 2019 19:40:07 +0000 (20:40 +0100)
committerJonathan Corbet <corbet@lwn.net>
Tue, 8 Jan 2019 23:33:47 +0000 (16:33 -0700)
commit896dd323abbf6a9980d8aca2656b6c4bf5352c3b
treeb640e8cd5112db716c9e87fa4ef014eca2a56c70
parent4ab5a5d2a4a2289c2af07accbec7170ca5671f41
docs: Revamp tainted-kernels.rst to make it more comprehensible

Add a section about decoding /proc/sys/kernel/tainted, create a more
understandable intro and a hopefully explain better the tainted flags in
bugs, oops or panics messages. Only thing missing then is a table that
quickly describes the various bits and taint flags before going into more
detail, so add that as well.

That table is partly based on a section from Documentation/sysctl/kernel.txt,
but a bit more compact. To avoid confusion I added the shortened version to
kernel.txt; the same table is used in three different places now:
./tools/debugging/kernel-chktaint,
Documentation/admin-guide/tainted-kernels.rst and
Documentation/sysctl/kernel.txt

During review of v1 (see above) a number of existing issues with the text
were raised, like outdated usages as well as incomplete or missing
descriptions.  Address most of those as well.

Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info>
[jc: tightened up changelog]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/admin-guide/tainted-kernels.rst
Documentation/sysctl/kernel.txt