Document the new coding style #69
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Gilles Peskine <[email protected]>
Provide the same amount of information with the same general structure, but adapt the level of detail to what's unusual and what isn't. Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
We're calling the code formatting script code_style, so avoid using the expressions "code style" or "coding style" to mean a different aspect of how the code is written. Signed-off-by: Gilles Peskine <[email protected]>
gilles-peskine-arm
added
needs-review
needs-reviewer
size-s
gilles-peskine-arm
added
the
needs-preceding-pr
mpg
requested changes
Dec 23, 2022
Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
Now that the rule for opening braces isn't a simple "on its own line", discuss the various cases: statements, types, initializers. In particular, for statements, prominently mention the exception for function definitions. Signed-off-by: Gilles Peskine <[email protected]>
mpg
previously approved these changes
Dec 23, 2022
athoelke
reviewed
Dec 23, 2022
| * Inside parentheses: `if (f(sizeof(int), (int) y))` | ||
| * Inside square brackets: `a[i + 1]` | ||
| * Before a comma: `f(x, y)` | ||
| * After a unary operator: `if (!condition)`, `++x` |
There was a problem hiding this comment.
Suggested change
| * After a unary operator: `if (!condition)`, `++x` | |
| * After a prefix unary operator: `if (!condition)`, `++x` |
athoelke
reviewed
Dec 23, 2022
| * Inside square brackets: `a[i + 1]` | ||
| * Before a comma: `f(x, y)` | ||
| * After a unary operator: `if (!condition)`, `++x` | ||
| * Before a unary operator: `x++` |
There was a problem hiding this comment.
Suggested change
| * Before a unary operator: `x++` | |
| * Before a postfix unary operator: `x++` |
athoelke
reviewed
Dec 23, 2022
| mbedtls_write_thing( void *thing, unsigned char *buf, size_t buflen, | ||
| size_t *outlen ); // yes | ||
| mbedtls_write_thing(..., unsigned char *buf, size_t *len); // no | ||
| mbedtls_write_thing(..., unsigned char *buf, size_t buflen, size_t *outlen); // yes | ||
| ``` | ||
|
|
||
| For PSA functions, [input buffers](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html#input-buffer-sizes) have a `size_t xxx_size` parameter after the buffer pointer, and [output buffers](https://armmbed.github.io/mbed-crypto/html/overview/conventions.html#output-buffer-sizes) have a `size_t xxx_size` parameter for the buffer size followed by a `size_t *xxx_length` parameter for the output length. This convention is also preferred in new `mbedtls_xxx` code, but older modules often use different conventions. |
There was a problem hiding this comment.
Can we link to the canonical PSA API pages instead? But maybe that should be a different PR...
The 1.1 specification is at https://arm-software.github.io/psa-api/crypto/1.1/
There was a problem hiding this comment.
any update on having a latest link?
Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
This was referenced Jan 4, 2023
mpg
approved these changes
Jan 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update the coding standards document to the new coding style (including Mbed-TLS/mbedtls#6836).
To be merged at the same time as the new coding style.
Fixes Mbed-TLS/mbedtls#6603.