bugGNU roff - Bugs: bug #51502, [PATCH] manuals: minor textual...

 
 

bug #51502: [PATCH] manuals: minor textual fixes

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Tue 18 Jul 2017 11:59:50 PM UTC
   
 
Category:  General Severity:  2 - Minor
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.22.4
* Mandatory Fields

Add a New Comment Rich Markup
   

Jump to the original submission

Wed 15 Jun 2022 02:45:09 PM UTC, comment #8: 

Apparently I forgot the 5/5 bug closer annotation.


commit 05ffb6af6e5fe23bac2e7f0469163ee490404ba1
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 2 21:00:37 2017 -0400

    manuals: Fix minor correctness and format issues.

    groff_diff(7):
    * Correct the explanation of the request ".itc"--it was backwards.
    * Add italic corrections where necessary when using font escapes.
    * The locally-defined string "ellipsis" ends in ".\&".  If it ends a
      sentence, an extra sentence space (protected with '\"' at the end of a
      line) has to be added, as the period is then not recognized as an end
      of sentence.

    groff_tmac(7):
    * Correct the spelling of "one" ( on -> one).

    roff(7):
    * Add italic correction.

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

commit 7aa009ae5142d2e6823ad586f292afd3e70ca644
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 2 20:37:03 2017 -0400

    groff(7): Fix unit names and macro argument usage.

    The name of units used in groff are written with lower case.

    The macros ".request" and ".register" set all arguments in boldface, so
    punctuation must be transferred to the next line.

    Fix damaged layout obscuring scaled points as a unit.

    Fixes Savannah #51502 [4/5].

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

commit db208857eb9b48e28ff81ad7674d43fce8bb2cf2
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 2 20:12:50 2017 -0400

    groff(7): Use pastable minus for option dash.

    Fixes Savannah #51502 [3/5].

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

commit 694f0e5424795ab4313a69b5c9a8ac98158b225d
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 2 19:31:46 2017 -0400

    manuals: Canonicalize spelling of "PostScript".

    contrib/glilypond/glilypond.1.man
    contrib/groffer/groffer.1.man
    man/roff.7.man
    src/devices/xditview/gxditview.1.man
    src/preproc/grn/grn.1.man

    Fixes Savannah #51502 [2/5].

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

commit c78c9b5d324ac870b37d226d6a9dfaea97b48a48
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Thu Nov 2 07:39:21 2017 -0400

    manuals: Fix minor textual issues.

    1) Correct spelling.

    2) Use the symbol 'in' for inch, not the English (American) specific '"'
    (quotation mark).

    3) Use '\e' to print '\', not '\\'.

    4) Use '\-' to indicate an option, not '-'.

    src/devices/grolbp/lbp.cpp: Fix a spelling error here, too.

    Fixes Savannah #51502 [1/5].

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


G. Branden Robinson <gbranden>
Group administrator
Thu 02 Nov 2017 06:29:10 AM UTC, comment #7: 

Thanks, Bjarni.

G. Branden Robinson <gbranden>
Group administrator
Wed 01 Nov 2017 10:06:20 PM UTC, comment #6: 



 The attachment is already shown at the bottom of the page on the web site.

  There is the missing text of comment #3:

Follow-up Comment #3, bug #51502 (project groff):


Subject: [PATCH] man: groff.7.man: fix the name of units and the arguments of
 two macros

  The name of units used in groff are written with lower case.

  The macros ".request" and ".register" set all arguments in boldface, so
punctuation must be transferred to the next line.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff.7.man | 102
++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 66 insertions(+), 36 deletions(-)

Patch is in the attachment.

(file #41388)
    _______________________________________________________

Additional Item Attachment:

File name: 0001-man-groff.7.man-fix-the-name-of-units-and-the-argument.txt.gz
Size:2 KB


Bjarni Ingi Gislason <bjarniig>
Wed 01 Nov 2017 06:07:18 AM UTC, comment #5: 

Comment #3 appears to be blank. Did Savannah eat something?

Can you re-supply the patch that would have been there?

G. Branden Robinson <gbranden>
Group administrator
Tue 08 Aug 2017 12:26:31 AM UTC, comment #4: 


From f88665832b0c84651d300b5892d7233ee0138106 Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Mon, 7 Aug 2017 23:57:52 +0000
Subject: [PATCH] Manuals: Some minor textual and formatting changes

  Add an italic correction

  Correct the explanation of the request ".itc"

  The string "ellipsis" ends in ".\&".  If it ends a sentence, an extra
sentence space (protected with '\"' at the end of a line) has to be added,
as the period is then not recognized as an end of sentence.

  Correct the spelling of "one" ( on -> one).

  The escape '\c' removes everything (except \R'...') after it.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff_diff.7.man | 8 ++++----
 man/groff_tmac.5.man | 2 +-
 man/roff.7.man       | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index db8f4684..d18b466f 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -120,7 +120,7 @@ The names of number registers, fonts, strings/\:macros/\:diversions,
 special characters (glyphs), and colors can be of any length.
 .
 In escape sequences, additionally to the classical
-\[oq]\fB(\fP\fIxx\fP\[cq] construction for a two-character glyph name,
+\[oq]\fB(\fP\,\fIxx\/\fP\[cq] construction for a two-character glyph name,
 you can use \[oq]\fB[\fP\,\fIxxx\/\fP\fB]\fP\[cq] for a name of
 arbitrary length.
 .
@@ -1776,7 +1776,7 @@ Variant of
 .B .it
 for which a line interrupted with
 .B \[rs]c
-counts as one input line.
+is not counted as an input line.
 .
 .TP
 .BI .kern\  n
@@ -2010,7 +2010,7 @@ with a positive value which are applied after the line is output.
 Remove the definitions of glyphs
 .IR c1 ,
 .IR c2 ,
-.I \*[ellipsis]
+.I \*[ellipsis]\ \"Add a sentence space
 This undoes the effect of a
 .B char
 request.
@@ -2029,7 +2029,7 @@ No effect otherwise.
 Remove the font-specific definitions of glyphs
 .IR c1 ,
 .IR c2 ,
-.I \*[ellipsis]
+.I \*[ellipsis]\ \"Add a sentence space
 This undoes the effect of a
 .B fschar
 request.
diff --git a/man/groff_tmac.5.man b/man/groff_tmac.5.man
index c15f0902..9c2ca1a5 100644
--- a/man/groff_tmac.5.man
+++ b/man/groff_tmac.5.man
@@ -630,7 +630,7 @@ So in
 .IR groff ,
 the
 .I man
-macro package may be specified as on of the following four methods:
+macro package may be specified as one of the following four methods:
 .
 .IP
 .EX
diff --git a/man/roff.7.man b/man/roff.7.man
index 60cffb9d..042f2390 100644
--- a/man/roff.7.man
+++ b/man/roff.7.man
@@ -801,7 +801,7 @@ This greatly eases the usage of
 The macro definitions of a package are kept in a file called
 .IB name .tmac
 (classically
-.BI tmac. name\c
+.BI tmac. name\/\c\" Italic correction comes before \c !
 ).
 .
 All tmac files are stored in one or more directories at standardized
--
2.13.2


Bjarni Ingi Gislason <bjarniig>
Wed 02 Aug 2017 01:27:16 AM UTC, comment #3: 


Subject: [PATCH] man: groff.7.man: fix the name of units and the arguments of
 two macros

  The name of units used in groff are written with lower case.

  The macros ".request" and ".register" set all arguments in boldface, so
punctuation must be transferred to the next line.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff.7.man | 102 ++++++++++++++++++++++++++++++++++++--------------------
 1 file changed, 66 insertions(+), 36 deletions(-)

Patch is in the attachment.

(file #41388)

Bjarni Ingi Gislason <bjarniig>
Sun 30 Jul 2017 09:38:25 PM UTC, comment #2: 


From 5aa5d26ec53856783ee790adab8ec11323c3449b Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Sun, 30 Jul 2017 21:33:05 +0000
Subject: [PATCH] manual: groff.7.man: Minor textual fix

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff.7.man | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/groff.7.man b/man/groff.7.man
index b0fe754c..13ae8354 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -3629,7 +3629,7 @@ is
 The availability of the Unicode characters depends on the used font.
 .
 For text mode, the device
-.B -Tutf8
+.B \-Tutf8
 is quite complete, for
 .I troff
 modes it might happen that some or many characters will not be
--
2.13.2


Bjarni Ingi Gislason <bjarniig>
Wed 19 Jul 2017 01:17:22 AM UTC, comment #1: 


From b5a952636f56a431d2325a9e5c1aa99c99a3cf90 Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Wed, 19 Jul 2017 01:11:40 +0000
Subject: [PATCH] manuals: fix writing of "PostScript"

1) Correct spelling
  Postcript -> PostScript
  Postscript -> PostScript

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 contrib/glilypond/glilypond.1.man    |  2 +-
 contrib/groffer/groffer.1.man        | 14 +++++++-------
 man/roff.7.man                       |  2 +-
 src/devices/xditview/gxditview.1.man |  2 +-
 src/preproc/grn/grn.1.man            |  2 +-
 5 files changed, 11 insertions(+), 11 deletions(-)


  Patch is in the attachment.


(file #41238)

Bjarni Ingi Gislason <bjarniig>
Tue 18 Jul 2017 11:59:50 PM UTC, original submission:  


From 3906658a86a4ffcdc9bd14199b1a6fa8eddb8bd9 Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Tue, 18 Jul 2017 23:49:20 +0000
Subject: [PATCH] manuals: minor textual fixes

1) Correct spelling

2) Use the symbol 'in' for inch, not the English (American) specific '"'
(quotation mark)

3) Use '\e' to print '\', not '\\'.

4) Use '\-' to indicate an option, not '-'.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 contrib/glilypond/glilypond.1.man |  2 +-
 contrib/gperl/gperl.1.man         |  8 ++++----
 contrib/gpinyin/gpinyin.1.man     |  2 +-
 src/devices/grolbp/lbp.cpp        |  2 +-
 src/devices/grolj4/lj4_font.5.man | 10 +++++-----
 src/devices/gropdf/pdfmom.1.man   |  2 +-
 src/preproc/pic/pic.1.man         |  2 +-
 src/roff/groff/groff.1.man        |  4 ++--
 tmac/groff_man.7.man              |  2 +-
 9 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/contrib/glilypond/glilypond.1.man b/contrib/glilypond/glilypond.1.man
