config/debuginfod.sysconfig: Clarify & classify the variables

Some of them are for debuginfod command line; others are environment
variables for the embedded client library.

Signed-off-by: Frank Ch. Eigler <fche@redhat.com>

diff --git a/config/ChangeLog b/config/ChangeLog
index cfb37b4223d98d1ef0d79579ade9c7f2cf52f89c..a444457ef98b739f1a8d5f94d27f1ac5bb9f1298 100644 (file)
--- a/config/ChangeLog
+++ b/config/ChangeLog
@@ -1,3 +1,7 @@
+2022-08-17  Frank Ch. Eigler  <fche@redhat.com>
+
+       * debuginfod.sysconfig: Clarify cmdline vs client-env variables.
+
 2022-05-03  Mark Wielaard  <mark@klomp.org>
 
        * profile.csh.in: Move the 2>/dev/null inside the sh -c '' quotes.

diff --git a/config/debuginfod.sysconfig b/config/debuginfod.sysconfig
index ae49a5af634d3448ab88a14c9c5f54d26b133d96..4ffb7e02d037673c2f1bff32ffd05e374dcfbb0c 100644 (file)
--- a/config/debuginfod.sysconfig
+++ b/config/debuginfod.sysconfig
@@ -1,16 +1,26 @@
-#
+#################
+# debuginfod command line options
+# see [man debuginfod]
+
+# required
 DEBUGINFOD_PORT="8002"
+
+# add more -v for more verbosity
 DEBUGINFOD_EXTRA_ARGS="-t43200 -F -R"
-#DEBUGINFOD_VERBOSE="-v"
 
 # some common places to find trustworthy ELF/DWARF files and RPMs
 DEBUGINFOD_PATHS="/usr/lib/debug /usr/bin /usr/libexec /usr/sbin /usr/lib /usr/lib64 /var/cache/yum /var/cache/dnf /var/lib/pulp"
 
-# prefer reliability/durability over performance
+# prefer sqlite database durability over performance
 #DEBUGINFOD_PRAGMAS="-D 'pragma synchronous=full;'"
 
-# upstream debuginfods
+#################
+# these environment variables affect federated queries to upstream servers
+# see [man debuginfod-client-config]
+
 #DEBUGINFOD_URLS="http://secondhost:8002 http://thirdhost:8002"
 #DEBUGINFOD_TIMEOUT="5"
 #DEBUGINFOD_RETRY_LIMIT="2"
 #DEBUGINFOD_CACHE_DIR=""
+#DEBUGINFOD_VERBOSE="1"
+#DEBUGINFOD_PROGRESS="1"