diff --git a/docs/source/advanced/goconserver/index.rst b/docs/source/advanced/goconserver/index.rst index 39f3ff2cc..50116e9ed 100644 --- a/docs/source/advanced/goconserver/index.rst +++ b/docs/source/advanced/goconserver/index.rst @@ -5,7 +5,6 @@ Go Conserver programming language. For more information, see https://github.com/xcat2/goconserver/ .. toctree:: - :maxdepth: 2 quickstart.rst diff --git a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst index c8fcc0dfb..73b452a42 100644 --- a/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst +++ b/docs/source/advanced/restapi/restapi_setup/restapi_setup.rst @@ -1,5 +1,5 @@ Enable the HTTPS protocol for REST API -===================================== +====================================== To improve the security between the REST API clients and server, enabling the secure transfer protocol (https) is the default configuration. diff --git a/docs/source/guides/admin-guides/basic_concepts/xcat_db/regexp_db.rst b/docs/source/guides/admin-guides/basic_concepts/xcat_db/regexp_db.rst index d1ff05af1..5d36de561 100644 --- a/docs/source/guides/admin-guides/basic_concepts/xcat_db/regexp_db.rst +++ b/docs/source/guides/admin-guides/basic_concepts/xcat_db/regexp_db.rst @@ -120,6 +120,7 @@ xCAT provides several functions that can simplify regular expressions. +-----------+-----------+-----------+-----------+ | row2-col1 | row2-col2 | row2-col3 | row2-col4 | +-----------+-----------+-----------+-----------+ + To obtain the rack index, use ``|row(\d+)-col(\d+)|(dim2idx($1, 4, $2))|``. This maps the racks to: +---+---+---+---+ @@ -127,6 +128,7 @@ xCAT provides several functions that can simplify regular expressions. +---+---+---+---+ | 5 | 6 | 7 | 8 | +---+---+---+---+ + Note that the size of the highest dimension (2 rows) is not needed, and all values are one-indexed. If each rack contains 20 nodes, use ``|row(\d+)-col(\d+)-node(\d+)|(dim2idx($1, 4, $2, 20, $3)`` to determine a node index (useful for determining IP addresses). diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst index 13e599054..23a8175b4 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/syncfile/syncfile_synclist_file.rst @@ -19,7 +19,7 @@ The path_of_src_file* should be the full path of the source file on the Manageme The path_of_dst_file* should be the full path of the destination file on target node. Please make sure path_of_dst_file* is not a existing directory on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail. -The path_of_dst_directory should be the full path of the destination directory. Please make sure *eth_of_dst_directory is not a existing file on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail. +The path_of_dst_directory should be the full path of the destination directory. Please make sure path_of_dst_directory is not a existing file on target node, otherwise, the file sync with ``updatenode -r /usr/bin/scp`` or ``xdcp -r /usr/bin/scp`` will fail. Since the synclist file is for common purpose, the target node need not be configured in it. diff --git a/docs/source/guides/admin-guides/references/man1/piflash.1.rst b/docs/source/guides/admin-guides/references/man1/piflash.1.rst index 1959a893e..887cab7c3 100644 --- a/docs/source/guides/admin-guides/references/man1/piflash.1.rst +++ b/docs/source/guides/admin-guides/references/man1/piflash.1.rst @@ -11,7 +11,7 @@ SYNOPSIS ******** -\ **piflash**\ -**\ **-package +\ **piflash**\ \ *noderange*\ -**\ **-package \ *filename*\ *********** diff --git a/xCAT-client/pods/man1/piflash.1.pod b/xCAT-client/pods/man1/piflash.1.pod index 9d4752f5f..c689e024c 100644 --- a/xCAT-client/pods/man1/piflash.1.pod +++ b/xCAT-client/pods/man1/piflash.1.pod @@ -5,7 +5,7 @@ B - Remotely applies firmware updates to servers. =head1 SYNOPSIS -B --package +B I --package I =head1 DESCRIPTION