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.

Sign up for GitHub

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

Jump to bottom

[PATCH v6] helper: clarify that ODP must be initialized before calling helper functions #2143

Merged
merged 1 commit into from
Dec 20, 2024
Merged

[PATCH v6] helper: clarify that ODP must be initialized before calling helper functions #2143

merged 1 commit into from
Dec 20, 2024

Conversation

JereLeppanen
Copy link
Collaborator

No description provided.

@odpbuild odpbuild changed the title helper: clarify that ODP must be initialized before calling helper functions [PATCH v1] helper: clarify that ODP must be initialized before calling helper functions Nov 8, 2024
@JereLeppanen JereLeppanen force-pushed the dev/helper-clarify-init branch from ae781eb to 4bf68c9 Compare November 8, 2024 15:23
@odpbuild odpbuild changed the title [PATCH v1] helper: clarify that ODP must be initialized before calling helper functions [PATCH v2] helper: clarify that ODP must be initialized before calling helper functions Nov 8, 2024
@TuomasTaipale TuomasTaipale mentioned this pull request Nov 12, 2024
Merged
TuomasTaipale
TuomasTaipale reviewed Nov 12, 2024
View reviewed changes
Copy link
Collaborator

@TuomasTaipale TuomasTaipale left a comment

Choose a reason for hiding this comment

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

I guess technically we could also allow odph_ipsec_auth_icv_len_default().

@JereLeppanen
Copy link
Collaborator Author

JereLeppanen commented Nov 13, 2024 •
edited
Loading

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.

@TuomasTaipale
Copy link
Collaborator

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 MatiasElo added this to the v1.46.0.0 release milestone Nov 26, 2024
@MatiasElo MatiasElo added the API next API change for next release label Nov 26, 2024
@JereLeppanen JereLeppanen force-pushed the dev/helper-clarify-init branch from 4bf68c9 to e543a75 Compare December 12, 2024 16:17
@odpbuild odpbuild changed the title [PATCH v2] helper: clarify that ODP must be initialized before calling helper functions [PATCH v3] helper: clarify that ODP must be initialized before calling helper functions Dec 12, 2024
@JereLeppanen JereLeppanen force-pushed the dev/helper-clarify-init branch from e543a75 to b25e2cd Compare December 17, 2024 10:20
@odpbuild odpbuild changed the title [PATCH v3] helper: clarify that ODP must be initialized before calling helper functions [PATCH v4] helper: clarify that ODP must be initialized before calling helper functions Dec 17, 2024
@JereLeppanen
Copy link
Collaborator Author

v4:

  • Rebase.
  • Add review tags.

@JereLeppanen JereLeppanen force-pushed the dev/helper-clarify-init branch from b25e2cd to a66ca94 Compare December 20, 2024 08:07
@odpbuild odpbuild changed the title [PATCH v4] helper: clarify that ODP must be initialized before calling helper functions [PATCH v5] helper: clarify that ODP must be initialized before calling helper functions Dec 20, 2024
@JereLeppanen
Copy link
Collaborator Author

v5:

  • Rebase.
  • Add review tag (Petri).

@MatiasElo MatiasElo added the API Ready API change ready to be merged (with the next API version increment) label Dec 20, 2024
@JereLeppanen @MatiasElo
helper: clarify that ODP must be initialized before calling helper fu…
098d4c4 
…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 <[email protected]>
Reviewed-by: Matias Elo <[email protected]>
Reviewed-by: Tuomas Taipale <[email protected]>
Reviewed-by: Petri Savolainen <[email protected]>
@MatiasElo MatiasElo force-pushed the dev/helper-clarify-init branch from a66ca94 to 098d4c4 Compare December 20, 2024 08:33
@odpbuild odpbuild changed the title [PATCH v5] helper: clarify that ODP must be initialized before calling helper functions [PATCH v6] helper: clarify that ODP must be initialized before calling helper functions Dec 20, 2024
@MatiasElo MatiasElo enabled auto-merge (rebase) December 20, 2024 08:33
@MatiasElo MatiasElo merged commit 9f4cd32 into OpenDataPlane:master Dec 20, 2024
160 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TuomasTaipale TuomasTaipale TuomasTaipale approved these changes

@psavol psavol psavol approved these changes

@MatiasElo MatiasElo MatiasElo approved these changes

Assignees
No one assigned
Labels
API next API change for next release API Ready API change ready to be merged (with the next API version increment)
Projects
None yet
Milestone
v1.46.0.0 release
Development

Successfully merging this pull request may close these issues.
4 participants
@JereLeppanen @TuomasTaipale @MatiasElo @psavol