[PATCH v2] helper: clarify that ODP must be initialized before calling helper functions #2143
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
JereLeppanen
force-pushed
the
dev/helper-clarify-init
branch
from
ae781eb
to
4bf68c9
Compare
odpbuild
changed the title
…nctions Explicitly state that ODP must be initialized before calling helper functions. Document exceptions to this rule individually. This has been the intended interpretation of the helper API all along, so this is only a clarification, not an API change. Signed-off-by: Jere Leppänen <jere.leppanen@nokia.com>
|
Yes, and also all functions in stress.h. But I've allowed here only the functions that we are currently calling before initialization. Another option would be to only allow odph_parse_options(), odph_options() and maybe odph_strcpy(), and fix the rest so that they would be called only after initialization. |
|
Only allowing the two option functions, the copy function (and the log macros so logging errors in option error handling would not become cumbersome?) sounds good to me. Have to discuss this with others. |
MatiasElo
reviewed
Nov 21, 2024
Comment on lines
+19
to
+21
| * ODP must be initialized before calling helper functions, unless stated | ||
| * otherwise. Pre-processor macros may be invoked independently of ODP | ||
| * initialization. |
There was a problem hiding this comment.
As discussed, this same clause could also be added to some helper API header (for example helper/include/odp/helper/odph_api.h).
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.