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

Jonathan Corbet
2025-03-07T14:22:30Z

Pratyush Yadav <ptyadav@amazon.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@amazon.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/.

From a quick perusal of your documentation:

- You never say what "KHO" is

- Your boxes live in a single global namespace?

- What sort of access control applies to one of these boxes? What keeps
me from mucking around inside somebody else's box?

Thanks,

jon