Backport 2.28: Update capitalization of "Mbed" and fix bump_version.sh #8194
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
Previously the code only recognized the old spelling "mbed TLS", so it missed doxygen/input/doc_mainpage.h. Signed-off-by: Gilles Peskine <[email protected]>
The official spelling of the trade mark changed from all-lowercase "mbed" to normal proper noun capitalization "Mbed" a few years ago. We've been using the new spelling in new text but still have the old spelling in a lot of text. This commit updates most occurrences of "mbed TLS": ``` sed -i -e 's/mbed TLS/Mbed TLS/g' $(git ls-files ':!ChangeLog' ':!tests/data_files/**' ':!tests/suites/*.data' ':!programs/x509/*' ':!configs/tfm*') ``` Justification for the omissions: * `ChangeLog`: historical text. * `test/data_files/**`, `tests/suites/*.data`, `programs/x509/*`: many occurrences are significant names in certificates and such. Changing the spelling would invalidate many signatures and tests. * `configs/tfm*`: this is an imported file. We'll follow the upstream updates. Signed-off-by: Gilles Peskine <[email protected]>
Signed-off-by: Gilles Peskine <[email protected]>
gilles-peskine-arm
added
needs-review
gilles-peskine-arm
requested review from
tom-cosgrove-arm and
tgonzalezorlandoarm
3 tasks
gilles-peskine-arm
requested review from
daverodgman
and removed request for
tom-cosgrove-arm
daverodgman
reviewed
Sep 12, 2023
| @@ -484,14 +484,14 @@ | |||
| /** | |||
| * \def MBEDTLS_MD2_PROCESS_ALT | |||
| * | |||
| * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you | |||
| * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you | |||
There was a problem hiding this comment.
Suggested change
| * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you | |
| * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use an |
I guess this was originally supposed to be "your", although probably "an" is better?
There was a problem hiding this comment.
There are several "your"s, and while this is a pre-existing typo that would be easy to fix here, it might be better to hold off and have a separate PR to change all the "your"s (and this "you") to be third-person/impersonal
(There's also the use of "alternative" vs "alternate" to be harmonised)
There was a problem hiding this comment.
This is fixing a bug in the release process (we missed one occurrence of the version number due to the capitalization inconsistency), so I'd rather not increase the scope.
daverodgman
approved these changes
Sep 12, 2023
tom-cosgrove-arm
added
approved
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.
Direct backport of #8034.
For the commit ‘Update spelling "mbed TLS" to "Mbed TLS"’, I ran the same script instead of trying to reconcile the patch.
PR checklist
Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")
Notes for the submitter
Please refer to the contributing guidelines, especially the
checklist for PR contributors.