ros-infrastructure / catkin_pkg

Standalone Python library for the catkin build system.
https://github.com/ros/catkin
Other
47 stars 89 forks source link

Make filenames to be used as ignore markers configurable #307

Closed janstrohbeck closed 2 years ago

janstrohbeck commented 3 years ago

catkin_pkg ignores packages that include one of {CATKIN_IGNORE, COLCON_IGNORE, AMENT_IGNORE}. For catkin_tools (which utilizes functions from catkin_pkg), I would like to implement a behavior such that it will only ignore packages that include CATKIN_IGNORE (and not those that have COLCON_IGNORE/AMENT_IGNORE). This PR does not change any functionality, it only makes the set of ignore markers configurable via a keyword argument. Link to catkin_tools PR: https://github.com/catkin/catkin_tools/pull/688

nuclearsandwich commented 2 years ago

At first I wasn't too bothered by this PR and I even just pushed up some basic test cases exercising it. But as I was getting ready to approve I started wondering what use cases there are for making this configurable. The inciting case was helpfully described in the accompanying catkin_tools pr which involves using a shared workspace with ROS 1 and ROS 2 packages and I'm not sure that I could ever endorse or recommend sharing a source space with two different build tools like catkin_tools and colcon. Once tests and linters are passing I think I default to accepting this change because it doesn't break anything in the default tooling but I'd like to get other opinions as well.