Memoteki
Back to articles

ament_cmake_autoでのincludeディレクトリのパスの扱い変更

ROS 2 ament
目次

ament_cmake_autoを使ったROS 2のパッケージをcolcon buildする際に、最近（2.5.4以降）includeディレクトリのパス周りが更新されていることに気づき、その背景と対応について調べたのでまとめます。

rcl/rclcppでのincludeディレクトリのパスの扱い

ROS 2 Humble以降とそれより前ではincludeディレクトリのパスが更新されています。

※変更前後どちらでも include <rclcpp/node.hpp>で使用できます。

Overlaying packages using CMake export targets can fail with merge install underlay · Issue #1150 · ros2/ros2
Bug report Required Info: Operating System: Any Installation type: Any installation that is a merge install (e.g. built with colcon build --merge-install) Version or commit hash: Any version Steps ...
GitHub
Add a Humble release note about the include directory change. by clalancette · Pull Request #3703 · ros2/ros2_documentation
That is, the fallout from ros2/ros2#1150 should be mentioned for people who are using IDEs with Humble. While we are in here, do some minor fixes to the formatting of the release notes. @audrow @sl...
GitHub

before

    /opt/ros/galactic/include/
    ├── rcl
    │   ├── node.h
    ├── rclcpp
    │   ├── node.hpp

after

    /opt/ros/humble/include
    ├── rcl
    │   └── rcl
    │       ├── node.h
    ├── rclcpp
    │   └── rclcpp
    │       ├── node.hpp

このパスの修正によりcolcon build --merge-installなどでmerge installする場合にunderlay/overlayに同名のパッケージがあると衝突してしまう問題を解決できるようになったようです。

ROS 2でヘッダファイルのインストール先が変わったらしい - HansRobo’s blog
※この記事はROS2 - Qiita Advent Calendar 2022 - Qiita，2日目の記事である ※である調で書いてしまったので文章が多少高圧的に感じられるかもしれないがご容赦願いたい ROS 2 Humbleを早々と試している人々の中には既に気付いている方もいらっしゃるかもしれない． そう，ヘッダファイルのインストール先が変わっているのである！！ 嘘だと思うなら下の画像を見て欲
HansRobo’s blog

Humbleリリース時にこの話を聞いたことがあったような気がしますが、そもそもmerge installをしていなかったり、単一ワークスペースのみで使っている場合はあまり影響がなかったので、完全に忘れていました。

ament_cmake_autoでの対応

このincludeディレクトリのパスの変更ですが、実は最近までament_cmake_autoではこのパスの変更が反映されていなかったようでした。 （ament_cmake_autoを使わずにament_cmakeでCMakeLists.txtを書いている場合は新しいincludeディレクトリのパスに変更されています）

反映されていなかった理由については、細かくは確認できていませんが、 ament_cmake_autoがあまり使われておらず影響範囲が少ないのが要因の1つではないかと思います。 ※詳細未調査です。詳しい経緯をご存知の方、是非教えてください。

先日rollingとkiltedについてはデフォルトの挙動を変更する形で反映されました。

Fix headers destination installed by ament_auto_package by HansRobo · Pull Request #540 · ament/ament_cmake
To fix ros2/ros2#1150, many packages that are resigtered in rosdistro, are fixed like ament/ament_index#83. This repository was not fixed at the time because it was not directly involved in install...
GitHub

humbleとjazzyについては、オプションを有効化することで反映できるようになり、有効化していない場合はcolcon build時にメッセージが表示されるようになりました。

In this package, headers install destination is set to include by ament_auto_package. It is recommended to install include/ros2_build_test_package instead and will be the default behavior of ament_auto_package from ROS 2 Kilted Kaiju. On distributions before Kilted, ament_auto_package behaves the same way when you use USE_SCOPED_HEADER_INSTALL_DIR option.

[backport] Fix headers destination installed by ament_auto_package (#540) by HansRobo · Pull Request #574 · ament/ament_cmake
This pull-request backports a bug fix for ament_auto_package to humble branch. #540 changes the header install target, but it shouldn't be destructive since it updating dependencies properly.
GitHub

今後のament_cmake_autoでのCMakeLists.txtの書き方

※ament_cmake_autoを使わずにament_cmakeでCMakeLists.txtを書いている場合は、 影響がないので、特に対応は必要ありません。

Rolling/Kilted

標準で新しいスタイル（include/<package_name>/<package_name> ディレクトリ）にインストールされるようになっています。

Humble/Jazzy

標準ではGalacticと同じスタイルなので、新しいスタイル（include/<package_name>/<package_name> ディレクトリ）にインストールする場合は、ament_auto_packageのUSE_SCOPED_HEADER_INSTALL_DIRオプションを有効化する必要があります。

ament_auto_package(
    USE_SCOPED_HEADER_INSTALL_DIR
    INSTALL_TO_SHARE launch param
)

ただし、このオプションはament_cmake_autoの2.5.4以降（バイナリ版は2025年4月末にリリースされています）でしか対応しておらず、それ以前のバージョンでは colcon build時にエラーとなる可能性があります。

参考

Overlaying packages using CMake export targets can fail with merge install underlay · Issue #1150 · ros2/ros2
Bug report Required Info: Operating System: Any Installation type: Any installation that is a merge install (e.g. built with colcon build --merge-install) Version or commit hash: Any version Steps ...
GitHub
[backport] Fix headers destination installed by ament_auto_package (#540) by HansRobo · Pull Request #574 · ament/ament_cmake
This pull-request backports a bug fix for ament_auto_package to humble branch. #540 changes the header install target, but it shouldn't be destructive since it updating dependencies properly.
GitHub
ROS 2でヘッダファイルのインストール先が変わったらしい - HansRobo’s blog
※この記事はROS2 - Qiita Advent Calendar 2022 - Qiita，2日目の記事である ※である調で書いてしまったので文章が多少高圧的に感じられるかもしれないがご容赦願いたい ROS 2 Humbleを早々と試している人々の中には既に気付いている方もいらっしゃるかもしれない． そう，ヘッダファイルのインストール先が変わっているのである！！ 嘘だと思うなら下の画像を見て欲
HansRobo’s blog
Share — X · Bluesky · はてブ ·

関連記事

miseを使っている環境でClaude CodeのVSCode拡張機能をインストールする
Mini Pupper 2をROS 2 Humbleで動かすまで