From: Mark Pearson <markpearson@lenovo.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Hans de Goede <hdegoede@redhat.com>,
Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Next Mailing List <linux-next@vger.kernel.org>
Subject: Re: [External] linux-next: build failure after merge of the pm tree
Date: Wed, 9 Dec 2020 10:04:22 -0500 [thread overview]
Message-ID: <8e670c7b-b7e7-80aa-343b-4e9d429b61ec@lenovo.com> (raw)
In-Reply-To: <20201209073352.178d5027@lwn.net>
Hi Jon,
On 09/12/2020 09:33, Jonathan Corbet wrote:
> On Wed, 9 Dec 2020 08:56:31 -0500 Mark Pearson
> <markpearson@lenovo.com> wrote:
>
>> I do see: WARNING: document isn't included in any toctree but I
>> think this is benign - I believe I'm getting it just because I
>> converted the file to .rst (as requested by Andy Shevchenko). If
>> this is important and needs to be addressed urgently as well let me
>> know.
>
> Normally this is solved by adding the newly created document to the
> index.rst file in the same directory.
>
> There isn't one in Documentation/ABI/testing, though; in fact, there
> are no RST files there. Files in Documentation/ABI are in a special
> format that is processed into RST during the docs build. If we want
> to add information outside of any specific ABI entry there, we're
> going to have to decide how we want to do that. It may well be,
> though, that the introductory information just belongs in the admin
> guide instead.
>
Should I just revert this file to plain text format?
I converted it to rst (as was requested) but I'm wondering if I'm just
causing a bunch of headaches and people are going to be cursing the one
weird random rst file in that directory going forwards :)
Mark
next prev parent reply other threads:[~2020-12-09 15:09 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-09 9:57 Stephen Rothwell
2020-12-09 13:56 ` [External] " Mark Pearson
2020-12-09 14:33 ` Jonathan Corbet
2020-12-09 15:04 ` Mark Pearson [this message]
2020-12-10 0:24 ` Jonathan Corbet
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=8e670c7b-b7e7-80aa-343b-4e9d429b61ec@lenovo.com \
--to=markpearson@lenovo.com \
--cc=corbet@lwn.net \
--cc=hdegoede@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=rjw@rjwysocki.net \
--cc=sfr@canb.auug.org.au \
/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
all inboxes | Powered by JetHome®