Skip to content

Commit

Permalink
Document the colcon mixin repo (#4882)
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Friedman <25047695+Ryanf55@users.noreply.github.com>
(cherry picked from commit 24b1610)
  • Loading branch information
Ryanf55 authored and mergify[bot] committed Dec 2, 2024
1 parent f2685d6 commit 81173b4
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst
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>`__.

0 comments on commit 81173b4

Please sign in to comment.