Skip to content

Commit b8a4fbc

Browse files
Czakijoerick
andauthored
Improve information about configuration overriding (#2598)
* Improve information about configuration overriding * remove obsolete " * Update docs/configuration.md Co-authored-by: Joe Rickerby <[email protected]> --------- Co-authored-by: Joe Rickerby <[email protected]>
1 parent 70de033 commit b8a4fbc

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/configuration.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,20 @@ The complete set of defaults for the current version of cibuildwheel are shown b
112112

113113
One feature specific to the configuration files is the ability to override
114114
settings based on selectors. To use, add a ``tool.cibuildwheel.overrides``
115-
array, and specify a ``select`` string. Then any options you set will only
115+
array, and specify a ``select`` string, referencing the [build identifier](options.md#build-skip) (not wheel name!).
116+
Then any options you set will only
116117
apply to items that match that selector. These are applied in order, with later
117118
matches overriding earlier ones if multiple selectors match. Environment
118119
variables always override static configuration.
119120

120121
A few of the options below have special handling in overrides. A different
121122
`before-all` will trigger a new container to launch on Linux, and cannot be
122123
overridden on macOS or Windows. Overriding the image on linux will also
123-
trigger new containers, one per image. Some commands are not supported;
124-
`output-dir`, build/skip/test_skip selectors, and architectures cannot be
125-
overridden.
124+
trigger new containers, one per image.
125+
126+
!!! note "Some commands are not supported"
127+
128+
The ``output-dir``, ``build``, ``skip``, ``test_skip`` selectors, and architectures cannot be overridden.
126129

127130
You can specify a table of overrides in `inherit={}`, any list or table in this
128131
list will inherit from previous overrides or the main configuration. The valid

0 commit comments

Comments
 (0)