index 2441832e..c45c2040 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -281,7 +281,7 @@ In this temporary directory, the temporary files are stored.
 Normally all
 .I groff
 output of this program is sent to
-.BR STDOUT R .
+.BR STDOUT .
 .
 With this option, that can be changed, such that the output is stored
 into a file named in the option argument
diff --git a/contrib/gperl/gperl.1.man b/contrib/gperl/gperl.1.man
index c10da9c8..1655721f 100644
--- a/contrib/gperl/gperl.1.man
+++ b/contrib/gperl/gperl.1.man
@@ -75,7 +75,7 @@ The license text is available in the internet at
 .SH DESCRIPTION
 .\" --------------------------------------------------------------------
 .
-This is a preprocesor for
+This is a preprocessor for
 .BR \%groff (@MAN1EXT@).
 .
 It allows to add
@@ -113,7 +113,7 @@ character for standard input.
 .
 As usual, the argument
 .B \-\-
-can be used in order to let all fowllowing arguments mean file names,
+can be used in order to let all following arguments mean file names,
 even if the names begin with a minus character
 .BR \- .
 .
@@ -128,7 +128,7 @@ All other arguments will be ignored by that.
 .
 These
 .I breaking
-options are heree
+options are here
 .
 .TP
 .B -h\~\fR|\fB\~--help
@@ -406,7 +406,7 @@ The printing towards
 .
 All error information goes to the real normal
 .IR "standard error" ,
-without other automatical storage.
+without other automatic storage.
 .
 .
 .\" --------------------------------------------------------------------
diff --git a/contrib/gpinyin/gpinyin.1.man b/contrib/gpinyin/gpinyin.1.man
index ceedbf05..41717eb6 100644
--- a/contrib/gpinyin/gpinyin.1.man
+++ b/contrib/gpinyin/gpinyin.1.man
@@ -58,7 +58,7 @@ This file was written by Bernd Warken <groff-bernd.warken-72@web.de>.
 .SH DESCRIPTION
 .\" --------------------------------------------------------------------
 .
-This is a preprocesor for
+This is a preprocessor for
 .BR \%groff (@MAN1EXT@).
 .
 It allows to add the Chinese European-like language
diff --git a/src/devices/grolbp/lbp.cpp b/src/devices/grolbp/lbp.cpp
index aaa03886..0f9006ec 100644
--- a/src/devices/grolbp/lbp.cpp
+++ b/src/devices/grolbp/lbp.cpp
@@ -401,7 +401,7 @@ inline void lbp_printer::polygon(int hpos, int vpos, int np, int *p)
   points = new int[np + 2];
   points[0] = hpos;
   points[1] = vpos;
-  // fprintf(stderr, "Poligon (%d,%d) ", points[0], points[1]);
+  // fprintf(stderr, "Polygon (%d,%d) ", points[0], points[1]);
   for (i = 0; i < np; i++)
     points[i + 2] = p[i];
   // for (i = 0; i < np; i++) fprintf(stderr, " %d ", p[i]);
