bugGNU roff - Bugs: bug #47784, troff(1) gives misleading...

 
 

bug #47784: troff(1) gives misleading definition of "all" for "-w all"

Submitter:  Kaz Kylheku <kkylheku>
Submitted:  Mon 25 Apr 2016 06:03:18 PM UTC
   
 
Category:  Core Severity:  2 - Minor
Item Group:  Documentation Status:  Fixed
Privacy:  Public Assigned to:  bgarrigues
Open/Closed:  Closed Planned Release:  1.22.4
* Mandatory Fields

Add a New Comment Rich Markup
   

Wed 15 Jun 2022 06:39:12 PM UTC, comment #2: 


commit 8ca41399a2449fe5d619a6edd292c127c891f4e7
Author: Bertrand Garrigues <bertrand.garrigues@laposte.net>
Date:   Mon Aug 28 23:16:38 2017 +0200

    Fix troff.1 misleading definition of -w all.

    See bug at https://savannah.gnu.org/bugs/?47784.  Suggested by Kaz
    Kylheku <kaz@kylheku.com>.


G. Branden Robinson <gbranden>
Group administrator
Tue 29 Aug 2017 09:40:52 PM UTC, comment #1: 

Commited on master.

Bertrand Garrigues <bgarrigues>
Group 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 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 bgarrigues (Posted a comment)
  • -email is unavailable- added by kkylheku (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
    2023-04-01 gbranden Item GroupIncorrect behaviour Documentation
        Summarydoc bug: troff.1 gives misleading definition of &quot;all&quot; for &quot;-w all&quot;. troff(1) gives misleading definition of "all" for "-w all"
    2023-04-01 gbranden Planned ReleaseNone 1.22.4
    2022-06-15 gbranden Assigned toNone bgarrigues
    2022-06-15 gbranden CategoryNone Core
    2017-08-29 bgarrigues Severity3 - Normal 2 - Minor
        StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-3230.
    Corresponding source code