git.net

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Problems in several man pages you maintain


This is automatically generated email about markup problems in a man
page for which you appear to be responsible.  If you are not the right
person or list, please tell me so I can correct my database.

See http://catb.org/~esr/doclifter/bugs.html for details on how and
why these patches were generated.  Feel free to email me with any
questions.  Note: These patches do not change the modification date of
any manual page.  You may wish to do that by hand.

I apologize if this message seems spammy or impersonal. The volume of
markup bugs I am tracking is over five hundred - there is no real
alternative to generating bugmail from a database and template.

--
                             Eric S. Raymond
-------------- next part --------------
Problems with List::Compare::Functional.3pm:

(May reflect bugs in POD).

Renaming SYNOPSIS because either (a) third-party viewers and
translators will try to interpret it as a command synopsis and become
confused, or (b) it actually needs to be named "SYNOPSIS" with no
modifier for function protoypes to be properly recognized.

I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package.  Please forward appropriately.  Also please
fix the package metadata so it identifies the upstream maintainers.

--- List::Compare::Functional.3pm-unpatched	2018-06-05 18:31:30.862319888 -0400
+++ List::Compare::Functional.3pm	2018-06-05 18:34:05.941265964 -0400
@@ -156,8 +156,8 @@
 follow the documentation below.  If, however, you used List::Compare::Functional
 prior to that version, see the discussion of interface changes farther
 below: April 2004 Change of Interface.
-.SH "SYNOPSIS"
-.IX Header "SYNOPSIS"
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
 .SS "Getting Started"
 .IX Subsection "Getting Started"
 List::Compare::Functional exports no subroutines by default.
-------------- next part --------------
Problems with top.1:

Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but most cases of it
are impossible to translate into DocBook markup), or it may mean the
command syntax fails to match the description.

I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package.  Please forward appropriately.  Also please
fix the package metadata so it identifies the upstream maintainers.

--- top.1-unpatched	2018-05-28 22:36:54.455690952 -0400
+++ top.1	2018-05-28 22:37:48.139326116 -0400
@@ -82,8 +82,6 @@
 .\" ----------------------------------------------------------------------
 \*(WE \*(CL
 
-The traditional switches `\-' and whitespace are optional.
-
 .\" ----------------------------------------------------------------------
 .SH DESCRIPTION
 .\" ----------------------------------------------------------------------
-------------- next part --------------
Problems with CURLOPT_PROXY_CAPATH.3:

Unknown or invalid macro.  That is, one that does not fit in the
macro set that the man page seems to be using.  This is a serious
error; it often means part of your text is being lost or rendered
incorrectly.

I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package.  Please forward appropriately.  Also please
fix the package metadata so it identifies the upstream maintainers.

--- CURLOPT_PROXY_CAPATH.3-unpatched	2018-05-29 00:41:38.112831606 -0400
+++ CURLOPT_PROXY_CAPATH.3	2018-05-29 00:41:49.140756659 -0400
@@ -69,5 +69,5 @@
 CURLE_OUT_OF_MEMORY
 .SH "SEE ALSO"
 .BR CURLOPT_PROXY_CAINFO "(3), "
-.Br CURLOPT_CAINFO "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
+.BR CURLOPT_CAINFO "(3), " CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
-------------- next part --------------
Problems with ntfssecaudit.8:

Broken command synopsis syntax.  This may mean you're using a
construction in the command synopsis other than the standard
[ ] | { }, or it may mean you have running text in the command synopsis
section (the latter is not technically an error, but most cases of it
are impossible to translate into DocBook markup), or it may mean the
command syntax fails to match the description.

I have been unable to identify an upstream maintainer for this
Ubuntu/Debian package, and am notifying the generic "Maintainer"
address in the package.  Please forward appropriately.  Also please
fix the package metadata so it identifies the upstream maintainers.

--- ntfssecaudit.8-unpatched	2018-05-29 00:30:49.381240422 -0400
+++ ntfssecaudit.8	2018-05-29 00:31:45.072861938 -0400
@@ -8,8 +8,9 @@
 .B ntfssecaudit
 \fB[\fIoptions\fP\fB]\fR
 .I args
+.SH OPTIONS
 .PP
-Where \fIoptions\fP is a combination of :
+The \fIoptions\fP may be a combination of:
 .RS
 -a full auditing of security data (Linux only)
 .RE
-------------- next part --------------
Problems with getty.8:

(Identical patches should apply to: agetty.8)

Contains a request or escape that is outside the portable subset that
can be rendered by non-groff viewers such as the KDE and GNOME help
browsers.

--- getty.8-unpatched	2018-05-18 17:27:33.601623318 -0400
+++ getty.8	2018-05-18 17:29:20.684895574 -0400
@@ -208,7 +208,7 @@
 replaced by the login name. For example:
 .RS
 .IP "" 4
-.B "\-\-login\-options '-h darkstar -- \\\u'"
+.B "\-\-login\-options '-h darkstar -- \eu'"
 .PP
 See \fB\-\-autologin\fR, \fB\-\-login\-program\fR and \fB\-\-remote\fR.
 .PP
-------------- next part --------------
Problems with hp-logcapture.1:

Your Synopsis is exceptionally creative.  Unfortunately, that means
it cannot be translated to structural markup even when things like
running-text inclusions have been moved elswhere.

--- hp-logcapture.1-unpatched	2018-05-18 06:49:22.933848813 -0400
+++ hp-logcapture.1	2018-05-18 06:51:35.360948831 -0400
@@ -1,16 +1,13 @@
 .TH "hp-logcapture" 1 "1.0" Linux "User Manuals"
 .SH NAME
 hp-logcapture \- HPLIP logs capture Utility
-.SH DESCRIPTION
-Captures the HPLIP log files.
-.SH SYNOPSIS
-.B  [su -c /sudo] hp-logcapture [USER INFO] [OPTIONS]
 .SH SYNOPSIS
-.B e.g. su -c 'hp-logcapture'
-.SH USER INFO
+.B  hp-logcapture [USER INFO] [OPTIONS]
+.SH DESCRIPTION
+Captures the HPLIP log files. Must be run as root.
+.SH OPTIONS
 .IP "User name for which logs to be collected:"
 --user=<username> 
-.SH OPTIONS
 .IP "This help information:"
 -h or --help
 .IP "Set the logging level:"