David Horstmann
1d181102fe
Reword slightly to be more tentative
...
We don't guarantee ABI stability, but we do try to maintain it where we
can.
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-14 10:50:20 +00:00
David Horstmann
079d7909a1
Add note about MBEDTLS_PRIVATE() in 3.6
...
Note that in the Mbed TLS 3.6 LTS, users can generally rely on being
able to access struct members through the MBEDTLS_PRIVATE() macro, since
we try to maintain ABI stability within an LTS version.
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-13 16:49:08 +00:00
David Horstmann
edebcc04f8
Fix typos in the 3.0 migration guide
...
Signed-off-by: David Horstmann <david.horstmann@arm.com>
2025-03-13 15:52:00 +00:00
Manuel Pégourié-Gonnard
490e30599b
Stop recommended deprecated function in migration guide
...
Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2025-01-23 09:33:59 +01:00
Dave Rodgman
b319684bca
Additional updates to docs links
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-10-12 16:47:08 +01:00
Tom Cosgrove
0b86ac1957
Fix typographical errors in .md files found by cspell
...
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
2022-07-29 13:44:01 +01:00
Werner Lewis
05d5f81c20
Fix spelling and formatting consistency
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-29 09:19:29 +01:00
Werner Lewis
4abd7c2545
Minor phrasing changes
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-27 09:42:34 +01:00
Werner Lewis
129d6adc0e
Use mbedtls-2.28 branch for documentation link
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-27 09:42:34 +01:00
Werner Lewis
4b8aaa4e60
Add clarification on 2.x branch choice
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-27 09:41:54 +01:00
Werner Lewis
f5b86f3b16
Add clarification for 2.x section
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-27 09:20:01 +01:00
Werner Lewis
f8a478795c
Add guidance for generating deprecated list
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-24 11:10:48 +01:00
Werner Lewis
016cec17e8
Add deprecated macros to migration guide
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-23 16:55:52 +01:00
Werner Lewis
745fcde406
Add reference to 2.x docs to migration guide
...
Signed-off-by: Werner Lewis <werner.lewis@arm.com>
2022-06-23 16:51:45 +01:00
Dave Rodgman
017a19997a
Update references to old Github organisation
...
Replace references to ARMmbed organisation with the new
org, Mbed-TLS, following project migration.
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2022-03-31 14:43:16 +01:00
Dave Rodgman
8e5020dead
Remove obsolete reference to _ret in migration guide
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-07-02 12:16:03 +01:00
Dave Rodgman
7b743193b0
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 20:10:10 +01:00
Dave Rodgman
9637bd30a3
Move subsections
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 20:07:57 +01:00
Dave Rodgman
b0e6bb54f9
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 20:03:55 +01:00
Dave Rodgman
26c12eb523
Remove C from code block
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:58:00 +01:00
Dave Rodgman
10963278e7
Mark all code blocks as C
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
a014831732
Add missing backticks
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
7d2ac88f93
Correct hyperlink
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
2482650483
Correct hyperlink
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
2b03457ca5
Improve wording
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
b4d15b1556
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
8128b69ffe
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
715966862d
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
507827e75a
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
68547187f6
Move subsections
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
897a95f46c
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
3f66943bdd
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
2d05e0f440
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
aa1fba2fed
Move subsection
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
7018053460
Reorder subsections
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
28701c63cb
Fix grammatical error
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
ce53b3afd6
Remove reference to removed item
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:13:24 +01:00
Dave Rodgman
9d3417845c
Add backticks where needed
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 19:12:32 +01:00
Dave Rodgman
2e1e623d33
Correct hyperlink syntax
...
Co-authored-by: Tomasz Rodziewicz <40165497+TRodziewicz@users.noreply.github.com>
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 17:58:10 +01:00
Dave Rodgman
6753a775b8
Fix grammatical error
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 17:15:28 +01:00
Dave Rodgman
26ad6c7ea7
Fix typo
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 17:14:01 +01:00
Dave Rodgman
92170cc3e1
Add general cross-reference for low/high-level crypto
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 14:53:23 +01:00
Dave Rodgman
c936bbb15a
Make blank lines before sections consistent
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 14:53:23 +01:00
Dave Rodgman
b1c6b4a7a5
Add cross-reference
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 14:53:16 +01:00
Dave Rodgman
a3758208ae
Move sub-sections to more appropriate places
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 14:17:03 +01:00
Dave Rodgman
4ea5643046
Change some section names
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 14:16:22 +01:00
Dave Rodgman
d462ca1f72
Fix typos
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 11:26:08 +01:00
Dave Rodgman
a54c16805e
Improve wording relating to removal of MBEDTLS_ERR_SSL_BAD_HS_XXX
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 11:11:07 +01:00
Dave Rodgman
a5a3cce49b
Add link between sections
...
Signed-off-by: Dave Rodgman <dave.rodgman@arm.com>
2021-06-30 11:06:58 +01:00
Gilles Peskine
a481052407
Add migration guide and changelog entry for MBEDTLS_PRIVATE
...
We forgot those in #4511 .
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
2021-06-30 11:06:40 +01:00