bugGNU troff - Bugs: bug #57498, [PATCH] nroff documentation...

 
 

bug #57498: [PATCH] nroff documentation housekeeping

Submitted by:  Dave <barx>
Submitted on:  Sun 29 Dec 2019 03:44:56 PM UTC  
 
Category:  Device - others Severity:  2 - Minor
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  Ingo Schwarze <schwarze>
Open/Closed:  Closed Planned Release:  1.22.5

Add a New Comment (Rich Markup)
   

You are not logged in

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

 

Sun 09 Feb 2020 12:59:04 AM UTC, comment #2: 

original submission:

> The patch also updates the order in which options are listed in the usage statement to match that of the man page.  (Commit ee0ce46b3 changed this order in the man page, for reasons not entirely clear: the log statement says "Sort lists of options in locale collation order," but the man page and the usage statement both ignore the user's current locale and hard-code the order of their lists.  Nevertheless, for consistency the order should be the same in both places.)


You're right--that's not clear.

What I meant was the locale collation order for en_US, since that is the language (and territorial variant) in which the man page is written.

G. Branden Robinson <gbranden>
Project Administrator
Sun 29 Dec 2019 05:54:21 PM UTC, comment #1: 

pushed as 67ca092b840dead8233a73d8ef85f06efd681b82 and 7d64486a24179ea3dfc1d77d61d9bedbcdc6185a, thanks

Ingo Schwarze <schwarze>
Project MemberIn charge of this item.
Sun 29 Dec 2019 03:44:56 PM UTC, original submission:  

The SYNOPSIS section of the nroff man page, as well as the usage statement output by "nroff --help", list -v among the other options that can be specified before a filename.  In fact, when -v is specified, any other options and filenames are ignored, so -v should not be here.

-v is a synonym of --version, both of which the SYNOPSIS already documents separately.  The usage statement does not document --version at all, so there is no real need for it to document -v either.

The attached patch removes -v from these erroneous places.

The patch also updates the order in which options are listed in the usage statement to match that of the man page.  (Commit ee0ce46b3 changed this order in the man page, for reasons not entirely clear: the log statement says "Sort lists of options in locale collation order," but the man page and the usage statement both ignore the user's current locale and hard-code the order of their lists.  Nevertheless, for consistency the order should be the same in both places.)

Dave <barx>

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #48136:  nroff.patch added by barx (849B - text/x-patch)

 

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 barx (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.

     

     

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2019-12-29 schwarze Severity3 - Normal => 2 - Minor
        StatusNone => Fixed
        Assigned toNone => schwarze
        Open/ClosedOpen => Closed
        Planned ReleaseNone => 1.22.5
    2019-12-29 barx Attached File- => Added nroff.patch, #48136

    Back to the top


    Powered by Savane 3.5