bugGNU troff - Bugs: bug #47784, doc bug: troff.1 gives misleading...

 
 

bug #47784: doc bug: troff.1 gives misleading definition of "all" for "-w all".

Submitted by:  Kaz Kylheku <kkylheku>
Submitted on:  Mon 25 Apr 2016 06:03:18 PM UTC  
 
Category: NoneSeverity: 2 - Minor
Item Group: Incorrect behaviourStatus: Fixed
Privacy: PublicAssigned to: None
Open/Closed: ClosedPlanned Release: None

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Tue 29 Aug 2017 09:40:52 PM UTC, comment #1:

Commited on master.

Bertrand Garrigues <bgarrigues>
Project Administrator
Mon 25 Apr 2016 06:03:18 PM UTC, original submission:

In the troff man page, the meaning of "all" is clearly described as not, in fact, inclusive of all warnings, but rather most warnings. This definition is given in the WARNINGS section, after the table of warnings.

However, there is a forward reference to "all" in the description of the -w option, where it is stated that "[F]or example, to enable all warnings, use -w all." This is giving the reader an incorrect implicit definition of what "all" means.

Someone looking for the warning option might see this first, then then scroll down to the table of warnings, and then assume that all those warnings are what "all warnings" refers to.

But, alas, some important errors such as undefined macros are not diagnosed by -w all, because "all" excludes "mac".

A suggested text might be. "To enable most warnings use -wwall. Absolutely all warnings are enabled with -ww."

Kaz Kylheku <kkylheku>

 

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

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by bgarrigues (Posted a comment)
  • -unavailable- added by kkylheku (Submitted the item)
  •  

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

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Tue 29 Aug 2017 09:40:52 PM UTCbgarriguesSeverity3 - Normal=>2 - Minor
      StatusNone=>Fixed
      Open/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup1