From 2bad8de18e8391a97c78a4d1fa8f260e09d89329 Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Mon, 3 May 2021 15:05:27 -0400 Subject: [PATCH] Fix formatting and grammar for makenetworks man page --- .../references/man8/makenetworks.8.rst | 26 ++++++++++++------- xCAT-client/pods/man8/makenetworks.8.pod | 14 +++++----- 2 files changed, 24 insertions(+), 16 deletions(-) diff --git a/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst b/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst index 6cead8f4d..0ee0733c3 100644 --- a/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst +++ b/docs/source/guides/admin-guides/references/man8/makenetworks.8.rst @@ -35,9 +35,9 @@ The \ **makenetworks**\ command can be used to gather network information from Every network that will be used to install a cluster node must be defined in the xCAT database. -The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save this information in the xCAT database. +The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save that information in the xCAT database. -You can use the "-d" option to display the network information without writing it to the database. +You can use the \ **-d**\ option to display the network information without writing it to the database. You can also redirect the output to a file that can be used with the xCAT \ **mkdef**\ command to define the networks. @@ -53,9 +53,9 @@ For example: This features allows you to verify and modify the network information before writing it to the database. -When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the mkdef, chdef, lsdef, and rmdef commands to manage this data. +When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the \ **mkdef**\ , \ **chdef**\ , \ **lsdef**\ , and \ **rmdef**\ commands to manage this data. -The default naming convention is to use a hyphen separated "net" and "mask" value with the "." replace by "_". (ex. "8_124_47_64-255_255_255_0") +The default naming convention is to use a hyphen separated "net" and "mask" values with the "." replaced by "_". (ex. "8_124_47_64-255_255_255_0") You can also modify the xCAT "networks" database table directly using the xCAT \ **tabedit**\ command. @@ -121,13 +121,19 @@ EXAMPLES makenetworks -d - The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the lsdef, mkdef, chdef and rmdef commands. + The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the \ **lsdef**\ , \ **mkdef**\ , \ **chdef**\ and \ **rmdef**\ commands. + + + .. code-block:: perl + + 9_114_37_0-255_255_255_0: + objtype=network + gateway=9.114.37.254 + mask=255.255.255.0 + net=9.114.37.0 + mgtifname=ens3 + mtu=1500 - 9_114_37_0-255_255_255_0: - objtype=network - gateway=9.114.37.254 - mask=255.255.255.0 - net=9.114.37.0 diff --git a/xCAT-client/pods/man8/makenetworks.8.pod b/xCAT-client/pods/man8/makenetworks.8.pod index 402873c43..f7c4f3173 100644 --- a/xCAT-client/pods/man8/makenetworks.8.pod +++ b/xCAT-client/pods/man8/makenetworks.8.pod @@ -16,9 +16,9 @@ The B command can be used to gather network information from an xC Every network that will be used to install a cluster node must be defined in the xCAT database. -The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save this information in the xCAT database. +The default behavior is to gather network information from the management node, and any configured xCAT service nodes, and automatically save that information in the xCAT database. -You can use the "-d" option to display the network information without writing it to the database. +You can use the B<-d> option to display the network information without writing it to the database. You can also redirect the output to a file that can be used with the xCAT B command to define the networks. @@ -30,9 +30,9 @@ For example: This features allows you to verify and modify the network information before writing it to the database. -When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the mkdef, chdef, lsdef, and rmdef commands to manage this data. +When the network information is gathered a default value is created for the "netname" attribute. This is done to make it possible to use the B, B, B, and B commands to manage this data. -The default naming convention is to use a hyphen separated "net" and "mask" value with the "." replace by "_". (ex. "8_124_47_64-255_255_255_0") +The default naming convention is to use a hyphen separated "net" and "mask" values with the "." replaced by "_". (ex. "8_124_47_64-255_255_255_0") You can also modify the xCAT "networks" database table directly using the xCAT B command. @@ -77,13 +77,15 @@ Display cluster network information but do not write the network definitions to makenetworks -d -The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the lsdef, mkdef, chdef and rmdef commands. +The output would be one or more stanzas of information similar to the following. The line that ends with a colon is the value of the "netname" attribute and is the name of the network object to use with the B, B, B and B commands. -9_114_37_0-255_255_255_0: + 9_114_37_0-255_255_255_0: objtype=network gateway=9.114.37.254 mask=255.255.255.0 net=9.114.37.0 + mgtifname=ens3 + mtu=1500 =back