From 703bb53d1cf0ad98064b5291c6a553d816f1da42 Mon Sep 17 00:00:00 2001 From: Kei Okada Date: Thu, 10 Dec 2015 12:33:35 +0900 Subject: [PATCH] add documentation for #192 --- docs/index.rst | 1 + docs/verbs/catkin_source.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/verbs/catkin_source.rst diff --git a/docs/index.rst b/docs/index.rst index 3699dca4..54626825 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ Catkin Command Line Tools verbs/catkin_list verbs/catkin_locate verbs/catkin_profile + verbs/catkin_source Advanced: Verb Aliasing Advanced: Contributing Verbs .. TODO: Advanced: Workspace Chaining diff --git a/docs/verbs/catkin_source.rst b/docs/verbs/catkin_source.rst new file mode 100644 index 00000000..181c4026 --- /dev/null +++ b/docs/verbs/catkin_source.rst @@ -0,0 +1,27 @@ +``catkin source`` -- Source Package Info +==================================== + +The ``source`` verb for the ``catkin`` command is used to source +setup.sh file in devel or install spaces of the containing workspace. + +This is a bash/zsh wrapper function, you need to + +.. code-block:: shell + + . /opt/ros/indigo/etc/bash_completion.d/catkin_shell_verbs.{bash,zsh} + +to enable this feature. + +Full Command-Line Interface +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: text + + usage: catkin source [-w /path/to/ws] + + Sources setup.sh in the workspace. + + optional arguments: + -w [/path/to/ws] + Source setup.sh from given workspace. +