From 9799445af124c2476c7e0cc5432375348b6a4724 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Tue, 14 Aug 2018 13:43:12 +0200 Subject: docs: tidy up TOCs and refs to license-rules.rst The documentation and TOCs are organized in a manner of a tree. Adding a TOC to the root, which refers to a file which is located in a subfolder forms a grid. Those TOCs are a bit confusing and thats why we get additional error messages while building partial documentation:: $ make SPHINXDIRS=process htmldocs ... checking consistency... Documentation/process/license-rules.rst: \ WARNING: document isn't included in any toctree To fix it, the *root-license-TOC* is replaced by a reference and the 'license-roles.txt' is added to the Documentation/process/index.rst TOC. BTW: there was an old licences remark in Documentation/process/howto.rst which is also updated, mentioning SPDX and pointing to the license-rules.rst Signed-off-by: Markus Heiser Signed-off-by: Jonathan Corbet --- Documentation/process/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/process/index.rst') diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst index 37bd0628b6ee..c0b3bd25dbae 100644 --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@ -19,6 +19,7 @@ Below are the essential guides that every developer should read. .. toctree:: :maxdepth: 1 + license-rules howto code-of-conflict development-process -- cgit From 84253c8be37d5f0b54d624be1bd1b90bbbfe14b3 Mon Sep 17 00:00:00 2001 From: Kees Cook Date: Wed, 17 Oct 2018 16:45:32 -0700 Subject: docs: Introduce deprecated APIs list As discussed in the "API replacement/deprecation" thread[1], this makes an effort to document what things shouldn't get (re)added to the kernel, by introducing Documentation/process/deprecated.rst. [1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html Signed-off-by: Kees Cook Signed-off-by: Jonathan Corbet --- Documentation/process/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation/process/index.rst') diff --git a/Documentation/process/index.rst b/Documentation/process/index.rst index c0b3bd25dbae..1ddde440f333 100644 --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@ -42,6 +42,7 @@ Other guides to the community that are of interest to most developers are: stable-kernel-rules submit-checklist kernel-docs + deprecated These are some overall technical guides that have been put here for now for lack of a better place. -- cgit