diff options
| author | Tristan Honscheid <honscheid@google.com> | 2023-04-14 11:53:51 -0600 |
|---|---|---|
| committer | Chromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-04-15 00:41:59 +0000 |
| commit | 776e4fc49f9b1f4c65fff7bc5494c487c0ecba42 (patch) | |
| tree | 9ae7b3e18ad802b98923862186ca597cbaa73e9f /docs/zephyr | |
| parent | 69a9a9ff9abf61a7bc082eec80eca7fb2d12eb73 (diff) | |
| download | chrome-ec-776e4fc49f9b1f4c65fff7bc5494c487c0ecba42.tar.gz | |
docs: Update docs on testcase.yaml to use new fields for conf files
Update our documentation to highlight the use of the new
`extra_conf_files`, `extra_overlay_confs`, and `extra_dtc_overlay_files`
YAML fields instead of specifying these in CMake variables in
`extra_args` in `testcase.yaml` files.
These new fields are more readable and were introduced in upstream
Zephyr earlier this year. The plan is to eventually deprecate the
ability to specify confs and overlays through extra_args upstream
following a migration.
BUG=None
BRANCH=None
TEST=None
Change-Id: I3db0b0dcbb24a8dc1f6e38214d7538e6dca50dfb
Signed-off-by: Tristan Honscheid <honscheid@google.com>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/4428296
Reviewed-by: Yuval Peress <peress@google.com>
Commit-Queue: Yuval Peress <peress@google.com>
Diffstat (limited to 'docs/zephyr')
| -rw-r--r-- | docs/zephyr/ztest.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/zephyr/ztest.md b/docs/zephyr/ztest.md index b5f40821fc..dc5f1bea3e 100644 --- a/docs/zephyr/ztest.md +++ b/docs/zephyr/ztest.md @@ -54,10 +54,18 @@ test cases, but the attributes are applied to all test cases in the file. See for more details. Some common attributes include: -- `extra_configs` which is a list of Kconfigs to add to the test. -- `extra_args` which is a string containing additional arguments to pass to - CMake - +- `extra_configs` - a list of Kconfigs to add to the test. +- `extra_conf_files` - specifies a YAML list of additional Kconfig files to + to apply to the build. Replaces the `CONF_FILE` field in extra_args. +- `extra_overlay_confs` - specifies a list of overlay Kconfig files. Replaces + the `OVERLAY_CONFIG` field in extra_args. +- `extra_dtc_overlay_files` - specifies a list of additional device tree files + to apply to the build. Replaces the `DTC_OVERLAY_FILE` field in extra_args. + +`extra_args` is a string field that allows injecting free-form CMake variables +into the build. It is rarely needed and the practice of specifying `CONF_FILE`, +`OVERLAY_CONFIG`, or `DTC_OVERLAY_FILE` here is deprecated. Please use the +above fields for these functions, as they are much more readable. ## Integration tests Integration tests build the full EC. They require devicetree and all Kconfigs to |