diff options
| author | Tom Hughes <tomhughes@chromium.org> | 2021-02-25 15:36:45 -0800 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2021-02-26 18:41:38 +0000 |
| commit | 028f15648f2459b89e0287f2ac2718273c122ad8 (patch) | |
| tree | a963b51c4880500d56be256108fda33fcb158d22 /docs | |
| parent | 55d7292a1ccfe85cf20d3dc483cdff4093bdcbae (diff) | |
| download | chrome-ec-028f15648f2459b89e0287f2ac2718273c122ad8.tar.gz | |
docs/fingerprint: Add Chrome OS Project Configuration details
model.yaml files no longer have to be created by hand; instead the
Chrome OS Project Configuration tools will generate it.
BRANCH=none
BUG=b:180410925
TEST=view in gitiles
Signed-off-by: Tom Hughes <tomhughes@chromium.org>
Change-Id: Id7eb218b7b908ed77dec33a2b7479bbf5a72fc4c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2721139
Reviewed-by: Craig Hesling <hesling@chromium.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/fingerprint/fingerprint.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/fingerprint/fingerprint.md b/docs/fingerprint/fingerprint.md index a7aee4f7bf..cfbefa96c4 100644 --- a/docs/fingerprint/fingerprint.md +++ b/docs/fingerprint/fingerprint.md @@ -481,7 +481,16 @@ that should be built as part of the build. See the [`model.yaml` for the Hatch board][hatch model.yaml] as an example. -You can test your changes by +Instead of crafting the `model.yaml` by hand, newer boards are moving to the +[Chrome OS Project Configuration] model, where the config is generated using +[Starlark]. The common [`create_fingerprint`] function can be used across models +to configure the fingerprint settings. See the [Morphius `config.star`] for an +example of how to call `create_fingerprint`. After you modify a `config.star` +file you will need to [regenerate the config]. If you need to change many +projects (e.g., modifying [`create_fingerprint`]), you can use the [`CLFactory`] +tool. + +Once you have updated the config, you can test your changes by [running `cros_config`](#chromeos-config-fingerprint). The Chrome OS Config documentation has a [section on testing properties] that describes this in more detail. @@ -552,3 +561,9 @@ a given device can be found by viewing `chrome://system/#platform_identity_sku`. [Nucleo H743ZI2]: https://www.digikey.com/en/products/detail/stmicroelectronics/NUCLEO-H743ZI2/10130892 [CBI Info]: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/design_docs/cros_board_info.md [Chrome OS Config SKU]: https://chromium.googlesource.com/chromiumos/platform2/+/HEAD/chromeos-config/README.md#identity +[Chrome OS Project Configuration]: https://chromium.googlesource.com/chromiumos/config/+/HEAD/README.md +[Starlark]: https://docs.bazel.build/versions/master/skylark/language.html +[`create_fingerprint`]: https://chromium.googlesource.com/chromiumos/config/+/e1fa0d7f56eb3dd6e9378e4326de086ada46b7d3/util/hw_topology.star#444 +[Morphius `config.star`]: https://chrome-internal.googlesource.com/chromeos/project/zork/morphius/+/593b657a776ed6b320c826916adc9cd845faf709/config.star#85 +[regenerate the config]: https://chromium.googlesource.com/chromiumos/config/+/HEAD/README.md#making-configuration-changes-for-your-project +[`CLFactory`]: https://chromium.googlesource.com/chromiumos/config/+/HEAD/README.md#making-bulk-changes-across-repos |