Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the colcon mixin repo (backport #4882) #4883

Merged
merged 1 commit into from
Dec 2, 2024
Merged

Document the colcon mixin repo (backport #4882) #4883

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,3 +349,31 @@ Tips
.. code-block:: bash

colcon test --packages-select YOUR_PKG_NAME --ctest-args -R YOUR_TEST_IN_PKG

Setup ``colcon`` mixins
-----------------------

Various command line options are tedious to write and/or difficult to remember.

For example, to change the CMake build type to debug, you normally use:

.. code-block:: console

colcon build --cmake-args -DCMAKE_BUILD_TYPE=Debug

To make common command line options easier to invoke this repository makes these "shortcuts" available.

To install the default colcon mixins, run the following:

.. code-block:: console

colcon mixin add default https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml
colcon mixin update default

Then, try out using the ``debug`` mixin:

.. code-block:: console

colcon build --mixin debug

For more details, see the `colcon mixin repository <https://github.com/colcon/colcon-mixin-repository>`__.