linux.git/Documentation/process/howto.rst, branch v4.20 Linux kernel source tree docs: tidy up TOCs and refs to license-rules.rst 2018-08-31T22:50:50+00:00 Markus Heiser markus.heiser@darmarit.de 2018-08-14T11:43:12+00:00 9799445af124c2476c7e0cc5432375348b6a4724 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> 
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/process/howto.rst: add a missing cross-reference 2018-06-29T15:24:15+00:00 Michael Rodin michael-git@rodin.online 2018-06-03T18:17:33+00:00 dad05139541359d61ea0850a7fc5311d9ca560f0 Add a missing cross-reference from Documentation/process/howto.rst to Documentation/admin-guide/README.rst. Signed-off-by: Michael Rodin <michael-git@rodin.online> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
Add a missing cross-reference from Documentation/process/howto.rst
to Documentation/admin-guide/README.rst.

Signed-off-by: Michael Rodin <michael-git@rodin.online>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/howto: Remove outdated info about bugzilla mailing lists 2018-02-18T23:49:25+00:00 Jonathan Neuschäfer j.neuschaefer@gmx.net 2018-02-13T22:06:32+00:00 bcd3cf0855c561d97146834c46f27aacc90252b4 The mailing list archives[1,2] show no activity since September 2011. [1]: https://lists.linuxfoundation.org/pipermail/bugme-new/ [2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/ Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The mailing list archives[1,2] show no activity since September 2011.

[1]: https://lists.linuxfoundation.org/pipermail/bugme-new/
[2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation: Delete reference to the kernel-mentors mailing list 2018-02-16T14:18:13+00:00 Minghui Liu minghui.liu.95@gmail.com 2018-02-16T01:03:14+00:00 bc0ef4a7e4c322ceeee00b1becab966cba7fedb7 Delete reference to the kernel-mentors mailing list because the mailing list no longer exists Signed-off-by: Minghui Liu <minghui.liu.95@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
Delete reference to the kernel-mentors mailing list because the mailing list no longer exists

Signed-off-by: Minghui Liu <minghui.liu.95@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: update old references for DocBook from the documentation 2017-05-16T11:44:19+00:00 Mauro Carvalho Chehab mchehab@s-opensource.com 2017-05-14T14:50:11+00:00 ff41c41943de489ccb12d064faae1e32265f7d56 DocBook is mentioned several times at the documentation. Update the obsolete references from it at the DocBook. Acked-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 
DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.

Acked-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/process/howto: Only send regression fixes after -rc1 2016-11-29T00:24:32+00:00 Dan Carpenter dan.carpenter@oracle.com 2016-11-28T14:43:15+00:00 388f9b20f98d4792f72091acac5031a99370827d The original text was not clear if white space or other harmless patches should be merged in -rc kernels. The discussion at Kernel Summit said that we should be more strict about sending regression fixes only. Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com> Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
The original text was not clear if white space or other harmless patches
should be merged in -rc kernels.  The discussion at Kernel Summit said
that we should be more strict about sending regression fixes only.

Signed-off-by: Dan Carpenter <dan.carpenter@oracle.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/process/howto: Mark subsection in suggested format 2016-11-08T00:03:50+00:00 SeongJae Park sj38.park@gmail.com 2016-10-31T20:27:10+00:00 d80b9d2aba35d2c9c030c77ad463454c077959ea `Specific guidelines for the kernel documentation` section of `kernel-documentation.rst` suggests to use ``~`` for subsection but subsections in HOWTO is not marked in the format. This commit marks them in the format. Signed-off-by: SeongJae Park <sj38.park@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net> 
`Specific guidelines for the kernel documentation` section of
`kernel-documentation.rst` suggests to use ``~`` for subsection but
subsections in HOWTO is not marked in the format.  This commit marks
them in the format.

Signed-off-by: SeongJae Park <sj38.park@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
docs: fix locations of several documents that got moved 2016-10-24T10:12:35+00:00 Mauro Carvalho Chehab mchehab@s-opensource.com 2016-10-18T12:12:27+00:00 8c27ceff3604b249a9efafbd1bd8b141b79e619d The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 
The previous patch renamed several files that are cross-referenced
along the Kernel documentation. Adjust the links to point to
the right places.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
docs-rst: add documents to development-process 2016-10-24T10:12:35+00:00 Mauro Carvalho Chehab mchehab@s-opensource.com 2016-09-21T11:40:21+00:00 186128f75392f8478ad1b32a675627d738881ca4 Add several documents to the development-process ReST book. As we don't want renames, use symlinks instead, keeping those documents on their original place. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> 
Add several documents to the development-process ReST book.

As we don't want renames, use symlinks instead, keeping those
documents on their original place.

Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>