bugGNU troff - Bugs: bug #53790, [man pages] avoid repetition of...

 
 

bug #53790: [man pages] avoid repetition of long strings (paths)

Submitter:  Bjarni Ingi Gislason <bjarniig>
Submitted:  Mon 30 Apr 2018 03:02:05 AM UTC
 
Category:  General Severity:  1 - Wish
Item Group:  Lint Status:  Invalid
Privacy:  Public Assigned to:  gbranden
Open/Closed:  Closed Planned Release:  1.22.4
* Mandatory Fields

Add a New Comment (Rich Markup)
   

Comment Type & Canned Response:
       No canned response available

 

Sun 04 Nov 2018 07:58:56 PM UTC, comment #1: 

I'm rejecting this one because I think having full paths in the man pages is useful.

The page-local .Tp macros were ugly; however, I got rid of them back in June with a commit specific to that purpose:

commit 0013a2e010a26f242925b33f8e66be83ebb23ef1
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
Date:   Mon Jun 18 01:30:23 2018 -0400

    man pages: Stop using .TP for ersatz tables.

    Remove gratuitous calculated indent setting and page-local macro ("Tp")
    often used to facilitate it.  The pages that use this trick do it as a
    way to simulate a 2-column table.

    This is a generalization of the fix to Savannah #53797, in which Bjarni
    Ingli Gislason noted one instance in refer(1).

    Impact on nroff output with 80 columns:

    man/groff_font.5:
    * All 3 items in the list of additional font file commands are
      consistently rendered with a hanging tag (before, none were).

    src/preproc/eqn/eqn.1:
    * Use a 2-column tbl(1) table to describe component types.  (Looks good
      in -Tpdf as well.)  I also recast some wording that confused me, after
      consulting src/preproc/eqn/text.cpp to check my understanding.

    src/preproc/refer/refer.1:
    * All items in the list of refer commends now have a hanging tag (some
      did before, but the overall indent was much farther to the right).
    * File paragraphs in the FILES section now have mixed hangs.

    src/roff/troff/troff.1:
    * Flag paragraphs in the OPTIONS section how have mixed hangs.

    src/utils/indxbib/indxbib.1:
    src/utils/lkbib/lkbib.1:
    src/utils/lookbib/lookbib.1:
    * File paragraphs in the FILES section now have mixed hangs.

    man/groff_font.5:
    src/devices/gropdf/gropdf.1:
    src/devices/grops/grops.1:
    src/preproc/grn/grn.1:
    src/preproc/pic/pic.1:
    src/utils/tfmtodit/tfmtodit.1:
    * No visible impact.

    Signed-off-by: G. Branden Robinson <g.branden.robinson@gmail.com>

G. Branden Robinson <gbranden>
Project Administrator
Mon 30 Apr 2018 03:02:05 AM UTC, original submission:  

From 4eb7370e2efa8de3f321dec3ad3bbd80e26a1342 Mon Sep 17 00:00:00 2001
From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
Date: Mon, 30 Apr 2018 02:54:46 +0000
Subject: [PATCH] man pages: Avoid repetition of long strings (paths)

  Show (use) a repeated long string (path) only once.

  Remove the then unused internal macro "Tp".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
---
 man/groff_font.5.man              | 14 +++++--------
 src/devices/grodvi/grodvi.1.man   | 17 ++++++++++------
 src/devices/gropdf/gropdf.1.man   | 30 +++++++++++++--------------
 src/devices/grops/grops.1.man     | 34 +++++++++++++++----------------
 src/preproc/eqn/eqn.1.man         | 14 ++++---------
 src/preproc/grn/grn.1.man         | 13 ++++--------
 src/preproc/pic/pic.1.man         | 13 ++++--------
 src/utils/tfmtodit/tfmtodit.1.man |  8 +++++---
 8 files changed, 64 insertions(+), 79 deletions(-)

  The patch is in the attachment.

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 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 9 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-06-10 gbranden Summary[PATCH] man pages: Avoid repetition of long strings (paths) [man pages] avoid repetition of long strings (paths)
    2022-03-05 gbranden CategoryNone General
        Item GroupFeature change Lint
        Planned ReleaseNone 1.22.4
    2018-11-04 gbranden Severity3 - Normal 1 - Wish
        StatusNone Invalid
        Assigned toNone gbranden
        Open/ClosedOpen Closed
    2018-04-30 bjarniig Attached File- Added 0001-man-pages-Avoid-repetition-of-long-strings-paths.txt, #44060

    Back to the top


    Powered by Savane 3.9