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

Revision history [back]

click to hide/show revision 1
initial version

What should be ignored for catkin?

Catkin (really CMake) does out-of-source builds (see in the CMake FAQ). That means that, in contrast to rosbuild, your source tree will not be polluted with build artefacts each time you compile your packages.

As long as you only store the sources of your packages in your VCS (so not your entire catkin_ws directory), you should not need to add anything special to ignore Catkin related files.

What should be ignored for catkin?

Catkin (really CMake) does out-of-source builds (see CMake FAQ - Out-of-source build trees in the CMake FAQ). That means that, in contrast to rosbuild, your source tree will not be polluted with build artefacts each time you compile your packages.

As long as you only store the sources of your packages in your VCS (so not your entire catkin_ws directory), you should not need to add anything special to ignore Catkin related files.

What should be ignored for catkin?

Catkin (really CMake) does out-of-source builds (see CMake FAQ - Out-of-source build trees in the CMake FAQ). That means that, in contrast to rosbuild, your source tree will not be polluted with build artefacts each time you compile your packages.

As long as you only store the sources of your packages in your VCS (so not your entire catkin_ws directory), you should not need to add anything special to ignore Catkin related files.

Whether you want to ignore some additional files is then entirely up to you.

What should be ignored for catkin?

Catkin (really CMake) does out-of-source builds (see CMake FAQ - Out-of-source build trees in the CMake FAQ). That means that, in contrast to rosbuild, your source tree will not be polluted with build artefacts each time you compile your packages.

As long as you only store the sources of your packages in your VCS (so not your entire catkin_ws directory), you should not need to add anything special to ignore Catkin related files.

Whether you want to ignore some additional files is then entirely up to you.


Edit: one thing I do tend to add to my .gitignore files is the mongodb created by MoveIt when you run a launch file from your MoveIt config that uses a database. These can become very large (4GB+) and you typically don't version those. Adding a line like default_warehouse_mongo_db/ should fix that.

Edit2: another would be CATKIN_IGNORE files. Just so you can selectively 'hide' packages in your workspace. But with the support for black/white listing packages in catkin_tools, I've not used that too much recently.

What should be ignored for catkin?

Catkin (really CMake) does out-of-source builds (see CMake FAQ - Out-of-source build trees in the CMake FAQ). That This means that, in contrast to rosbuild, your source tree will not be polluted with build artefacts each time you compile your packages.

As long as you only store the sources of your packages in your VCS (so not your entire catkin_ws directory), you should not need to add anything special to ignore Catkin related files.

Whether you want to ignore some additional files is then entirely up to you.


Edit: one thing I do tend to add to my .gitignore files is the mongodb created by MoveIt when you run a launch file from your MoveIt config that uses a database. These can become very large (4GB+) and you typically don't version those. Adding a line like default_warehouse_mongo_db/ should fix that.

Edit2: another would be CATKIN_IGNORE files. Just so you can selectively 'hide' packages in your workspace. But with the support for black/white listing packages in catkin_tools, I've not used that too much recently.