You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,6 @@ For quick merging, the contribution should be short, and concentrated on a singl
14
14
15
15
All contributions are made under the [Apache License 2.0](LICENSE).
16
16
17
-
1. Fork the [Mbed TLS documentation repository on GitHub](https://github.com/ARMmbed/mbedtls-docs) to start making your changes.
17
+
1. Fork the [Mbed TLS documentation repository on GitHub](https://github.com/Mbed-TLS/mbedtls-docs) to start making your changes.
18
18
1. Ensure that each commit has at least one `Signed-off-by:` line from the committer. If anyone else contributes to the commit, they should also add their own `Signed-off-by:` line. By adding this line, contributor(s) certify that the contribution is made under the terms of the [Developer Certificate of Origin](dco.txt).
19
19
1. Send a pull request (PR) and work with us until it gets merged and published.
Copy file name to clipboardExpand all lines: kb/development/mbedtls-coding-standards.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -236,7 +236,7 @@ Length parameters:
236
236
237
237
## API conventions
238
238
239
-
This section applies fully to classic `mbedtls_xxx()` APIs and mostly to the newer `psa_xxx()` APIs. PSA have their own [conventions described in the PSA Crypto API specification](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html) which take precedence in case of conflicts.
239
+
This section applies fully to classic `mbedtls_xxx()` APIs and mostly to the newer `psa_xxx()` APIs. PSA have their own [conventions described in the PSA Crypto API specification](https://arm-software.github.io/psa-api/crypto/1.1/overview/conventions.html) which take precedence in case of conflicts.
240
240
241
241
### Module contexts
242
242
@@ -258,7 +258,7 @@ Most functions should return `int`, more specifically `0` on success (the operat
258
258
259
259
* Functions that can never fail should either return `void` (such as `mbedtls_cipher_init()`) or directly the information requested (such as `mbedtls_mpi_get_bit()`).
260
260
* Functions that look up some information should return either a pointer to this information or `NULL` if it wasn't found.
261
-
* PSA functions that can fail return a [`psa_status_t` value](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html#return-status).
261
+
* PSA functions that can fail return a [`psa_status_t` value](https://arm-software.github.io/psa-api/crypto/1.1/overview/conventions.html#return-status).
262
262
* Some functions may multiplex the return value, such as `mbedtls_asn1_write_len()` returns the length written on success or a negative error code. This mimics the behavior of some standard functions such as `write()` and `read()`, except there is no equivalent to `errno`: the return code should be specific enough.
263
263
* Some internal functions may return `-1` on errors rather than a specific error code; it is then up to the calling function to pick a more appropriate error code if the error is to be propagated back to the user.
264
264
* Functions whose name clearly indicates a boolean (such as, the name contains "has", "is" or "can") should return `0` for false and `1` for true. The name must be clear: for example, `mbdtls_has_foobar_support()` will return `1` if support for foobar is present; by contrast, `mbedtls_check_foobar_support()` will return `0` if support for foobar is present (success) and `-1` or a more specific error code if not. All functions named `check` must follow this rule and return `0` to indicate acceptable/valid/present/etc. Preference should generally be given to `check` names in order to avoid a mixture of `== 0` and `!= 0` tests.
0 commit comments