lkml.org 
[lkml]   [2020]   [Apr]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [RFC PATCH v2 11/12] documentation: Add IPE Documentation
    On Mon,  6 Apr 2020 15:14:38 -0700
    deven.desai@linux.microsoft.com wrote:

    > From: Deven Bowers <deven.desai@linux.microsoft.com>
    >
    > Add IPE's documentation to the kernel tree.
    >
    > Signed-off-by: Deven Bowers <deven.desai@linux.microsoft.com>

    Thanks for including this nice documentation from the outset! I have a
    couple of tiny nits to pick, but nothing really substantive to complain
    about, so:

    Acked-by: Jonathan Corbet <corbet@lwn.net>

    [...]

    > +IPE is a Linux Security Module, which allows for a configurable policy

    I'd drop the comma (I told you these were nits!)

    [...]

    > +IPE Policy
    > +~~~~~~~~~~
    > +
    > +IPE policy is designed to be both forward compatible and backwards
    > +compatible. There is one required line, at the top of the policy,
    > +indicating the policy name, and the policy version, for instance:
    > +
    > +::
    > +
    > + policy_name="Ex Policy" policy_version=0.0.0

    This pattern can be compressed a bit by just putting the "::" at the end of
    the last line of text:

    indicating the policy name, and the policy version, for instance::

    policy_name="Ex Policy" policy_version=0.0.0

    The result is a bit more readable in the plain-text format, IMO, and
    renders exactly the same in Sphinx.

    Thanks,

    jon

    \
     
     \ /
      Last update: 2020-04-14 17:39    [W:4.361 / U:0.200 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site