Linux Integrity Measurement development
 help / color / mirror / Atom feed
From: Ken Goldman <kgold@linux.ibm.com>
To: linux-kernel@vger.kernel.org, linux-integrity@vger.kernel.org
Subject: Re: Documentation on IMA for Linux Kernel Documentation
Date: Wed, 22 Mar 2023 18:02:21 -0400	[thread overview]
Message-ID: <c03bf464-00c1-9121-fb2f-549ac991a658@linux.ibm.com> (raw)
In-Reply-To: <a50110ca-843a-7586-ed2a-aca12702dde9@infradead.org>

On 3/13/2023 6:34 PM, Randy Dunlap wrote:
> On 3/13/23 15:25, Randy Dunlap wrote:
>> [add IMA list]
>>
>> On 3/13/23 14:43, 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.
>>>
>>> 2. What is the process for getting a block of documentation added to https://www.kernel.org/doc/html?
>>
>> 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.
> Ken, if you are not familiar with in-tree kernel documentation, you should take a look
> at the Documentation/doc-guide/ subdirectory for some documentation on the documentation.
>
> Also you can ask for help with specific issues at linux-doc@vger.kernel.org

I've read the guidelines, coding in rest markdown, using sphinx to test 
the web pages.  I think it's right.

1. I was hoping that someone could look at what I'm doing to see if it 
has a chance of acceptance.

I.e., I don't want to spend months on this only to get a quick 'nack'.

2. I wonder what the process for submission is.


  reply	other threads:[~2023-03-22 22:02 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <7c91820d-0153-e4db-1c60-38b6f650ed20@linux.ibm.com>
2023-03-13 22:25 ` Documentation on IMA for Linux Kernel Documentation Randy Dunlap
2023-03-13 22:34   ` Randy Dunlap
2023-03-22 22:02     ` Ken Goldman [this message]
2023-03-22 22:58       ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c03bf464-00c1-9121-fb2f-549ac991a658@linux.ibm.com \
    --to=kgold@linux.ibm.com \
    --cc=linux-integrity@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox