From 63a6c46371d160dd7141de951d819310c6a8c50d Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Tue, 15 Aug 2017 13:35:12 -0400 Subject: [PATCH 1/3] Sync Usage and Man pages for openbmc rflash command --- perl-xCAT/xCAT/Usage.pm | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index dd40450e3..7339bc267 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -342,10 +342,10 @@ my %usage = ( rflash -p [--activate {disruptive|deferred}] [-d ] rflash [--commit | --recover] [-V|--verbose] rflash [--bpa_acdl] - PPC64LE (using IPMI Management) specific: - rflash [-c|--check] [--retry=] [-V] [|-d=] - PPC64LE (using OpenBMC Management) specific: - rflash [-c|--check] [-l|--list] [-a|--activate] [-u|--upload] [-d|--delete] [|]", + OpenPOWER BMC specific (using IPMI): + rflash [|-d=] [-c|--check] [--retry=] [-V] + OpenPOWER OpenBMC specific : + rflash [|] [-c|--check] [-a|--activate] [-l|--list] [-u|--upload] [-d|--delete]", "mkhwconn" => "Usage: mkhwconn [-h|--help] From 62c56561f28ef7a81f6e130838cf9c182895e2cd Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Tue, 15 Aug 2017 13:39:05 -0400 Subject: [PATCH 2/3] mend --- docs/source/guides/admin-guides/references/man5/nics.5.rst | 2 +- docs/source/guides/admin-guides/references/man7/group.7.rst | 4 ++-- docs/source/guides/admin-guides/references/man7/node.7.rst | 4 ++-- docs/source/guides/admin-guides/references/man7/osimage.7.rst | 2 +- perl-xCAT/xCAT/Usage.pm | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man5/nics.5.rst b/docs/source/guides/admin-guides/references/man5/nics.5.rst index cf4aab58c..208523103 100644 --- a/docs/source/guides/admin-guides/references/man5/nics.5.rst +++ b/docs/source/guides/admin-guides/references/man5/nics.5.rst @@ -129,7 +129,7 @@ nics Attributes: \ **nicsadapter**\ Comma-separated list of extra parameters that will be used for each NIC configuration. - !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. + !,!, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face diff --git a/docs/source/guides/admin-guides/references/man7/group.7.rst b/docs/source/guides/admin-guides/references/man7/group.7.rst index 9a67dd224..a79e56ee8 100644 --- a/docs/source/guides/admin-guides/references/man7/group.7.rst +++ b/docs/source/guides/admin-guides/references/man7/group.7.rst @@ -41,7 +41,7 @@ group Attributes: \ **addkcmdline**\ (bootparams.addkcmdline) - User specified one or more parameters to be passed to the kernel. For the kernel options need to be persistent after installation, specify them with prefix "R::" + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ") @@ -669,7 +669,7 @@ group Attributes: \ **nicsadapter**\ (nics.nicsadapter) Comma-separated list of extra parameters that will be used for each NIC configuration. - !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. + !,!, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face diff --git a/docs/source/guides/admin-guides/references/man7/node.7.rst b/docs/source/guides/admin-guides/references/man7/node.7.rst index 0ab71ac4d..fbf9ada59 100644 --- a/docs/source/guides/admin-guides/references/man7/node.7.rst +++ b/docs/source/guides/admin-guides/references/man7/node.7.rst @@ -41,7 +41,7 @@ node Attributes: \ **addkcmdline**\ (bootparams.addkcmdline) - User specified one or more parameters to be passed to the kernel. For the kernel options need to be persistent after installation, specify them with prefix "R::" + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ") @@ -669,7 +669,7 @@ node Attributes: \ **nicsadapter**\ (nics.nicsadapter) Comma-separated list of extra parameters that will be used for each NIC configuration. - !|,!|, for example, eth0!MTU=1500|MTU=1460,ib0!MTU=65520 CONNECTED_MODE=yes. + !,!, for example, enP3p3s0f1!mac=98:be:94:59:fa:cd linkstate=DOWN,enP3p3s0f2!mac=98:be:94:59:fa:ce candidatename=enP3p3s0f2/enx98be9459face diff --git a/docs/source/guides/admin-guides/references/man7/osimage.7.rst b/docs/source/guides/admin-guides/references/man7/osimage.7.rst index c74014cf6..b4310d976 100644 --- a/docs/source/guides/admin-guides/references/man7/osimage.7.rst +++ b/docs/source/guides/admin-guides/references/man7/osimage.7.rst @@ -41,7 +41,7 @@ osimage Attributes: \ **addkcmdline**\ (linuximage.addkcmdline) - User specified arguments to be passed to the kernel. The user arguments are appended to xCAT.s default kernel arguments. For the kernel options need to be persistent after installation, specify them with prefix "R::". This attribute is ignored if linuximage.boottarget is set. + User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" "). This attribute is ignored if linuximage.boottarget is set. diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index 7339bc267..b0c78d73b 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -344,7 +344,7 @@ my %usage = ( rflash [--bpa_acdl] OpenPOWER BMC specific (using IPMI): rflash [|-d=] [-c|--check] [--retry=] [-V] - OpenPOWER OpenBMC specific : + OpenPOWER OpenBMC specific: rflash [|] [-c|--check] [-a|--activate] [-l|--list] [-u|--upload] [-d|--delete]", "mkhwconn" => "Usage: From c8ee22034d7cbffe4500da6a2019b55dc54fd9da Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Thu, 17 Aug 2017 10:45:10 -0400 Subject: [PATCH 3/3] Manpage and usage improvements --- .../source/guides/admin-guides/references/man1/rflash.1.rst | 6 +++++- perl-xCAT/xCAT/Usage.pm | 4 +++- xCAT-client/pods/man1/rflash.1.pod | 6 +++++- 3 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/rflash.1.rst b/docs/source/guides/admin-guides/references/man1/rflash.1.rst index 84d176e49..dbece0af2 100644 --- a/docs/source/guides/admin-guides/references/man1/rflash.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rflash.1.rst @@ -57,7 +57,11 @@ OpenPOWER OpenBMC specific : ============================ -\ **rflash**\ \ *noderange*\ [\ *tar_file_path*\ | \ *image_id*\ ] [\ **-c | -**\ **-check**\ ] [\ **-a | -**\ **-activate**\ ] [\ **-l | -**\ **-list**\ ] [\ **-u | -**\ **-upload**\ ] [\ **-d | -**\ **-delete**\ ] +\ **rflash**\ \ *noderange*\ {[\ **-c | -**\ **-check**\ ] | [\ **-l | -**\ **-list**\ ]} + +\ **rflash**\ \ *noderange*\ \ *tar_file_path*\ {[\ **-c | -**\ **-check**\ ] | [\ **-u | -**\ **-upload**\ ]} + +\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-d | -**\ **-delete**\ ]} diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index b0c78d73b..b41fa6ab9 100755 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -345,7 +345,9 @@ my %usage = ( OpenPOWER BMC specific (using IPMI): rflash [|-d=] [-c|--check] [--retry=] [-V] OpenPOWER OpenBMC specific: - rflash [|] [-c|--check] [-a|--activate] [-l|--list] [-u|--upload] [-d|--delete]", + rflash {[-c|--check] | [-l|--list]} + rflash {[-c|--check] | [-u|--upload]} + rflash {[-a|--activate] | [-d|--delete]}", "mkhwconn" => "Usage: mkhwconn [-h|--help] diff --git a/xCAT-client/pods/man1/rflash.1.pod b/xCAT-client/pods/man1/rflash.1.pod index 70c964d15..ac2de5adc 100644 --- a/xCAT-client/pods/man1/rflash.1.pod +++ b/xCAT-client/pods/man1/rflash.1.pod @@ -28,7 +28,11 @@ B I [I | B<-d=>I] [B<-c>|B<--c =head2 OpenPOWER OpenBMC specific : -B I [I | I] [B<-c>|B<--check>] [B<-a>|B<--activate>] [B<-l>|B<--list>] [B<-u>|B<--upload>] [B<-d>|B<--delete>] +B I {[B<-c>|B<--check>] | [B<-l>|B<--list>]} + +B I I {[B<-c>|B<--check>] | [B<-u>|B<--upload>]} + +B I I {[B<-a>|B<--activate>] | [B<-d>|B<--delete>]} =head1 B