Skip to content

Commit ed40a93

Browse files
committed
chore: add note to scheme README RE scheme.gen.go
Add a note to scheme/README.md about keeping scheme.gen.go updated, as the automatic make-based solution does not always work. Signed-off-by: Sergei Trofimov <[email protected]>
1 parent 13f2640 commit ed40a93

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

scheme/README.md

+6
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ schemes. Currently the following schemes are implemented:
1212
- `parsec-cca` : Parsec CCA based hardware-backed attestation, details
1313
[here](https://github.com/CCC-Attestation/attested-tls-poc/blob/main/doc/parsec-evidence-cca.md)
1414

15+
> [!NOTE]
16+
> When adding (or removing) a scheme, please update `../builtin/scheme.gen.go`
17+
> to include the appropriate entries. This can be done automatically using
18+
> `../scripts/gen-schemes` script (see `../buildin/Makefile`) or by manually
19+
> editing the file. The script takes a long time to execute, so unless multiple
20+
> schemes are being added/moved/deleted, manual editing may be easier.
1521
1622
## Implementing Attestation Scheme Support
1723

0 commit comments

Comments
 (0)