Merge pull request #6962 from gurevichmark/depricate_addkcmdline

Docs improvements

docs/source/guides/admin-guides/manage_clusters/common/deployment/cfg_partition.rst

@@ -33,7 +33,7 @@ The partition file must follow the partitioning syntax of the respective install
      * The file ``/root/anaconda-ks.cfg`` is a sample kickstart file created by RedHat installing during the installation process based on the options that you selected.
      * system-config-kickstart is a tool with graphical interface for creating kickstart files
 
-   * SLES: `Autoyast documentation  <https://doc.opensuse.org/projects/autoyast/configuration.html#CreateProfile.Partitioning>`_ 
+   * SLES: `Autoyast documentation  <https://doc.opensuse.org/projects/autoyast/#CreateProfile-Partitioning>`_ 
 
      * Use yast2 autoyast in GUI or CLI mode to customize the installation options and create autoyast file
      * Use yast2 clone_system to create autoyast configuration file ``/root/autoinst.xml`` to clone an existing system
@@ -384,7 +384,7 @@ Create a shell script that will be run on the node during the install process to
 
 The purpose of the partition script is to create the ``/tmp/partionfile`` that will be inserted into the kickstart/autoyast/preseed template, the script could include complex logic like select which disk to install and even configure RAID, etc
 
-**Note**: the partition script feature is not thoroughly tested on SLES, there might be problems, use this feature on SLES at your own risk.
+.. note:: the partition script feature is not thoroughly tested on SLES, there might be problems, use this feature on SLES at your own risk.
 
 .. END_Partition_Definition_Script_Create_partition_script_content
 
@@ -460,7 +460,7 @@ Run below commands to associate partition script with osimage: ::
 
 - The ``s:`` preceding the filename tells nodeset that this is a script.
 - For RedHat, when nodeset runs and generates the ``/install/autoinst`` file for a node, it will add the execution of the contents of this script to the %pre section of that file. The ``nodeset`` command will then replace the ``#XCAT_PARTITION_START#...#XCAT_PARTITION_END#`` directives from the osimage template file with ``%include /tmp/partitionfile`` to dynamically include the tmp definition file your script created.
-    - For Ubuntu, when nodeset runs and generates the ``/install/autoinst`` file for a node, it will replace the ``#XCA_PARTMAN_RECIPE_SCRIPT#`` directive and add the execution of the contents of this script to the ``/install/autoinst/<node>.pre``, the ``/install/autoinst/<node>.pre`` script will be run in the preseed/early_command.
+- For Ubuntu, when nodeset runs and generates the ``/install/autoinst`` file for a node, it will replace the ``#XCA_PARTMAN_RECIPE_SCRIPT#`` directive and add the execution of the contents of this script to the ``/install/autoinst/<node>.pre``, the ``/install/autoinst/<node>.pre`` script will be run in the preseed/early_command.
 
 .. END_Partition_Definition_Script_Associate_partition_script_with_osimage_common
 

docs/source/guides/admin-guides/manage_clusters/common/deployment/driver_update_disk.rst

@@ -19,7 +19,7 @@ No matter which approach chosen, there are two steps to make new drivers work. o
 
 There are two approaches for xCAT to find the driver disk (pick one):
 
-#. Specify the location of the driver disk in the osimage object (*This is ONLY supported in 2.8 and later*)
+#. Specify the location of the driver disk in the osimage object (*This is ONLY supported in xCAT 2.8 and later*)
 
   The value for the 'driverupdatesrc' attribute is a comma separated driver disk list. The tag 'dud' must be specified before the full path of 'driver update disk' to specify the type of the file: ::
 
@@ -66,14 +66,16 @@ If 'osupdatename' is specified, the kernel shipped with the 'osupdatename' will
 
 - If specifying the driver disk location in the osimage, there are two ways to inject drivers:
 
-  #. ::
+  #. Using nodeset command only: ::
+
       nodeset <noderange> osimage=<osimagename>
 
-  #. ::
+  #. Using geninitrd with nodeset command: ::
+
       geninitrd <osimagename>
       nodeset <noderange> osimage=<osimagename> --noupdateinitrd
 
-**Note:** 'geninitrd' + 'nodeset --noupdateinitrd' is useful when you need to run nodeset frequently for a diskful node. 'geninitrd' only needs be run once to rebuild the initrd and 'nodeset --noupdateinitrd' will not touch the initrd and kernel in /tftpboot/xcat/osimage/<osimage name>/.
+.. note:: 'geninitrd' + 'nodeset --noupdateinitrd' is useful when you need to run nodeset frequently for a diskful node. 'geninitrd' only needs be run once to rebuild the initrd and 'nodeset --noupdateinitrd' will not touch the initrd and kernel in /tftpboot/xcat/osimage/<osimage name>/.
 
 - If putting the driver disk in <installroot>/driverdisk/<os>/<arch>:
 
