bugGNU roff - Bugs: bug #53052, manuals: Use correct macro,...

 
 

bug #53052: manuals: Use correct macro, "BR" or "B" in a macro ("esc" and "EnvVar")

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Fri 02 Feb 2018 10:44:29 PM UTC
   
 
Category:  Core Severity:  2 - Minor
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.23.0
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 15 Jun 2022 02:31:45 PM UTC, comment #5: 

As noted by Bjarni in comment #4, my steamroller eventually flattened these issues in its own way.

G. Branden Robinson <gbranden>
Group administrator
Fri 18 Dec 2020 04:25:15 AM UTC, comment #4: 

Thanks for doing the research, Bjarni!

Resolving.

G. Branden Robinson <gbranden>
Group administrator
Thu 17 Dec 2020 11:36:39 PM UTC, comment #3: 

1) The issue in "man/groff.7.man" was fixed with commit

5d2d67ad53af3aa960c0a29a40928e54bc248507

from 14th November 2020.

2) src/roff/groff/groff.1.man

a) The macro ".EnvVar" was removed in commit

84fb9f9f6f4bdc2d36688038011216693e44087f

from 13th November 2020.

b) the misuse of the ".BR" macro was corrected in commit

253d2295cbc6b1556f52ef45e9a70f18c4b319c5

from 19th November 2018.

  This ticket (#53052 from 2nd February 2018) can thus be closed as
being fixed.

Bjarni Ingi Gislason <bjarniig>
Sun 04 Mar 2018 12:36:10 AM UTC, comment #2: 

  There is nothing wrong with the content of the patch.
It is based on and uses more knowledge than the current code.
It is thus superior to the current code.

  There is no data to support your claims.  Should people simply accept
that as true, without any facts or references?

  Is that a good best current practice?  What about the future?

  Is this project based on or accepts non-science?

  Is the policy: if not wrong(?), it may (shall) not be made better?

###

Herman Rubin in the Usenet forum "misc.education":

In the sciences, authority counts for little.  Quoting
Newton will not avail, unless he was correct in that
instance.  He was not always correct.

###

>I know people who can pass tests and get full scholarships to college
>who make bad decisions.  I don't think the ability to puke information
>onto a bubble sheet is going to help a person make a decision.


I agree.  Making decisions requires thinking, and this is not
developed my memorization and routine manipulations.  What is
needed is getting general principles, and having to decide when
and how to apply them in situations other than those in class
or in the textbooks.

We have far too many bureaucrats in decision making positions
who can only go by the book, or try to impose a "moral" version
which is certainly not within their authority.

Bjarni Ingi Gislason <bjarniig>
Fri 16 Feb 2018 11:13:33 PM UTC, comment #1: 

This should be rejected.  There is nothing wrong with the code Bjarni suggests to change, except that in general, manual pages ought to refrain from using the .de request.

Ingo Schwarze <schwarze>
Group Member
Fri 02 Feb 2018 10:44:29 PM UTC, original submission:  


From 8238a9202a42d8d8134552c75b1186b1228f8e9d Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Fri, 2 Feb 2018 22:34:34 +0000
Subject: [PATCH] manuals: Use correct macro, "BR" or "B" in a macro ("esc" and
 "EnvVar")

groff.1.man:
  Additionally correct ".BR X" to ".B X"

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff.7.man            | 7 ++++++-
 src/roff/groff/groff.1.man | 9 +++++++--
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/man/groff.7.man b/man/groff.7.man
index 84a3de2d..18e1dd77 100644
--- a/man/groff.7.man
+++ b/man/groff.7.man
@@ -161,7 +161,12 @@ groff \- a short reference for the GNU roff language
 .\" Result  : prints \name, where 'name' is in B, 'punct' in R
 .\"
 .de esc
-.  BR "\e\\$1" \\$2
+.  ie \\n[.$]<2 \{\
+.    B "\e\\$1"
+.  \}
+.  el \{\
+.    BR "\e\\$1" \\$2
+.  \}
 ..
 .\" ====================================================================
 .\" .escarg name arg [punct]
diff --git a/src/roff/groff/groff.1.man b/src/roff/groff/groff.1.man
index 16a2c262..6cc076c3 100644
--- a/src/roff/groff/groff.1.man
+++ b/src/roff/groff/groff.1.man
@@ -40,7 +40,12 @@ groff \- front-end for the groff document formatting system
 .\" Environment variable
 .de EnvVar
 .  SM
-.  BR \%\\$1 \\$2
+.  ie \n[.$]<2 \{\
+.    B \%\\$1
+.  \}
+.  el \{\
+.    BR \%\\$1 \\$2
+.  \}
 ..
 .\" ====================================================================
 .\" 'char or string'
@@ -809,7 +814,7 @@ The
 .I physical
 paper size, giving the actual dimensions of the paper sheets, is
 controlled by output devices like
-.BR grops
+.B grops
 with the command-line options
 .B \-p
 and
--
2.15.1


Bjarni Ingi Gislason <bjarniig>

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

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 schwarze (Posted a comment)
  • -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 8 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-15 gbranden CategoryNone Core
        Summary[PATCH] manuals: Use correct macro, &quot;BR&quot; or &quot;B&quot; in a macro (&quot;esc&quot; and &quot;EnvVar&quot;) manuals: Use correct macro, "BR" or "B" in a macro ("esc" and "EnvVar")
    2020-12-18 gbranden Severity1 - Wish 2 - Minor
        StatusNone Fixed
        Assigned toNone gbranden
        Open/ClosedOpen Closed
        Planned ReleaseNone 1.23.0
    2018-02-16 schwarze Severity3 - Normal 1 - Wish

    Back to the top

    Powered by Savane 3.13-f8d8.
    Corresponding source code