[apparmor] [patch] parser/apparmor.d.pod: fix manpage formatting issues

Seth Arnold seth.arnold at canonical.com
Tue Jun 2 18:43:41 UTC 2015


On Tue, Jun 02, 2015 at 10:17:44AM -0700, Steve Beattie wrote:
>  - added preceding space before the '*' and '**' explanation =item
>    entries; without these the list would get treated as a bullet list
>    and then the pod tools would complain that the later entries were not
>    bullet list items (added a comment to explain as well)

>  
> -=item B<*>
> +=item B< *>
>  
>  can substitute for any number of characters, excepting '/'
>  
> -=item B<**>
> +=item B< **>
>  
>  can substitute for any number of characters, including '/'
>  
> @@ -1349,6 +1357,8 @@ with the I<allow> qualifier.
>  Specifies that the task must have the same euid/fsuid as the object being
>  referenced by the permission check.
>  
> +=back
> +

Most of this patch is really good but this change seems awkward; it
causes the rendering to look funny in the terminal and doesn't change
the HTML output when rendered by firefox.

The * and ** entries don't line up with the others:

   Globbing
       File resources may be specified with a globbing syntax
       similar to that used by popular shells, such as csh(1),
       bash(1), zsh(1).

        *  can substitute for any number of characters, excepting
           '/'

        ** can substitute for any number of characters, including
           '/'

       ?   can substitute for any single character excepting '/'

       [abc]
           will substitute for the single character a, b, or c

       [a-c]
           will substitute for the single character a, b, or c

       [^a-c]
           will substitute for any single character not matching a,
           b or c

       {ab,cd}
           will expand to one rule to match ab, one rule to match cd

(This output is generated with an alias I've written to make
copy-and-pasting manpages to stack overflow work better:
soman is aliased to `MANPAGER=cat MANWIDTH=70 man -7 --nh --nj'
-- but the output looked similarly funny with the default rendering.)

I'd rather see this part of the patch dropped: it makes the text output
funnny and didn't appear to actually change the rendered html output.

Acked-by: Seth Arnold <seth.arnold at canonical.com>

Thanks!
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 473 bytes
Desc: Digital signature
URL: <https://lists.ubuntu.com/archives/apparmor/attachments/20150602/b6b601bb/attachment.pgp>


More information about the AppArmor mailing list