bug-patch
[Top][All Lists]
Advanced

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

[bug-patch] Problems in patch.1


From: esr
Subject: [bug-patch] Problems in patch.1
Date: Tue, 18 Jun 2013 01:13:49 -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 patch.1:

Use of low-level troff hackery to set special indents or breaks can't
be translated. The page will have rendering faults in HTML, and
probably also under third-party man page browsers such as Xman,
Rosetta, and the KDE help browser.  This patch eliminates .br, .ta, .ti,
.ce, .in, and \h in favor of requests like .RS/.RE that have
structural translations.

Synopsis has to be immediately after NAME section for DocBook
translation to work.

--- patch.1-unpatched   2012-07-04 14:24:35.489706536 -0400
+++ patch.1     2012-07-04 14:27:18.729703484 -0400
@@ -1,14 +1,10 @@
 .\" patch man page
-.de Id
-.ds Dt \\$4
-..
 .ds = \-\^\-
 .de Sp
 .if t .sp .3
 .if n .sp
 ..
-.TH PATCH 1 \*(Dt GNU
-.ta 3n
+.TH PATCH 1 "" GNU
 .SH NAME
 patch \- apply a diff file to an original
 .SH SYNOPSIS
@@ -241,7 +237,9 @@
 The upshot of all this is that you should be able to say, while in a news
 interface, something like the following:
 .Sp
+.RS
        \fB| patch \-d /usr/src/local/blurfl\fP
+.RE
 .Sp
 and patch a file in the
 .B blurfl
@@ -466,7 +464,9 @@
 out the patch.
 For example, supposing the file name in the patch file was
 .Sp
+.RS
        \fB/u/howard/src/blurfl/blurfl.c\fP
+.RE
 .Sp
 setting
 .B \-p0
@@ -474,13 +474,17 @@
 .B \-p1
 gives
 .Sp
+.RS
        \fBu/howard/src/blurfl/blurfl.c\fP
+.RE
 .Sp
 without the leading slash,
 .B \-p4
 gives
 .Sp
+.RS
        \fBblurfl/blurfl.c\fP
+.RE
 .Sp
 and not specifying
 .B \-p
@@ -858,7 +862,9 @@
 option.
 Here is an example command, using Bourne shell syntax:
 .Sp
+.RS
        \fBLC_ALL=C TZ=UTC0 diff \-Naur gcc\-2.7 gcc\-2.8\fP
+.RE
 .PP
 Tell your recipients how to apply the patch
 by telling them which directory to
@@ -907,13 +913,13 @@
 .BI \-p N
 option, do not send output that looks like this:
 .Sp
-.ft B
+.ft CW
 .ne 3
-       diff \-Naur v2.0.29/prog/README prog/README
+        diff \-Naur v2.0.29/prog/README prog/README
 .br
-       \-\^\-\^\- v2.0.29/prog/README   Mon Mar 10 15:13:12 1997
+        \-\^\-\^\- v2.0.29/prog/README   Mon Mar 10 15:13:12 1997
 .br
-       +\^+\^+ prog/README   Mon Mar 17 14:58:22 1997
+        +\^+\^+ prog/README   Mon Mar 17 14:58:22 1997
 .ft
 .Sp
 because the two file names have different numbers of slashes,
@@ -922,13 +928,13 @@
 interpret the file names differently.
 To avoid confusion, send output that looks like this instead:
 .Sp
-.ft B
+.ft CW
 .ne 3
-       diff \-Naur v2.0.29/prog/README v2.0.30/prog/README
+        diff \-Naur v2.0.29/prog/README v2.0.30/prog/README
 .br
-       \-\^\-\^\- v2.0.29/prog/README   Mon Mar 10 15:13:12 1997
+        \-\^\-\^\- v2.0.29/prog/README   Mon Mar 10 15:13:12 1997
 .br
-       +\^+\^+ v2.0.30/prog/README   Mon Mar 17 14:58:22 1997
+        +\^+\^+ v2.0.30/prog/README   Mon Mar 17 14:58:22 1997
 .ft
 .Sp
 .PP

reply via email to

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