summaryrefslogtreecommitdiff
path: root/openstackclient
diff options
context:
space:
mode:
authorMatt Riedemann <mriedem.os@gmail.com>2019-07-01 15:06:56 -0400
committerMatt Riedemann <mriedem.os@gmail.com>2019-07-01 15:06:56 -0400
commit879f8207786caf1cd9e1465e32e322abd111508c (patch)
tree05df15f311fe61de8439f52b28d0fe2c9f2b13c1 /openstackclient
parenteada2db332caa3dc042650437a1536e589505c2b (diff)
downloadpython-openstackclient-879f8207786caf1cd9e1465e32e322abd111508c.tar.gz
docs: clarify compute service --service option
The compute service commands emit a "Binary" in the output but the --service filter option isn't as clear that it's the binary (for set it is but not list) nor do the docs give an example of a binary (typically nova-compute but could be others like nova-conductor, nova-scheduler, etc). This simply mentions that the --service option is the binary for "compute service list" and gives an example value for the option in both list and set help. Change-Id: If87fc37352c3a251cc89041723adbe04dedf4f8a
Diffstat (limited to 'openstackclient')
-rw-r--r--openstackclient/compute/v2/service.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/openstackclient/compute/v2/service.py b/openstackclient/compute/v2/service.py
index 18e6d9d9..98347c9f 100644
--- a/openstackclient/compute/v2/service.py
+++ b/openstackclient/compute/v2/service.py
@@ -72,7 +72,8 @@ class ListService(command.Lister):
parser.add_argument(
"--service",
metavar="<service>",
- help=_("List only specified service (name only)")
+ help=_("List only specified service binaries (name only). For "
+ "example, ``nova-compute``, ``nova-conductor``, etc.")
)
parser.add_argument(
"--long",
@@ -126,7 +127,8 @@ class SetService(command.Command):
parser.add_argument(
"service",
metavar="<service>",
- help=_("Name of service (Binary name)")
+ help=_("Name of service (Binary name), for example "
+ "``nova-compute``")
)
enabled_group = parser.add_mutually_exclusive_group()
enabled_group.add_argument(