Re: [External] linux-next: build failure after merge of the pm tree

[Jonathan Corbet <corbet@lwn.net>]

On Wed, 9 Dec 2020 10:04:22 -0500
Mark Pearson <markpearson@lenovo.com> wrote:

> 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 :)

No, not quite; stuff in the ABI directory should be in the special format
used there.  You're partway there, but the free text outside of the
entries itself doesn't belong there.  I'd split the file, moving the free
text to an RST file, probably in the admin guide.  The actual ABI entry
information stays in the file you've added now. 

Thanks,

jon