Bug#1071107: elf_begin.3: fix a table and lines in the SYNOPSIS
Package: libelf-dev
Version: 0.191-1+b1
Severity: normal
Tags: patch
Dear Maintainer,
* What led up to the situation?
Warnings from 'groff -ww -b ...'
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint elf_begin.3":
mandoc: elf_begin.3:13:2: STYLE: fill mode already enabled, skipping: fi
mandoc: elf_begin.3:25:2: ERROR: data block open at end of tbl: TE
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -rCHECKSTYLE=0":
tbl:<stdin>:35: error: end of data in middle of text block
tbl:<stdin>:35: error: giving up on this table region
an.tmac:<stdin>:35: warning: tbl preprocessor failed, or it or soelim was not run; table(s) likely not rendered (TE macro called with TW register undefined)
-.-
The patch is in the attachment.
-- System Information:
Debian Release: trixie/sid
APT prefers testing-proposed-updates
APT policy: (500, 'testing-proposed-updates'), (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages libelf-dev depends on:
ii libelf1t64 0.191-1+b1
ii libzstd-dev 1.5.5+dfsg2-2
ii zlib1g-dev 1:1.3.dfsg-3.1
libelf-dev recommends no packages.
libelf-dev suggests no packages.
-- no debconf information
--- elf_begin.3 2024-05-13 00:16:25.560355291 +0000
+++ elf_begin.3.new 2024-05-14 12:32:59.931073929 +0000
@@ -3,10 +3,10 @@
.TH ELF_BEGIN 3 2017-09-05 "Libelf" "Libelf Programmer's Manual"
.SH NAME
elf_begin \- Return descriptor for ELF file.
-.nf
.SH SYNOPSIS
.B #include <libelf.h>
.sp
+.nf
.BI "Elf *elf_begin (int " filedes ", Elf_Cmd " cmd ", Elf *" ref ");"
.BI "Elf *elf_clone (int " filedes ", Elf_Cmd " cmd ");"
.BI "int elf_end (Elf *" elf ");"
@@ -26,12 +26,12 @@ For an explanation of the terms used in
allbox;
lbw29 lb lb
l l l.
-Interface Attribute Value
+Interface Attribute Value
T{
.BR elf_begin (),
.BR elf_clone (),
.BR elf_end ()
-T} Thread safety MT-Safe
+T} Thread safety MT-Safe
.TE
.SH SEE ALSO
Reply to:
- Prev by Date:
Processing of gcc-13_13.2.0-25_source.changes
- Next by Date:
Processed: tagging 1065386, tagging 1060580, tagging 1060578, tagging 1060573, tagging 1060528, tagging 1060527 ...
- Previous by thread:
Processing of gcc-13_13.2.0-25_source.changes
- Next by thread:
Processed: tagging 1065386, tagging 1060580, tagging 1060578, tagging 1060573, tagging 1060528, tagging 1060527 ...
- Index(es):