diff --git a/src/devices/grolj4/lj4_font.5.man b/src/devices/grolj4/lj4_font.5.man
index 05224baf..fe33f3ab 100644
--- a/src/devices/grolj4/lj4_font.5.man
+++ b/src/devices/grolj4/lj4_font.5.man
@@ -113,12 +113,12 @@ Although HP PCL~5 LaserJet printers support an internal resolution of
 7200 units per inch, they use a 16-bit signed integer for cursor
 positioning; if
 .B devlj4
-is to support U.S.\& ledger paper (11"~\(mu~17"), the maximum usable
-resolution is 32\|767~/~17, or 1927, units per inch, which rounds down
-to 1200 units per inch.
+is to support U.S.\& ledger paper (11~in~\(mu~17~in; in = inch),
+the maximum usable resolution is 32\|767~/~17, or 1927 units per inch,
+which rounds down to 1200 units per inch.
 .
-If the largest required paper size is less (e.g., 8.5"~\(mu~11" or
-A5), a greater resolution (and lesser unitwidth) can be specified.
+If the largest required paper size is less (e.g., 8.5~in~\(mu~11~in,
+or A5), a greater resolution (and lesser unitwidth) can be specified.
 .
 .
 .\" --------------------------------------------------------------------
diff --git a/src/devices/gropdf/pdfmom.1.man b/src/devices/gropdf/pdfmom.1.man
index 90fef598..d732926b 100644
--- a/src/devices/gropdf/pdfmom.1.man
+++ b/src/devices/gropdf/pdfmom.1.man
@@ -88,7 +88,7 @@ which uses
 .BR groff 's
 PostScript driver.
 .
-In either case, multiple runs of the source file are peformed in
+In either case, multiple runs of the source file are performed in
 order to satisfy any forward references in the document.
 .
 .
diff --git a/src/preproc/pic/pic.1.man b/src/preproc/pic/pic.1.man
index 141a494b..c5d17513 100644
--- a/src/preproc/pic/pic.1.man
+++ b/src/preproc/pic/pic.1.man
@@ -1247,7 +1247,7 @@ the resulting (intermediate)
 file can be then converted to virtually any graphics format using the
 tools of the
 .B netpbm
-package .
+package.
 .
 .
 .\" --------------------------------------------------------------------
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 84e70957..6d68ea31 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -55,7 +55,7 @@ Werner Lemberg
 ..
 .
 .\" --------------------------------------------------------------------
-.\" Definitons
+.\" Definitions
 .\" --------------------------------------------------------------------
 .
 .\" --------------------------------------------------------------------
@@ -849,7 +849,7 @@ A4 paper in landscape orientation for the PS device:
 .
 .IP
 .EX
-groff -Tps -P-pa4 -P-l \&...\&
+groff \-Tps \-P-pa4 \-P-l \&...\&
 .EE
 .
 .
diff --git a/tmac/groff_man.7.man b/tmac/groff_man.7.man
index 69e56677..1cd3f46c 100644
--- a/tmac/groff_man.7.man
+++ b/tmac/groff_man.7.man
@@ -359,7 +359,7 @@ second argument.
 .
 .IP
 For example, the following paragraphs were all set up with bullets as
-the designator, using \[oq].IP\ \\(bu\ 4\[cq].
+the designator, using \[oq].IP\ \e(bu\ 4\[cq].
 .
 The whole block has been enclosed with
 .B .RS
--
2.13.2


Bjarni Ingi Gislason <bjarniig>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gbranden (Posted a comment)
  • -email is unavailable- added by bgarrigues (Updated the item)
  • -email is unavailable- added by bjarniig (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only logged-in users can vote.

     

    Follow 11 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-15 gbranden CategoryNone General
        Planned ReleaseNone 1.22.4
    2018-07-02 bgarrigues Open/ClosedOpen Closed
    2017-11-03 gbranden StatusIn Progress Fixed
    2017-11-02 gbranden StatusNeed Info In Progress
    2017-11-01 gbranden StatusNone Need Info
        Assigned toNone gbranden
    2017-09-01 bgarrigues Severity3 - Normal 2 - Minor
        Item GroupNone Documentation
    2017-08-02 bjarniig Attached File- Added 0001-man-groff.7.man-fix-the-name-of-units-and-the-argument.txt.gz, #41388
    2017-07-19 bjarniig Attached File- Added 0001-manuals-fix-writing-of-PostScript.txt.gz, #41238

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code