Blame SOURCES/sos-bz1311129-sos-conf-disabled-plugins-manpages.patch

d8dc0d
From 4cb21e2c16b55e7506a3cefd9148ba4bf49dbce1 Mon Sep 17 00:00:00 2001
d8dc0d
From: Pavel Moravec <pmoravec@redhat.com>
d8dc0d
Date: Wed, 17 Apr 2019 13:17:24 +0200
d8dc0d
Subject: [PATCH] [sosreport] update sos.conf manpages by [general] section
d8dc0d
 description
d8dc0d
d8dc0d
Since PR #1530, sosreport supports all command line options. Man pages
d8dc0d
should document the enhancement.
d8dc0d
d8dc0d
Resolves: #1652
d8dc0d
d8dc0d
Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
d8dc0d
---
d8dc0d
 man/en/sos.conf.5 | 38 ++++++++++++++++++++++++++++++++++----
d8dc0d
 1 file changed, 34 insertions(+), 4 deletions(-)
d8dc0d
d8dc0d
diff --git a/man/en/sos.conf.5 b/man/en/sos.conf.5
d8dc0d
index b40a48e1..ad18d5f2 100644
d8dc0d
--- a/man/en/sos.conf.5
d8dc0d
+++ b/man/en/sos.conf.5
d8dc0d
@@ -6,19 +6,49 @@ sos.conf \- sosreport configuration
d8dc0d
 sosreport uses a configuration file at /etc/sos.conf.
d8dc0d
 .SH PARAMETERS
d8dc0d
 .sp
d8dc0d
-There are two sections in the sosreport configuration file:
d8dc0d
-plugins, and tunables. Options are set using 'ini'-style
d8dc0d
-\fBname = value\fP pairs.
d8dc0d
+There are three sections in the sosreport configuration file:
d8dc0d
+general, plugins and tunables. Options are set using 'ini'-style
d8dc0d
+\fBname = value\fP pairs. Disabling/enabling a boolean option
d8dc0d
+is done the same way like on command line (e.g. process.lsof=off).
d8dc0d
 
d8dc0d
 Some options accept a comma separated list of values.
d8dc0d
 
d8dc0d
+Using options that dont expect a value (like all-logs or no-report)
d8dc0d
+will result in enabling those options, regardless of value set.
d8dc0d
+
d8dc0d
+Sections are parsed in the ordering:
d8dc0d
+.br
d8dc0d
+- \fB[general]\fP
d8dc0d
+.br
d8dc0d
+- \fB[plugins]\fP (disable)
d8dc0d
+.br
d8dc0d
+- \fB[plugins]\fP (enable)
d8dc0d
+.br
d8dc0d
+- \fB[tunables]\fP
d8dc0d
+
d8dc0d
+.TP
d8dc0d
+\fB[general]\fP
d8dc0d
+<option>      Sets (long) option value. Short options (i.e. z=auto)
d8dc0d
+              are not supported.
d8dc0d
 .TP
d8dc0d
 \fB[plugins]\fP
d8dc0d
-disable Comma separated list of plugins to disable.
d8dc0d
+disable       Comma separated list of plugins to disable.
d8dc0d
+.br
d8dc0d
+enable        Comma separated list of plugins to enable.
d8dc0d
 .TP
d8dc0d
 \fB[tunables]\fP
d8dc0d
 plugin.option Alter available options for defined plugin.
d8dc0d
 .SH EXAMPLES
d8dc0d
+To use quiet and batch mode with 10 threads:
d8dc0d
+.LP
d8dc0d
+[general]
d8dc0d
+.br
d8dc0d
+batch=yes
d8dc0d
+.br
d8dc0d
+build=true
d8dc0d
+.br
d8dc0d
+threads=10
d8dc0d
+.sp
d8dc0d
 To disable the 'general' and 'filesys' plugins:
d8dc0d
 .LP
d8dc0d
 [plugins]
d8dc0d
-- 
d8dc0d
2.17.2
d8dc0d
d8dc0d
From 84822ff1bbe2d5543daa8059b0a2270c88e473d6 Mon Sep 17 00:00:00 2001
d8dc0d
From: Pavel Moravec <pmoravec@redhat.com>
d8dc0d
Date: Wed, 17 Apr 2019 11:51:09 +0200
d8dc0d
Subject: [PATCH] [sosreport] initialize disabled plugins properly when parsing
d8dc0d
 sos.conf
d8dc0d
d8dc0d
opts.noplugins is referred when parsing "tunables" section, so
d8dc0d
the variable must be set to empty list every time.
d8dc0d
d8dc0d
Resolves: #1651
d8dc0d
d8dc0d
Signed-off-by: Pavel Moravec <pmoravec@redhat.com>
d8dc0d
---
d8dc0d
 sos/__init__.py | 2 +-
d8dc0d
 1 file changed, 1 insertion(+), 1 deletion(-)
d8dc0d
d8dc0d
diff --git a/sos/__init__.py b/sos/__init__.py
d8dc0d
index dfc7ed5f..ed59025a 100644
d8dc0d
--- a/sos/__init__.py
d8dc0d
+++ b/sos/__init__.py
d8dc0d
@@ -250,8 +250,8 @@ class SoSOptions(object):
d8dc0d
                 optlist.extend(SoSOptions._opt_to_args(opt, val))
d8dc0d
             opts._merge_opts(argparser.parse_args(optlist), is_default)
d8dc0d
 
d8dc0d
+        opts.noplugins = []
d8dc0d
         if config.has_option("plugins", "disable"):
d8dc0d
-            opts.noplugins = []
d8dc0d
             opts.noplugins.extend([plugin.strip() for plugin in
d8dc0d
                                   config.get("plugins", "disable").split(',')])
d8dc0d
 
d8dc0d
-- 
d8dc0d
2.17.2
d8dc0d