diff options
| author | Matt Riedemann <mriedem.os@gmail.com> | 2019-07-01 15:06:56 -0400 |
|---|---|---|
| committer | Matt Riedemann <mriedem.os@gmail.com> | 2019-07-01 15:06:56 -0400 |
| commit | 879f8207786caf1cd9e1465e32e322abd111508c (patch) | |
| tree | 05df15f311fe61de8439f52b28d0fe2c9f2b13c1 /doc/source/cli/command-objects | |
| parent | eada2db332caa3dc042650437a1536e589505c2b (diff) | |
| download | python-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 'doc/source/cli/command-objects')
| -rw-r--r-- | doc/source/cli/command-objects/compute-service.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/source/cli/command-objects/compute-service.rst b/doc/source/cli/command-objects/compute-service.rst index ba624ea0..51d5c864 100644 --- a/doc/source/cli/command-objects/compute-service.rst +++ b/doc/source/cli/command-objects/compute-service.rst @@ -39,7 +39,8 @@ List compute services .. option:: --service <service> - List only specified service (name only) + List only specified service binaries (name only). For example, + ``nova-compute``, ``nova-conductor``, etc. .. option:: --long @@ -86,4 +87,4 @@ Set compute service properties .. describe:: <service> - Name of service (Binary name) + Name of service (Binary name), for example ``nova-compute`` |