libnetplan: String helpers for the new API design + filepath transition#275
Merged
Conversation
slyon
approved these changes
May 4, 2022
Contributor
slyon
left a comment
slyon
left a comment
There was a problem hiding this comment.
Thank you very much! LGTM.
I left some minor inline comments that we should fix while rebasing the branch, before we merge it. Very nice handling of the deprecation warning and the python buffer allocation that is automatically increasing in size!
schopin-pro
force-pushed
the
lib-api-string
branch
from
a0ccbb4 to
c4ecb0c
Compare
Codecov Report
@@ Coverage Diff @@
## main #275 +/- ##
==========================================
- Coverage 99.10% 99.04% -0.06%
==========================================
Files 61 61
Lines 11129 10893 -236
==========================================
- Hits 11029 10789 -240
- Misses 100 104 +4
Continue to review full report at Codecov.
|
This allows us to access safer string manipulation functions such as stpncpy (no that's not a type), which are available in the POSIX 2008 standard. This specific function will be useful in implementing the new API pattern of user-provided string buffers. In the newer versions of the POSIX standard, usleep has been deprecated then removed entirely, to be replaced by nanosleep, hence the change in dbus.c.
schopin-pro
force-pushed
the
lib-api-string
branch
from
c4ecb0c to
0c862be
Compare
slyon
reviewed
May 5, 2022
Contributor
|
Thank you very much. LGTM. Feel free to merge it! |
This function copies a NUL-terminated string into a sized buffer using the semantics decided in our API design document, with two small differences: * Except for the NULL case, the output buffer is systematically overwritten. * The return value isn't the last written byte, but the length of the NUL-terminated string *including the first NUL* (i.e. what can be safely memcpy-ed). That's because stpncpy writes NULs up 'til the end of the buffer. Those differences seemed minor enough not to be bothered with reimplementing a string manipulation function from scratch because of them. V2: added documentation on the netplan_copy_string function. V3: fix typo
As discussed, we rename the ambiguous filename field into filepath, as it denotes a full file patch, not the file base name. We introduce a new API for it that conforms to the API design guidelines (that should really be spelled out in the repo :-) ). The older function is kept around for ABI compatibility but moved out of the API, hence the API break warning.
schopin-pro
force-pushed
the
lib-api-string
branch
from
0c862be to
b03ce94
Compare
2 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
3 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
This PR implements some infrastructure to easily implement new APIs according to our guidelines, especially regarding strings.
To demonstrate it, the last commit transition
netdef->filenameintonetdef->filepath, implementing the new getter accordingly.Checklist
make checksuccessfully.make check-coverage).