| ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange |
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 ?
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.
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.
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.
Asked: 2017-02-16 04:33:41 -0500
Seen: 1,045 times
Last updated: Feb 16 '17
ROS Answers is licensed under Creative Commons Attribution 3.0 Content on this site is licensed under a Creative Commons Attribution Share Alike 3.0 license.
