diff --git a/doc/source/man/heat-api-cfn.rst b/doc/source/man/heat-api-cfn.rst index 2577897606..ef5f74d78f 100644 --- a/doc/source/man/heat-api-cfn.rst +++ b/doc/source/man/heat-api-cfn.rst @@ -15,7 +15,7 @@ heat-api-cfn is a CloudFormation compatible API service to the heat project. INVENTORY ========= 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. OPTIONS diff --git a/doc/source/man/heat-api-cloudwatch.rst b/doc/source/man/heat-api-cloudwatch.rst index 85aad6bb0a..0f782dbb2e 100644 --- a/doc/source/man/heat-api-cloudwatch.rst +++ b/doc/source/man/heat-api-cloudwatch.rst @@ -10,7 +10,7 @@ SYNOPSIS 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 ======= diff --git a/doc/source/man/heat-api.rst b/doc/source/man/heat-api.rst index 708e94955e..c470e751df 100644 --- a/doc/source/man/heat-api.rst +++ b/doc/source/man/heat-api.rst @@ -15,7 +15,7 @@ heat-api provides an external REST API to the heat project. INVENTORY ========= 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. OPTIONS diff --git a/doc/source/man/heat-db-setup.rst b/doc/source/man/heat-db-setup.rst index 68cc0ec18f..3590b6b8d7 100644 --- a/doc/source/man/heat-db-setup.rst +++ b/doc/source/man/heat-db-setup.rst @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION =========== 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. @@ -39,15 +39,15 @@ OPTIONS .. 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 - 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 - 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 ======== diff --git a/doc/source/man/heat-engine.rst b/doc/source/man/heat-engine.rst index 1d9420ba74..86c2d2ccd2 100644 --- a/doc/source/man/heat-engine.rst +++ b/doc/source/man/heat-engine.rst @@ -2,7 +2,7 @@ heat-engine =========== -.. program:: heat-api-engine +.. program:: heat-engine SYNOPSIS ======== diff --git a/doc/source/man/heat-keystone-setup.rst b/doc/source/man/heat-keystone-setup.rst index f3c05ceea7..23637c6695 100644 --- a/doc/source/man/heat-keystone-setup.rst +++ b/doc/source/man/heat-keystone-setup.rst @@ -13,7 +13,7 @@ SYNOPSIS 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.