Skip to content

Commit 05e4856

Browse files
Add migration guide directory
Signed-off-by: Gilles Peskine <[email protected]>
1 parent e08cefe commit 05e4856

File tree

1 file changed

+22
-0
lines changed
  • docs/4.0-migration-guide

1 file changed

+22
-0
lines changed

docs/4.0-migration-guide/README

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
This directory contains sections intended for the migration guide
2+
from Mbed TLS 3.6 to TF-PSA-Crypto 1.0 + Mbed TLS 4.0.
3+
4+
The files in this document should be markdown files with the .md
5+
extension. They should generally contain level-2 sections (## title).
6+
The files will be consolidated into a single cohesive document or
7+
document set shortly before the .0 releases.
8+
9+
The reason to have multiple files is that each strand of work can create
10+
one file, without worrying about where to fit in the document structure.
11+
We'll worry about the general structure once we have the content.
12+
Furthermore, placing different strands of work in separate files will
13+
avoid merge conflicts (as would happen e.g. if parallel strands of
14+
work append to the same file in concurrent pull requests).
15+
16+
Files can be placed in the docs/4.0-migration-guide indifferently in
17+
mbedtls or TF-PSA-Crypto, as convenient.
18+
19+
Documentation that is specifically about migrating from the legacy
20+
crypto API to the PSA crypto API should be added to the existing
21+
docs/psa-transition.md instead.
22+

0 commit comments

Comments
 (0)