doc: coding guidelines: Add a new rule for macro name collisions #51963
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
carlescufi
requested review from
MaureenHelm,
stephanosio,
gmarull,
dleach02 and
galak
de-nordic
previously approved these changes
Nov 4, 2022
stephanosio
reviewed
Nov 4, 2022
cfriedt
previously requested changes
Nov 4, 2022
henrikbrixandersen
previously approved these changes
Nov 5, 2022
carlescufi
dismissed stale reviews from henrikbrixandersen and de-nordic
via
e425ace
carlescufi
force-pushed
the
common-macros
branch
from
2881112 to
d3d7c1c
Compare
carlescufi
requested review from
stephanosio,
de-nordic and
henrikbrixandersen
stephanosio
previously approved these changes
Nov 7, 2022
de-nordic
previously approved these changes
Nov 8, 2022
gmarull
previously approved these changes
Nov 8, 2022
cfriedt
dismissed
their stale review
It's not really of huge personal interest
tbursztyka
previously approved these changes
Nov 14, 2022
|
@carlescufi Shall we merge this now that nobody objects to it ? |
nashif
added
TSC
jhedberg
previously approved these changes
Nov 21, 2022
carlescufi
requested review from
nashif,
gmarull,
mbolivar-nordic,
sjg20 and
henrikbrixandersen
henrikbrixandersen
approved these changes
Feb 20, 2023
gmarull
approved these changes
Feb 20, 2023
stephanosio
approved these changes
Feb 20, 2023
mbolivar-nordic
approved these changes
Feb 20, 2023
de-nordic
approved these changes
Feb 21, 2023
fabiobaltieri
approved these changes
Feb 21, 2023
MaureenHelm
approved these changes
Feb 21, 2023
jfischer-no
approved these changes
Feb 21, 2023
LingaoM
approved these changes
Feb 21, 2023
|
Needs final ACK in the TSC today before merging |
|
motion passed at TSC |
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 6, 2023
We've been guarding the definition of MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 6, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 11, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 11, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 11, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 11, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 11, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 12, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
added a commit
to teslabs/zephyr
that referenced
this pull request
Apr 14, 2023
We've been guarding the definition of BIT/MIN/MAX/CLAMP macros as they are commonly found in other projects. This is dangerous, because depending on the order of includes, Zephyr code could end up using macros defined by other projects (e.g. via HALs). The current #ifndef _protection_ goes against the recently established guidelines in zephyrproject-rtos#51963, so let's remove it. Ref. https://docs.zephyrproject.org/latest/contribute/coding_guidelines/ index.html#rule-a-3-macro-name-collisions Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
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.
This commit is the outcome of the discussion that has taken place in multiple forums:
Discord:
https://discord.com/channels/720317445772017664/1014241011989487716/1032623375228608522
GitHub:
#51371 #50239
Signed-off-by: Carles Cufi carles.cufi@nordicsemi.no