GNU bug report logs - #31600
[PATCH] man: Some formatting fixes in "du.x" and "rm.x"

Previous Next

Package: coreutils;

Reported by: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>

Date: Sat, 26 May 2018 00:11:01 UTC

Severity: normal

Tags: patch

Done: Pádraig Brady <P <at> draigBrady.com>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: help-debbugs <at> gnu.org (GNU bug Tracking System)
To: Pádraig Brady <P <at> draigBrady.com>
Cc: tracker <at> debbugs.gnu.org
Subject: bug#31600: closed ([PATCH] man: Some formatting fixes in "du.x"
 and "rm.x")
Date: Sat, 26 May 2018 04:23:01 +0000
[Message part 1 (text/plain, inline)]
Your message dated Fri, 25 May 2018 21:22:20 -0700
with message-id <fdb3d999-6756-b499-a7df-59c4e8c48847 <at> draigBrady.com>
and subject line Re: bug#31600: [PATCH] man: Some formatting fixes in "du.x" and "rm.x"
has caused the debbugs.gnu.org bug report #31600,
regarding [PATCH] man: Some formatting fixes in "du.x" and "rm.x"
to be marked as done.

(If you believe you have received this mail in error, please contact
help-debbugs <at> gnu.org.)


-- 
31600: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=31600
GNU Bug Tracking System
Contact help-debbugs <at> gnu.org with problems
[Message part 2 (message/rfc822, inline)]
From: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
To: bug-coreutils <at> gnu.org
Subject: [PATCH] man: Some formatting fixes in "du.x" and "rm.x"
Date: Sat, 26 May 2018 00:10:11 +0000
  Change ".BR" to ".B" if there is only one argument.

  Protect an end-of-sentence indicator (.?!) with '\&' if it does not
mean an end of a sentence.

  Change '--' to '\-\­' if it indicates an option.

  Change '\=' to '='.

Signed-off-by: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
---

  Details:

  Warnings from "groff".

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

  [ "test-groff" is a developmental version of "groff" ]

<du.x>:12 (macro BR): only 1 argument, but more are expected
<du.x>:14 (macro BR): only 1 argument, but more are expected
<du.x>:17 (macro BR): only 1 argument, but more are expected
<du.x>:25 (macro BR): only 1 argument, but more are expected
<du.x>:27 (macro BR): only 1 argument, but more are expected

#

troff: <rm.x>:16: warning: escape character ignored before '='
troff: <rm.x>:25: warning: escape character ignored before '='

###

 man/du.x | 12 ++++++------
 man/rm.x |  4 ++--
 2 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/man/du.x b/man/du.x
index 43f66ffa2..cd68e40ea 100644
--- a/man/du.x
+++ b/man/du.x
@@ -9,20 +9,20 @@ du \- estimate file space usage
 .\" Add any additional description here
 [PATTERNS]
 PATTERN is a shell pattern (not a regular expression).  The pattern
-.BR ?
+.B ?\&
 matches any one character, whereas
-.BR *
+.B *
 matches any string (composed of zero, one or multiple characters).  For
 example,
-.BR *.o
+.B *.o
 will match any files whose names end in
 .BR .o .
 Therefore, the command
 .IP
-.B du --exclude=\(aq*.o\(aq
+.B du \-\-exclude=\(aq*.o\(aq
 .PP
 will skip all files and subdirectories ending in
-.BR .o
+.B .o
 (including the file
-.BR .o
+.B .o
 itself).
diff --git a/man/rm.x b/man/rm.x
index 278eba009..3044a0914 100644
--- a/man/rm.x
+++ b/man/rm.x
@@ -13,7 +13,7 @@ documents the GNU version of
 removes each specified file.  By default, it does not remove
 directories.
 .P
-If the \fI\-I\fR or \fI\-\-interactive\=once\fR option is given,
+If the \fI\-I\fR or \fI\-\-interactive=once\fR option is given,
 and there are more than three files or the \fI\-r\fR, \fI\-R\fR,
 or \fI\-\-recursive\fR are given, then
 .B rm
@@ -22,7 +22,7 @@ the response is not affirmative, the entire command is aborted.
 .P
 Otherwise, if a file is unwritable, standard input is a terminal, and
 the \fI\-f\fR or \fI\-\-force\fR option is not given, or the
-\fI\-i\fR or \fI\-\-interactive\=always\fR option is given,
+\fI\-i\fR or \fI\-\-interactive=always\fR option is given,
 .B rm
 prompts the user for whether to remove the file.  If the response is
 not affirmative, the file is skipped.
-- 
2.17.0


-- 
Bjarni I. Gislason


[Message part 3 (message/rfc822, inline)]
From: Pádraig Brady <P <at> draigBrady.com>
To: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>, 31600-done <at> debbugs.gnu.org
Subject: Re: bug#31600: [PATCH] man: Some formatting fixes in "du.x" and "rm.x"
Date: Fri, 25 May 2018 21:22:20 -0700
On 25/05/18 17:10, Bjarni Ingi Gislason wrote:
>   Change ".BR" to ".B" if there is only one argument.
> 
>   Protect an end-of-sentence indicator (.?!) with '\&' if it does not
> mean an end of a sentence.
> 
>   Change '--' to '\-\­' if it indicates an option.
> 
>   Change '\=' to '='.
> 
> Signed-off-by: Bjarni Ingi Gislason <bjarniig <at> rhi.hi.is>
> ---
> 
>   Details:
> 
>   Warnings from "groff".
> 
>   Output is from: test-groff -b -e -mandoc -T utf8 -rF0 -t -w w -z 


Pushed at:
https://git.sv.gnu.org/gitweb/?p=coreutils.git;a=commitdiff;h=fb1ca34

thanks!
Pádraig.



This bug report was last modified 6 years and 361 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.