arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

better description of kit location

Browse Source 
git-svn-id: https://svn.code.sf.net/p/xcat/code/xcat-core/trunk@16606 8638fb3e-16cb-4fca-ae20-7b5d299a9bcd
This commit is contained in:
nott 2013-06-11 12:55:41 +00:00
parent f14b1042d3
commit 28a6d78c06
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
xCAT-buildkit/pods/man1/buildkit.1.pod
View File

@ -20,9 +20,23 @@ The B<buildkit> command provides a collection of utilities that may be used to p
You will need to run the B<buildkit> command several times with different subcommands to step through the process of building a kit:
The following example illustrates the basic process for building a new Kit. It assumes that each subcommand will operate in the current working directory. You could specify a different location by using the "B<-l>|B<--kitloc> I<directory>" option.
By default the B<buildkit> subcommands will operate in the current working directory, (ie. look for files, create directories etc.). You could specify a different location by using the "B<-l | --kitloc> I<directory>" option.
In this example we are building a Kit named "mytstkit".
The kit I<location> is the full path name of the directory that contains the kit files, including the kit basename. You would use the same location value for all the buildkit subcommands.
For example, to create a new kit named "prodkit" in the directory /home/mykits/ I<either> run:
B<cd /home/mykits>
B<buildkit create prodkit>
or
B<buidkit create prodkit -l /home/mykits/prodkit>
In both cases the /home/mykits/prodkit directory is created and the inital files for the kit are created in that directory.
The following example illustrates the basic process for building a new Kit. In this example we are building a Kit named "mytstkit".
=over 4
@ -121,31 +135,31 @@ Command version.
=item B<create> I<kit_basename>
Creates a new kit build directory structure for kit I<kit_basename> in the current directory. The sample kit files from /opt/xcat/share/xcat/kits/kit_template are copied over, and the <cwd>/I<kit_basename>/buildkit.conf is modified for the specified I<kit_basename>.
Creates a new kit build directory structure for kit I<kit_basename> using the location specified on the command line or the current directory. The sample kit files from /opt/xcat/share/xcat/kits/kit_template are copied over, and the buildkit.conf file is modified for the specified I<kit_basename>.
=item B<chkconfig>
Reads the buildkit.conf file from the current directory, verifies that the file syntax is correct and that all specified files exist.
Reads the buildkit.conf file, verifies that the file syntax is correct and that all specified files exist.
=item B<listrepo>
Reads the buildkit.conf file from the current directory, lists all Kit package repositories listed in the file, and reports the build status for each repository.
Reads the buildkit.conf file, lists all Kit package repositories listed in the file, and reports the build status for each repository.
=item B<buildrepo> {I<repo_name> | B<all>}
Reads the buildkit.conf file from the current directory, and builds the specified Kit package repository. The built packages are placed in the directory <cwd>/build/kit_repodir/I<repo_name>. If B<all> is specified, all kit repositories are built.
Reads the buildkit.conf file, and builds the specified Kit package repository. The built packages are placed in the directory <kit location>/build/kit_repodir/I<repo_name>. If B<all> is specified, all kit repositories are built.
=item B<cleanrepo> {I<repo_name> | B<all>}
Reads the buildkit.conf file from the current directory, and deletes all the package files and package meta data files from the <cwd>/build/kit_repodir/I<repo_name> directory. If B<all> is specified, all kit repository files are deleted.
Reads the buildkit.conf file, and deletes all the package files and package meta data files from the <kit location>/build/kit_repodir/I<repo_name> directory. If B<all> is specified, all kit repository files are deleted.
=item B<buildtar>
Reads the buildkit.conf file from the current directory, validates that all kit repositories have been built, and builds the Kit tar file <cwd>/I<kitname>.tar.bz2.
Reads the buildkit.conf file, validates that all kit repositories have been built, and builds the Kit tar file <kit location>/I<kitname>.tar.bz2.
=item B<cleantar>
Reads the buildkit.conf file from the current directory, deletes the Kit tar <cwd>/I<kitname>.tar.bz2, and deletes all files in the build work directory <cwd>/build/I<kitname>.
Reads the buildkit.conf file, deletes the Kit tar <kit location>/I<kitname>.tar.bz2, and deletes all files in the build work directory <kit location>/build/I<kitname>.
=item B<cleanall>
@ -155,7 +169,7 @@ Equivalent to running B<buildkit cleanrepo all> and B<buildkit cleantar>.
I<kit_tarfile> {B<-p> | B<--pkgdir> I<package_directory>} [B<-k> | B<--kitversion> I<version>] [B<-r> | B<--kitrelease> I<release>]
Add product package rpms to a previously built kit tar file. This is used for incomplete product kits that are built and shipped separately from the product packages, and are identified with a I<kit_tarfile> name of I<kitname>.B<NEED_PRODUCT_PKGS.tar.bz2>. Optionally, change the kit release and version values when building the new kit tarfile. If kitcomponent version and/or release values are defaulted to the kit values, those will also be changed and new kitcomponent rpms will be built. If kit or kitcomponent scripts, plugins, or other files specify name, release, or version substitution strings, these will all be replaced with the new values when built into the new complete kit tarfile I<cwd>/I<new_kitname>.B<tar.bz2>.
Add product package rpms to a previously built kit tar file. This is used for partial product kits that are built and shipped separately from the product packages, and are identified with a I<kit_tarfile> name of I<kitname>.B<NEED_PRODUCT_PKGS.tar.bz2>. Optionally, change the kit release and version values when building the new kit tarfile. If kitcomponent version and/or release values are defaulted to the kit values, those will also be changed and new kitcomponent rpms will be built. If kit or kitcomponent scripts, plugins, or other files specify name, release, or version substitution strings, these will all be replaced with the new values when built into the new complete kit tarfile I<kit location>/I<new_kitname>.B<tar.bz2>.
=back