add documentation for #192 #244
Conversation
| Shell support in ``catkin`` command | ||
| ----------------------------------- | ||
|
|
||
| A bash/zsh user can use wrapper wrapper function, please read :doc:`development/catkin_shell_verbs`. |
There was a problem hiding this comment.
"wrapper wrapper" looks like a typo.
|
Thanks for working on this @k-okada. |
|
thanks for review, updated docs |
|
|
||
| .. code-block:: shell | ||
|
|
||
| . /opt/ros/indigo/etc/bash_completion.d/catkin_shell_verbs.{bash,zsh} |
There was a problem hiding this comment.
Sorry, it is not correct ,and I think it is not installed, how can I configure setup.py to install ./scripts/catkin_shell_verbs.bash
There was a problem hiding this comment.
I'm not sure what the right thing to do here is, maybe @jbohren can advise?
You could do something cute like this:
$ source `catkin --locate-extra-shell-verbs`
And then install the shell scripts that need to be sourced in with the Python code and provide an option to expose their final location.
There was a problem hiding this comment.
ok, how about this 25b8c4f, I'm not sure
how to get installed location ...
http://stackoverflow.com/questions/50499/how-do-i-get-the-path-and-name-of-the-file-that-is-currently-executing
◉ Kei Okada
On Sat, Dec 12, 2015 at 5:12 AM, William Woodall notifications@github.com
wrote:
In docs/advanced/catkin_shell_verbs.rst
#244 (comment):@@ -0,0 +1,36 @@
+Shell support incatkincommand
+===================================
+
+When you source the following file, you can use bash/zsh shell functions which provide added utility.
+
+.. code-block:: shell
+
- . /opt/ros/indigo/etc/bash_completion.d/catkin_shell_verbs.{bash,zsh}
I'm not sure what the right thing to do here is, maybe @jbohren
https://github.com/jbohren can advise?You could do something cute like this:
$ source
catkin --locate-extra-shell-verbsAnd then install the shell scripts that need to be sourced in with the
Python code and provide an option to expose their final location.—
Reply to this email directly or view it on GitHub
https://github.com/catkin/catkin_tools/pull/244/files#r47399572.
There was a problem hiding this comment.
Possibly resource_filename is what you are looking for.
There was a problem hiding this comment.
Do you know a reliable way to determine where the correct share/catkin_tools is to be found?
There was a problem hiding this comment.
what I found so far is follows:
os.path.abspath(os.path.join(os.path.dirname(inspect.getfile(catkin_tools)), '../../../../share/catkin_tools'))
os.path.abspath(os.path.join(imp.find_module('catkin_tools')[1], '../../../../share/catkin'))
if we do not have other solution, we have to accept this ugly expresson, or put catkin_shell_verbs.bash under dist-packages
There was a problem hiding this comment.
There was a problem hiding this comment.
In [2]: resource_filename(Requirement.parse("catkin_tools"), "catkin_shell_verbs.bash")
Out[2]: '/home/k-okada/catkin_ws/ws_catkin/install/lib/python2.7/dist-packages/catkin_shell_verbs.bash'
In [3]:
Do you really want to exit ([y]/n)? y
k-okada@kokada-t440s:~/catkin_ws/ws_catkin$ find install -name catkin_shell_verbs.bash
install/share/catkin_tools/catkin_shell_verbs.bash
x-9
There was a problem hiding this comment.
I'd say just put it in dist-packages along side the code.
…ption to get the path
| for arg in sysargs: | ||
| if arg == '--locate-extra-shell-verbs': | ||
| import inspect | ||
| print(os.path.abspath(os.path.join(inspect.stack()[-1][1],'../../','share/catkin_tools/catkin_shell_verbs.bash'))) |
|
Looks like the CI is not passing, but other than a few comments it is looking good to me. |
|
I fixed this up and merged it, thanks @k-okada! |
this includes #192