Bug#740973: sprof(1): Some typographical changes in the manual
Package: libc-dev-bin
Version: 2.17-97
Severity: minor
Tags: patch
Dear Maintainer,
* What led up to the situation?
Testing a man page
* What exactly did you do (or not do) that was effective (or
ineffective)?
groff -b -e -mandoc -t -z -ww < sprof.1
* What was the outcome of this action?
<standard input>:46: warning: macro `Tr' not defined
<standard input>:95: warning: number register `F' not defined
<standard input>:223: warning: macro `IX' not defined
Input file is sprof.1 (/usr/share/man/man1/sprof.1.gz)
* What outcome did you expect instead?
No warnings
It looks like the manual was created by using pod2man. Latest version
of that program should be used as it corrects some constructs causing
groff to issue warnings.
Changes:
String "Tr" defined for groff
Character \(bv (bold (big) vertical?), translated from |, is displayed by
"man" as a question mark. Therefore only used in "troff" output.
Space at end of line removed
Register F and macro IX defined for groff
-- changed to \-\- if it means an option
Patch:
--- sprof.1 2013-11-29 19:31:48.000000000 +0000
+++ sprof.1.new 2014-03-02 21:53:45.000000000 +0000
@@ -40,7 +40,12 @@
.\" string Tr holds user defined translation string.
.\" Bell System Logo is used as a dummy character.
.\"
-.tr \(*W-|\(bv\*(Tr
+.\" Avoid warning from groff about undefined string
+.if \n(.g \{\
+. if !dTr .ds Tr
+.\}
+.ie t .tr \(*W-|\(bv\*(Tr
+.el .tr \(*W-\*(Tr
.ie n \{\
.ds -- \(*W-
.ds PI pi
@@ -82,13 +87,19 @@
'br\}
.\" If the F register is turned on, we'll generate
.\" index entries out stderr for the following things:
-.\" TH Title
+.\" TH Title
.\" SH Header
-.\" Sh Subsection
+.\" Sh Subsection
.\" Ip Item
.\" X<> Xref (embedded
.\" Of course, you have to process the output yourself
.\" in some meaningful fashion.
+.\" Avoid warning from groff about undefined register and macro
+. de IX
+..
+.if \n(.g \{\
+. if !rF . nr F 0
+.\}
.if \nF \{
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
@@ -195,17 +206,17 @@ sprof \- Read and display shared object
.SH "SYNOPSIS"
\fBsprof\fR \fB\-p\fR|\fB\-c\fR [\fB\-q\fR]
.SH "DESCRIPTION"
-\fB--call-pairs\fR, \fB\-c\fR
+\fB\-\-call-pairs\fR, \fB\-c\fR
.PP
.Vb 1
\& print list of count paths and their number of use
.Ve
-\fB--flat-profile\fR, \fB\-p\fR
+\fB\-\-flat-profile\fR, \fB\-p\fR
.PP
.Vb 1
\& generate flat profile with counts and ticks
.Ve
-\fB--graph\fR, \fB\-q\fR
+\fB\-\-graph\fR, \fB\-q\fR
.PP
.Vb 1
\& generate call graph
-- System Information:
Debian Release: jessie/sid
APT prefers stable-updates
APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 'testing'), (500, 'stable')
Architecture: i386 (i586)
Kernel: Linux 3.2.53-rt75-1
Locale: LANG=is_IS, LC_CTYPE=is_IS (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Versions of packages libc-dev-bin depends on:
ii libc6 2.17-97
Versions of packages libc-dev-bin recommends:
ii manpages-dev 3.58-1
libc-dev-bin suggests no packages.
-- no debconf information
--
Bjarni I. Gislason
Reply to: