diff options
| author | Jake Hunsaker <jhunsake@redhat.com> | 2017-12-24 13:04:44 -0500 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2018-04-17 15:33:39 +0100 |
| commit | 333918cba972db00d524074491593a2b080a153c (patch) | |
| tree | ccdec4ecdf04a62aee6cf50cdf9dbd1ddb053966 /man/en | |
| parent | ca755c2ee7b2ba8774b1f36555c6d9d39eeedff5 (diff) | |
| download | sos-333918cba972db00d524074491593a2b080a153c.tar.gz | |
[sosreport] Allow policies to change report name generation
This changes the way sos generates the name for the final archive.
Policies may now control the naming pattern by changing the new
'name_pattern' attribute. By default, this is set to 'legacy' for all
policies, and maintains the naming pattern that sos has used up until
this point. A policy may also set name_pattern to 'friendly' which will
result in a more user-friendly name for the archive. Additionally, a
policy may set name_pattern to a format() parsable string to explicitly
set how the tarball should be named.
Additionally, this removes the prompt for a 'customer name' on the
report when running interactively. Instead, the short hostname of the
system is now always used in place of the 'customer name'.
A new option, --label, has been added (and which --name will now map to)
which if provided will append a user-given string to the archive name
after the hostname.
This also sets the Red Hat policy to use the new 'friendly' pattern.
Closes: #469
Resolves: #1175
Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'man/en')
| -rw-r--r-- | man/en/sosreport.1 | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/man/en/sosreport.1 b/man/en/sosreport.1 index be7afd65..8ec70c7e 100644 --- a/man/en/sosreport.1 +++ b/man/en/sosreport.1 @@ -11,7 +11,7 @@ sosreport \- Collect and package diagnostic and support data [-k plug.opt|--plugin-option plug.opt]\fR [--no-report] [--config-file conf]\fR [--batch] [--build] [--debug]\fR - [--name name] [--case-id id] [--ticket-number nr] + [--label label] [--case-id id] [--ticket-number nr] [-s|--sysroot SYSROOT]\fR [-c|--chroot {auto|always|never}\fR [--tmp-dir directory]\fR @@ -124,7 +124,12 @@ Override the default compression type specified by the active policy. Generate archive without prompting for interactive input. .TP .B \--name NAME -Specify a name to be used for the archive. +Deprecated. See \--label +.TP +.B \--label LABEL +Specify an arbitrary identifier to associate with the archive. +Labels will be appended after the system's short hostname and may contain +alphanumeric characters. .TP .B \--case-id NUMBER Specify a case identifier to associate with the archive. |