From 493acbec798114e12bea1e2c301137eb2a805a25 Mon Sep 17 00:00:00 2001 From: Kanagaraj Manickam Date: Mon, 6 Apr 2015 16:54:31 +0530 Subject: [PATCH] Adds --version into command docs Adds --version option in the heat command help documents. Change-Id: I8c71391893a1c9697abd57344e04f88e6a2bcd4c --- doc/source/man/heat-api-cfn.rst | 5 +++++ doc/source/man/heat-api-cloudwatch.rst | 5 +++++ doc/source/man/heat-api.rst | 5 +++++ doc/source/man/heat-engine.rst | 5 +++++ doc/source/man/heat-keystone-setup-domain.rst | 2 +- doc/source/man/heat-manage.rst | 5 +++++ 6 files changed, 26 insertions(+), 1 deletion(-) diff --git a/doc/source/man/heat-api-cfn.rst b/doc/source/man/heat-api-cfn.rst index ef5f74d78f..9d3b51de5c 100644 --- a/doc/source/man/heat-api-cfn.rst +++ b/doc/source/man/heat-api-cfn.rst @@ -33,6 +33,11 @@ OPTIONS over-ridden. The set is parsed after the file(s), if any, specified via --config-file, hence over-ridden options in the directory take precedence. +.. cmdoption:: --version + + Show program's version number and exit. The output could be empty if + the distribution didn't specify any version information. + FILES ======== diff --git a/doc/source/man/heat-api-cloudwatch.rst b/doc/source/man/heat-api-cloudwatch.rst index 0f782dbb2e..ed2f689140 100644 --- a/doc/source/man/heat-api-cloudwatch.rst +++ b/doc/source/man/heat-api-cloudwatch.rst @@ -27,6 +27,11 @@ OPTIONS over-ridden. The set is parsed after the file(s), if any, specified via --config-file, hence over-ridden options in the directory take precedence. +.. cmdoption:: --version + + Show program's version number and exit. The output could be empty if + the distribution didn't specify any version information. + FILES ======== diff --git a/doc/source/man/heat-api.rst b/doc/source/man/heat-api.rst index c470e751df..b03892cfce 100644 --- a/doc/source/man/heat-api.rst +++ b/doc/source/man/heat-api.rst @@ -33,6 +33,11 @@ OPTIONS over-ridden. The set is parsed after the file(s), if any, specified via --config-file, hence over-ridden options in the directory take precedence. +.. cmdoption:: --version + + Show program's version number and exit. The output could be empty if + the distribution didn't specify any version information. + FILES ======== diff --git a/doc/source/man/heat-engine.rst b/doc/source/man/heat-engine.rst index 86c2d2ccd2..6c91f90e4c 100644 --- a/doc/source/man/heat-engine.rst +++ b/doc/source/man/heat-engine.rst @@ -32,6 +32,11 @@ OPTIONS over-ridden. The set is parsed after the file(s), if any, specified via --config-file, hence over-ridden options in the directory take precedence. +.. cmdoption:: --version + + Show program's version number and exit. The output could be empty if + the distribution didn't specify any version information. + FILES ======== diff --git a/doc/source/man/heat-keystone-setup-domain.rst b/doc/source/man/heat-keystone-setup-domain.rst index 878e3ee6c8..e686f7e7d5 100644 --- a/doc/source/man/heat-keystone-setup-domain.rst +++ b/doc/source/man/heat-keystone-setup-domain.rst @@ -86,7 +86,7 @@ OPTIONS .. cmdoption:: --version - Show program's version number and exit. The output could be empty if + Show program's version number and exit. The output could be empty if the distribution didn't specify any version information. diff --git a/doc/source/man/heat-manage.rst b/doc/source/man/heat-manage.rst index 115b73ebe3..9b306b4a7b 100644 --- a/doc/source/man/heat-manage.rst +++ b/doc/source/man/heat-manage.rst @@ -44,6 +44,11 @@ Heat Db version Shows details for all currently running heat engines. +``heat-manage --version`` + + Shows program's version number and exit. The output could be empty if + the distribution didn't specify any version information. + FILES =====