ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

Why is tutorial code isolated from the package code?

asked 2012-12-27 08:06:01 -0500

mirzashah gravatar image

One of the things that threw me off with ROS code organization was that the code for package tutorials is in a separate repository from the package code. Intuitively, it would make sense to have a directory within the package called "tutorials" just as we often have a "test" directory for unit tests.

Why is tutorial code isolated from the package code? Is it bad practice to combine the two?

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2012-12-27 08:22:46 -0500

tfoote gravatar image

This is an artifact of the fact that previously stacks were the unit of release and with fast iterations on libraries with tutorials and tutorials being developed separately the isolation was useful.

With the new catkin based packaging allowing independent packages to be in the same repository it is a good time for maintainers to consider bringing the tutorials into the same repository with the source. (As a separate package so as not to add dependencies to libraries just useful for the tutorials.)

If the development efforts are expected to be significantly out of sync that will be a cost, as the packages in a single repository are required to be versioned together by the release tools, the maintainer might not want to do this. However as packages stabilize, tutorials can be considered part of core documentation and should be able to moved closer to the core functionality.

edit flag offensive delete link more

Question Tools


Asked: 2012-12-27 08:06:01 -0500

Seen: 180 times

Last updated: Dec 27 '12