-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add instructions how to map argument of other build tools to colcon
- Loading branch information
1 parent
33ff4e8
commit b8f52b0
Showing
6 changed files
with
196 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
ament_tools | ||
=========== | ||
|
||
The following describes the mapping of some ``ament_tools`` options and arguments to the ``colcon`` command line interface. | ||
|
||
ament build | test | ||
------------------ | ||
|
||
``[BASEPATH]`` | ||
``--base-paths BASEPATH`` | ||
|
||
``--build-space PATH`` | ||
``--build-base PATH`` | ||
|
||
``--install-space PATH`` | ||
``--install-base PATH`` | ||
|
||
``--build-tests`` | ||
``--cmake-args \ -DBUILD_TESTING=1`` | ||
|
||
``-s``, ``--symlink-install`` | ||
``--symlink-install`` | ||
|
||
``--isolated`` | ||
The colcon option ``--merge-install`` has the inverse logic. | ||
|
||
``--start-with PKGNAME`` | ||
``--package-start PKGNAME`` | ||
|
||
``--end-with PKGNAME`` | ||
``--package-end PKGNAME`` | ||
|
||
``--only-packages PKGNAME1 ... PKGNAMEn`` | ||
``--package-whitelist PKGNAME1 ... PKGNAMEn`` | ||
|
||
``--skip-packages PKGNAME1 ... PKGNAMEn`` | ||
``--package-blacklist PKGNAME1 ... PKGNAMEn`` | ||
|
||
``--parallel`` | ||
colcon uses the parallel execution by default. | ||
To build packages sequentially use ``--executor sequential``. | ||
|
||
ament build | ||
----------- | ||
|
||
``colcon build ...`` | ||
|
||
``--cmake-args -D... --`` | ||
``--cmake-args \ -D...``, ``--cmake-args " -D..."`` | ||
Any CMake arguments which start with a dash need to be prefixed with a space. | ||
This can either be done using an escaped space or by quoting the argument with a leading space. | ||
The closing double dash is not necessary anymore. | ||
|
||
``--force-cmake-configure`` | ||
``--cmake-force-configure`` | ||
|
||
``--use-ninja`` | ||
``--cmake-args \ -G Ninja`` | ||
|
||
ament test | ||
---------- | ||
|
||
``colcon test ...`` | ||
|
||
``--ctest-args ... --`` | ||
``--ctest-args ...`` | ||
Any CTest arguments which start with a dash need to be prefixed with a space (see ``--cmake-args``). | ||
|
||
``--retest-until-fail N`` | ||
``--retest-until-fail N`` | ||
|
||
``--retest-until-pass N`` | ||
``--retest-until-pass N`` | ||
|
||
``--abort-on-test-error`` | ||
``--abort-on-error`` | ||
|
||
ament test_results | ||
------------------ | ||
|
||
``colcon test-result ...`` | ||
|
||
``[BASEPATH]`` | ||
``--build-base BASEPATH`` | ||
|
||
``--verbose`` | ||
``--all`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
catkin_make_isolated | ||
==================== | ||
|
||
The following describes the mapping of some ``catkin_make_isolated`` options and arguments to the ``colcon`` command line interface. | ||
|
||
``--source PATH`` | ||
``--base-paths BASEPATH`` | ||
|
||
``--build PATH`` | ||
``--build-base PATH`` | ||
|
||
``--devel PATH`` | ||
colcon doesn't support the concept of a "devel" space. | ||
Instead you can choose the path of the devel space as the install base and perform an normal installation. | ||
|
||
``--install-space PATH`` | ||
``--install-base PATH`` | ||
|
||
``--merge`` | ||
``--merge-install`` | ||
|
||
``--use-ninja`` | ||
``--cmake-args \ -G Ninja`` | ||
|
||
``--use-nmake`` | ||
``--cmake-args \ -G "NMake Makefiles"`` | ||
|
||
``--install`` | ||
colcon always performs an installation. | ||
It doesn't support the concept of a "devel" space. | ||
|
||
``--cmake-args ...`` | ||
``--cmake-args \ -D...``, ``--cmake-args " -D..."`` | ||
Any CMake arguments which start with a dash need to be prefixed with a space. | ||
This can either be done using an escaped space or by quoting the argument with a leading space. | ||
The closing double dash is not necessary anymore. | ||
|
||
``--force-cmake`` | ||
``--cmake-force-configure`` | ||
|
||
``--pkg PKGNAME1 ... PKGNAMEn`` | ||
``--package-whitelist PKGNAME1 ... PKGNAMEn`` | ||
|
||
``--from-pkg PKGNAME`` | ||
``--package-start PKGNAME`` | ||
|
||
``--only-pkg-with-deps PKGNAME1 ... PKGNAMEn`` | ||
``--packages-up-to PKGNAME1 ... PKGNAMEn`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
catkin_tools | ||
============ | ||
|
||
The following describes the mapping of some ``catkin_tools`` options and arguments to the ``colcon`` command line interface. | ||
|
||
catkin build | ||
------------ | ||
|
||
``[PKGNAME1 ... PKGNAMEn]`` | ||
``--packages-up-to PKGNAME1 ... PKGNAMEn`` | ||
|
||
``--no-deps`` | ||
``--package-whitelist PKGNAME1 ... PKGNAMEn`` | ||
|
||
``--start-with PKGNAME`` | ||
``--package-start PKGNAME`` | ||
|
||
``--force-cmake`` | ||
``--cmake-force-configure`` | ||
|
||
``--cmake-args ... --`` | ||
``--cmake-args \ -D...``, ``--cmake-args " -D..."`` | ||
Any CMake arguments which start with a dash need to be prefixed with a space. | ||
This can either be done using an escaped space or by quoting the argument with a leading space. | ||
The closing double dash is not necessary anymore. | ||
|
||
``-v``, ``--verbose`` | ||
``--event-handler console_cohesion+`` | ||
|
||
``-i``, ``--interleave-output`` | ||
``--event-handler console_direct+`` | ||
|
||
``--no-status`` | ||
``--event-handler status-`` | ||
|
||
``--no-summarize``, ``--no-summary`` | ||
``--event-handler summary-`` | ||
|
||
``--no-notify`` | ||
``--event-handler desktop_notification-`` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
ament | ||
args | ||
cmake | ||
CMake | ||
colcon | ||
CTest | ||
devel | ||
macOS | ||
metadata | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters