[PATCH 1/2] landlock: Minor typo and grammar fixes in IPC scoping documentation
Günther Noack
gnoack at google.com
Wed Feb 26 20:24:22 UTC 2025
Hello!
On Wed, Feb 12, 2025 at 04:06:06PM +0100, Alejandro Colomar wrote:
> So you could really use man9 for internal Landlock stuff. Even if I
> think generated documentation isn't ideal, it's better than nothing.
> Being able to use man(1) for reading kernel documentation would still be
> a nice feature.
>
> And while I can't run all the linters that I run on hand-written docs on
> generated pages (because generated source necessarily triggers many
> false positives), I could still run some, which would trigger some
> accidents in the docs, and would also detect bugs in the software
> translating the docs from one language to another.
>
> So, I'd still recommend you considering man9.
This is different to the BPF helpers; Landlock's existing man pages document
user space APIs, and the largest part of the kernel-side .rst documentation for
Landlock also covers only user space. Only a small part of the .rst
documentation is about kernel internals.
If I understood that correctly, section 9 is supposed to be document things that
are relevant to kernel developers, right? So it doesn't sound like the right
place for the documentation that we have?
—Günther
More information about the Linux-security-module-archive
mailing list