summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects
diff options
context:
space:
mode:
authorRobin Cernin <rcernin@redhat.com>2018-10-18 10:39:49 +1000
committerSean McGinnis <sean.mcginnis@gmail.com>2020-01-10 16:40:03 +0000
commitdf872713c72de9a4b3d1422dd74aabe0bf26f145 (patch)
treed90aa4c234148a733633844cac3b62011e420660 /doc/source/cli/command-objects
parent3fe5d27a4df00280d00cc9041b99911b3d576eef (diff)
downloadpython-openstackclient-df872713c72de9a4b3d1422dd74aabe0bf26f145.tar.gz
Improve document 'openstack complete'
The openstack complete command requires bash-completion package Without the relevant package the bash completion doesn't work. Change-Id: I47c77f3e7efe112417d2b96936fcd0cafeb9442e Closes-Bug: #1798493 (cherry picked from commit 4173690b2492680ab504ef0d60498eeb5a3d8ae2)
Diffstat (limited to 'doc/source/cli/command-objects')
-rw-r--r--doc/source/cli/command-objects/complete.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/source/cli/command-objects/complete.rst b/doc/source/cli/command-objects/complete.rst
index 20e5c41d..165d5d07 100644
--- a/doc/source/cli/command-objects/complete.rst
+++ b/doc/source/cli/command-objects/complete.rst
@@ -11,8 +11,11 @@ Typical usage for this command is::
openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null
-If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``),
-then this command will likely be run for you.
+It is highly recommended to install ``python-openstackclient`` from a package
+(``apt-get`` or ``yum``). In some distributions the package ``bash-completion`` is shipped
+as dependency, and the `openstack complete` command will be run as a post-install action,
+however not every distribution include this dependency and you might need to install
+``bash-completion`` package to enable autocomplete feature.
complete
--------