Skip to content

Commit f2a9ca2

Browse files
Simplify the colcon-argcomplete documentation. (#4433) (#4436)
* Simplify the colcon-argcomplete documentation. The colcon documentation already states that there may be different locations for the argcomplete script depending on how it was installed. Just use that documentation as a reference point. Signed-off-by: Chris Lalancette <[email protected]> (cherry picked from commit 29f4464) Co-authored-by: Chris Lalancette <[email protected]>
1 parent 82a4b31 commit f2a9ca2

File tree

1 file changed

+2
-22
lines changed

1 file changed

+2
-22
lines changed

source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -334,28 +334,8 @@ To undo this in Linux and macOS, locate your system's shell startup script and r
334334
Setup ``colcon`` tab completion
335335
-------------------------------
336336

337-
The command ``colcon`` `supports command completion <https://colcon.readthedocs.io/en/released/user/installation.html#enable-completion>`__ for bash and bash-like shells if the ``colcon-argcomplete`` package is installed.
338-
339-
.. tabs::
340-
341-
.. group-tab:: Linux
342-
343-
.. code-block:: console
344-
345-
echo "source /usr/share/colcon_argcomplete/hook/colcon-argcomplete.bash" >> ~/.bashrc
346-
347-
.. group-tab:: macOS
348-
349-
.. code-block:: console
350-
351-
echo "source $HOME/.local/share/colcon_argcomplete/hook/colcon-argcomplete.bash" >> ~/.bash_profile
352-
353-
.. group-tab:: Windows
354-
355-
Not yet available
356-
357-
Depending on the way you installed ``colcon`` and where your workspace is, the instructions above may vary, please refer to `the documentation <https://colcon.readthedocs.io/en/released/user/installation.html>`__ for more details.
358-
To undo this in Linux and macOS, locate your system's shell startup script and remove the appended source command.
337+
The ``colcon`` command supports command completion for bash and bash-like shells.
338+
The ``colcon-argcomplete`` package must be installed, and `some setup may be required <https://colcon.readthedocs.io/en/released/user/installation.html#enable-completion>`__ to make it work.
359339

360340
Tips
361341
----

0 commit comments

Comments
 (0)