diff --git a/docs/source/advanced/kit/custom/build/buildkit-rpm.rst b/docs/source/advanced/kit/custom/build/buildkit-rpm.rst index 263f135a9..5cbc271ed 100644 --- a/docs/source/advanced/kit/custom/build/buildkit-rpm.rst +++ b/docs/source/advanced/kit/custom/build/buildkit-rpm.rst @@ -1,26 +1,22 @@ -Installing the xCAT-buildkit ------------------------------ +Requirements +============ -The xCAT-buildkit RPM is required to build a kit. It will be installed automatically as part of installing base xCAT. If the build server is not an xCAT management node, it can be +The ``xCAT-buildkit`` rpm is required to create xCAT Software Kits. This rpm should be installed along with the rest of xCAT. - #. Download the xCAT tar file and install the xCAT-buildkit RPM from the local repositroy - #. Install the RPM directly from the internet-hosted repository +If the xCAT management node is not intended to be used to build the Software Kit, refer to the :doc:`Install Guide ` to configure the xCAT repository on the target node and install ``xCAT-buildkit`` using one of the following commands: -Once the repositories are setup, install xCAT-buildkit and all its dependencies. - -**[RHEL]** :: +* **[RHEL]** :: yum clean metadata yum install xCAT-buildkit -**[SLES]** :: +* **[SLES]** :: - zypper clean - zypper install xCAT-buildkit + zypper clean + zypper install xCAT-buildkit +* **[UBUNTU]** :: -**[UBUNTU]** :: - - apt-get clean - apt-get install xcat-buildkit + apt-get clean + apt-get install xcat-buildkit diff --git a/docs/source/advanced/kit/custom/build/validatekit.rst b/docs/source/advanced/kit/custom/build/validatekit.rst index 01b6633d7..ea2f108ec 100644 --- a/docs/source/advanced/kit/custom/build/validatekit.rst +++ b/docs/source/advanced/kit/custom/build/validatekit.rst @@ -1,10 +1,9 @@ -Validating the Kit Configuration --------------------------------- +Validating Kits +--------------- -After modify the buildkit.conf file and copy all necessary files to the kit directories, use the ``chkconfig`` subcommand to validate the build configuration file. :: +After modifying the ``buildkit.conf`` file and copying all the necessary files to the kit directories, use the ``chkconfig`` option on :doc:`buildkit ` to validate the configuration file: :: - buildkit chkconfig + buildkit chkconfig -This command will verify all required fields defined in the buildkit.conf, included all internally referenced attributes and all referenced files. +This command will verify all required fields defined in the buildkit.conf. If errors are found, fix the specified error and rerun the command until all fields are validated. -Fix any errors then rerun this command until all the fields are validated.