bugmake - Bugs: bug #56420, Unclear wording or missing word

 
 

bug #56420: Unclear wording or missing word

Submitter:  None
Submitted:  Thu 30 May 2019 08:15:34 PM UTC
   
 
Severity:  3 - Normal Item Group:  Documentation
Status:  Wont Fix Privacy:  Public
Assigned to:  None Open/Closed:  Closed
Component Version:  None Operating System:  None
Fixed Release:  None Triage Status:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Sun 25 Aug 2019 05:23:22 AM UTC, comment #2: 

Thanks for this report.

I agree with Martin, that the proposed change would be more clear.

However, the problem is that, as you can see by the path in the patch below, the make-stds.texi file is not part of the GNU make project; it's part of the gnulib project.

GNU make builds simply take this file from the gnulib project and include it verbatim in its distribution.

So if you want this wording changed you'll need to file a bug against gnulib which can be done on their mailing list: http://lists.gnu.org/mailman/listinfo/bug-gnulib

Paul D. Smith <psmith>
Group administrator
Thu 30 May 2019 09:22:39 PM UTC, comment #1: 

The context, specifically the start of the previous paragraph:

> If there are C compiler options that must be used for proper compilation of certain files, do not include them in CFLAGS.

...

> Do include the ‘-g’ option in CFLAGS, because that is not required for proper compilation.


... tells us that the OP is wrong to think, if they do, that "Don't" was intended.  Perhaps this would make the contrast clearer:


martind@swiftboat:~/download/make-git/gnulib/doc$ git diff
diff --git a/doc/make-stds.texi b/doc/make-stds.texi
index d37b244..c390ffe 100644
--- a/doc/make-stds.texi
+++ b/doc/make-stds.texi
@@ -254,7 +254,7 @@ ALL_CFLAGS = -I. $(CFLAGS)
         $(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
 @end smallexample

-Do include the @samp{-g} option in @code{CFLAGS}, because that is not
+Do, however, include the @samp{-g} option in @code{CFLAGS}, because that is not
 @emph{required} for proper compilation.  You can consider it a default
 that is only recommended.  If the package is set up so that it is
 compiled with GCC by default, then you might as well include @samp{-O}
martind@swiftboat:~/download/make-git/gnulib/doc$


Martin Dorey <mdorey>
Thu 30 May 2019 08:15:34 PM UTC, original submission:  

About halfway through section 16.3 of the GNU make manual (https://www.gnu.org/software/make/manual/make.html), it says "Do include the ‘-g’ option in CFLAGS, because that is not required for proper compilation. You can consider it a default that is only recommended. If the package is set up so that it is compiled with GCC by default, then you might as well include ‘-O’ in the default value of CFLAGS as well."

The surrounding wording strongly implies that the "Do" at the beginning of the quoted section was supposed to be "Don't". Please clarify this.

Anonymous

 

(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 psmith (Posted a comment)
  • -email is unavailable- added by mdorey (Posted a comment)
  •  

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

    Date Changed by Updated Field Previous Value => Replaced by
    2019-08-25 psmith StatusNone Wont Fix
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code