Skip to content

Commit

Permalink
doc: Misc fixes to 'bash-completion'
Browse files Browse the repository at this point in the history
Fix some minor formatting issues with this document.

Signed-off-by: Stephen Finucane <[email protected]>
Signed-off-by: Ben Pfaff <[email protected]>
  • Loading branch information
stephenfin authored and blp committed Dec 22, 2016
1 parent 73c76b4 commit ea0c5fd
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions Documentation/intro/install/bash-completion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
Bash command-line completion scripts
====================================

There are two completion scripts available, ovs-appctl-bashcomp.bash and
ovs-vsctl-bashcomp.bash respectively.
There are two completion scripts available: ``ovs-appctl-bashcomp.bash`` and
``ovs-vsctl-bashcomp.bash``.

ovs-appctl-bashcomp
-------------------

ovs-appctl-bashcomp.bash adds bash command-line completion support for
ovs-appctl, ovs-dpctl, ovs-ofctl and ovsdb-tool commands.
``ovs-appctl-bashcomp.bash`` adds bash command-line completion support for
``ovs-appctl``, ``ovs-dpctl``, ``ovs-ofctl`` and ``ovsdb-tool`` commands.

Features
~~~~~~~~
Expand All @@ -48,19 +48,14 @@ Features
Limitations
~~~~~~~~~~~

- Only supports a small set of important keywords (``dp``, ``datapath``, ``bridge``, ``switch``,
``port``, ``interface``, ``iface``).
- Only supports a small set of important keywords (``dp``, ``datapath``,
``bridge``, ``switch``, ``port``, ``interface``, ``iface``).

- Does not support parsing of nested options. For example:


::
- Does not support parsing of nested options. For example::

$ ovsdb-tool create [db [schema]]

- Does not support expansion on repeated argument. For example:

::
- Does not support expansion on repeated argument. For example::

$ ovs-dpctl show [dp...]).

Expand All @@ -70,8 +65,8 @@ Limitations
ovs-vsctl-bashcomp
-------------------

ovs-vsctl-bashcomp.bash adds bash command-line completion support for ovs-vsctl
command.
``ovs-vsctl-bashcomp.bash`` adds Bash command-line completion support for
``ovs-vsctl`` command.

Features
~~~~~~~~
Expand All @@ -84,7 +79,7 @@ Features

- Deal with argument relations like 'one and more', 'zero or one'.

- Complete multiple ovs-vsctl commands cascaded via ``--``.
- Complete multiple ``ovs-vsctl`` commands cascaded via ``--``.

Limitations
~~~~~~~~~~~
Expand Down

0 comments on commit ea0c5fd

Please sign in to comment.