|
 |
ba407d |
From 3b439fb64d8d65b0c09aa8452bf0181ec20f8bcf Mon Sep 17 00:00:00 2001
|
|
|
ba407d |
From: Jose Castillo <jcastillo@redhat.com>
|
|
|
ba407d |
Date: Wed, 3 Mar 2021 13:03:16 +0100
|
|
|
ba407d |
Subject: [PATCH] [man] Multiple fixes in man pages
|
|
|
ba407d |
|
|
|
ba407d |
This patch fixes references to sosreport, to the
|
|
|
ba407d |
preferred 'sos report'. Also adds "SEE ALSO" consistently
|
|
|
ba407d |
for all man pages, and fixes a MAINTAINER line.
|
|
|
ba407d |
|
|
|
ba407d |
Resolves: #2432
|
|
|
ba407d |
|
|
|
ba407d |
Signed-off-by: Jose Castillo <jcastillo@redhat.com>
|
|
|
ba407d |
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
|
|
|
ba407d |
---
|
|
|
ba407d |
man/en/sos-clean.1 | 5 +++++
|
|
|
ba407d |
man/en/sos-collect.1 | 1 +
|
|
|
ba407d |
man/en/sos-report.1 | 22 ++++++++++++++--------
|
|
|
ba407d |
3 files changed, 20 insertions(+), 8 deletions(-)
|
|
|
ba407d |
|
|
|
ba407d |
diff --git a/man/en/sos-clean.1 b/man/en/sos-clean.1
|
|
|
ba407d |
index 0c62ed07..d64a0ec7 100644
|
|
|
ba407d |
--- a/man/en/sos-clean.1
|
|
|
ba407d |
+++ b/man/en/sos-clean.1
|
|
|
ba407d |
@@ -77,6 +77,11 @@ Default: 4
|
|
|
ba407d |
.TP
|
|
|
ba407d |
.B \-\-no-update
|
|
|
ba407d |
Do not write the mapping file contents to /etc/sos/cleaner/default_mapping
|
|
|
ba407d |
+.SH SEE ALSO
|
|
|
ba407d |
+.BR sos (1)
|
|
|
ba407d |
+.BR sos-report (1)
|
|
|
ba407d |
+.BR sos-collect (1)
|
|
|
ba407d |
+
|
|
|
ba407d |
.SH MAINTAINER
|
|
|
ba407d |
.nf
|
|
|
ba407d |
Jake Hunsaker <jhunsake@redhat.com>
|
|
|
ba407d |
diff --git a/man/en/sos-collect.1 b/man/en/sos-collect.1
|
|
|
ba407d |
index d4e5e648..da36542d 100644
|
|
|
ba407d |
--- a/man/en/sos-collect.1
|
|
|
ba407d |
+++ b/man/en/sos-collect.1
|
|
|
ba407d |
@@ -330,6 +330,7 @@ Sosreport option. Override the default compression type.
|
|
|
ba407d |
.SH SEE ALSO
|
|
|
ba407d |
.BR sos (1)
|
|
|
ba407d |
.BR sos-report (1)
|
|
|
ba407d |
+.BR sos-clean (1)
|
|
|
ba407d |
|
|
|
ba407d |
.SH MAINTAINER
|
|
|
ba407d |
Jake Hunsaker <jhunsake@redhat.com>
|
|
|
ba407d |
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1
|
|
|
ba407d |
index e7fae97b..81005959 100644
|
|
|
ba407d |
--- a/man/en/sos-report.1
|
|
|
ba407d |
+++ b/man/en/sos-report.1
|
|
|
ba407d |
@@ -38,11 +38,12 @@ sosreport \- Collect and package diagnostic and support data
|
|
|
ba407d |
[-h|--help]\fR
|
|
|
ba407d |
|
|
|
ba407d |
.SH DESCRIPTION
|
|
|
ba407d |
-\fBsosreport\fR generates an archive of configuration and diagnostic
|
|
|
ba407d |
-information from the running system. The archive may be stored locally
|
|
|
ba407d |
-or centrally for recording or tracking purposes or may be sent to
|
|
|
ba407d |
-technical support representatives, developers or system administrators
|
|
|
ba407d |
-to assist with technical fault-finding and debugging.
|
|
|
ba407d |
+\fBreport\fR is an sos subcommand that generates an archive of
|
|
|
ba407d |
+configuration and diagnostic information from the running system.
|
|
|
ba407d |
+The archive may be stored locally or centrally for recording or
|
|
|
ba407d |
+tracking purposes or may be sent to technical support representatives,
|
|
|
ba407d |
+developers or system administrators to assist with technical
|
|
|
ba407d |
+fault-finding and debugging.
|
|
|
ba407d |
.LP
|
|
|
ba407d |
Sos is modular in design and is able to collect data from a wide
|
|
|
ba407d |
range of subsystems and packages that may be installed. An
|
|
|
ba407d |
@@ -110,8 +111,8 @@ User defined presets are saved under /var/lib/sos/presets as JSON-formatted file
|
|
|
ba407d |
.B \--add-preset ADD_PRESET [options]
|
|
|
ba407d |
Add a preset with name ADD_PRESET that enables [options] when called.
|
|
|
ba407d |
|
|
|
ba407d |
-For example, 'sosreport --add-preset mypreset --log-size=50 -n logs' will enable
|
|
|
ba407d |
-a user to run 'sosreport --preset mypreset' that sets the maximum log size to
|
|
|
ba407d |
+For example, 'sos report --add-preset mypreset --log-size=50 -n logs' will enable
|
|
|
ba407d |
+a user to run 'sos report --preset mypreset' that sets the maximum log size to
|
|
|
ba407d |
50 and disables the logs plugin.
|
|
|
ba407d |
|
|
|
ba407d |
Note: to set a description for the preset that is displayed with \fB--list-presets\fR,
|
|
|
ba407d |
@@ -343,9 +344,14 @@ been tested for this port or may still be under active development.
|
|
|
ba407d |
.TP
|
|
|
ba407d |
.B \--help
|
|
|
ba407d |
Display usage message.
|
|
|
ba407d |
+.SH SEE ALSO
|
|
|
ba407d |
+.BR sos (1)
|
|
|
ba407d |
+.BR sos-clean (1)
|
|
|
ba407d |
+.BR sos-collect (1)
|
|
|
ba407d |
+
|
|
|
ba407d |
.SH MAINTAINER
|
|
|
ba407d |
.nf
|
|
|
ba407d |
-Bryn M. Reeves <bmr@redhat.com>
|
|
|
ba407d |
+Jake Hunsaker <jhunsake@redhat.com>
|
|
|
ba407d |
.fi
|
|
|
ba407d |
.SH AUTHORS & CONTRIBUTORS
|
|
|
ba407d |
See \fBAUTHORS\fR file in the package documentation.
|
|
|
ba407d |
--
|
|
|
ba407d |
2.26.3
|
|
|
ba407d |
|