Skip to content

Commit b2a014f

Browse files
committed
Add UPDATING guide on how to update the example
This example has a few dependencies. Explain how to update each of them.
1 parent f8de46c commit b2a014f

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

UPDATING.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Updating this example's dependencies
2+
3+
When you feel like modifying any of this example's dependencies (Mbed Crypto,
4+
Cryptoauthlib), for example to update the secure element driver interface,
5+
you'll need to make your changes across a handful of different components.
6+
7+
1. Update SE driver interface (and tests) in Mbed Crypto (`mbed-crypto`)
8+
1. Save the changes to a branch in your fork of Mbed Crypto (`mbed-crypto`)
9+
1. Update Mbed OS (`mbed-os`) with your Mbed Crypto fork's SE driver changes
10+
1. Save the changes to a branch in your fork of Mbed OS (`mbed-os`)
11+
1. `cd features/mbedtls/mbed-crypto/importer`
12+
1. Within the `Makefile`, edit `CRYPTO_RELEASE` to point to your branch
13+
1. Within the `Makefile`, edit `CRYPTO_REPO_URL` to point to your fork
14+
1. `make update`; if you have an `mbed-crypto` in a different repo already
15+
checked out, this command can fail. Use `rm -rf
16+
TARGET_IGNORE/mbed-crypto/` and run `make update` again
17+
1. `make all`
18+
1. Commit your changes on a branch in your fork
19+
1. Update the ATECC608A driver for Mbed OS (`mbed-os-atecc608a`) for the
20+
interface changes
21+
1. Save the changes to a branch in your fork of `mbed-os-atecc608a`
22+
1. Update the Mbed OS example for ATECC608A (`mbed-os-example-atecc608a`)
23+
1. For each example subfolder you want to update:
24+
1. Point the `mbed-os.lib` file at the branch in your fork
25+
1. Point the `mbed-os-atecc608a.lib` file at the branch in your fork
26+
1. `mbed deploy`

0 commit comments

Comments
 (0)