On 3/22/2023 6:58 PM, Randy Dunlap wrote:
On 3/22/23 15:04, Ken Goldman wrote:
I'm writing documentation on IMA targeting users (not kernel developers). It includes concepts, details on writing policies, the IMA event log format, utilities, and more. It aggregates existing scattered documentation, but adds much more. It's maybe 1/2 done.
Questions:
1. Are there people who could look at it and see if I'm on the right path?
It's a lot of work. I'd like to know that it has some chance of acceptance.
Review in terms of IMA-specific content? or in terms of ReST usage?
or in general terms to see if it is appropriate for kernel tree documentation?
I think that you should Cc: linux-integrity@xxxxxxxxxxxxxxx for their input
as well as linux-doc@xxxxxxxxxxxxxxx. Several of us here can look at it for
general review feedback.
Not the accuracy - I have IMA experts looking at that.
I want to know if it'll be accepted, and if the structure is OK.
2. What is the process for getting a block of documentation added to
https://www.kernel.org/doc/html?
From last week's email:
It should be added to the kernel tree in the Documentation/userspace-api/ subdirectory
or Documentation/security/ subdirectory. The kernel.org/doc/ web pages are generated
from what is in the Linux kernel tree.
although if you don't think that it is appropriate for either of those subdirectories,
just explain and justify that and it might be possible to put it somewhere else.
"Where" comes later. I just want to know if it'll be accepted at all.