Commit 057aa3d
committed
Fix bad whatis entry in manpage
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"1 parent 3f78ca5 commit 057aa3d
1 file changed
Lines changed: 5 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
17 | 22 | | |
18 | 23 | | |
19 | 24 | | |
| |||
0 commit comments