• Steve Beattie's avatar
    manpages: incorporate podchecker; fix errors and (most) warnings · c48d7dc7
    Steve Beattie authored
    This patch adds a 'check_pod_files' make target to the common make
    rules, and then fixes the errors it highlighted as well as most of
    the warnings. It will cause 'make check' in most of the directories to
    fail if there are errors in a pod file (but not if there are warnings).
    
    Common issues were:
    
      - using an '=over/=back' pair for code-like snippets that did not
        contain any =items therein; the =over keyword is intended for
        indenting lists of =item entries, and generates a warning if
        there isn't any.
    
      - not escaping '<' or '>'
    
      - blank lines that contained spaces or tabs
    
    The second -warnings flag passed to podchecker is to add additional
    warnings, un-escaped '<' and '>' being of them.
    
    I did not fix all of the warnings in apparmor.d.pod, as I have not come
    up with a good warning-free way to express the BNF of the language
    similar in format to what is currently generated. The existing
    libapparmor warnings (complaints about duplicate =item definition
    names) are actually a result of passing the second -warnings flag.
    The integration into libapparmor is suboptimal due to automake's
    expectation that there will be a test driver program(s) for make check
    targets; that's why I added the podchecker call to the manpage
    generation point.
    Signed-off-by: Steve Beattie's avatarSteve Beattie <steve@nxnw.org>
    Acked-by: 's avatarSeth Arnold <seth.arnold@canonical.com>
    ---
     changehat/mod_apparmor/Makefile         |    3 
     changehat/mod_apparmor/mod_apparmor.pod |   28 ++-
     common/Make.rules                       |    4 
     libraries/libapparmor/doc/Makefile.am   |    7 
     parser/Makefile                         |    2 
     parser/apparmor.d.pod                   |  275
    +++++++++++++-------------------
     utils/Makefile                          |    3 
     utils/aa-cleanprof.pod                  |    2 
     utils/aa-complain.pod                   |    2 
     utils/aa-decode.pod                     |    2 
     utils/aa-easyprof.pod                   |   69 +++-----
     utils/aa-enforce.pod                    |    2 
     utils/aa-genprof.pod                    |    2 
     utils/aa-logprof.pod                    |    6 
     utils/aa-sandbox.pod                    |   64 ++-----
     utils/logprof.conf.pod                  |    2 
     utils/vim/Makefile                      |    2 
     17 files changed, 212 insertions(+), 263 deletions(-)
    c48d7dc7
aa-sandbox.pod 6.16 KB