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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <8e670c7b-b7e7-80aa-343b-4e9d429b61ec@lenovo.com>
Date:   Wed, 9 Dec 2020 10:04:22 -0500
From:   Mark Pearson <markpearson@...ovo.com>
To:     Jonathan Corbet <corbet@....net>
CC:     Stephen Rothwell <sfr@...b.auug.org.au>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Hans de Goede <hdegoede@...hat.com>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Linux Next Mailing List <linux-next@...r.kernel.org>
Subject: Re: [External] linux-next: build failure after merge of the pm tree

Hi Jon,

On 09/12/2020 09:33, Jonathan Corbet wrote:
> On Wed, 9 Dec 2020 08:56:31 -0500 Mark Pearson
> <markpearson@...ovo.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