Document and restructure libnetplan's public API symbols#438
Merged
slyon merged 4 commits intocanonical:mainfrom Jan 29, 2024
Merged
Document and restructure libnetplan's public API symbols#438slyon merged 4 commits intocanonical:mainfrom
slyon merged 4 commits intocanonical:mainfrom
Conversation
slyon
changed the title
slyon
force-pushed
the
api-docs
branch
3 times, most recently
from
a41ac1e to
4bff7e6
Compare
daniloegea
approved these changes
Jan 26, 2024
Contributor
daniloegea
left a comment
daniloegea
left a comment
There was a problem hiding this comment.
Looks good. I just left a few suggestions and notes about typos.
It's not properly implemented and unused.
Moving all the functions related to NetplanNetDefinition into netdef.h - Mostly "netplan_netdef_*" functions - Functions which take NetplanNetDefinition* as their first argument Moving all the functions related to NetplanState into state.h - Mostly "netplan_state_*" functions - Functions which take NetplanState* as their first argument - Iterator functions that work on NetplanState* Leaving include/netplan.h mostly empty, as a bare aggregation of the other headers, so we don't break NetworkManager, which includes <netplan/netplan.h>.
Contributor
Author
|
Thanks, those were some nice finds! I fixed it all as suggested and rebased. Let's get this merged, once CI is green. @rkratky Feel free to still leave your comments in here. If anything, I can fix it in a follow-up PR. |
slyon
force-pushed
the
api-docs
branch
4 times, most recently
from
8354b0a to
1fb01cd
Compare
Contributor
Author
|
The NetworkManager CI is failing again... But it is unrelated to these changes and needs fixing independently in the CI images. |
5 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Please review commit-by-commit.
It's mostly adding Doxygen comments to our public functions.
But also dropping one public symbol from the API (
netplan_generate), which is not properly implemented and still unused, so let's get rid of it until we grow a need for it and can have it implemented the correct way.Finally, I'm moving around the documented declarations into their related header files:
NetplanParser*NetplanState*NetplanNetDefinition*Note
You can ignore the final commit (abi-compat: Update for dropped 'netplan_generate' symbol), which is auto-generated noise to
abi-compat/jammy_1.0.xml.FR-6079
Checklist
make checksuccessfully.make check-coverage).