Skip to content

Commit 24b1610

Browse files
authored
Document the colcon mixin repo (#4882)
Signed-off-by: Ryan Friedman <[email protected]>
1 parent 5358b59 commit 24b1610

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

source/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,3 +349,31 @@ Tips
349349
.. code-block:: bash
350350
351351
colcon test --packages-select YOUR_PKG_NAME --ctest-args -R YOUR_TEST_IN_PKG
352+
353+
Setup ``colcon`` mixins
354+
-----------------------
355+
356+
Various command line options are tedious to write and/or difficult to remember.
357+
358+
For example, to change the CMake build type to debug, you normally use:
359+
360+
.. code-block:: console
361+
362+
colcon build --cmake-args -DCMAKE_BUILD_TYPE=Debug
363+
364+
To make common command line options easier to invoke this repository makes these "shortcuts" available.
365+
366+
To install the default colcon mixins, run the following:
367+
368+
.. code-block:: console
369+
370+
colcon mixin add default https://raw.githubusercontent.com/colcon/colcon-mixin-repository/master/index.yaml
371+
colcon mixin update default
372+
373+
Then, try out using the ``debug`` mixin:
374+
375+
.. code-block:: console
376+
377+
colcon build --mixin debug
378+
379+
For more details, see the `colcon mixin repository <https://github.com/colcon/colcon-mixin-repository>`__.

0 commit comments

Comments
 (0)