Re: [RFC PATCH 2/5] misc: add documentation for FDBox
From: Jonathan Corbet <corbet@lwn.net>
Date: 2025-03-07 15:25:08
Also in:
kexec, linux-fsdevel, linux-mm, lkml
Pratyush Yadav [off-list ref] writes:
On Fri, Mar 07 2025, Jonathan Corbet wrote:quoted
Pratyush Yadav [off-list ref] writes:quoted
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 <redacted> --- 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.rstPlease 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... :)