diff --git a/reference/mixin-arguments.rst b/reference/mixin-arguments.rst index 388bb0c..8e12c9b 100644 --- a/reference/mixin-arguments.rst +++ b/reference/mixin-arguments.rst @@ -50,3 +50,5 @@ In all other cases the latter value replaces the former value. But passing these arguments to CMake would result in the latter value of ``CMAKE_C_FLAGS`` overwriting the former even though the user likely wanted both compiler options to be used. + + Furthermore, the option values of a mixin used through the CLI override the default values of a :ref:`default file `. diff --git a/user/configuration.rst b/user/configuration.rst index c44256c..8ca60a1 100644 --- a/user/configuration.rst +++ b/user/configuration.rst @@ -91,10 +91,12 @@ The following are a few examples (see e.g. ``colcon build --help``): The default value for the environment variable ``COLCON_HOME`` is pointing to the directory ``.colcon`` within the users home directory. +.. _configuration_defaults-yaml: + defaults.yaml ------------- -Default files are used to configure ``colcon`` behavior for all packages being operated on. +Default files are used to configure the **default** ``colcon`` behavior for all packages being operated on. Multiple configuration files can be used to modify verb behavior without using the CLI: * If the configuration file ``$COLCON_HOME/defaults.yaml`` exists it is used to customize the default behavior of the CLI. @@ -110,6 +112,10 @@ In the case of more than one nested verbs the key is the names separated by dots To specify configuration options *before* the first verb use an empty string key. The value is another dictionary containing the verb specific configuration. +.. note:: + + When using a :doc:`mixin <../reference/mixin-arguments>` through the CLI, the mixin's option values override default values from a default file. + Verb specific configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~