Merged
Conversation
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
To keep sphinx happy. Signed-off-by: Hannes Reinecke <hare@suse.de>
When configuring with 'meson -Dman=true' sphinx is printing out errors on the generated libnvme.rst file. This patch fixes up the function documentations to fixup these warnings. Signed-off-by: Hannes Reinecke <hare@suse.de>
Regenerate libnvme.rst with 'kernel-doc src/nvme/{filters,ioctl,linux,tree,types,fabrics,util}.h > doc/libnvme.rst'
Signed-off-by: Hannes Reinecke <hare@suse.de>
Collaborator
|
I think we could add a script for regenerating the doc as we have in nvme-cli. And add a check list what to do before a release. I am going to forget it for sure. |
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.
Run kernel-doc over the source files and update comments to keep sphinx happy.