diff options
author | Joseph Myers <jsm@polyomino.org.uk> | 2004-07-03 00:57:12 +0100 |
---|---|---|
committer | Joseph Myers <jsm28@gcc.gnu.org> | 2004-07-03 00:57:12 +0100 |
commit | 962e6e00c1d8cc493defec4e83222eb3b2d1fe72 (patch) | |
tree | 958b578b1dceccdb7246fb9f76df3bb9c636e4e2 /gcc/doc/trouble.texi | |
parent | d9634d537130407bc8ea2ada9508e2386e1b714b (diff) | |
download | gcc-962e6e00c1d8cc493defec4e83222eb3b2d1fe72.zip gcc-962e6e00c1d8cc493defec4e83222eb3b2d1fe72.tar.gz gcc-962e6e00c1d8cc493defec4e83222eb3b2d1fe72.tar.bz2 |
bugreport.texi, [...]: Avoid some first-person references and patronizing comments.
* doc/bugreport.texi, doc/configterms.texi, doc/contrib.texi,
doc/contribute.texi, doc/cpp.texi, doc/cppinternals.texi,
doc/extend.texi, doc/install.texi, doc/invoke.texi, doc/md.texi,
doc/portability.texi, doc/tree-ssa.texi, doc/trouble.texi: Avoid
some first-person references and patronizing comments. Based on
printed manual.
* doc/invoke.texi: Don't reference fortran@gnu.org.
* doc/trouble.texi (Warning when a non-void function value is
ignored): Rewrite. From Russ Allbery and Chris Devers.
From-SVN: r84034
Diffstat (limited to 'gcc/doc/trouble.texi')
-rw-r--r-- | gcc/doc/trouble.texi | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/gcc/doc/trouble.texi b/gcc/doc/trouble.texi index c28f9a2..39273c3 100644 --- a/gcc/doc/trouble.texi +++ b/gcc/doc/trouble.texi @@ -129,7 +129,7 @@ Older GDB versions sometimes fail to read the output of GCC version DBX rejects some files produced by GCC, though it accepts similar constructs in output from PCC@. Until someone can supply a coherent description of what is valid DBX input and what is not, there is -nothing I can do about these problems. You are on your own. +nothing that can be done about these problems. @item The GNU assembler (GAS) does not support PIC@. To generate PIC code, you @@ -509,8 +509,7 @@ ISO C does not permit such a construct. @item K&R compilers allow comments to cross over an inclusion boundary -(i.e.@: started in an include file and ended in the including file). I think -this would be quite ugly and can't imagine it could be needed. +(i.e.@: started in an include file and ended in the including file). @cindex external declaration scope @cindex scope of external declarations @@ -1242,11 +1241,16 @@ more annoyance than good. @item Warning when a non-void function value is ignored. -Coming as I do from a Lisp background, I balk at the idea that there is -something dangerous about discarding a value. There are functions that -return values which some callers may find useful; it makes no sense to -clutter the program with a cast to @code{void} whenever the value isn't -useful. +C contains many standard functions that return a value that most +programs choose to ignore. One obvious example is @code{printf}. +Warning about this practice only leads the defensive programmer to +clutter programs with dozens of casts to @code{void}. Such casts are +required so frequently that they become visual noise. Writing those +casts becomes so automatic that they no longer convey useful +information about the intentions of the programmer. For functions +where the return value should never be ignored, use the +@code{warn_unused_result} function attribute (@pxref{Function +Attributes}). @item @opindex fshort-enums |