Package: patch
Version: 2.7.6-2
Severity: minor
Tags: patch

Dear Maintainer,

  Suggested commit message for "git":

Change ".BR" with one argument to ".B".

Change the argument of ".BR <arg>." into two by separating the
punctuation from the first one.

Protect the period (with \&) from being interpreted as an end of a
sentence.

Change '--' to '\*=' (defined in the man page).

Split long lines into two (or more).

Split lines that only have one space after the end of a sentence into
two ore more (man-pages(7), groff.info).

Add a comma after "e.g." and "i.e." (man-pages(7)).

####

  Suggested notes for "git":

Input file is patch.1

Test nr. 2:

Enable and fix warnings from 'test-groff'.

<patch.1>:696 (macro BR): only 1 argument, but more are expected
<patch.1>:1057 (macro BR): only 1 argument, but more are expected

Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z 

  and

Test nr. 15:

Change the name of a macro for two fonts (e.g., BR and IR) to one letter,
if there is only one argument.
Add the second argument if needed.  It is sometimes part of the first one.

696:.BR \*=suffix
1057:.BR \-p0.

####

Test nr. 8:

Protect a full stop (.) with "\&", if it has a blank (white-space) in
front of or (ignoring characters that are transparent to it) after it,
and it does not mean an end of a sentence.

1190:\fB#ifdef OLDCODE\fP .\|.\|. \fB#else .\|.\|. #endif\fP),

#####

Test nr. 12 (adjusted):

Change -- to the defined string "=", ".ds = \-\^\-"

437:\fB--fuzz\fR=\fInum\fP option into account.


#####

Test nr. 27:

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause.

patch.1: line 63        length 83
patch.1: line 304       length 82
patch.1: line 367       length 83

#####

Test nr. 28:

Wrong distance between sentences or protect the indicator.

1) Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) and "info groff".

Or

2) Adjust space between sentences (two spaces),

3) or protect the indicator by adding "\&" after it.

The "indicator" is an "end-of-sentence character" (.!?).

307:endings. On Windows, reads and writes do transform line endings by default,
759:given in context diff headers. Unless specified in the time stamps,
849:Marshall T. Rose and Einar A. Stefferud,
1190:\fB#ifdef OLDCODE\fP .\|.\|. \fB#else .\|.\|. #endif\fP),

#####

Test nr. 42:

Add a comma after "e.g." and "i.e." (man-pages(7)).

