bug-coreutils
[Top][All Lists]
Advanced

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

bug#31803: Problems in chroot.2, ln.1, test.1, [.1


From: esr
Subject: bug#31803: Problems in chroot.2, ln.1, test.1, [.1
Date: Tue, 12 Jun 2018 15:16:14 -0400 (EDT)

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
Problems with test.1:

(Identical patches should apply to: [.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.

Command-line options described are not actually implemented.

--- test.1-unpatched    2018-04-17 21:54:23.971441556 -0400
+++ test.1      2018-04-17 21:58:02.075011621 -0400
@@ -7,20 +7,15 @@
 \fI\,EXPRESSION\/\fR
 .br
 .B test
-
-.br
-.B [
-\fI\,EXPRESSION \/\fR]
-.br
-.B [
-]
-.br
-.B [
-\fI\,OPTION\/\fR
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP
 Exit with the status determined by EXPRESSION.
+.PP
+The command "[" is linked to test, and a trailing "]" im the arguments
+is ignored.  Thus, acomposition of the operations described below may
+be surrounded by [ ] and will be interpreted as a test command.  This
+syntax is frequently used in shell conditionals.
 .TP
 \fB\-\-help\fR
 display this help and exit
Problems with chroot.2:

My translator trips over a useless command in list markup.

List syntax error. This means .IP, .TP or .RS/.RE markup is garbled.
Common causes include .TP just before a section header, .TP entries
with tags but no bodies, and mandoc lists with no trailing .El.
These confuse doclifter, and may also mess up stricter man-page
browsers like Xman and Rosetta.

--- chroot.2-unpatched  2018-05-17 13:06:30.287251247 -0400
+++ chroot.2    2018-05-17 13:08:13.406550442 -0400
@@ -46,17 +46,13 @@
 .BR chroot ():
 .ad l
 .RS 4
-.PD 0
-.TP 4
 Since glibc 2.2.2:
 .nf
 _XOPEN_SOURCE && ! (_POSIX_C_SOURCE\ >=\ 200112L)
     || /* Since glibc 2.20: */ _DEFAULT_SOURCE
     || /* Glibc versions <= 2.19: */ _BSD_SOURCE
-.TP 4
 .fi
 Before glibc 2.2.2: none
-.PD
 .RE
 .ad b
 .SH DESCRIPTION
Problems with ln.1:

Parenthesized comments in command synopsis.  This is impossible
to translate to DocBook.

--- ln.1-unpatched      2018-04-17 21:19:33.699561983 -0400
+++ ln.1        2018-04-17 21:20:35.227440696 -0400
@@ -4,16 +4,16 @@
 ln \- make links between files
 .SH SYNOPSIS
 .B ln
-[\fI\,OPTION\/\fR]... [\fI\,-T\/\fR] \fI\,TARGET LINK_NAME   (1st form)\/\fR
+[\fI\,OPTION\/\fR]... [\fI\,-T\/\fR] \fI\,TARGET LINK_NAME\/\fR
 .br
 .B ln
-[\fI\,OPTION\/\fR]... \fI\,TARGET                  (2nd form)\/\fR
+[\fI\,OPTION\/\fR]... \fI\,TARGET\/\fR
 .br
 .B ln
-[\fI\,OPTION\/\fR]... \fI\,TARGET\/\fR... \fI\,DIRECTORY     (3rd form)\/\fR
+[\fI\,OPTION\/\fR]... \fI\,TARGET\/\fR... \fI\,DIRECTORY\/\fR
 .br
 .B ln
-[\fI\,OPTION\/\fR]... \fI\,-t DIRECTORY TARGET\/\fR...  \fI\,(4th form)\/\fR
+[\fI\,OPTION\/\fR]... \fI\,-t DIRECTORY TARGET\/\fR...
 .SH DESCRIPTION
 .\" Add any additional description here
 .PP

reply via email to

[Prev in Thread] Current Thread [Next in Thread]