Ask Your Question
0

Is ROS.org's Code API generator supposed to work with python code imported using git_checkout.mk

asked 2012-02-23 06:57:35 -0600

updated 2012-02-23 08:55:47 -0600

kwc gravatar image

Hello,

I am using git_chekout.mk in http://www.ros.org/wiki/teer to fetch teer's source code into ROS. Currently, there is no "Code API" generated for it; is it because the generator is busy/overloaded or because it is not supposed to index fetched code? If the latter explanation is the right one, what is the best practice to document inside ROS code fetched from outside (be it with git_checkout, svn_checkout or tarball's import)?

Thank you, kind regards

edit retag flag offensive close merge delete

2 Answers

Sort by » oldest newest most voted
1

answered 2012-02-23 08:54:43 -0600

kwc gravatar image

The indexer does not 'build' any code that it runs the generator against (see NOTE). git_checkout.mk requires building the code. In the past, we attempted to add this feature to the indexer, but it simply is intractable for it to successfully build arbitrary code checkouts, for numerous reasons.

If you wish to document fetched code, then the way to do that is to submit the fetched code separately to the indexer, or manually generate the documentation yourself and upload to an appropriate location.

NOTE: The only exception is documentation for diamondback/electric versioned docs, which is only for released/debian-ized stacks. This feature is going away as, starting in Fuerte, stacks are no longer including source within the installed layout.

edit flag offensive delete link more
0

answered 2012-02-23 22:57:17 -0600

Thank you for the answer. I am now using git submodules to fetch the upstream teer in a subdirectory inside teer_ros. That should solve the issue nicely.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

Stats

Asked: 2012-02-23 06:57:35 -0600

Seen: 113 times

Last updated: Feb 23 '12