p71924506
/
linux_old1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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 <markus.heiser@darmarit.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Markus Heiser 2018-08-14 13:43:12 +02:00 committed by Jonathan Corbet
parent 60ca05c3b4
commit 9799445af1
4 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/index.rst
View File

@ -22,10 +22,7 @@ The following describes the license of the Linux kernel source code
(GPLv2), how to properly mark the license of individual files in the source (GPLv2), how to properly mark the license of individual files in the source
tree, as well as links to the full license text. tree, as well as links to the full license text.
.. toctree:: * :ref:`kernel_licensing`
:maxdepth: 2
process/license-rules.rst
User-oriented documentation User-oriented documentation
--------------------------- ---------------------------

13
Documentation/process/howto.rst
View File

@ -57,12 +57,13 @@ of doing things.
Legal Issues Legal Issues
------------ ------------
The Linux kernel source code is released under the GPL. Please see the The Linux kernel source code is released under the GPL. Please see the file
file, COPYING, in the main directory of the source tree, for details on COPYING in the main directory of the source tree. The Linux kernel licensing
the license. If you have further questions about the license, please rules and how to use `SPDX <https://spdx.org/>`_ identifiers in source code are
contact a lawyer, and do not ask on the Linux kernel mailing list. The descibed in :ref:`Documentation/process/license-rules.rst <kernel_licensing>`.
people on the mailing lists are not lawyers, and you should not rely on If you have further questions about the license, please contact a lawyer, and do
their statements on legal matters. not ask on the Linux kernel mailing list. The people on the mailing lists are
not lawyers, and you should not rely on their statements on legal matters.
For common questions and answers about the GPL, please see: For common questions and answers about the GPL, please see:

1
Documentation/process/index.rst
View File

@ -19,6 +19,7 @@ Below are the essential guides that every developer should read.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
license-rules
howto howto
code-of-conflict code-of-conflict
development-process development-process

2
Documentation/process/license-rules.rst
View File

@ -1,5 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0 .. SPDX-License-Identifier: GPL-2.0
.. _kernel_licensing:
Linux kernel licensing rules Linux kernel licensing rules
============================ ============================