@@ -94,7 +96,7 @@ There are two ways to inject drivers:
        geninitrd <osimagename> [--ignorekernelchk]
        nodeset <noderange> osimage=<osimagename> --noupdateinitrd
 
-**Note:** 'geninitrd' + 'nodeset --noupdateinitrd' is useful when you need to run nodeset frequently for diskful nodes. 'geninitrd' only needs to be run once to rebuild the initrd and 'nodeset --noupdateinitrd' will not touch the initrd and kernel in /tftpboot/xcat/osimage/<osimage name>/.
+.. note:: 'geninitrd' + 'nodeset --noupdateinitrd' is useful when you need to run nodeset frequently for diskful nodes. 'geninitrd' only needs to be run once to rebuild the initrd and 'nodeset --noupdateinitrd' will not touch the initrd and kernel in /tftpboot/xcat/osimage/<osimage name>/.
 
 The option '--ignorekernelchk' is used to skip the kernel version checking when injecting drivers from osimage.driverupdatesrc. To use this flag, you should make sure the drivers in the driver rpms are usable for the target kernel.
 .. END_inject_into_initrd__for_diskful_for_RPM

docs/source/guides/admin-guides/references/man5/bootparams.5.rst

@@ -56,7 +56,7 @@ bootparams Attributes:
 
 \ **kcmdline**\ 
  
- Arguments to be passed to the kernel
+ (Deprecated, use addkcmdline instead) Arguments to be passed to the kernel.
  
 
 

docs/source/guides/admin-guides/references/man5/openbmc.5.rst

@@ -62,13 +62,13 @@ openbmc Attributes:
 
 \ **username**\ 
  
- The BMC userid.
+ The BMC userid. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 
 \ **password**\ 
  
- The BMC password.
+ The BMC password. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 

docs/source/guides/admin-guides/references/man7/group.7.rst

@@ -85,7 +85,7 @@ group Attributes:
  
  or
  
- The BMC password.
+ The BMC password. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 
@@ -141,7 +141,7 @@ group Attributes:
  
  or
  
- The BMC userid.
+ The BMC userid. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 
@@ -459,7 +459,7 @@ group Attributes:
 
 \ **kcmdline**\  (bootparams.kcmdline)
  
- Arguments to be passed to the kernel
+ (Deprecated, use addkcmdline instead) Arguments to be passed to the kernel.
  
 
 

docs/source/guides/admin-guides/references/man7/node.7.rst

@@ -97,7 +97,7 @@ node Attributes:
  
  or
  
- The BMC password.
+ The BMC password. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 
@@ -153,7 +153,7 @@ node Attributes:
  
  or
  
- The BMC userid.
+ The BMC userid. If not specified, the key=openbmc row in the passwd table is used as the default.
  
 
 
@@ -471,7 +471,7 @@ node Attributes:
 
 \ **kcmdline**\  (bootparams.kcmdline)
  
- Arguments to be passed to the kernel
+ (Deprecated, use addkcmdline instead) Arguments to be passed to the kernel.
  
 
 

perl-xCAT/xCAT/Schema.pm

@@ -330,7 +330,7 @@ passed as argument rather than by table value',
             'node' => 'The node or group name',
 'kernel' => 'The kernel that network boot actions should currently acquire and use.  Note this could be a chained boot loader such as memdisk or a non-linux boot loader',
 'initrd' => 'The initial ramdisk image that network boot actions should use (could be a DOS floppy or hard drive image if using memdisk as kernel)',
-            'kcmdline' => 'Arguments to be passed to the kernel',
+            'kcmdline' => '(Deprecated, use addkcmdline instead) Arguments to be passed to the kernel.',
             'addkcmdline' => 'User specified kernel options for os provision process(no prefix) or the provisioned os(with prefix "R::"). The options should be delimited with spaces(" ")',
             'dhcpstatements' => 'xCAT manipulated custom dhcp statements (not intended for user manipulation)',
 'adddhcpstatements' => 'Custom dhcp statements for administrator use (not implemneted yet)',
@@ -452,8 +452,8 @@ passed as argument rather than by table value',
             bmc => 'The hostname of the BMC adapter.',
             consport => 'The console port for OpenBMC.',
             taggedvlan => 'bmcsetup script will configure the network interface of the BMC to be tagged to the VLAN specified.',
-            username => 'The BMC userid.',
-            password => 'The BMC password.',
+            username => 'The BMC userid. If not specified, the key=openbmc row in the passwd table is used as the default.',
+            password => 'The BMC password. If not specified, the key=openbmc row in the passwd table is used as the default.',
             comments => 'Any user-written notes.',
             disable  => "Set to 'yes' or '1' to comment out this row.",
         },