meta-starlingx/meta-stx-distro/recipes-security/gssproxy/files/Clarify-debug-and-debug_level-in-man-pages.patch

   1 From 384a1cff4855ad612ca71d3831a0c2c19a355c49 Mon Sep 17 00:00:00 2001
   2 From: Robbie Harwood <rharwood@redhat.com>
   3 Date: Wed, 11 Apr 2018 16:01:21 -0400
   4 Subject: [PATCH] Clarify debug and debug_level in man pages
   5
   6 In particular, add debug_level to gssproxy(5) since it was previously
   7 accepted but not documented.
   8
   9 Signed-off-by: Robbie Harwood <rharwood@redhat.com>
  10 Reviewed-by: Simo Sorce <simo@redhat.com>
  11 Merges: #229
  12 (cherry picked from commit e0e96e46be03102903533a9816b4deefe1adfaf8)
  13 ---
  14  proxy/man/gssproxy.8.xml      | 24 +++++++++++++++++++++++-
  15  proxy/man/gssproxy.conf.5.xml |  5 ++++-
  16  2 files changed, 27 insertions(+), 2 deletions(-)
  17
  18 diff --git a/proxy/man/gssproxy.8.xml b/proxy/man/gssproxy.8.xml
  19 index 1df4b0d..21f7e6a 100644
  20 --- a/proxy/man/gssproxy.8.xml
  21 +++ b/proxy/man/gssproxy.8.xml
  22 @@ -118,13 +118,35 @@
  23                      </para>
  24                  </listitem>
  25              </varlistentry>
  26 +
  27              <varlistentry>
  28                  <term>
  29                      <option>-d</option>,<option>--debug</option>
  30                  </term>
  31                  <listitem>
  32                      <para>
  33 -                        Turn on debugging.
  34 +                        Turn on debugging.  This option is identical to
  35 +                        --debug-level=1.
  36 +                    </para>
  37 +                </listitem>
  38 +            </varlistentry>
  39 +
  40 +            <varlistentry>
  41 +                <term>
  42 +                    <option>--debug-level=</option>
  43 +                </term>
  44 +                <listitem>
  45 +                    <para>
  46 +                        Turn on debugging at the specified level.  0
  47 +                        corresponds to no logging, while 1 turns on basic
  48 +                        debug logging.  Level 2 increases verbosity, including
  49 +                        more detailed credential verification.
  50 +                    </para>
  51 +                    <para>
  52 +                        At level 3 and above, KRB5_TRACE output is logged.  If
  53 +                        KRB5_TRACE was already set in the execution
  54 +                        environment, trace output is sent to its value
  55 +                        instead.
  56                      </para>
  57                  </listitem>
  58              </varlistentry>
  59 diff --git a/proxy/man/gssproxy.conf.5.xml b/proxy/man/gssproxy.conf.5.xml
  60 index ad9d96f..abb6745 100644
  61 --- a/proxy/man/gssproxy.conf.5.xml
  62 +++ b/proxy/man/gssproxy.conf.5.xml
  63 @@ -191,7 +191,10 @@
  64                  <varlistentry>
  65                      <term>debug (boolean)</term>
  66                      <listitem>
  67 -                        <para>Enable debugging to syslog.</para>
  68 +                        <para>
  69 +                            Enable debugging to syslog.  Setting to true is
  70 +                            identical to setting debug_level to 1.
  71 +                        </para>
  72                          <para>Default: debug = false</para>
  73                      </listitem>
  74                  </varlistentry>