Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Subject: Re: [External] linux-next: build failure after merge of the pm tree
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>
References: <20201209205754.41ac2424@canb.auug.org.au>
 <203934b6-dd68-b02d-757f-c0336352d397@lenovo.com>
 <20201209073352.178d5027@lwn.net>
From:   Mark Pearson <markpearson@lenovo.com>
Message-ID: <8e670c7b-b7e7-80aa-343b-4e9d429b61ec@lenovo.com>
Date:   Wed, 9 Dec 2020 10:04:22 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101
 Thunderbird/78.4.0
MIME-Version: 1.0
In-Reply-To: <20201209073352.178d5027@lwn.net>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 7bit
Precedence: bulk

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