Skip to content

Commit 1852e22

Browse files
authored
Document colcon_defaults.yaml feature (#89)
1 parent fa2d559 commit 1852e22

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

user/configuration.rst

+9-2
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,16 @@ The following are a few examples (see e.g. ``colcon build --help``):
9494
defaults.yaml
9595
-------------
9696

97-
If the configuration file ``$COLCON_HOME/defaults.yaml`` exists it is used to customize the default behavior of the CLI.
98-
The location can also be modified using the environment variable ``COLCON_DEFAULTS_FILE`` (see ``colcon --help``).
97+
Default files are used to configure ``colcon`` behavior for all packages being operated on.
98+
Multiple configuration files can be used to modify verb behavior without using the CLI:
9999

100+
* If the configuration file ``$COLCON_HOME/defaults.yaml`` exists it is used to customize the default behavior of the CLI.
101+
The location can also be modified using the environment variable ``COLCON_DEFAULTS_FILE`` (see ``colcon --help``).
102+
103+
* If the configuration file ``colcon_defaults.yaml`` exists in a workspace root, it will be used to change the behavior of any invocation of ``colcon`` in that workspace.
104+
The option values specified in the workspace file will always override the global defaults.
105+
106+
Configuration files use standard YAML (or JSON) syntax.
100107
The first level of the configuration file is a dictionary.
101108
The key is the ``verb`` name.
102109
In the case of more than one nested verbs the key is the names separated by dots.

0 commit comments

Comments
 (0)