Skip to content

Commit c5490cf

Browse files
committed
🪲 Fixed #1008 by documenting new feature in BreakingChanges and removing references to removed features.
1 parent f565aa2 commit c5490cf

File tree

4 files changed

+10
-9
lines changed

4 files changed

+10
-9
lines changed

docs/BreakingChanges.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,16 @@ In addition, a previously undocumented feature for merging a second configuratio
181181

182182
Thorough documentation on Mixins and the new options for loading a project configuration can be found in _[CeedlingPacket](CeedlingPacket.md))_.
183183

184+
## Replaced `options:` files, environment project specifications, and nested project files with comprehensive `mixins` feature
185+
186+
The following features have all been removed from Ceedling's functionality. No need to worry, though. The new `mixins` feature can handle all the situations these features previously supported, and much more. Check out the [documentation](CeedlingPacket.md) for more detail.
187+
188+
- `options:blah.yml` command-line options (see `--mixin` command line option)
189+
- The corresponding `options_paths:` key in the project.yml file no longer has any effect. (see `:mixins:` ➡️ `:load_paths:` project.yml specification)
190+
- The `project.yml` file now specifies other yaml files to load using the `:mixins:` ➡️ `:enabled:` section
191+
- `CEEDLING_PROJECT_FILE` environment variable (see `CEEDLING_MIXIN_#` specification)
192+
- `CEEDLING_SER_FILE` environment variable (see `CEEDLING_MIXIN_#` specification)
193+
184194
## Tool definition inline Ruby evaluation replacement removed (inline Ruby string expansion remains)
185195

186196
Reaching back to the earliest days of Ceedling, tool definitions supported two slightly different string replacement options that executed at different points in a build’s lifetime. Yeah. It was maybe not great.

docs/CeedlingPacket.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3010,9 +3010,6 @@ and migrated to the `:test_build` and `:release_build` sections.
30103010
:build_root: project_awesome/build
30113011
:use_exceptions: FALSE
30123012
:use_test_preprocessor: :all
3013-
:options_paths:
3014-
- project/options
3015-
- external/shared/options
30163013
:release_build: TRUE
30173014
:compile_threads: :auto
30183015
```

plugins/dependencies/example/boss/project.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@
2727
:test_threads: 8
2828
:compile_threads: 8
2929

30-
# you can specify different yaml config files which modify the existing one
31-
:options_paths: []
32-
3330
# enable release build (more details in release_build section below)
3431
:release_build: TRUE
3532

plugins/dependencies/example/supervisor/project.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@
2727
:test_threads: 8
2828
:compile_threads: 8
2929

30-
# you can specify different yaml config files which modify the existing one
31-
:options_paths: []
32-
3330
# enable release build (more details in release_build section below)
3431
:release_build: TRUE
3532

0 commit comments

Comments
 (0)