diff options
| author | Jose Castillo <jcastillo@redhat.com> | 2020-05-22 11:30:28 +0100 |
|---|---|---|
| committer | Jake Hunsaker <jhunsake@redhat.com> | 2021-02-22 10:33:00 -0500 |
| commit | 7ac0fdbc4a7467ffdf54a96fa4dced11a6be22ed (patch) | |
| tree | 1337fd7863f94bf7b514a957d555d4c34d511cd0 /man | |
| parent | 20d8938fe948c4bbfedd6b68b59a543e8b2baaca (diff) | |
| download | sos-7ac0fdbc4a7467ffdf54a96fa4dced11a6be22ed.tar.gz | |
Clarify default timeout for all plugins
The default timeout for all plugins is 300, but
the global timeout is set as -1 in the option list. This is
because this timeout is unset by default. This patch
attempts to clarify the -1 exposed to the user when using
commands like 'sos report -l', via the option description
as well as a note clarifying it in the man page.
Closes: #2003
Resolves: #2415
Signed-off-by: Jose Castillo <jcastillo@redhat.com>
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'man')
| -rw-r--r-- | man/en/sos-report.1 | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/man/en/sos-report.1 b/man/en/sos-report.1 index fcf3d020..e7fae97b 100644 --- a/man/en/sos-report.1 +++ b/man/en/sos-report.1 @@ -243,7 +243,8 @@ Specify the number of threads sosreport will use for concurrency. Defaults to 4. .TP .B \--plugin-timeout TIMEOUT Specify a timeout in seconds to allow each plugin to run for. A value of 0 -means no timeout will be set. +means no timeout will be set. A value of -1 is used to indicate the default +timeout of 300 seconds. Note that this options sets the timeout for all plugins. If you want to set a timeout for a specific plugin, use the 'timeout' plugin option available to |