584:and if the first command is an append (i.e. it should have been a delete)
787:(e.g. with
966:in different directories, e.g.\&
975:(e.g. the file
988:(e.g. with
1022:(e.g. a shell script) to accomplish them should accompany the patch.

#####

  PATCH:


--- patch.1     2018-04-10 20:23:42.000000000 +0000
+++ patch.1.new 2018-04-10 21:08:57.000000000 +0000
@@ -60,7 +60,8 @@ Thus you could feed an article or messag
 diff listing to
 .BR patch ,
 and it should work.
-If the entire diff is indented by a consistent amount, if lines end in 
\s-1CRLF\s0,
+If the entire diff is indented by a consistent amount,
+if lines end in \s-1CRLF\s0,
 or if a diff is encapsulated one or more times by prepending
 "\fB\- \fP" to lines starting with "\fB\-\fP" as specified by Internet RFC 934,
 this is taken into account.
@@ -300,11 +301,13 @@ is
 \fB\*=binary\fP
 Write all files in binary mode, except for standard output and
 .BR /dev/tty .
-When reading, disable the heuristic for transforming CRLF line endings into LF
-line endings.  This option is needed on \s-1POSIX\s0 systems when applying 
patches
+When reading,
+disable the heuristic for transforming CRLF line endings into LF line endings.
+This option is needed on \s-1POSIX\s0 systems when applying patches
 generated on non-\s-1POSIX\s0 systems to non-\s-1POSIX\s0 files.
 (On \s-1POSIX\s0 systems, file reads and writes never transform line
-endings. On Windows, reads and writes do transform line endings by default,
+endings.
+On Windows, reads and writes do transform line endings by default,
 and patches should be generated by
 .B "diff\ \*=binary"
 when line endings are significant.)
@@ -364,7 +367,8 @@ for that.
 Set the maximum fuzz factor.
 This option only applies to diffs that have context, and causes
 .B patch
-to ignore up to that many lines of context in looking for places to install a 
hunk.
+to ignore up to that many lines of context in looking for places to
+install a hunk.
 Note that a larger fuzz factor increases the odds of a faulty patch.
 The default fuzz factor is 2.  A fuzz factor greater than or equal to the
 number of lines of context in the context diff, ordinarily 3, ignores all
@@ -434,7 +438,7 @@ lines from the patch; in the merge forma
 format is the default.
 
 This option implies \fB\*=forward\fP and does not take the
-\fB--fuzz\fR=\fInum\fP option into account.
+\fB\*=fuzz\fR=\fInum\fP option into account.
 .TP
 \fB\-n\fP  or  \fB\*=normal\fP
 Interpret the patch file as a normal diff.
@@ -581,7 +585,7 @@ If it can, you are asked if you want to
 option set.
 If it can't, the patch continues to be applied normally.
 (Note: this method cannot detect a reversed patch if it is a normal diff
-and if the first command is an append (i.e. it should have been a delete)
+and if the first command is an append (i.e., it should have been a delete)
 since appends always succeed, due to the fact that a null context matches
 anywhere.
 Luckily, most patches add or change lines rather than delete them, so most
@@ -693,7 +697,7 @@ or
 and
 .B \-z
 or
-.BR \*=suffix
+.B \*=suffix
 options specify the simple backup file name.
 If none of these options are given, then a simple backup suffix is used;
 it is the value of the
@@ -756,7 +760,8 @@ is
 .TP
 \fB\-Z\fP  or  \fB\*=set\-utc\fP
 Set the modification and access times of patched files from time stamps
-given in context diff headers. Unless specified in the time stamps,
+given in context diff headers.
+Unless specified in the time stamps,
 assume that the context diff headers use Coordinated Universal Time
 (\s-1UTC\s0, often known as \s-1GMT\s0).  Also see the
 .B \-T
@@ -784,7 +789,7 @@ Due to the limitations of
 .B diff
 output format, these options cannot update the times of files whose
 contents have not changed.  Also, if you use these options, you should remove
-(e.g. with
+(e.g., with
 .BR "make\ clean" )
 all files that depend on the patched files, so that later invocations of
 .B make
@@ -846,7 +851,7 @@ controlling terminal; used to get answer
 .BR ed (1),
 .BR merge (1).
 .Sp
-Marshall T. Rose and Einar A. Stefferud,
+Marshall T.\& Rose and Einar A.\& Stefferud,
 Proposed Standard for Message Encapsulation,
 Internet RFC 934 <URL:ftp://ftp.isi.edu/in-notes/rfc934.txt> (1985-01).
 .SH "NOTES FOR PATCH SENDERS"
@@ -972,7 +977,7 @@ Take care not to send out reversed patch
 whether they already applied the patch.
 .PP
 Try not to have your patch modify derived files
-(e.g. the file
+(e.g., the file
 .B configure
 where there is a line
 .B "configure: configure.in"
@@ -985,7 +990,7 @@ have the recipients apply the patch with
 or
 .B \*=set\-utc
 option, and have them remove any unpatched files that depend on patched files
-(e.g. with
+(e.g., with
 .BR "make\ clean" ).
 .PP
 While you may be able to get away with putting 582 diff listings into
@@ -1019,7 +1024,7 @@ empty files, empty directories, or speci
 Nor can they represent changes to file metadata like ownership, permissions,
 or whether one file is a hard link to another.
 If changes like these are also required, separate instructions
-(e.g. a shell script) to accomplish them should accompany the patch.
+(e.g., a shell script) to accomplish them should accompany the patch.
 .PP
 .B patch
 cannot tell if the line numbers are off in an
@@ -1054,7 +1059,7 @@ the
 option's operand was optional, and a bare
 .B \-p
 was equivalent to
-.BR \-p0.
+.BR \-p0 .
 The
 .B \-p
 option now requires an operand, and
@@ -1187,7 +1192,7 @@ Please report bugs via email to
 .BR <bug-pa...@gnu.org> .
 .PP
 If code has been duplicated (for instance with
-\fB#ifdef OLDCODE\fP .\|.\|. \fB#else .\|.\|. #endif\fP),
+\fB#ifdef OLDCODE\fP .\|.\|.\& \fB#else .\|.\|.\& #endif\fP),
 .B patch
 is incapable of patching both versions, and, if it works at all, will likely
 patch the wrong one, and tell you that it succeeded to boot.


-- System Information:
Debian Release: buster/sid
  APT prefers stable-updates
  APT policy: (500, 'stable-updates'), (500, 'proposed-updates'), (500, 
'testing'), (500, 'stable')
Architecture: amd64 (x86_64)

Kernel: Linux 4.9.82-1u3 (SMP w/2 CPU cores)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE=is_IS.iso88591 (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages patch depends on:
ii  libc6  2.27-3

patch recommends no packages.

Versions of packages patch suggests:
pn  diffutils-doc  <none>
pn  ed             <none>

-- no debconf information

-- 
Bjarni I. Gislason

Reply via email to