]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/commitdiff
docs: tidy up TOCs and refs to license-rules.rst
authorMarkus Heiser <markus.heiser@darmarit.de>
Tue, 14 Aug 2018 11:43:12 +0000 (13:43 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 31 Aug 2018 22:50:50 +0000 (16:50 -0600)
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>
Documentation/index.rst
Documentation/process/howto.rst
Documentation/process/index.rst
Documentation/process/license-rules.rst

index 5db7e87c7cb1d615e6a361983f4ea545dd054c81..c858c2e66e361d2531a1f8d8cc996c98df8a7fd2 100644 (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
 tree, as well as links to the full license text.
 
-.. toctree::
-   :maxdepth: 2
-
-   process/license-rules.rst
+* :ref:`kernel_licensing`
 
 User-oriented documentation
 ---------------------------
index 130bf0f4887502d6ec3cd5e7b677e840439be859..dcb25f94188e42f0c5ccbae2cb6702ef38d1538c 100644 (file)
@@ -57,12 +57,13 @@ of doing things.
 Legal Issues
 ------------
 
-The Linux kernel source code is released under the GPL.  Please see the
-file, COPYING, in the main directory of the source tree, for details on
-the license.  If you have further questions about the license, please
-contact a lawyer, and do 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.
+The Linux kernel source code is released under the GPL.  Please see the file
+COPYING in the main directory of the source tree. The Linux kernel licensing
+rules and how to use `SPDX <https://spdx.org/>`_ identifiers in source code are
+descibed in :ref:`Documentation/process/license-rules.rst <kernel_licensing>`.
+If you have further questions about the license, please contact a lawyer, and do
+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:
 
index 37bd0628b6ee90989a8471cff080c78cc32c69cb..c0b3bd25dbae57deadca06767abb746701aa57ca 100644 (file)
@@ -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
index 8ea26325fe3f114474aa0b959f931aca1e410728..2bb8c0fc2238a25cd8fa47121bcbbefed88e81c0 100644 (file)
@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: GPL-2.0
 
+.. _kernel_licensing:
+
 Linux kernel licensing rules
 ============================