Skip to content

Commit

Permalink
verbs: renaming path verb to find verb
Browse files Browse the repository at this point in the history
  • Loading branch information
jbohren committed Mar 19, 2015
1 parent 67c493d commit d3afa3f
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
4 changes: 2 additions & 2 deletions catkin_tools/verbs/catkin_find/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,10 @@ def main(opts):
packages = find_packages(ctx.source_space_abs)
catkin_pkg = [path for path, p in packages.items() if p.name == opts.pkg]
if catkin_pkg:
print(os.path.join(ctx.source_space_abs,catkin_pkg[0]))
print(os.path.join(ctx.source_space_abs, catkin_pkg[0]))
else:
print(clr("@{rf}ERROR: Could not find a package named '%s' in source space '%s'@|" %
(opts.pkg, ctx.source_space_abs)), file=sys.stderr)
(opts.pkg, ctx.source_space_abs)), file=sys.stderr)
sys.exit(2)
except RuntimeError as e:
print(clr('@{rf}ERROR: %s@|' % str(e)), file=sys.stderr)
Expand Down
34 changes: 34 additions & 0 deletions docs/verbs/catkin_find.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
``catkin find`` -- Find Workspace Locations
===========================================

The ``find`` verb can be used to find important locations in the workspace such as
the active ``source``, ``build``, ``devel``, and ``install`` spaces, and package
source directories in the workspace.

Full Command-Line Interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: text
usage: catkin find [-h] [--workspace WORKSPACE] [--profile PROFILE]
[--root | --space {src,build,devel,install} | --pkg PACKAGE]
Get the paths to important locations in a workspace.
optional arguments:
-h, --help show this help message and exit
--workspace WORKSPACE, -w WORKSPACE
The path to the catkin_tools workspace or a directory
contained within it (default: ".")
--profile PROFILE The name of a config profile to use (default: active
profile)
Paths:
Get the absolute path to one of the following locations in the given
workspace with the given profile.
--root, -r The workspace root. (default)
--space {src,build,devel,install}, -s {src,build,devel,install}
One of the active workspace sub-spaces.
--pkg PACKAGE, -p PACKAGE
Get the path to a source package in the workspace.

0 comments on commit d3afa3f

Please sign in to comment.