From a63b7e8191853f94dc66cfc4ef70fdb9bb2cae83 Mon Sep 17 00:00:00 2001 From: Lucas Alvares Gomes Date: Fri, 10 Feb 2017 10:34:51 +0000 Subject: [PATCH] Fix documentation title and README This patch fixes the documentation title, the name of the project is VirtualBMC (with the capital cases) and also fix the README, it changes the order of "team and repository tag" title to be the last and add graceful shutdown and NMI as supported commands for ipmitool. Change-Id: Ieb857b4c1065d5fff2028ee78a4a4e8586cd4724 --- README.rst | 26 +++++++++++++++----------- doc/source/index.rst | 4 ++-- 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 91ef3ac..26499f7 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,4 @@ -======================== -Team and repository tags -======================== - -.. image:: http://governance.openstack.org/badges/virtualbmc.svg - :target: http://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - +=========== Virtual BMC =========== @@ -24,8 +16,8 @@ Supported IPMI commands .. code-block:: bash - # Power the virtual machine on or off - ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power on|off + # Power the virtual machine on, off, graceful off and NMI + ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power on|off|soft|diag # Check the power status ipmitool -I lanplus -U admin -P password -H 127.0.0.1 power status @@ -35,3 +27,15 @@ Supported IPMI commands # Get the current boot device ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5 + + # Get the current boot device + ipmitool -I lanplus -U admin -P password -H 127.0.0.1 chassis bootparam get 5 + +Team and repository tags +------------------------ + +.. image:: http://governance.openstack.org/badges/virtualbmc.svg + :target: http://governance.openstack.org/reference/tags/index.html + +.. Change things from this point on + diff --git a/doc/source/index.rst b/doc/source/index.rst index e6b901f..26538a0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to virtualbmc's documentation! -======================================================== +Welcome to VirtualBMC's documentation! +====================================== Contents: