doc: Correct docstring format to silence warnings #927
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
Several unikraft files have inconsistent docstrings which generate many warnings when building with clang. This change corrects all inconsistencies, silencing the warnings. Signed-off-by: Andrei Tatar <andrei@unikraft.io>
4 tasks
razvand
requested review from
RaduNichita and
StefanJum
and removed request for
a team
razvand
added
area/docs
mschlumpp
approved these changes
Jun 21, 2023
There was a problem hiding this comment.
Thanks for fixing all the documentation comments 🎉
Reviewed-by: Marco Schlumpp marco@unikraft.io
StefanJum
approved these changes
Jun 23, 2023
There was a problem hiding this comment.
Looks good, thanks a lot @andreittr 🚀
Reviewed-by: Stefan Jumarea stefanjumarea02@gmail.com
razvand
approved these changes
Jun 28, 2023
RaduNichita
approved these changes
Jun 28, 2023
There was a problem hiding this comment.
All good also from my side.
Reviewed-by: Radu Nichita radunichita99@gmail.com
rares-miculescu
pushed a commit
to rares-miculescu/unikraft
that referenced
this pull request
Jul 1, 2023
Several unikraft files have inconsistent docstrings which generate many warnings when building with clang. This change corrects all inconsistencies, silencing the warnings. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Marco Schlumpp <marco@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: unikraft#927
rares-miculescu
pushed a commit
to rares-miculescu/unikraft
that referenced
this pull request
Jul 5, 2023
Several unikraft files have inconsistent docstrings which generate many warnings when building with clang. This change corrects all inconsistencies, silencing the warnings. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Marco Schlumpp <marco@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: unikraft#927
i-Pear
pushed a commit
to i-Pear/unikraft
that referenced
this pull request
Jul 31, 2023
Several unikraft files have inconsistent docstrings which generate many warnings when building with clang. This change corrects all inconsistencies, silencing the warnings. Signed-off-by: Andrei Tatar <andrei@unikraft.io> Reviewed-by: Marco Schlumpp <marco@unikraft.io> Reviewed-by: Stefan Jumarea <stefanjumarea02@gmail.com> Approved-by: Razvan Deaconescu <razvand@unikraft.io> Tested-by: Unikraft CI <monkey@unikraft.io> GitHub-Closes: unikraft#927
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.
Description of changes
Several unikraft files have inconsistent docstrings which generate many warnings when building with clang.
This change corrects all inconsistencies, silencing the warnings.
This PR contains only changes in comments. No actual compilable code was changed.
Tested with a mostly "everything + the kitchen sink" Kconfig of base unikraft (no external libs); no doc warnings remain.
Prerequisite checklist
checkpatch.ukon your commit series before opening this PR;Base target
Additional configuration
You may need to clear your compiler cache (
ccache -C) on systems where by default it interposes on your compiler (e.g. Fedora) in order to see the effect. Apparently ccache compares sources after preprocessing.