Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename common.h to mbedtls_common.h #67

Open
wants to merge 1 commit into
base: zephyr
Choose a base branch
from

Conversation

frkv
Copy link
Collaborator

@frkv frkv commented Jan 22, 2025

Note: This change will be proposed upstream in Mbed TLS with the hope that this commit is can be reverted

Description

-Changing all instances of #include "common.h" to
#include "mbedtls_common.h" to prevent collitions
-Changing the name of common.h to mbedtls_common.h -Mbed TLS uses the file name "common.h" for common
settings relevant for build. Unfortunately common.h
is not guarded with any folder-structure as this
is an internal file that is present in the folder
where source-files resides. Due to the way that
zephyr adds include-folders it will be difficult to
prevent someone coming up with the same name and
adding the include-folder earlier than Mbed TLS.

PR checklist

Please tick as appropriate and edit the reasons (e.g.: "backport: not needed because this is a new feature")

  • changelog provided, or not required
  • 3.6 backport done, or not required
  • 2.28 backport done, or not required
  • tests provided, or not required

Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant!
(Note: There are still a few hits for common.h in comments which will need to be changed as well to submit that upstream.)

@Vge0rge Vge0rge self-requested a review January 22, 2025 11:29
@frkv frkv force-pushed the mbedtls_common branch 2 times, most recently from 8cba4fe to fcf3eac Compare January 22, 2025 12:51
-Changing all instances of #include "common.h" to
 #include "mbedcrypto_common.h" to prevent collitions
-Changing the name of common.h to mbedcrypto_common.h
-Mbed TLS uses the file name "common.h" for common
 settings relevant for build. Unfortunately common.h
 is not guarded with any folder-structure as this
 is an internal file that is present in the folder
 where source-files resides. Due to the way that
 zephyr adds include-folders it will be difficult to
 prevent someone coming up with the same name and
 adding the include-folder earlier than Mbed TLS.

Note: This change will be proposed upstream in Mbed TLS
with the hope that this commit is can be reverted

Signed-off-by: Frank Audun Kvamtrø <[email protected]>
Copy link
Collaborator

@tomi-font tomi-font left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idea abandoned

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants