openstack/heat
Code Issues Proposed changes

Fix syntax error in docs

Browse Source 
There are several syntax errors in docs.
The patch will add missing punctuation, remove extra whitespace, and
change the "heat-api-engine" to "heat-engine" in heat-engine.rst.

Change-Id: I67dcad5e0e0a1f71a67ab8fc4311d96db4820c29
This commit is contained in:
huangtianhua 2014-01-18 10:51:09 +08:00
parent bca680bc91
commit f87114a527
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/man/heat-api-cfn.rst
View File

@ -15,7 +15,7 @@ heat-api-cfn is a CloudFormation compatible API service to the heat project.
INVENTORY INVENTORY
========= =========
heat-api-cfn is a service that exposes an external REST based api to the heat-api-cfn is a service that exposes an external REST based api to the
heat-engine service. The communication between the heat-api-cfn and heat-engine service. The communication between the heat-api-cfn and
heat-engine uses message queue based RPC. heat-engine uses message queue based RPC.
OPTIONS OPTIONS

2
doc/source/man/heat-api-cloudwatch.rst
View File

@ -10,7 +10,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
=========== ===========
heat-api-cloudwatch is a CloudWatch alike API service to the heat project heat-api-cloudwatch is a CloudWatch-like API service to the heat project.
OPTIONS OPTIONS
======= =======

2
doc/source/man/heat-api.rst
View File

@ -15,7 +15,7 @@ heat-api provides an external REST API to the heat project.
INVENTORY INVENTORY
========= =========
heat-api is a service that exposes an external REST based api to the heat-api is a service that exposes an external REST based api to the
heat-engine service. The communication between the heat-api heat-engine service. The communication between the heat-api and
heat-engine uses message queue based RPC. heat-engine uses message queue based RPC.
OPTIONS OPTIONS

8
doc/source/man/heat-db-setup.rst
View File

@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
=========== ===========
heat-db-setup is a tool which configures the local MySQL database for heat-db-setup is a tool which configures the local MySQL database for
heat. Typically distro-specific tools would provide this functionality heat. Typically distro-specific tools would provide this functionality
so please read the distro-specific documentation for configuring Heat. so please read the distro-specific documentation for configuring Heat.
@ -39,15 +39,15 @@ OPTIONS
.. cmdoption:: -p, --password .. cmdoption:: -p, --password
Specify the password for the 'heat' MySQL user that will use to connect to the 'heat' MySQL database. By default, the password 'heat' will be used. Specify the password for the 'heat' MySQL user that the script will use to connect to the 'heat' MySQL database. By default, the password 'heat' will be used.
.. cmdoption:: -r, --rootpw .. cmdoption:: -r, --rootpw
Specify the root MySQL password. If the script installs the MySQL server, it will set the root password to this value instead of prompting for a password. If the MySQL server is already installed, this password will be used to connect to the database instead of having to prompt for it. Specify the root MySQL password. If the script installs the MySQL server, it will set the root password to this value instead of prompting for a password. If the MySQL server is already installed, this password will be used to connect to the database instead of having to prompt for it.
.. cmdoption:: -y, --yes .. cmdoption:: -y, --yes
In cases where the script would normally ask for confirmation before doing something, such as installing mysql-server, just assume yes. This is useful if you want to run the script non-interactively. In cases where the script would normally ask for confirmation before doing something, such as installing mysql-server, just assume yes. This is useful if you want to run the script non-interactively.
EXAMPLES EXAMPLES
======== ========

2
doc/source/man/heat-engine.rst
View File

@ -2,7 +2,7 @@
heat-engine heat-engine
=========== ===========
.. program:: heat-api-engine .. program:: heat-engine
SYNOPSIS SYNOPSIS
======== ========

2
doc/source/man/heat-keystone-setup.rst
View File

@ -13,7 +13,7 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
=========== ===========
The heat-keystone-setup tool configures keystone for use with Heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone. The heat-keystone-setup tool configures keystone for use with Heat. This script requires admin keystone credentials to be available in the shell environment and write access to /etc/keystone.
Distributions may provide other tools to setup keystone for use with Heat, so check the distro documenation first. Distributions may provide other tools to setup keystone for use with Heat, so check the distro documenation first.