Merged
Conversation
During Debian packaging lintian complains about the NAME section of the man page which doesn't provide a brief description which is parsed to generate a database for commands such as apropos and whatis. Maybe there are better way to do but this seems to work and produces necessary and sufficient output : diff -baupr old/docs/man/man3/libocxl.h.3 new/docs/man/man3/libocxl.h.3 --- old/docs/man/man3/libocxl.h.3 2018-04-27 10:05:02.718531541 +0200 +++ new/docs/man/man3/libocxl.h.3 2018-04-27 10:29:42.821057863 +0200 @@ -2,7 +2,8 @@ .ad l .nh .SH NAME -libocxl.h +libocxl.h \- library functions to implement userspace drivers for OpenCAPI accelerators + .SH SYNOPSIS .br .PP @@ -231,6 +232,11 @@ libocxl.h .br .RI "Convert endianess and write a 64-bit value to an AFU's MMIO region\&. " .in -1c +.SH "Detailed Description" +.PP +library functions to implement userspace drivers for OpenCAPI accelerators + + .SH "Data Structure Documentation" .PP .SH "struct ocxl_identifier"
deece
approved these changes
Apr 30, 2018
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
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.
During Debian packaging lintian complains about the NAME section of the man
page which doesn't provide a brief description which is parsed to generate a
database for commands such as apropos and whatis.
Maybe there are better way to do but this seems to work and produces necessary
and sufficient output :