linux-kernel - Re: [PATCH] docs, nvme: add a feature and quirk policy document

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] [day] [month] [year] [list]

Message-ID: <87sfh6mchs.fsf@meer.lwn.net>
Date:   Fri, 23 Dec 2022 07:16:31 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Christoph Hellwig <hch@....de>
Cc:     Christoph Hellwig <hch@....de>, axboe@...a.com, sagi@...mberg.me,
        kbusch@...nel.org, linux-nvme@...ts.infradead.org,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Jens Axboe <axboe@...nel.dk>
Subject: Re: [PATCH] docs, nvme: add a feature and quirk policy document

Christoph Hellwig <hch@....de> writes:

> On Thu, Dec 22, 2022 at 01:54:35PM -0700, Jonathan Corbet wrote:
>> I'm not really a fan of adding more top-level directories; one of these
>> years I'd like to try to move things in the opposite direction.  That is
>> a battle for another day, though; for now let's just go with this and
>> get the document merged.
>
> I though about that, but could not thing of a good subdirectory.

We can paint that shed another day :)

>> That said, I suspect you'll add a build warning about the new document
>> not being included in any toctree.  Fixing that would involve adding a
>> basic index.rst to the new directory and adding that to a file like
>> Documentation/subsystem-apis.rst.
>
> The new document is included in
> Documentation/maintainer/maintainer-entry-profile.rst in this path.

Duh sorry, I'm not quite sure what I was thinking there.

> I also did check for new warnings and did not see any, even if that's
> a little difficult with the rather chatty shpinx output.

Someday we'll get all those warnings gone...I hope...

Meanwhile, if it's useful:

Acked-by: Jonathan Corbet <corbet@....net>

Thanks,

jon