lkml.org 
[lkml]   [2022]   [Dec]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
SubjectRe: [PATCH] docs, nvme: add a feature and quirk policy document
Date
Christoph Hellwig <hch@lst.de> writes:

> On Wed, Dec 21, 2022 at 06:45:32AM -0700, Jonathan Corbet wrote:
>> Sorry, the argument is that the subsystem profiles there were created
>> for the very purpose of documenting subsystem-specific patch policies
>> like those found in your document. The hope is that, someday, people
>> will be able to go to one place to learn what special hoops any given
>> subsystem will make them jump through.
>>
>> This isn't something I'm going to dig in my heels on, though. But at a
>> minimum, could you add an entry to
>> Documentation/maintainer/maintainer-entry-profile.rst ?
>
> What about the following? This moves the file to a new
> Documentation/nvme/ directory and then links it form
> Documentation/maintainer/maintainer-entry-profile.rst:

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.

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.

Thanks,

jon

\
 
 \ /
  Last update: 2023-03-26 23:18    [W:0.366 / U:0.164 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site