add documentation for #192

catkin · Dec 10, 2015 · 703bb53 · 703bb53
1 parent b7adda7
commit 703bb53
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git 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/verb_customization>
    Advanced: Contributing Verbs <development/extending_the_catkin_command>
 .. TODO: Advanced: Workspace Chaining <advanced/workspace_chaining>

diff --git a/docs/verbs/catkin_source.rst 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.
+