From 6b3bd342664fdfe80c55c513de125bd471676d6f Mon Sep 17 00:00:00 2001 From: "zhang.xiuhua" Date: Wed, 15 Jun 2016 15:25:52 +0800 Subject: [PATCH] Correct command usage in bare metal document This change is about command usage. see description in this link: http://docs.openstack.org/contributor-guide/writing-style/ui-terminology.html notice this sentence: "Depending on whether you describe CLI actions in the running text or in procedures, consider the following usage" Change-Id: I0902af058b5e8b6ba678b3fe6151a2021eaf1233 --- doc/admin-guide/source/baremetal.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/admin-guide/source/baremetal.rst b/doc/admin-guide/source/baremetal.rst index c9c2e4f7e9..2f68724897 100644 --- a/doc/admin-guide/source/baremetal.rst +++ b/doc/admin-guide/source/baremetal.rst @@ -114,7 +114,7 @@ If you get this message, check the following: #. Introspection should have succeeded for you before, or you should have entered the required bare-metal node properties manually. - For each node in :command:`ironic node-list` use: + For each node in the :command:`ironic node-list` command, use: .. code-block:: console @@ -130,14 +130,14 @@ If you get this message, check the following: $ openstack flavor show FLAVOR -#. Make sure that enough nodes are in ``available`` state according to - :command:`ironic node-list`. Nodes in ``manageable`` state usually mean they - have failed introspection. +#. Make sure that enough nodes are in ``available`` state according to the + :command:`ironic node-list` command. Nodes in ``manageable`` state usually + mean they have failed introspection. #. Make sure nodes you are going to deploy to are not in maintenance mode. - Use :command:`ironic node-list` to check. A node automatically going to - maintenance mode usually means the incorrect credentials for this node. - Check them and then remove maintenance mode: + Use the :command:`ironic node-list` command to check. A node automatically + going to maintenance mode usually means the incorrect credentials for + this node. Check them and then remove maintenance mode: .. code-block:: console @@ -147,5 +147,5 @@ If you get this message, check the following: service to the Compute service after introspection. Our tooling usually accounts for it, but if you did some steps manually there may be a period of time when nodes are not available to the Compute service yet. Check that - :command:`nova hypervisor-stats` correctly shows total amount of resources - in your system. + the :command:`nova hypervisor-stats` command correctly shows total amount + of resources in your system.