linux-kernel - Re: [RFC PATCH 2/5] misc: add documentation for FDBox

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: <87ecz87tik.fsf@trenco.lwn.net>
Date: Fri, 07 Mar 2025 08:25:07 -0700
From: Jonathan Corbet <corbet@....net>
To: Pratyush Yadav <ptyadav@...zon.de>
Cc: linux-kernel@...r.kernel.org, Eric Biederman <ebiederm@...ssion.com>,
 Arnd Bergmann <arnd@...db.de>, Greg Kroah-Hartman
 <gregkh@...uxfoundation.org>, Alexander Viro <viro@...iv.linux.org.uk>,
 Christian Brauner <brauner@...nel.org>, Jan Kara <jack@...e.cz>, Hugh
 Dickins <hughd@...gle.com>, Alexander Graf <graf@...zon.com>, Benjamin
 Herrenschmidt <benh@...nel.crashing.org>, David Woodhouse
 <dwmw2@...radead.org>, James Gowans <jgowans@...zon.com>, Mike Rapoport
 <rppt@...nel.org>, Paolo Bonzini <pbonzini@...hat.com>, Pasha Tatashin
 <tatashin@...gle.com>, Anthony Yznaga <anthony.yznaga@...cle.com>, Dave
 Hansen <dave.hansen@...el.com>, David Hildenbrand <david@...hat.com>, Jason
 Gunthorpe <jgg@...dia.com>, Matthew Wilcox <willy@...radead.org>, Wei Yang
 <richard.weiyang@...il.com>, Andrew Morton <akpm@...ux-foundation.org>,
 linux-fsdevel@...r.kernel.org, linux-doc@...r.kernel.org,
 linux-mm@...ck.org, kexec@...ts.infradead.org
Subject: Re: [RFC PATCH 2/5] misc: add documentation for FDBox

Pratyush Yadav <ptyadav@...zon.de> writes:

> On Fri, Mar 07 2025, Jonathan Corbet wrote:
>
>> Pratyush Yadav <ptyadav@...zon.de> writes:
>>
>>> With FDBox in place, add documentation that describes what it is and how
>>> it is used, along with its UAPI and in-kernel API.
>>>
>>> Since the document refers to KHO, add a reference tag in kho/index.rst.
>>>
>>> Signed-off-by: Pratyush Yadav <ptyadav@...zon.de>
>>> ---
>>>  Documentation/filesystems/locking.rst |  21 +++
>>>  Documentation/kho/fdbox.rst           | 224 ++++++++++++++++++++++++++
>>>  Documentation/kho/index.rst           |   3 +
>>>  MAINTAINERS                           |   1 +
>>>  4 files changed, 249 insertions(+)
>>>  create mode 100644 Documentation/kho/fdbox.rst
>>
>> Please do not create a new top-level directory under Documentation for
>> this; your new file belongs in userspace-api/.
>
> I did not. The top-level directory comes from the KHO patches [0] (not
> merged yet). This series is based on top of those. You can find the full
> tree here [1].
>
> Since this is closely tied to KHO I found it a good fit for putting it
> on KHO's directory. I don't have strong opinions about this so don't
> mind moving it elsewhere if you think that is better.

I've not seen the KHO stuff, but I suspect I'll grumble about that too.
Our documentation should be organized for its audience, not for its
authors.  So yes, I think that your documentation of the user-space
interface should definitely go in the userspace-api book.

Thanks,

jon

(Who now realizes he has been arguing this point of view for over ten
years ... eventually it will get across... :)