ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | Q&A
Ask Your Question

What does CATKIN_IGNORE file does in build folder in catkin_ws ?

asked 2017-02-16 04:33:41 -0500

a443 gravatar image

Hi, While the ROS tutorials page on catkin_workspace, I came across the CATKIN_IGNORE file present in the build folder contain in the catkin_ws. I want to know what does the CATKIN_IGNORE file do ?


edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2017-02-16 04:52:15 -0500

gvdhoorn gravatar image

CATKIN_IGNORE is a bit underdocumented, but the tutorial you link actually seems to contain the answer to your question:

CATKIN_IGNORE         -- Keeps catkin from walking this directory

In other words: a CATKIN_IGNORE file in the build directory makes Catkin (ie: catkin_make, catkin_make_isolated, but also catkin from catkin_tools) ignore that specific directory.

This works for other directories as well.

Related REP: REP-128: Naming Conventions for Catkin Based Workspaces.

Related ROS Answers question: #q208180.

edit flag offensive delete link more


Thanks gvdhoorn

a443 gravatar image a443  ( 2017-02-16 05:36:10 -0500 )edit

REP-128 shows this file in a workspace build/ dir (and with multiple pkgs shown in workspace_folder/src I took it to imply a meta-package or even ~/catkin_ws itself). I only got it to work in the top level of the package. In that sense, I found the existing documentation confusing.

jwhendy gravatar image jwhendy  ( 2017-07-07 12:35:20 -0500 )edit

This answer resolved my confusion on what to do after trying a bunch of incantations of it in a catkin_ws/src/pkg/build location. Ultimately I just used ~/catkin_ws/src/pkg/CATKIN_IGNORE successfully.

jwhendy gravatar image jwhendy  ( 2017-07-07 12:37:26 -0500 )edit

As I wrote: CATKIN_IGNORE is rather underdocumented. But from your issue on catkin_pkg I'm guessing this is sort-of resolved now.

gvdhoorn gravatar image gvdhoorn  ( 2017-07-07 16:51:01 -0500 )edit

The question & answer you link to are the same as I linked to as being 'related'?

gvdhoorn gravatar image gvdhoorn  ( 2017-07-07 16:51:43 -0500 )edit

Your Answer

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

Add Answer

Question Tools

1 follower


Asked: 2017-02-16 04:33:41 -0500

Seen: 933 times

Last updated: Feb 16 '17