The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: Thomas Gleixner <tglx@linutronix.de>,
	Jonas Oberg <jonas@fsfe.org>,
	Philippe Ombredanne <pombredanne@nexb.com>,
	Kate Stewart <kstewart@linuxfoundation.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: tidy up TOCs and refs to license-rules.rst
Date: Fri, 31 Aug 2018 16:50:15 -0600	[thread overview]
Message-ID: <20180831165015.1461bdc7@lwn.net> (raw)
In-Reply-To: <20180814114312.23201-1-markus.heiser@darmarit.de>

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

  reply	other threads:[~2018-08-31 22:50 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-08-14 11:43 [PATCH] docs: tidy up TOCs and refs to license-rules.rst Markus Heiser
2018-08-31 22:50 ` Jonathan Corbet [this message]
2018-09-01  7:32   ` Markus Heiser

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180831165015.1461bdc7@lwn.net \
    --to=corbet@lwn.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=jonas@fsfe.org \
    --cc=kstewart@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=pombredanne@nexb.com \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox