From c519024679714b610cbc3d59cfeef23011007f1b Mon Sep 17 00:00:00 2001 From: XuWei Date: Mon, 6 Jun 2016 03:50:00 -0400 Subject: [PATCH] Fix issue 846, update mknb doc --- .../guides/admin-guides/references/man8/mknb.8.rst | 12 ++++++------ xCAT-client/pods/man8/mknb.8.pod | 13 ++++++------- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man8/mknb.8.rst b/docs/source/guides/admin-guides/references/man8/mknb.8.rst index e7753beb2..119a369ef 100644 --- a/docs/source/guides/admin-guides/references/man8/mknb.8.rst +++ b/docs/source/guides/admin-guides/references/man8/mknb.8.rst @@ -27,14 +27,14 @@ DESCRIPTION *********** -The \ **mknb**\ command is run by xCAT automatically, when xCAT is installed on the management node. +The \ **mknb**\ command is run by xCAT automatically when xCAT is installed on the management node. It creates a network boot root image (used for node discovery, BMC programming, and flashing) -for the same architecture that the management node is. So you normally do not need to run the \ **mknb**\ -command yourself. +for the same architecture that the management node is. So you normally do not need to run the +\ **mknb**\ command yourself. -If you do run \ **mknb**\ to add custom utilities to your boot root image, and you have an xCAT Hierarchical Cluster with service nodes that each have a local /tftpboot directory (site sharedtftp=0), you will also need to copy the generated root image to each service node. +If you make custom changes to the network boot root image, you will need to run \ **mknb**\ again to regenerate the diskless image to include your changes. If you have an xCAT Hierarchical Cluster with Service Nodes having local /tftpboot directories (site.sharedtftp=0), you will need to copy the generated root image to each Service Node. -Presently, only the arch x86_64 is supported. +Presently, the architectures x86_64 and ppc64 are supported. For ppc64le, use the ppc64 architecture. ******* @@ -45,7 +45,7 @@ OPTIONS \ *arch*\ - The hardware architecture for which to build the boot image: x86_64 + The hardware architecture for which to build the boot image. diff --git a/xCAT-client/pods/man8/mknb.8.pod b/xCAT-client/pods/man8/mknb.8.pod index 476ce19a3..47ca88c04 100644 --- a/xCAT-client/pods/man8/mknb.8.pod +++ b/xCAT-client/pods/man8/mknb.8.pod @@ -9,15 +9,14 @@ B I =head1 DESCRIPTION -The B command is run by xCAT automatically, when xCAT is installed on the management node. +The B command is run by xCAT automatically when xCAT is installed on the management node. It creates a network boot root image (used for node discovery, BMC programming, and flashing) -for the same architecture that the management node is. So you normally do not need to run the B -command yourself. +for the same architecture that the management node is. So you normally do not need to run the +B command yourself. -If you do run B to add custom utilities to your boot root image, and you have an xCAT Hierarchical Cluster with service nodes that each have a local /tftpboot directory (site sharedtftp=0), you will also need to copy the generated root image to each service node. +If you make custom changes to the network boot root image, you will need to run B again to regenerate the diskless image to include your changes. If you have an xCAT Hierarchical Cluster with Service Nodes having local /tftpboot directories (site.sharedtftp=0), you will need to copy the generated root image to each Service Node. - -Presently, only the arch x86_64 is supported. +Presently, the architectures x86_64 and ppc64 are supported. For ppc64le, use the ppc64 architecture. =head1 OPTIONS @@ -25,7 +24,7 @@ Presently, only the arch x86_64 is supported. =item I -The hardware architecture for which to build the boot image: x86_64 +The hardware architecture for which to build the boot image. =back