bugGNU troff - Bugs: bug #52521, [PATCH] contrib/.../man pages:...

 
 

bug #52521: [PATCH] contrib/.../man pages: Remove unnecessary ".nh/.hy" pairs

Submitted by:  Bjarni Ingi Gislason <bjarniig>
Submitted on:  Sun 26 Nov 2017 09:13:49 PM UTC  
 
Category:  None Severity:  3 - Normal
Item Group:  Documentation Status:  None
Privacy:  Public Assigned to:  None
Open/Closed:  Open Planned Release:  None

Add a New Comment (Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

Tue 28 Nov 2017 05:07:27 PM UTC, comment #4: 

Regarding Bjarni's suggestion to add comments 'The original had a ".nh/.hy" pair without any explanation (why?)':

Well the intention of the author is obvious:  They didn't want placeholders to be hyphenated, if anybody would run man(1) with hyphenation enabled (which hopefully nobody does anyway).

So just zap the .nh/.hy without adding any \% or comments.
No manual page should manipulate such gory low-level details.

Ingo Schwarze <schwarze>
Project Member
Tue 28 Nov 2017 03:05:35 AM UTC, comment #3: 

From 40a961f19f2be6f8a44b90daf6d6ad11bb8720df Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Tue, 28 Nov 2017 02:59:52 +0000
Subject: [PATCH] groffer.1.man: Some ".nh/.hy/" pairs were left behind.

  Remove the rest of unexplained ".nh/.hy" pairs and add '\%' were
appropriate

  Fix an option.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
contrib/groffer/groffer.1.man | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)

