lkml.org 
[lkml]   [2018]   [Aug]   [31]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] docs: tidy up TOCs and refs to license-rules.rst
On Tue, 14 Aug 2018 13:43:12 +0200
Markus Heiser <markus.heiser@darmarit.de> wrote:

> 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

So those are two separate changes and should really have been in two
different patches. I guess we can let that slide just this
once...applied.

I do have to wonder if the licensing rules are *really* the most
important thing in our docs - the thing that readers should encounter
first, before anything else. I think I'll revisit that at another time...

Thanks,

jon

\
 
 \ /
  Last update: 2018-09-01 00:55    [W:0.036 / U:0.568 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site