[PATCH v4] api: std: clarify odp_bool_t documentation #2077
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
odpbuild
changed the title
| @@ -22,7 +22,7 @@ extern "C" { | |||
| * @{ | |||
| */ | |||
|
|
|||
| typedef int odp_bool_t; | |||
| typedef bool odp_bool_t; | |||
There was a problem hiding this comment.
This is not only for memory savings but to make the behavior comply with the clarified API when 64 bit values are assigned to an odp_bool (otherwise e.g. unsigned values with the low 32 bits zero (like 0x100000000) would get converted to zero). The commit message could mention this.
There was a problem hiding this comment.
Commit message improved in V2.
|
With a commit message improvement, Reviewed-by: Janne Peltonen janne.peltonen@nokia.com |
odpbuild
changed the title
JannePeltonen
approved these changes
Jul 8, 2024
psavol
approved these changes
Aug 14, 2024
MatiasElo
added
API spec OK
jerinjacobk
approved these changes
Sep 4, 2024
MatiasElo
force-pushed
the
dev/api-bool
branch
from
ecb6ad7
to
400b1cf
Compare
odpbuild
changed the title
MatiasElo
added
API Ready
Match pktio_if_ops_t.promisc_mode_set() argument type (odp_bool_t) to the API function odp_pktio_promisc_mode_set(). Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
Improve odp_bool_t documentation by stating how the data type can by used with standard C booleans and what is considered true/false. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
Change ABI type for odp_bool_t from int to bool to comply with the clarified API documentation. Otherwise for example unsigned values with all zero lowest 32 bits (e.g. 0x100000000) would get converted to zero. The change can also reduce memory usage. Signed-off-by: Matias Elo <matias.elo@nokia.com> Reviewed-by: Janne Peltonen <janne.peltonen@nokia.com> Reviewed-by: Petri Savolainen <petri.savolainen@nokia.com>
MatiasElo
force-pushed
the
dev/api-bool
branch
from
400b1cf
to
479ad77
Compare
odpbuild
changed the title
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.
No description provided.