diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-08-28 02:31:37 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2017-08-28 02:48:07 -0400 |
| commit | d5836eae68a7ef4ad425e2645954250f3dc0d5bb (patch) | |
| tree | 211a7b0e1b115c26c017ef43307912cf4540013e /doc | |
| parent | 25caabb2e9ae6548e452eff1bdabeeb23386e1ab (diff) | |
| download | buildstream-d5836eae68a7ef4ad425e2645954250f3dc0d5bb.tar.gz | |
doc/source/completion.rst: Added some docs on setting up bash completions
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/completion.rst | 16 | ||||
| -rw-r--r-- | doc/source/index.rst | 1 |
2 files changed, 17 insertions, 0 deletions
diff --git a/doc/source/completion.rst b/doc/source/completion.rst new file mode 100644 index 000000000..cc5f6d33c --- /dev/null +++ b/doc/source/completion.rst @@ -0,0 +1,16 @@ +.. _completion: + +Bash Completions +================ + +Bash completions are supported by sourcing the ``buildstream/data/bst`` +script found in the BuildStream repository. On many systems this script +can be installed into a completions directory but when installing BuildStream +without a package manager this is not an option. + +To enable completions for an installation of BuildStream you +installed yourself from git, just append the script verbatim +to your ``~/.bash_completion``: + +.. literalinclude:: ../../buildstream/data/bst + :language: yaml diff --git a/doc/source/index.rst b/doc/source/index.rst index 77a2ad899..95f89c407 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -31,6 +31,7 @@ off the ground installing it on a new host. * :ref:`installing` * :ref:`invoking` +* :ref:`completion` * :ref:`config` * :ref:`projectconf` * :ref:`format` |