Resolves: RHEL-55399, diag_encl man and help page are not in sync

This commit is contained in:
Than Ngo 2024-10-27 15:56:44 +01:00
parent 6b71fdc084
commit 2c243daab9
2 changed files with 77 additions and 1 deletions

View File

@ -0,0 +1,72 @@
commit 565035cf98e97c7adda523221e109c676daf3430
Author: Barnali Guha Thakurata <barnali@linux.ibm.com>
Date: Mon Jan 8 20:16:19 2024 +0530
diag_encl help output update
This patch changes "scsi_enclosure" in the help output of diag_encl to
"sgn ..." so that it matches with the naming convention in the
manual page
Before patch:
diags/diag_encl --help
Usage: diags/diag_encl [-h] [-V] [...] [<scsi_enclosure>]
[...]
<scsi_enclosure>: the sg device on which to operate, such
as sg7; if not specified, all such
devices will be diagnosed
man diags/man/diag_encl.8
...
SYNOPSIS
diag_encl [-s [-c][-l]] [-v] [-f <path.pg2>] [sgn ...]
diag_encl -d
diag_encl --version
diag_encl --help
...
After patch:
diags/diag_encl --help
Usage: diags/diag_encl [-h] [-V] [...] [-f <path.pg2>] [<sgn ...>]
[...]
<sgn ...>: the scsi device on which to operate, such
as sg7; if not specified, all such
devices will be diagnosed
man diags/man/diag_encl.8
...
SYNOPSIS
diag_encl [-s [-c][-l]] [-v] [-f <path.pg2>] [sgn ...]
diag_encl -d
diag_encl --version
diag_encl --help
...
Signed-off-by: Barnali Guha Thakurata <barnali@linux.ibm.com>
diff --git a/diags/diag_encl.c b/diags/diag_encl.c
index 449b097..e0d86ce 100644
--- a/diags/diag_encl.c
+++ b/diags/diag_encl.c
@@ -75,8 +75,7 @@ static struct {
*/
static void
print_usage(const char *name) {
- printf("Usage: %s [-h] [-V] [-s [-c][-l]] [-v] [-f <path.pg2>]"
- " [<scsi_enclosure>]\n"
+ printf("Usage: %s [-h] [-V] [-s [-c][-l]] [-v] [-f <path.pg2>] [<sgn ...>]\n"
"\n\t-h: print this help message\n"
"\t-s: generate serviceable events for any failures and\n"
"\t write events to the servicelog\n"
@@ -87,7 +86,7 @@ print_usage(const char *name) {
"\t-V: print the version of the command and exit\n"
"\t-f: for testing, read SES data from path.pg2 and VPD\n"
"\t from path.vpd\n"
- "\t<scsi_enclosure>: the sg device on which to operate, such\n"
+ "\t<sgn ...>: the scsi device on which to operate, such\n"
"\t as sg7; if not specified, all such\n"
"\t devices will be diagnosed\n", name);
}

View File

@ -1,6 +1,6 @@
Name: ppc64-diag
Version: 2.7.9
Release: 3%{?dist}
Release: 4%{?dist}
Summary: PowerLinux Platform Diagnostics
URL: https://github.com/power-ras/%{name}
License: GPLv2
@ -40,6 +40,7 @@ Patch10: ppc64-diag-2.7.9-handle_multiple_platform_dumps.patch
Patch11: ppc64-diag-2.7.9-moving-trim_trail_space-function.patch
Patch12: ppc64-diag-2.7.9-utilize-trim_trail_space-in-event_fru_callout.patch
Patch13: ppc64-diag-2.7.9-enable-light-path-diagnostics-for-RTAS-events.patch
Patch14: ppc64-diag-2.7.9-diag_encl-man-and-help-page.patch
%description
This package contains various diagnostic tools for PowerLinux.
@ -176,6 +177,9 @@ if [ "$1" = "0" ]; then # last uninstall
fi
%changelog
* Sun Oct 27 2024 Than Ngo <than@redhat.com> - 2.7.9-4
- Resolves: RHEL-55399, diag_encl man and help page are not in sync
* Sun Dec 10 2023 Than Ngo <than@redhat.com> - 2.7.9-3
- Enable light path diagnostics for RTAS events
Resolves: RHEL-11478