View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0009021 | libmicrohttpd | documentation | public | 2024-07-24 16:03 | 2024-07-31 12:57 |
| Reporter | fernst | Assigned To | Karlson2k | ||
| Priority | low | Severity | text | Reproducibility | always |
| Status | resolved | Resolution | fixed | ||
| Product Version | 1.0.0 | ||||
| Summary | 0009021: manpage mdoc warning: .Lb: no description for library 'libmicrohttpd' available (#8) | ||||
| Description | The file "doc/libmicrohttpd.3" seems to be missing a library description, leading to a mdoc warning. However, such a description could easily be added, see below. | ||||
| Steps To Reproduce | $ man --version man 2.11.2 $ git clone https://git.gnunet.org/libmicrohttpd.git [...] $ cd libmicrohttpd/ $ LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z doc/libmicrohttpd.3 >/dev/null mdoc warning: .Lb: no description for library 'libmicrohttpd' available (#8) $ | ||||
| Additional Information | The current manpage thus reads $ LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -Tutf8 doc/libmicrohttpd.3 | head -n 7 mdoc warning: .Lb: no description for library 'libmicrohttpd' available (#8) LIBMICROHTTPD(3) BSD Library Functions Manual LIBMICROHTTPD(3) NAME libmicrohttpd — library for embedding HTTP servers LIBRARY library “libmicrohttpd” $ Whereas with the attached patch introducing a (rather redundant) description the warning would be gone: $ LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -Tutf8 doc/libmicrohttpd.3 | head -n 7 LIBMICROHTTPD(3) BSD Library Functions Manual LIBMICROHTTPD(3) NAME libmicrohttpd — library for embedding HTTP servers LIBRARY library for embedding HTTP servers (libmicrohttpd) $ LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z doc/libmicrohttpd.3 >/dev/null $ Yes, I know that Info documentation exists and is preferred. Still, this warning could easily be fixed, cf. the attached patch. | ||||
| Tags | patch | ||||
| Attached Files | manpage_add_library_description.patch (359 bytes)
diff --git a/doc/libmicrohttpd.3 b/doc/libmicrohttpd.3 index cfa0762b..a50d4061 100644 --- a/doc/libmicrohttpd.3 +++ b/doc/libmicrohttpd.3 @@ -5,6 +5,7 @@ .Nm libmicrohttpd .Nd library for embedding HTTP servers .Sh LIBRARY +.ds doc-str-Lb-libmicrohttpd library for embedding HTTP servers (libmicrohttpd) .Lb libmicrohttpd .Sh SYNOPSIS .In microhttpd.h | ||||
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2024-07-24 16:03 | fernst | New Issue | |
| 2024-07-24 16:03 | fernst | Tag Attached: patch | |
| 2024-07-24 16:03 | fernst | File Added: manpage_add_library_description.patch | |
| 2024-07-31 00:58 | Christian Grothoff | Assigned To | => Karlson2k |
| 2024-07-31 00:58 | Christian Grothoff | Status | new => assigned |
| 2024-07-31 12:56 | Karlson2k | Note Added: 0022878 | |
| 2024-07-31 12:57 | Karlson2k | Status | assigned => resolved |
| 2024-07-31 12:57 | Karlson2k | Resolution | open => fixed |
