From 28482d4a61feb5b9313e753a3540583166bd1820 Mon Sep 17 00:00:00 2001 From: Victor Hu Date: Tue, 16 Feb 2016 23:35:40 -0500 Subject: [PATCH] - Fix some warnings that come out from pod2man during the build on the build machine - Committed the rst file changes that result from running create_man_pages.py script --- .../references/man1/nimnodecust.1.rst | 2 +- .../references/man1/nimnodeset.1.rst | 2 +- .../references/man1/nodechprofile.1.rst | 23 ++++-- .../admin-guides/references/man1/rinv.1.rst | 70 ------------------- .../references/man1/rspconfig.1.rst | 12 ---- .../references/man1/swapnodes.1.rst | 13 ++-- .../references/man1/switchdiscover.1.rst | 4 -- .../references/man1/updatenode.1.rst | 4 -- .../admin-guides/references/man5/vm.5.rst | 2 +- xCAT-client/pods/man1/nimnodecust.1.pod | 2 - xCAT-client/pods/man1/nimnodeset.1.pod | 3 - xCAT-client/pods/man1/nodechprofile.1.pod | 4 ++ xCAT-client/pods/man1/reventlog.1.pod | 2 + xCAT-client/pods/man1/swapnodes.1.pod | 10 +-- xCAT-client/pods/man8/rinstall.8.pod | 2 + xCAT-client/pods/man8/xcatconfig.8.pod | 2 +- 16 files changed, 34 insertions(+), 123 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst b/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst index 7175eebd2..8a82dad79 100644 --- a/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nimnodecust.1.rst @@ -134,7 +134,6 @@ EXAMPLES nimnodecust -s 61lppsource -p openssh.base.server node01 - 2) Install the product software contained in the two bundles called "llbnd" and "pebnd" on all AIX nodes contained in the xCAT node group called "aixnodes". Assume that all the software packages have been copied to the NIM lpp_source resource called "61lppsource". @@ -143,6 +142,7 @@ EXAMPLES nimnodecust -s 61lppsource -b llbnd,pebnd aixnodes + ***** FILES ***** diff --git a/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst b/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst index 5e3f70114..021aad1e7 100644 --- a/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nimnodeset.1.rst @@ -158,7 +158,6 @@ EXAMPLES nimnodeset -i 61gold node01 - 2) Initialize all AIX nodes contained in the xCAT node group called "aixnodes" using the image definitions pointed to by the "provmethod" attribute of the xCAT node definitions. @@ -175,6 +174,7 @@ EXAMPLES nimnodeset -i 611image node02 installp_bundle=sshbundle,addswbundle + ***** FILES ***** diff --git a/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst b/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst index 9cb4bccf6..1d02e020a 100644 --- a/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst +++ b/docs/source/guides/admin-guides/references/man1/nodechprofile.1.rst @@ -88,16 +88,25 @@ EXAMPLES - -.. code-block:: perl - - nodechprofile compute-000,compute-001 imageprofile=rhels6.3_packaged +1. To change the image profile to rhels6.3_packaged for compute nodes compute-000 and compute-001, use the following command: + + + .. code-block:: perl + + nodechprofile compute-000,compute-001 imageprofile=rhels6.3_packaged + + +2. To change all of the profiles for compute node compute-000, enter the following command: + + + .. code-block:: perl + + nodechprofile compute-000 imageprofile=rhels6.3_packaged networkprofile=default_cn hardwareprofile=default_ipmi + + -.. code-block:: perl - - nodechprofile compute-000 imageprofile=rhels6.3_packaged networkprofile=default_cn hardwareprofile=default_ipmi ******** diff --git a/docs/source/guides/admin-guides/references/man1/rinv.1.rst b/docs/source/guides/admin-guides/references/man1/rinv.1.rst index a720fe742..0b5388f4b 100644 --- a/docs/source/guides/admin-guides/references/man1/rinv.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rinv.1.rst @@ -221,133 +221,63 @@ Calling \ **rinv**\ for VMware will display the UUID/GUID, nuumber of CPUs, amo Calculates the total size of every known storage pool. -<<<<<<< HEAD - \ **-**\ **-diskpool**\ \ *pool*\ \ *space*\ - - Lists the storage devices (ECKD and FBA) contained in a disk pool. Space can be: all, free, or used. - -======= \ **-**\ **-diskpool**\ \ *pool*\ \ *space*\ ->>>>>>> man1 changes for commands p-z Lists the storage devices (ECKD and FBA) contained in a disk pool. Space can be: all, free, or used. -<<<<<<< HEAD - \ **-**\ **-fcpdevices**\ \ *state*\ \ *details*\ - - Lists the FCP device channels that are active, free, or offline. State can be: active, free, or offline. - -======= \ **-**\ **-fcpdevices**\ \ *state*\ \ *details*\ ->>>>>>> man1 changes for commands p-z Lists the FCP device channels that are active, free, or offline. State can be: active, free, or offline. -<<<<<<< HEAD - \ **-**\ **-diskpoolnames**\ - - Lists the known disk pool names. - -======= \ **-**\ **-diskpoolnames**\ ->>>>>>> man1 changes for commands p-z Lists the known disk pool names. -<<<<<<< HEAD - \ **-**\ **-networknames**\ - - Lists the known network names. - -======= \ **-**\ **-networknames**\ ->>>>>>> man1 changes for commands p-z Lists the known network names. -<<<<<<< HEAD - \ **-**\ **-network**\ \ *name*\ - - Shows the configuration of a given network device. - -======= \ **-**\ **-network**\ \ *name*\ ->>>>>>> man1 changes for commands p-z Shows the configuration of a given network device. -<<<<<<< HEAD - \ **-**\ **-ssi**\ - - Obtain the SSI and system status. - -======= \ **-**\ **-ssi**\ ->>>>>>> man1 changes for commands p-z Obtain the SSI and system status. -<<<<<<< HEAD - \ **-**\ **-smapilevel**\ - - Obtain the SMAPI level installed on the z/VM system. - -======= \ **-**\ **-smapilevel**\ ->>>>>>> man1 changes for commands p-z Obtain the SMAPI level installed on the z/VM system. -<<<<<<< HEAD - \ **-**\ **-wwpns**\ \ *fcp_channel*\ - - Query a given FCP device channel on a z/VM system and return a list of WWPNs. - -======= \ **-**\ **-wwpns**\ \ *fcp_channel*\ ->>>>>>> man1 changes for commands p-z Query a given FCP device channel on a z/VM system and return a list of WWPNs. -<<<<<<< HEAD - \ **-**\ **-zfcppool**\ \ *pool*\ \ *space*\ - - List the SCSI/FCP devices contained in a zFCP pool. Space can be: free or used. - -======= \ **-**\ **-zfcppool**\ \ *pool*\ \ *space*\ ->>>>>>> man1 changes for commands p-z List the SCSI/FCP devices contained in a zFCP pool. Space can be: free or used. -<<<<<<< HEAD - \ **-**\ **-zfcppoolnames**\ - - List the known zFCP pool names. - -======= \ **-**\ **-zfcppoolnames**\ ->>>>>>> man1 changes for commands p-z List the known zFCP pool names. diff --git a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst index c656236de..f2a223a64 100644 --- a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst @@ -226,11 +226,7 @@ BPA/Frame (using Direct FSP Management) Specific: \ **rspconfig**\ \ *noderange*\ {\ **sysname**\ } -<<<<<<< HEAD -\ **rspconfig**\ \ *noderange*\ \ **sysname**\ ={\ **\\* | name**\ } -======= \ **rspconfig**\ \ *noderange*\ \ **sysname**\ ={\* | \ *name*\ } ->>>>>>> man1 changes for commands p-z \ **rspconfig**\ \ *noderange*\ {\ **pending_power_on_side**\ } @@ -599,11 +595,7 @@ OPTIONS -<<<<<<< HEAD -\ **-v**\ , \ **-**\ **-version**\ -======= \ **-v**\ | \ **-**\ **-version**\ ->>>>>>> man1 changes for commands p-z Display the version number. @@ -1173,15 +1165,11 @@ EXAMPLES To reset the network interface of the specified nodes: -<<<<<<< HEAD - \ **rspconfig**\ \ *-**\ **-resetnet*\ -======= .. code-block:: perl rspconfig --resetnet ->>>>>>> man1 changes for commands p-z Output is similar to: diff --git a/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst b/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst index 85cb2caf3..55c8b6f4e 100644 --- a/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst +++ b/docs/source/guides/admin-guides/references/man1/swapnodes.1.rst @@ -33,17 +33,12 @@ This command is only for Power 775 using Direct FSP Management, and used in Powe The \ **swapnodes**\ command will keep the \ **current_node**\ name in the xCAT table, and use the \ *fip_node*\ 's hardware resource. Besides that, the IO adapters will be assigned to the new hardware resource if they are in the same CEC. So the swapnodes command will do 2 things: +1. Swap the location info in the db between 2 nodes: -1. swap the location info in the db between 2 nodes: - - All the ppc table attributes (including hcp, id, parent, supernode and so on). - All the nodepos table attributes(including rack, u, chassis, slot, room and so on). - - - -2. assign the I/O adapters from the defective node(the original current_node) to the available node(the original fip_node) if the nodes are in the same cec. - +All the ppc table attributes (including hcp, id, parent, supernode and so on). +All the nodepos table attributes(including rack, u, chassis, slot, room and so on). +2. Assign the I/O adapters from the defective node(the original current_node) to the available node(the original fip_node) if the nodes are in the same cec. The \ **swapnodes**\ command shouldn't make the decision of which 2 nodes are swapped. It will just received the 2 node names as cmd line parameters. diff --git a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst index dc9141c1b..a93d04356 100644 --- a/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst +++ b/docs/source/guides/admin-guides/references/man1/switchdiscover.1.rst @@ -142,10 +142,6 @@ EXAMPLES switchdiscover --range 10.2.3.4/24 -w -<<<<<<< HEAD - \ **switchdiscover**\ \ *-**\ **-range 10.2.3.4/24 -w*\ -======= ->>>>>>> man1 changes for commands p-z It is recommended to run \ **makehosts**\ after the switches are saved in the DB. diff --git a/docs/source/guides/admin-guides/references/man1/updatenode.1.rst b/docs/source/guides/admin-guides/references/man1/updatenode.1.rst index f62e6118c..53941ca17 100644 --- a/docs/source/guides/admin-guides/references/man1/updatenode.1.rst +++ b/docs/source/guides/admin-guides/references/man1/updatenode.1.rst @@ -656,10 +656,6 @@ and the "rsync" rpm using the installp flags "-agQXY" and the rpm flags "-i --no updatenode xcatn11,xcatn12 -V -S otherpkgs="I:gpfs.base,R:rsync-2.6.2-1.aix5.1.ppc.rpm" installp_flags="-agQXY" rpm_flags="-i --nodeps" -<<<<<<< HEAD - \ **updatenode xcatn11,xcatn12 -V -S otherpkgs="I:gpfs.base,R:rsync-2.6.2-1.aix5.1.ppc.rpm" installp_flags="-agQXY" rpm_flags="-i -**\ **-nodeps"**\ -======= ->>>>>>> man1 changes for commands p-z Note: Using the "-V" flag with multiple nodes may result in a large amount of output. diff --git a/docs/source/guides/admin-guides/references/man5/vm.5.rst b/docs/source/guides/admin-guides/references/man5/vm.5.rst index ccbd52df1..ece3064cc 100644 --- a/docs/source/guides/admin-guides/references/man5/vm.5.rst +++ b/docs/source/guides/admin-guides/references/man5/vm.5.rst @@ -190,7 +190,7 @@ vm Attributes: \ **othersettings**\ - This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:'vcpupin:'0-15,^8' ',Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. + This allows specifying a semicolon delimited list of key->value pairs to include in a vmx file of VMware or KVM. For partitioning on normal power machines, this option is used to specify the hugepage and/or bsr information, the value is like:'hugepage:1,bsr=2'. For KVM cpu pinning, this option is used to specify the physical cpu set on the host, the value is like:"vcpupin:'0-15,^8'",Its syntax is a comma separated list and a special markup using '-' and '^' (ex. '0-4', '0-3,^2') can also be allowed, the '-' denotes the range and the '^' denotes exclusive. For KVM memory binding, the value is like:'membind:0', restrict a guest to allocate memory from the specified set of NUMA nodes. For PCI passthrough, the value is like:'devpassthrough:pci_0001_01_00_0,pci_0000_03_00_0',the PCI devices are assigned to a virtual machine, and the virtual machine can use this I/O exclusively,the devices list are a list of PCI device names delimited with comma, the PCI device names can be obtained by running \ **virsh nodedev-list**\ on the host. diff --git a/xCAT-client/pods/man1/nimnodecust.1.pod b/xCAT-client/pods/man1/nimnodecust.1.pod index 342e4e756..ea5eaa711 100644 --- a/xCAT-client/pods/man1/nimnodecust.1.pod +++ b/xCAT-client/pods/man1/nimnodecust.1.pod @@ -83,13 +83,11 @@ An error has occurred. nimnodecust -s 61lppsource -p openssh.base.server node01 -=back 2) Install the product software contained in the two bundles called "llbnd" and "pebnd" on all AIX nodes contained in the xCAT node group called "aixnodes". Assume that all the software packages have been copied to the NIM lpp_source resource called "61lppsource". nimnodecust -s 61lppsource -b llbnd,pebnd aixnodes -=back =head1 FILES diff --git a/xCAT-client/pods/man1/nimnodeset.1.pod b/xCAT-client/pods/man1/nimnodeset.1.pod index 8ae87989b..6b3ad0b91 100644 --- a/xCAT-client/pods/man1/nimnodeset.1.pod +++ b/xCAT-client/pods/man1/nimnodeset.1.pod @@ -105,20 +105,17 @@ An error has occurred. nimnodeset -i 61gold node01 -=back 2) Initialize all AIX nodes contained in the xCAT node group called "aixnodes" using the image definitions pointed to by the "provmethod" attribute of the xCAT node definitions. nimnodeset aixnodes -=back 3) Initialize an xCAT node called "node02". Include installp_bundle resources that are not included in the osimage definition. This assumes the NIM installp_bundle resources have already been created. nimnodeset -i 611image node02 installp_bundle=sshbundle,addswbundle -=back =head1 FILES diff --git a/xCAT-client/pods/man1/nodechprofile.1.pod b/xCAT-client/pods/man1/nodechprofile.1.pod index d1fefad81..ebefee98d 100644 --- a/xCAT-client/pods/man1/nodechprofile.1.pod +++ b/xCAT-client/pods/man1/nodechprofile.1.pod @@ -56,6 +56,8 @@ Sets the new hardware profile name used by the node, where is =head1 EXAMPLES +=over 2 + =item 1. To change the image profile to rhels6.3_packaged for compute nodes compute-000 and compute-001, use the following command: @@ -66,6 +68,8 @@ To change all of the profiles for compute node compute-000, enter the following nodechprofile compute-000 imageprofile=rhels6.3_packaged networkprofile=default_cn hardwareprofile=default_ipmi +=back + =head1 SEE ALSO L, L, L, L diff --git a/xCAT-client/pods/man1/reventlog.1.pod b/xCAT-client/pods/man1/reventlog.1.pod index e61c7d40e..b18de103d 100644 --- a/xCAT-client/pods/man1/reventlog.1.pod +++ b/xCAT-client/pods/man1/reventlog.1.pod @@ -75,6 +75,8 @@ Output is similar to: node4: clear node5: clear +=back + =head1 SEE ALSO L, L diff --git a/xCAT-client/pods/man1/swapnodes.1.pod b/xCAT-client/pods/man1/swapnodes.1.pod index 2c1d33323..c1e17308f 100644 --- a/xCAT-client/pods/man1/swapnodes.1.pod +++ b/xCAT-client/pods/man1/swapnodes.1.pod @@ -14,18 +14,12 @@ This command is only for Power 775 using Direct FSP Management, and used in Powe The B command will keep the B name in the xCAT table, and use the I's hardware resource. Besides that, the IO adapters will be assigned to the new hardware resource if they are in the same CEC. So the swapnodes command will do 2 things: -=over 2 - -=item 1. -swap the location info in the db between 2 nodes: +1. Swap the location info in the db between 2 nodes: All the ppc table attributes (including hcp, id, parent, supernode and so on). All the nodepos table attributes(including rack, u, chassis, slot, room and so on). -=item 2. -assign the I/O adapters from the defective node(the original current_node) to the available node(the original fip_node) if the nodes are in the same cec. - -=back +2. Assign the I/O adapters from the defective node(the original current_node) to the available node(the original fip_node) if the nodes are in the same cec. The B command shouldn't make the decision of which 2 nodes are swapped. It will just received the 2 node names as cmd line parameters. diff --git a/xCAT-client/pods/man8/rinstall.8.pod b/xCAT-client/pods/man8/rinstall.8.pod index 098d293c3..12e516d74 100644 --- a/xCAT-client/pods/man8/rinstall.8.pod +++ b/xCAT-client/pods/man8/rinstall.8.pod @@ -56,6 +56,8 @@ Provisoon node1 and start a console to monitor the process. rinstall node1 -c +=back + =head1 B B L, L, L diff --git a/xCAT-client/pods/man8/xcatconfig.8.pod b/xCAT-client/pods/man8/xcatconfig.8.pod index 3085057be..1f4f926b0 100644 --- a/xCAT-client/pods/man8/xcatconfig.8.pod +++ b/xCAT-client/pods/man8/xcatconfig.8.pod @@ -107,5 +107,5 @@ To add the Management Node to the DB: xcatconfig -m - =back +