More than 1 year has passed since last update.

colcon buildのオプション一覧

Last updated at 2024-01-03Posted at 2024-01-03

colcon buildのオプションをcolcon build --help
の出力をもとにChatGPTで翻訳して整理したもの。

基本的なオプション

--build-base BUILD_BASE
- ビルドディレクトリのベースパスを指定します（デフォルトはbuild）。
- 実行例:
```
colcon build --build-base ./custom_build_dir
```
--install-base INSTALL_BASE
- インストールプレフィックスのベースパスを指定します（デフォルトはinstall）。
- 実行例:
```
colcon build --install-base ./custom_install_dir
```
--merge-install
- すべてのインストールプレフィックスを単一の場所に統合します。
- 実行例:
```
colcon build --merge-install
```
--symlink-install
- 可能な場所でファイルのコピーの代わりにシンボリックリンクを使用します。
- 実行例:
```
colcon build --symlink-install
```
--test-result-base TEST_RESULT_BASE
- テスト結果のベースパスを指定します（デフォルトは--build-base）。
- 実行例:
```
colcon build --test-result-base ./test_results
```
--continue-on-error
- パッケージのビルドが失敗しても、他のパッケージのビルドを続行します（失敗したパッケージに依存するパッケージはスキップされます）。
- 実行例:
```
colcon build --continue-on-error
```

--executor {parallel,sequential}
- すべてのパッケージを処理するための実行方法を指定します（デフォルトはparallel）。
- 実行例:
```
colcon build --executor sequential
```
--parallel-workers NUMBER
- 並列処理するパッケージの最大数を指定します、または'0'で制限なし（デフォルトは20）。
- 実行例:
```
colcon build --parallel-workers 8
```

--event-handlers [name1+ [name2- ...]]
- イベントハンドラを有効（+）または無効（-）にします。
- 実行例:
```
colcon build --event-handlers console_direct+
```

--ignore-user-meta
- ユーザ設定ディレクトリ内の*.metaファイルを無視します。
- 実行例:
```
colcon build --ignore-user-meta
```
--metas [PATH ...]
- colcon.metaファイルが含まれているディレクトリ、または同じメタ情報を含む任意のファイルのパスを指定します。
- 実行例:
```
colcon build --metas ./my_meta_folder
```
--base-paths [PATH ...]
- パッケージを再帰的に探すためのベースパスを指定します。
- 実行例:
```
colcon build --base-paths ./src
```

--packages-ignore [PKG_NAME ...]
- 特定のパッケージを無視します。
- 実行例:
```
colcon build --packages-ignore package_to_ignore
```
--packages-select [PKG_NAME ...]
- 特定のパッケージのみを処理します。
- 実行例:
```
colcon build --packages-select package_to_build
```
--packages-skip [PKG_NAME ...]
- 特定のパッケージをスキップします。
- 実行例:
```
colcon build --packages-skip package_to_skip
```
--packages-up-to [PKG_NAME ...]
- 特定のパッケージとその依存パッケージのみを処理します。
- 実行例:
```
colcon build --packages-up-to package_to_limit
```

--cmake-args [ ...]
- CMakeプロジェクトに引数を渡します。
- 実行例:
```
colcon build --cmake-args -DCUSTOM_OPTION=ON
```
--cmake-clean-cache
- ビルド前にCMakeキャッシュを削除します。
- 実行例:
```
colcon build --cmake-clean-cache
```

--catkin-cmake-args [ ...]
- 'catkin'パッケージに引数を渡します。
- 実行例:
```
colcon build --catkin-cmake-args -DCATKIN_OPTION=ON
```
--catkin-skip-building-tests
- 'colcon test'を後で実行しない場合、'catkin'パッケージの'tests'ターゲットのビルドをスキップします。
- 実行例:
```
colcon build --catkin-skip-building-tests
```