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

Warn about mixin overriding default values #106

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Warn about mixin overriding default values #106

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions reference/mixin-arguments.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <configuration_defaults-yaml>`.
8 changes: 7 additions & 1 deletion user/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down