Skip to content

Fix bad whatis entry in manpage#3

Merged
deece merged 1 commit intoOpenCAPI:masterfrom
frediz:master
Apr 30, 2018
Merged

Fix bad whatis entry in manpage#3
deece merged 1 commit intoOpenCAPI:masterfrom
frediz:master

Conversation

@frediz
Copy link
Copy Markdown
Contributor

@frediz frediz commented Apr 27, 2018

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/ new/docs/man/
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"

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 deece merged commit c93c4b7 into OpenCAPI:master Apr 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants