check_names: extend typo check to PSA macro/enum names #6558
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
Typos of PSA macro and enum names are not checked by check_names.py. This commit extend the check list to include PSA_XXX references. The words should be macro/enum names defined as public_macros, internal_macros, private_macros and enums. This commit alse extend the scope of enums to include those are defined in library/*.c. A new type of macros "private", which are defined in library/*.c was also added. Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>
This macro is expected to be defined out of the library, and there is no definition in the library. Thus it needs to be excluded from typo check. Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>
Fix the PSA_XXX typos detected by check_names.py. PSA_WANT is actually not typo, but would cause a false negative result. So PSA_WANT is reworded to PSA_WANT_xxx. Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>
lpy4105
added
enhancement
needs-review
The PSA_CRYPTO_C is excluded from typo check for the following
false negative report:
```
> include/mbedtls/check_config.h:329: 'PSA_CRYPTO_C' looks like a typo. It
was not found in any macros or any enums. If this is not a typo, put //no-
check-names after it.
|
329 | * Note: ECJPAKE_C depends on MD_C || PSA_CRYPTO_C. */
| ^^^^^^^^^^^^
```
Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>
gilles-peskine-arm
added
needs-backports
yuhaoth
previously approved these changes
Nov 11, 2022
yuhaoth
added
approved
lpy4105
removed
the
needs-backports
gilles-peskine-arm
added
the
needs-backports
tests/scripts/check_names.py
Outdated
| r"MBEDTLS_TEST_LIBTESTDRIVER*") | ||
| r"MBEDTLS_TEST_LIBTESTDRIVER*|" | ||
| r"PSA_CRYPTO_DRIVER_TEST|" | ||
| r"PSA_CRYPTO_C") |
There was a problem hiding this comment.
PSA_CRYPTO_C is not needed here. There's only one place that uses it in comment in check_config.h and it can be easily fixed.
There was a problem hiding this comment.
I know you are referring to
mbedtls/include/mbedtls/check_config.h
Line 330 in 531a871
I think it might not be a typo. The
MBEDTLS_ prefix is omitted from the macro names not only in PSA_CRYPTO_C, but also in ECJPAKE_C and MD_C. I would like to keep the exclusion here OR add the MBEDTLS_ back for all these three macro names. What's you suggestion?
There was a problem hiding this comment.
Not really a typo, just a decision to shorten the names to keep it compact :)
Compliance-(or typo-)checking scripts should have priority over such simplification in comments, so I would suggest either:
- Only changing
MBEDTLS_PSA_CRYPTO_Cto keep the script happy (it's fine, these are just comments); - Changing all of these to full macro names to be consistent.
AndrzejKurek
suggested changes
Nov 23, 2022
Signed-off-by: Pengyu Lv <pengyu.lv@arm.com>
lpy4105
dismissed stale reviews from yuhaoth and gilles-peskine-arm
via
3bb0e43
AndrzejKurek
approved these changes
Nov 24, 2022
mpg
removed
the
needs-backports
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.
Description
This PR extends typo checks of
check_names.pyto include PSA macro/enum names.Resolve: #6416
Status
READY
Todos
check_names.pyto check typos of PSA macro/enum names