diff --git a/contrib/groffer/groffer.1.man b/contrib/groffer/groffer.1.man
index 3b25a3a1..a49ad620 100644
--- a/contrib/groffer/groffer.1.man
+++ b/contrib/groffer/groffer.1.man
@@ -2525,9 +2525,9 @@ it is specified in the \%\f(CRPOSIX\~1003.1\fP based format:
'fi
.P
but the two-letter code in
-.nh
-.I <language>
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.I \%<language>
is sufficient for most purposes.
.
If for a complicated
@@ -2995,15 +2995,15 @@ retrieving
.IR \%man\~pages .
.
A locale name is typically of the form
-.nh
-.IR language [\c
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.IR \%language [\c
.B _\c
-.IR territory [\c
+.IR \%territory [\c
.B .\c
-.IR codeset [\c
+.IR \%codeset [\c
.B @\c
-.IR modifier ]]],
-.hy
+.IR \%modifier ]]],
where
.I \%language
is an ISO 639 language code,
@@ -3301,7 +3301,8 @@ or
.
.P
.ft CR
-.nh
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" that was removed, as the ".nf/.fi" is enough
.nf
# groffer configuration file
#
@@ -3310,7 +3311,6 @@ or
\-\-resolution=100
\-\-viewer=gxditview \-geometry 900x1200
.fi
-.hy
.ft
.
.
@@ -3478,9 +3478,9 @@ and
(in the section with the lowest number, being\~7 in this case).
.
The quotes around
-.nh
-.I \(cqtroff(1)\(cq
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.I \%\(cqtroff(1)\(cq
are necessary because the parentheses are special shell characters;
escaping them with a backslash character
.I \(rs(
@@ -3506,9 +3506,9 @@ program, decompress it, format it to
or
.I \%xhtml
format
-.nh
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" that was removed
.RI ( \%www\~mode )
-.hy
and view the result in the web browser
.BR \%galeon .
The option
@@ -3766,17 +3766,17 @@ Documentation on the
.I \%groff intermediate output
before the run of a
.IR postprocessor .
-.nh
-.RI ( ditroff
-output).
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.RI ( \%ditroff
+\%output).
.
This can be run by the
.B groff
or
.B groffer
option
-.BR -Z .
+.BR \-Z .
.
.
.TP
--
2.15.0

Bjarni Ingi Gislason <bjarniig>
Sun 26 Nov 2017 10:33:30 PM UTC, comment #2: 

  I put the patch in the attachment, with minor change in the prolog.

(file #42494)

Bjarni Ingi Gislason <bjarniig>
Sun 26 Nov 2017 09:21:41 PM UTC, comment #1: 

  As seen in the first line I forgot a '+' at the end.

  The mail I got contains all the spaces so I don't think I will have to resubmitt the report.

Bjarni Ingi Gislason <bjarniig>
Sun 26 Nov 2017 09:13:49 PM UTC, original submission:  

+verbatim
From 10454d6c9c52c301d65872d93ec783d8e565e9ce Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Sun, 26 Nov 2017 21:04:22 +0000
Subject: [PATCH] contrib/.../man pages: Remove unnecessary ".nh/.hy" pairs

  The used ".hy" request changed the value of the '.hy' register to 1,
as that was the default value.

  Use other methods to inhibit possible hyphenations.

  Fix a missing space between arguments for the macro ".BR".

  Remove extra character '<' (my fault in an earlier patch):

7ec6840ad contrib/groffer/groffer.1.man    (Bjarni Ingi Gislason
2017-11-07 01:09:24 +0000   35) <.
1

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 contrib/glilypond/glilypond.1.man |  4 +--
 contrib/groffer/groffer.1.man     | 51 +++++++++++++++++++++------------------
 2 files changed, 28 insertions(+), 27 deletions(-)

diff --git a/contrib/glilypond/glilypond.1.man b/contrib/glilypond/glilypond.1.man
index 7a8bc7fa..134344f7 100644
--- a/contrib/glilypond/glilypond.1.man
+++ b/contrib/glilypond/glilypond.1.man
@@ -119,7 +119,7 @@ it is easier to use the following device options, either
 .
 .BR \-\-ps ,
 .BR \-\-div ,
-.BR \-\-html,
+.BR \-\-html ,
 or
 .BR \-\-xhtml .
 .
@@ -161,7 +161,6 @@ and is called through
 .SS "Breaking Options"
 .\" ====================================================================
 .
-.nh
 .nf
 .TP
 .BR \-? | \-h | \-\-help | \-\-usage
@@ -175,7 +174,6 @@ Print version information.
 .BR \-l | \-\-license
 Print license information.
 .fi
-.hy
 .
 .
 .\" ====================================================================
diff --git a/contrib/groffer/groffer.1.man b/contrib/groffer/groffer.1.man
index e90294e4..3b25a3a1 100644
--- a/contrib/groffer/groffer.1.man
+++ b/contrib/groffer/groffer.1.man
@@ -32,7 +32,7 @@ groffer \- display groff files and man\~pages on X and tty
 .\"
 .\" The license text is available in the internet at
 .\" <http://www.gnu.org/licenses/gpl-2.0.html>.
-<.
+.
 .
 .\" ====================================================================
 .\" Characters
@@ -107,9 +107,9 @@ The
 .B \%groffer
 program also includes many of the features for finding and displaying
 the \%\f(CRUnix\fP manual pages
-.nh
-.RI ( man\~pages ),
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.RI ( \%man\~\%pages ),
 such that it can be used as a replacement for a
 .BR \%man (1)
 program.
@@ -1295,9 +1295,9 @@ The default is looking up for local files.
 .TP
 .B \-\-man
 Check the non-option command-line arguments
-.nh
-.RI ( filespecs )
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?), so
+.\" \% was added
+.RI ( \%filespecs )
 first on being
 .IR \%man\~pages ,
 then whether they represent an existing file.
@@ -2070,25 +2070,25 @@ X Window System viewer programs are
 .
 .IP \*(BU 2m
 in a PDF viewer
-.nh
-.RI ( \%pdf\~mode )
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?).
+.\" This is in a short one line paragraph so this is without any effect
+.RI ( pdf\~mode )
 .
 .IP \*(BU 2m
 in a web browser
-.nh
+.\" The original had a ".nh/.hy" pair without any explanation (why?).
+.\" This is in a short one line paragraph so this is without any effect.
 .RI ( html ,
 .RI ( xhtml ,
 or
-.IR \%www\~mode )
-.hy
+.IR www\~mode )
 .RE
 .
 .IP \*(BU 2m
 in a PostScript viewer
-.nh
-.RI ( \%ps\~mode )
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?)
+.\" This is in a short one line paragraph so this is without any effect
+.RI ( ps\~mode )
 .
 .IP \*(BU 2m
 X Window System
@@ -2102,9 +2102,9 @@ or
 .
 .IP \*(BU 2m
 in a DVI viewer program
-.nh
-.RI ( \%dvi\~mode )
-.hy
+.\" The original had a ".nh/.hy" pair without any explanation (why?)
+.\" This is in a short one line paragraph so this is without any effect
+.RI ( dvi\~mode )
 .
 .
 .P
@@ -2231,10 +2231,10 @@ In
 the option
 .B \-Z
 disables post-processing, thus producing the
-.nh
-.I groff intermediate
+.\" The original had a ".nh/.hy" pair without any explanations (why)
+.\" so \% was added
+.I \%groff \%intermediate
 .IR output .
-.hy
 .
 In this mode, the input is formatted, but not postprocessed; see
 .BR \%groff_out (@MAN5EXT@)
@@ -2516,10 +2516,13 @@ In \f(CRGNU\fP
 .BR man ,
 it is specified in the \%\f(CRPOSIX\~1003.1\fP based format:
 .P
-.nh
+.\" The one-liner is inside a paragraph so no-filling is enough
+.\" to inhibit the hypenation caused by the minus-hyphen character
+.\" The original had just ".hy" which made register .hy = 1
+'nf
 \fI<language>\/\fP[\f(CB_\fP\,\fI<territory>\/\fP[\f(CB.\fP\
 \fI<character-set>\/\fP[\f(CB,\fP\,\fI<version>\/\fP]]],
-.hy
+'fi
 .P
 but the two-letter code in
 .nh
--
2.15.0

-verbatim-

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 schwarze (Posted a comment)
  • -email is unavailable- added by bjarniig (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2017-11-26 bjarniig Attached File- => Added 0001-contrib-.-man-pages-Remove-unnecessary-.nh-.hy-pairs.txt, #42494

    Back to the top


    Powered by Savane 3.5