OSDN Git Service

Add missing docs for feature added by Richard Henderson.
[pf3gnuchains/gcc-fork.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21      A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstack-protector @gol
242 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
243 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
244 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
245 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
246 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
247 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
248 -Wwrite-strings}
249
250 @item C-only Warning Options
251 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
252 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
253 -Wstrict-prototypes  -Wtraditional @gol
254 -Wdeclaration-after-statement -Wno-pointer-sign}
255
256 @item Debugging Options
257 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
258 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
259 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
260 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
261 -fdump-ipa-all -fdump-ipa-cgraph @gol
262 -fdump-tree-all @gol
263 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
264 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
267 -fdump-tree-ch @gol
268 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-nrv -fdump-tree-vect @gol
277 -fdump-tree-sink @gol
278 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-salias @gol
280 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
282 -ftree-vectorizer-verbose=@var{n} @gol
283 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
284 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
285 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
286 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
287 -ftest-coverage  -ftime-report -fvar-tracking @gol
288 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
289 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
290 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
291 -print-multi-directory  -print-multi-lib @gol
292 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
293 -save-temps  -time}
294
295 @item Optimization Options
296 @xref{Optimize Options,,Options that Control Optimization}.
297 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
298 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
299 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
300 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
301 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
302 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
303 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
304 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
305 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
306 -fforce-addr  -ffunction-sections @gol
307 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
308 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
309 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
310 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
311 -fmodulo-sched -fno-branch-count-reg @gol
312 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
313 -fno-function-cse  -fno-guess-branch-probability @gol
314 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
315 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
316 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
317 -fomit-frame-pointer  -foptimize-register-move @gol
318 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
319 -fprofile-generate -fprofile-use @gol
320 -fregmove  -frename-registers @gol
321 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
322 -frerun-cse-after-loop  -frerun-loop-opt @gol
323 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
324 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
325 -fsched-spec-load-dangerous  @gol
326 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
327 -fsched2-use-superblocks @gol
328 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
329 -fsignaling-nans -fsingle-precision-constant  @gol
330 -fstack-protector  -fstack-protector-all @gol
331 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
332 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
333 -fsplit-ivs-in-unroller -funswitch-loops @gol
334 -fvariable-expansion-in-unroller @gol
335 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
336 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
337 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
338 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
339 -ftree-salias -fweb @gol
340 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
341 --param @var{name}=@var{value}
342 -O  -O0  -O1  -O2  -O3  -Os}
343
344 @item Preprocessor Options
345 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
346 @gccoptlist{-A@var{question}=@var{answer} @gol
347 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
348 -C  -dD  -dI  -dM  -dN @gol
349 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
350 -idirafter @var{dir} @gol
351 -include @var{file}  -imacros @var{file} @gol
352 -iprefix @var{file}  -iwithprefix @var{dir} @gol
353 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
354 -isysroot @var{dir} @gol
355 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
356 -P  -fworking-directory  -remap @gol
357 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
358 -Xpreprocessor @var{option}}
359
360 @item Assembler Option
361 @xref{Assembler Options,,Passing Options to the Assembler}.
362 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
363
364 @item Linker Options
365 @xref{Link Options,,Options for Linking}.
366 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
367 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
368 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
369 -Wl,@var{option}  -Xlinker @var{option} @gol
370 -u @var{symbol}}
371
372 @item Directory Options
373 @xref{Directory Options,,Options for Directory Search}.
374 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
375 -specs=@var{file}  -I- --sysroot=@var{dir}}
376
377 @item Target Options
378 @c I wrote this xref this way to avoid overfull hbox. -- rms
379 @xref{Target Options}.
380 @gccoptlist{-V @var{version}  -b @var{machine}}
381
382 @item Machine Dependent Options
383 @xref{Submodel Options,,Hardware Models and Configurations}.
384 @c This list is ordered alphanumerically by subsection name.
385 @c Try and put the significant identifier (CPU or system) first,
386 @c so users have a clue at guessing where the ones they want will be.
387
388 @emph{ARC Options}
389 @gccoptlist{-EB  -EL @gol
390 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
391 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
392
393 @emph{ARM Options}
394 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
395 -mabi=@var{name} @gol
396 -mapcs-stack-check  -mno-apcs-stack-check @gol
397 -mapcs-float  -mno-apcs-float @gol
398 -mapcs-reentrant  -mno-apcs-reentrant @gol
399 -msched-prolog  -mno-sched-prolog @gol
400 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
401 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
402 -mthumb-interwork  -mno-thumb-interwork @gol
403 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
404 -mstructure-size-boundary=@var{n} @gol
405 -mabort-on-noreturn @gol
406 -mlong-calls  -mno-long-calls @gol
407 -msingle-pic-base  -mno-single-pic-base @gol
408 -mpic-register=@var{reg} @gol
409 -mnop-fun-dllimport @gol
410 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
411 -mpoke-function-name @gol
412 -mthumb  -marm @gol
413 -mtpcs-frame  -mtpcs-leaf-frame @gol
414 -mcaller-super-interworking  -mcallee-super-interworking}
415
416 @emph{AVR Options}
417 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
418 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
419
420 @emph{Blackfin Options}
421 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
422 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
423 -mlow-64k -mno-low64k -mid-shared-library @gol
424 -mno-id-shared-library -mshared-library-id=@var{n} @gol
425 -mlong-calls  -mno-long-calls}
426
427 @emph{CRIS Options}
428 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
429 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
430 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
431 -mstack-align  -mdata-align  -mconst-align @gol
432 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
433 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
434 -mmul-bug-workaround  -mno-mul-bug-workaround}
435
436 @emph{CRX Options}
437 @gccoptlist{-mmac -mpush-args}
438
439 @emph{Darwin Options}
440 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
441 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
442 -client_name  -compatibility_version  -current_version @gol
443 -dead_strip @gol
444 -dependency-file  -dylib_file  -dylinker_install_name @gol
445 -dynamic  -dynamiclib  -exported_symbols_list @gol
446 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
447 -force_flat_namespace  -headerpad_max_install_names @gol
448 -image_base  -init  -install_name  -keep_private_externs @gol
449 -multi_module  -multiply_defined  -multiply_defined_unused @gol
450 -noall_load   -no_dead_strip_inits_and_terms @gol
451 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
452 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
453 -private_bundle  -read_only_relocs  -sectalign @gol
454 -sectobjectsymbols  -whyload  -seg1addr @gol
455 -sectcreate  -sectobjectsymbols  -sectorder @gol
456 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
457 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
458 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
459 -single_module  -static  -sub_library  -sub_umbrella @gol
460 -twolevel_namespace  -umbrella  -undefined @gol
461 -unexported_symbols_list  -weak_reference_mismatches @gol
462 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
463 -mone-byte-bool}
464
465 @emph{DEC Alpha Options}
466 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
467 -mieee  -mieee-with-inexact  -mieee-conformant @gol
468 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
469 -mtrap-precision=@var{mode}  -mbuild-constants @gol
470 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
471 -mbwx  -mmax  -mfix  -mcix @gol
472 -mfloat-vax  -mfloat-ieee @gol
473 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
474 -msmall-text  -mlarge-text @gol
475 -mmemory-latency=@var{time}}
476
477 @emph{DEC Alpha/VMS Options}
478 @gccoptlist{-mvms-return-codes}
479
480 @emph{FRV Options}
481 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
482 -mhard-float  -msoft-float @gol
483 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
484 -mdouble  -mno-double @gol
485 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
486 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
487 -mlinked-fp  -mlong-calls  -malign-labels @gol
488 -mlibrary-pic  -macc-4  -macc-8 @gol
489 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
490 -moptimize-membar -mno-optimize-membar @gol
491 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
492 -mvliw-branch  -mno-vliw-branch @gol
493 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
494 -mno-nested-cond-exec  -mtomcat-stats @gol
495 -mTLS -mtls @gol
496 -mcpu=@var{cpu}}
497
498 @emph{H8/300 Options}
499 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
500
501 @emph{HPPA Options}
502 @gccoptlist{-march=@var{architecture-type} @gol
503 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
504 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
505 -mfixed-range=@var{register-range} @gol
506 -mjump-in-delay -mlinker-opt -mlong-calls @gol
507 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
508 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
509 -mno-jump-in-delay  -mno-long-load-store @gol
510 -mno-portable-runtime  -mno-soft-float @gol
511 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
512 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
513 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
514 -munix=@var{unix-std}  -nolibdld  -static  -threads}
515
516 @emph{i386 and x86-64 Options}
517 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
518 -mfpmath=@var{unit} @gol
519 -masm=@var{dialect}  -mno-fancy-math-387 @gol
520 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
521 -mno-wide-multiply  -mrtd  -malign-double @gol
522 -mpreferred-stack-boundary=@var{num} @gol
523 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
524 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
525 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
526 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
527 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
528 -mcmodel=@var{code-model} @gol
529 -m32  -m64 -mlarge-data-threshold=@var{num}}
530
531 @emph{IA-64 Options}
532 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
533 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
534 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
535 -minline-float-divide-max-throughput @gol
536 -minline-int-divide-min-latency @gol
537 -minline-int-divide-max-throughput  @gol
538 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
539 -mno-dwarf2-asm -mearly-stop-bits @gol
540 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
541 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
542
543 @emph{M32R/D Options}
544 @gccoptlist{-m32r2 -m32rx -m32r @gol
545 -mdebug @gol
546 -malign-loops -mno-align-loops @gol
547 -missue-rate=@var{number} @gol
548 -mbranch-cost=@var{number} @gol
549 -mmodel=@var{code-size-model-type} @gol
550 -msdata=@var{sdata-type} @gol
551 -mno-flush-func -mflush-func=@var{name} @gol
552 -mno-flush-trap -mflush-trap=@var{number} @gol
553 -G @var{num}}
554
555 @emph{M32C Options}
556 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
557
558 @emph{M680x0 Options}
559 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
560 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
561 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
562 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
563 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
564
565 @emph{M68hc1x Options}
566 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
567 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
568 -msoft-reg-count=@var{count}}
569
570 @emph{MCore Options}
571 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
572 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
573 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
574 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
575 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
576
577 @emph{MIPS Options}
578 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
579 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
580 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
581 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
582 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
583 -mdsp  -mpaired-single  -mips3d @gol
584 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
585 -G@var{num}  -membedded-data  -mno-embedded-data @gol
586 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
587 -msplit-addresses  -mno-split-addresses  @gol
588 -mexplicit-relocs  -mno-explicit-relocs  @gol
589 -mcheck-zero-division  -mno-check-zero-division @gol
590 -mdivide-traps  -mdivide-breaks @gol
591 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
592 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
593 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
594 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
595 -mfix-sb1  -mno-fix-sb1 @gol
596 -mflush-func=@var{func}  -mno-flush-func @gol
597 -mbranch-likely  -mno-branch-likely @gol
598 -mfp-exceptions -mno-fp-exceptions @gol
599 -mvr4130-align -mno-vr4130-align}
600
601 @emph{MMIX Options}
602 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
603 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
604 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
605 -mno-base-addresses  -msingle-exit  -mno-single-exit}
606
607 @emph{MN10300 Options}
608 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
609 -mam33  -mno-am33 @gol
610 -mam33-2  -mno-am33-2 @gol
611 -mno-crt0  -mrelax}
612
613 @emph{PDP-11 Options}
614 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
615 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
616 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
617 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
618 -mbranch-expensive  -mbranch-cheap @gol
619 -msplit  -mno-split  -munix-asm  -mdec-asm}
620
621 @emph{PowerPC Options}
622 See RS/6000 and PowerPC Options.
623
624 @emph{RS/6000 and PowerPC Options}
625 @gccoptlist{-mcpu=@var{cpu-type} @gol
626 -mtune=@var{cpu-type} @gol
627 -mpower  -mno-power  -mpower2  -mno-power2 @gol
628 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
629 -maltivec  -mno-altivec @gol
630 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
631 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
632 -mnew-mnemonics  -mold-mnemonics @gol
633 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
634 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
635 -malign-power  -malign-natural @gol
636 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
637 -mstring  -mno-string  -mupdate  -mno-update @gol
638 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
639 -mstrict-align  -mno-strict-align  -mrelocatable @gol
640 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
641 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
642 -mdynamic-no-pic  -maltivec  -mswdiv @gol
643 -mprioritize-restricted-insns=@var{priority} @gol
644 -msched-costly-dep=@var{dependence_type} @gol
645 -minsert-sched-nops=@var{scheme} @gol
646 -mcall-sysv  -mcall-netbsd @gol
647 -maix-struct-return  -msvr4-struct-return @gol
648 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
649 -misel -mno-isel @gol
650 -misel=yes  -misel=no @gol
651 -mspe -mno-spe @gol
652 -mspe=yes  -mspe=no @gol
653 -mvrsave -mno-vrsave @gol
654 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
655 -mprototype  -mno-prototype @gol
656 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
657 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
658
659 @emph{S/390 and zSeries Options}
660 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
661 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
662 -mpacked-stack  -mno-packed-stack @gol
663 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
664 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
665 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
666 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
667
668 @emph{SH Options}
669 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
670 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
671 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
672 -m5-64media  -m5-64media-nofpu @gol
673 -m5-32media  -m5-32media-nofpu @gol
674 -m5-compact  -m5-compact-nofpu @gol
675 -mb  -ml  -mdalign  -mrelax @gol
676 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
677 -mieee  -misize  -mpadstruct  -mspace @gol
678 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
679 -mdivsi3_libfunc=@var{name}  @gol
680 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
681  -minvalid-symbols}
682
683 @emph{SPARC Options}
684 @gccoptlist{-mcpu=@var{cpu-type} @gol
685 -mtune=@var{cpu-type} @gol
686 -mcmodel=@var{code-model} @gol
687 -m32  -m64  -mapp-regs  -mno-app-regs @gol
688 -mfaster-structs  -mno-faster-structs @gol
689 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
690 -mhard-quad-float  -msoft-quad-float @gol
691 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
692 -mstack-bias  -mno-stack-bias @gol
693 -munaligned-doubles  -mno-unaligned-doubles @gol
694 -mv8plus  -mno-v8plus  -mvis  -mno-vis
695 -threads -pthreads}
696
697 @emph{System V Options}
698 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
699
700 @emph{TMS320C3x/C4x Options}
701 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
702 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
703 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
704 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
705
706 @emph{V850 Options}
707 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
708 -mprolog-function  -mno-prolog-function  -mspace @gol
709 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
710 -mapp-regs  -mno-app-regs @gol
711 -mdisable-callt  -mno-disable-callt @gol
712 -mv850e1 @gol
713 -mv850e @gol
714 -mv850  -mbig-switch}
715
716 @emph{VAX Options}
717 @gccoptlist{-mg  -mgnu  -munix}
718
719 @emph{x86-64 Options}
720 See i386 and x86-64 Options.
721
722 @emph{Xstormy16 Options}
723 @gccoptlist{-msim}
724
725 @emph{Xtensa Options}
726 @gccoptlist{-mconst16 -mno-const16 @gol
727 -mfused-madd  -mno-fused-madd @gol
728 -mtext-section-literals  -mno-text-section-literals @gol
729 -mtarget-align  -mno-target-align @gol
730 -mlongcalls  -mno-longcalls}
731
732 @emph{zSeries Options}
733 See S/390 and zSeries Options.
734
735 @item Code Generation Options
736 @xref{Code Gen Options,,Options for Code Generation Conventions}.
737 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
738 -ffixed-@var{reg}  -fexceptions @gol
739 -fnon-call-exceptions  -funwind-tables @gol
740 -fasynchronous-unwind-tables @gol
741 -finhibit-size-directive  -finstrument-functions @gol
742 -fno-common  -fno-ident @gol
743 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
744 -fno-jump-tables @gol
745 -freg-struct-return  -fshared-data  -fshort-enums @gol
746 -fshort-double  -fshort-wchar @gol
747 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
748 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
749 -fargument-alias  -fargument-noalias @gol
750 -fargument-noalias-global  -fleading-underscore @gol
751 -ftls-model=@var{model} @gol
752 -ftrapv  -fwrapv  -fbounds-check @gol
753 -fvisibility}
754 @end table
755
756 @menu
757 * Overall Options::     Controlling the kind of output:
758                         an executable, object files, assembler files,
759                         or preprocessed source.
760 * C Dialect Options::   Controlling the variant of C language compiled.
761 * C++ Dialect Options:: Variations on C++.
762 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
763                         and Objective-C++.
764 * Language Independent Options:: Controlling how diagnostics should be
765                         formatted.
766 * Warning Options::     How picky should the compiler be?
767 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
768 * Optimize Options::    How much optimization?
769 * Preprocessor Options:: Controlling header files and macro definitions.
770                          Also, getting dependency information for Make.
771 * Assembler Options::   Passing options to the assembler.
772 * Link Options::        Specifying libraries and so on.
773 * Directory Options::   Where to find header files and libraries.
774                         Where to find the compiler executable files.
775 * Spec Files::          How to pass switches to sub-processes.
776 * Target Options::      Running a cross-compiler, or an old version of GCC.
777 @end menu
778
779 @node Overall Options
780 @section Options Controlling the Kind of Output
781
782 Compilation can involve up to four stages: preprocessing, compilation
783 proper, assembly and linking, always in that order.  GCC is capable of
784 preprocessing and compiling several files either into several
785 assembler input files, or into one assembler input file; then each
786 assembler input file produces an object file, and linking combines all
787 the object files (those newly compiled, and those specified as input)
788 into an executable file.
789
790 @cindex file name suffix
791 For any given input file, the file name suffix determines what kind of
792 compilation is done:
793
794 @table @gcctabopt
795 @item @var{file}.c
796 C source code which must be preprocessed.
797
798 @item @var{file}.i
799 C source code which should not be preprocessed.
800
801 @item @var{file}.ii
802 C++ source code which should not be preprocessed.
803
804 @item @var{file}.m
805 Objective-C source code.  Note that you must link with the @file{libobjc}
806 library to make an Objective-C program work.
807
808 @item @var{file}.mi
809 Objective-C source code which should not be preprocessed.
810
811 @item @var{file}.mm
812 @itemx @var{file}.M
813 Objective-C++ source code.  Note that you must link with the @file{libobjc}
814 library to make an Objective-C++ program work.  Note that @samp{.M} refers
815 to a literal capital M@.
816
817 @item @var{file}.mii
818 Objective-C++ source code which should not be preprocessed.
819
820 @item @var{file}.h
821 C, C++, Objective-C or Objective-C++ header file to be turned into a
822 precompiled header.
823
824 @item @var{file}.cc
825 @itemx @var{file}.cp
826 @itemx @var{file}.cxx
827 @itemx @var{file}.cpp
828 @itemx @var{file}.CPP
829 @itemx @var{file}.c++
830 @itemx @var{file}.C
831 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
832 the last two letters must both be literally @samp{x}.  Likewise,
833 @samp{.C} refers to a literal capital C@.
834
835 @item @var{file}.mm
836 @itemx @var{file}.M
837 Objective-C++ source code which must be preprocessed.
838
839 @item @var{file}.mii
840 Objective-C++ source code which should not be preprocessed.
841
842 @item @var{file}.hh
843 @itemx @var{file}.H
844 C++ header file to be turned into a precompiled header.
845
846 @item @var{file}.f
847 @itemx @var{file}.for
848 @itemx @var{file}.FOR
849 Fortran source code which should not be preprocessed.
850
851 @item @var{file}.F
852 @itemx @var{file}.fpp
853 @itemx @var{file}.FPP
854 Fortran source code which must be preprocessed (with the traditional
855 preprocessor).
856
857 @item @var{file}.r
858 Fortran source code which must be preprocessed with a RATFOR
859 preprocessor (not included with GCC)@.
860
861 @item @var{file}.f90
862 @itemx @var{file}.f95
863 Fortran 90/95 source code which should not be preprocessed.
864
865 @item @var{file}.F90
866 @itemx @var{file}.F95
867 Fortran 90/95 source code which must be preprocessed (with the
868 traditional preprocessor).
869
870 @c FIXME: Descriptions of Java file types.
871 @c @var{file}.java
872 @c @var{file}.class
873 @c @var{file}.zip
874 @c @var{file}.jar
875
876 @item @var{file}.ads
877 Ada source code file which contains a library unit declaration (a
878 declaration of a package, subprogram, or generic, or a generic
879 instantiation), or a library unit renaming declaration (a package,
880 generic, or subprogram renaming declaration).  Such files are also
881 called @dfn{specs}.
882
883 @itemx @var{file}.adb
884 Ada source code file containing a library unit body (a subprogram or
885 package body).  Such files are also called @dfn{bodies}.
886
887 @c GCC also knows about some suffixes for languages not yet included:
888 @c Pascal:
889 @c @var{file}.p
890 @c @var{file}.pas
891
892 @item @var{file}.s
893 Assembler code.
894
895 @item @var{file}.S
896 Assembler code which must be preprocessed.
897
898 @item @var{other}
899 An object file to be fed straight into linking.
900 Any file name with no recognized suffix is treated this way.
901 @end table
902
903 @opindex x
904 You can specify the input language explicitly with the @option{-x} option:
905
906 @table @gcctabopt
907 @item -x @var{language}
908 Specify explicitly the @var{language} for the following input files
909 (rather than letting the compiler choose a default based on the file
910 name suffix).  This option applies to all following input files until
911 the next @option{-x} option.  Possible values for @var{language} are:
912 @smallexample
913 c  c-header  c-cpp-output
914 c++  c++-header  c++-cpp-output
915 objective-c  objective-c-header  objective-c-cpp-output
916 objective-c++ objective-c++-header objective-c++-cpp-output
917 assembler  assembler-with-cpp
918 ada
919 f77  f77-cpp-input  ratfor
920 f95
921 java
922 treelang
923 @end smallexample
924
925 @item -x none
926 Turn off any specification of a language, so that subsequent files are
927 handled according to their file name suffixes (as they are if @option{-x}
928 has not been used at all).
929
930 @item -pass-exit-codes
931 @opindex pass-exit-codes
932 Normally the @command{gcc} program will exit with the code of 1 if any
933 phase of the compiler returns a non-success return code.  If you specify
934 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
935 numerically highest error produced by any phase that returned an error
936 indication.
937 @end table
938
939 If you only want some of the stages of compilation, you can use
940 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
941 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
942 @command{gcc} is to stop.  Note that some combinations (for example,
943 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
944
945 @table @gcctabopt
946 @item -c
947 @opindex c
948 Compile or assemble the source files, but do not link.  The linking
949 stage simply is not done.  The ultimate output is in the form of an
950 object file for each source file.
951
952 By default, the object file name for a source file is made by replacing
953 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
954
955 Unrecognized input files, not requiring compilation or assembly, are
956 ignored.
957
958 @item -S
959 @opindex S
960 Stop after the stage of compilation proper; do not assemble.  The output
961 is in the form of an assembler code file for each non-assembler input
962 file specified.
963
964 By default, the assembler file name for a source file is made by
965 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
966
967 Input files that don't require compilation are ignored.
968
969 @item -E
970 @opindex E
971 Stop after the preprocessing stage; do not run the compiler proper.  The
972 output is in the form of preprocessed source code, which is sent to the
973 standard output.
974
975 Input files which don't require preprocessing are ignored.
976
977 @cindex output file option
978 @item -o @var{file}
979 @opindex o
980 Place output in file @var{file}.  This applies regardless to whatever
981 sort of output is being produced, whether it be an executable file,
982 an object file, an assembler file or preprocessed C code.
983
984 If @option{-o} is not specified, the default is to put an executable
985 file in @file{a.out}, the object file for
986 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
987 assembler file in @file{@var{source}.s}, a precompiled header file in
988 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
989 standard output.
990
991 @item -v
992 @opindex v
993 Print (on standard error output) the commands executed to run the stages
994 of compilation.  Also print the version number of the compiler driver
995 program and of the preprocessor and the compiler proper.
996
997 @item -###
998 @opindex ###
999 Like @option{-v} except the commands are not executed and all command
1000 arguments are quoted.  This is useful for shell scripts to capture the
1001 driver-generated command lines.
1002
1003 @item -pipe
1004 @opindex pipe
1005 Use pipes rather than temporary files for communication between the
1006 various stages of compilation.  This fails to work on some systems where
1007 the assembler is unable to read from a pipe; but the GNU assembler has
1008 no trouble.
1009
1010 @item -combine
1011 @opindex combine
1012 If you are compiling multiple source files, this option tells the driver
1013 to pass all the source files to the compiler at once (for those
1014 languages for which the compiler can handle this).  This will allow
1015 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1016 language for which this is supported is C@.  If you pass source files for
1017 multiple languages to the driver, using this option, the driver will invoke
1018 the compiler(s) that support IMA once each, passing each compiler all the
1019 source files appropriate for it.  For those languages that do not support
1020 IMA this option will be ignored, and the compiler will be invoked once for
1021 each source file in that language.  If you use this option in conjunction
1022 with @option{-save-temps}, the compiler will generate multiple
1023 pre-processed files
1024 (one for each source file), but only one (combined) @file{.o} or
1025 @file{.s} file.
1026
1027 @item --help
1028 @opindex help
1029 Print (on the standard output) a description of the command line options
1030 understood by @command{gcc}.  If the @option{-v} option is also specified
1031 then @option{--help} will also be passed on to the various processes
1032 invoked by @command{gcc}, so that they can display the command line options
1033 they accept.  If the @option{-Wextra} option is also specified then command
1034 line options which have no documentation associated with them will also
1035 be displayed.
1036
1037 @item --target-help
1038 @opindex target-help
1039 Print (on the standard output) a description of target specific command
1040 line options for each tool.
1041
1042 @item --version
1043 @opindex version
1044 Display the version number and copyrights of the invoked GCC@.
1045 @end table
1046
1047 @node Invoking G++
1048 @section Compiling C++ Programs
1049
1050 @cindex suffixes for C++ source
1051 @cindex C++ source file suffixes
1052 C++ source files conventionally use one of the suffixes @samp{.C},
1053 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1054 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1055 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1056 files with these names and compiles them as C++ programs even if you
1057 call the compiler the same way as for compiling C programs (usually
1058 with the name @command{gcc}).
1059
1060 @findex g++
1061 @findex c++
1062 However, C++ programs often require class libraries as well as a
1063 compiler that understands the C++ language---and under some
1064 circumstances, you might want to compile programs or header files from
1065 standard input, or otherwise without a suffix that flags them as C++
1066 programs.  You might also like to precompile a C header file with a
1067 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1068 program that calls GCC with the default language set to C++, and
1069 automatically specifies linking against the C++ library.  On many
1070 systems, @command{g++} is also installed with the name @command{c++}.
1071
1072 @cindex invoking @command{g++}
1073 When you compile C++ programs, you may specify many of the same
1074 command-line options that you use for compiling programs in any
1075 language; or command-line options meaningful for C and related
1076 languages; or options that are meaningful only for C++ programs.
1077 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1078 explanations of options for languages related to C@.
1079 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1080 explanations of options that are meaningful only for C++ programs.
1081
1082 @node C Dialect Options
1083 @section Options Controlling C Dialect
1084 @cindex dialect options
1085 @cindex language dialect options
1086 @cindex options, dialect
1087
1088 The following options control the dialect of C (or languages derived
1089 from C, such as C++, Objective-C and Objective-C++) that the compiler
1090 accepts:
1091
1092 @table @gcctabopt
1093 @cindex ANSI support
1094 @cindex ISO support
1095 @item -ansi
1096 @opindex ansi
1097 In C mode, support all ISO C90 programs.  In C++ mode,
1098 remove GNU extensions that conflict with ISO C++.
1099
1100 This turns off certain features of GCC that are incompatible with ISO
1101 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1102 such as the @code{asm} and @code{typeof} keywords, and
1103 predefined macros such as @code{unix} and @code{vax} that identify the
1104 type of system you are using.  It also enables the undesirable and
1105 rarely used ISO trigraph feature.  For the C compiler,
1106 it disables recognition of C++ style @samp{//} comments as well as
1107 the @code{inline} keyword.
1108
1109 The alternate keywords @code{__asm__}, @code{__extension__},
1110 @code{__inline__} and @code{__typeof__} continue to work despite
1111 @option{-ansi}.  You would not want to use them in an ISO C program, of
1112 course, but it is useful to put them in header files that might be included
1113 in compilations done with @option{-ansi}.  Alternate predefined macros
1114 such as @code{__unix__} and @code{__vax__} are also available, with or
1115 without @option{-ansi}.
1116
1117 The @option{-ansi} option does not cause non-ISO programs to be
1118 rejected gratuitously.  For that, @option{-pedantic} is required in
1119 addition to @option{-ansi}.  @xref{Warning Options}.
1120
1121 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1122 option is used.  Some header files may notice this macro and refrain
1123 from declaring certain functions or defining certain macros that the
1124 ISO standard doesn't call for; this is to avoid interfering with any
1125 programs that might use these names for other things.
1126
1127 Functions which would normally be built in but do not have semantics
1128 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1129 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1130 built-in functions provided by GCC}, for details of the functions
1131 affected.
1132
1133 @item -std=
1134 @opindex std
1135 Determine the language standard.  This option is currently only
1136 supported when compiling C or C++.  A value for this option must be
1137 provided; possible values are
1138
1139 @table @samp
1140 @item c89
1141 @itemx iso9899:1990
1142 ISO C90 (same as @option{-ansi}).
1143
1144 @item iso9899:199409
1145 ISO C90 as modified in amendment 1.
1146
1147 @item c99
1148 @itemx c9x
1149 @itemx iso9899:1999
1150 @itemx iso9899:199x
1151 ISO C99.  Note that this standard is not yet fully supported; see
1152 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1153 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1154
1155 @item gnu89
1156 Default, ISO C90 plus GNU extensions (including some C99 features).
1157
1158 @item gnu99
1159 @itemx gnu9x
1160 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1161 this will become the default.  The name @samp{gnu9x} is deprecated.
1162
1163 @item c++98
1164 The 1998 ISO C++ standard plus amendments.
1165
1166 @item gnu++98
1167 The same as @option{-std=c++98} plus GNU extensions.  This is the
1168 default for C++ code.
1169 @end table
1170
1171 Even when this option is not specified, you can still use some of the
1172 features of newer standards in so far as they do not conflict with
1173 previous C standards.  For example, you may use @code{__restrict__} even
1174 when @option{-std=c99} is not specified.
1175
1176 The @option{-std} options specifying some version of ISO C have the same
1177 effects as @option{-ansi}, except that features that were not in ISO C90
1178 but are in the specified version (for example, @samp{//} comments and
1179 the @code{inline} keyword in ISO C99) are not disabled.
1180
1181 @xref{Standards,,Language Standards Supported by GCC}, for details of
1182 these standard versions.
1183
1184 @item -aux-info @var{filename}
1185 @opindex aux-info
1186 Output to the given filename prototyped declarations for all functions
1187 declared and/or defined in a translation unit, including those in header
1188 files.  This option is silently ignored in any language other than C@.
1189
1190 Besides declarations, the file indicates, in comments, the origin of
1191 each declaration (source file and line), whether the declaration was
1192 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1193 @samp{O} for old, respectively, in the first character after the line
1194 number and the colon), and whether it came from a declaration or a
1195 definition (@samp{C} or @samp{F}, respectively, in the following
1196 character).  In the case of function definitions, a K&R-style list of
1197 arguments followed by their declarations is also provided, inside
1198 comments, after the declaration.
1199
1200 @item -fno-asm
1201 @opindex fno-asm
1202 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1203 keyword, so that code can use these words as identifiers.  You can use
1204 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1205 instead.  @option{-ansi} implies @option{-fno-asm}.
1206
1207 In C++, this switch only affects the @code{typeof} keyword, since
1208 @code{asm} and @code{inline} are standard keywords.  You may want to
1209 use the @option{-fno-gnu-keywords} flag instead, which has the same
1210 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1211 switch only affects the @code{asm} and @code{typeof} keywords, since
1212 @code{inline} is a standard keyword in ISO C99.
1213
1214 @item -fno-builtin
1215 @itemx -fno-builtin-@var{function}
1216 @opindex fno-builtin
1217 @cindex built-in functions
1218 Don't recognize built-in functions that do not begin with
1219 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1220 functions provided by GCC}, for details of the functions affected,
1221 including those which are not built-in functions when @option{-ansi} or
1222 @option{-std} options for strict ISO C conformance are used because they
1223 do not have an ISO standard meaning.
1224
1225 GCC normally generates special code to handle certain built-in functions
1226 more efficiently; for instance, calls to @code{alloca} may become single
1227 instructions that adjust the stack directly, and calls to @code{memcpy}
1228 may become inline copy loops.  The resulting code is often both smaller
1229 and faster, but since the function calls no longer appear as such, you
1230 cannot set a breakpoint on those calls, nor can you change the behavior
1231 of the functions by linking with a different library.  In addition,
1232 when a function is recognized as a built-in function, GCC may use
1233 information about that function to warn about problems with calls to
1234 that function, or to generate more efficient code, even if the
1235 resulting code still contains calls to that function.  For example,
1236 warnings are given with @option{-Wformat} for bad calls to
1237 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1238 known not to modify global memory.
1239
1240 With the @option{-fno-builtin-@var{function}} option
1241 only the built-in function @var{function} is
1242 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1243 function is named this is not built-in in this version of GCC, this
1244 option is ignored.  There is no corresponding
1245 @option{-fbuiltin-@var{function}} option; if you wish to enable
1246 built-in functions selectively when using @option{-fno-builtin} or
1247 @option{-ffreestanding}, you may define macros such as:
1248
1249 @smallexample
1250 #define abs(n)          __builtin_abs ((n))
1251 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1252 @end smallexample
1253
1254 @item -fhosted
1255 @opindex fhosted
1256 @cindex hosted environment
1257
1258 Assert that compilation takes place in a hosted environment.  This implies
1259 @option{-fbuiltin}.  A hosted environment is one in which the
1260 entire standard library is available, and in which @code{main} has a return
1261 type of @code{int}.  Examples are nearly everything except a kernel.
1262 This is equivalent to @option{-fno-freestanding}.
1263
1264 @item -ffreestanding
1265 @opindex ffreestanding
1266 @cindex hosted environment
1267
1268 Assert that compilation takes place in a freestanding environment.  This
1269 implies @option{-fno-builtin}.  A freestanding environment
1270 is one in which the standard library may not exist, and program startup may
1271 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1272 This is equivalent to @option{-fno-hosted}.
1273
1274 @xref{Standards,,Language Standards Supported by GCC}, for details of
1275 freestanding and hosted environments.
1276
1277 @item -fms-extensions
1278 @opindex fms-extensions
1279 Accept some non-standard constructs used in Microsoft header files.
1280
1281 Some cases of unnamed fields in structures and unions are only
1282 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1283 fields within structs/unions}, for details.
1284
1285 @item -trigraphs
1286 @opindex trigraphs
1287 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1288 options for strict ISO C conformance) implies @option{-trigraphs}.
1289
1290 @item -no-integrated-cpp
1291 @opindex no-integrated-cpp
1292 Performs a compilation in two passes: preprocessing and compiling.  This
1293 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1294 @option{-B} option.  The user supplied compilation step can then add in
1295 an additional preprocessing step after normal preprocessing but before
1296 compiling.  The default is to use the integrated cpp (internal cpp)
1297
1298 The semantics of this option will change if "cc1", "cc1plus", and
1299 "cc1obj" are merged.
1300
1301 @cindex traditional C language
1302 @cindex C language, traditional
1303 @item -traditional
1304 @itemx -traditional-cpp
1305 @opindex traditional-cpp
1306 @opindex traditional
1307 Formerly, these options caused GCC to attempt to emulate a pre-standard
1308 C compiler.  They are now only supported with the @option{-E} switch.
1309 The preprocessor continues to support a pre-standard mode.  See the GNU
1310 CPP manual for details.
1311
1312 @item -fcond-mismatch
1313 @opindex fcond-mismatch
1314 Allow conditional expressions with mismatched types in the second and
1315 third arguments.  The value of such an expression is void.  This option
1316 is not supported for C++.
1317
1318 @item -funsigned-char
1319 @opindex funsigned-char
1320 Let the type @code{char} be unsigned, like @code{unsigned char}.
1321
1322 Each kind of machine has a default for what @code{char} should
1323 be.  It is either like @code{unsigned char} by default or like
1324 @code{signed char} by default.
1325
1326 Ideally, a portable program should always use @code{signed char} or
1327 @code{unsigned char} when it depends on the signedness of an object.
1328 But many programs have been written to use plain @code{char} and
1329 expect it to be signed, or expect it to be unsigned, depending on the
1330 machines they were written for.  This option, and its inverse, let you
1331 make such a program work with the opposite default.
1332
1333 The type @code{char} is always a distinct type from each of
1334 @code{signed char} or @code{unsigned char}, even though its behavior
1335 is always just like one of those two.
1336
1337 @item -fsigned-char
1338 @opindex fsigned-char
1339 Let the type @code{char} be signed, like @code{signed char}.
1340
1341 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1342 the negative form of @option{-funsigned-char}.  Likewise, the option
1343 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1344
1345 @item -fsigned-bitfields
1346 @itemx -funsigned-bitfields
1347 @itemx -fno-signed-bitfields
1348 @itemx -fno-unsigned-bitfields
1349 @opindex fsigned-bitfields
1350 @opindex funsigned-bitfields
1351 @opindex fno-signed-bitfields
1352 @opindex fno-unsigned-bitfields
1353 These options control whether a bit-field is signed or unsigned, when the
1354 declaration does not use either @code{signed} or @code{unsigned}.  By
1355 default, such a bit-field is signed, because this is consistent: the
1356 basic integer types such as @code{int} are signed types.
1357 @end table
1358
1359 @node C++ Dialect Options
1360 @section Options Controlling C++ Dialect
1361
1362 @cindex compiler options, C++
1363 @cindex C++ options, command line
1364 @cindex options, C++
1365 This section describes the command-line options that are only meaningful
1366 for C++ programs; but you can also use most of the GNU compiler options
1367 regardless of what language your program is in.  For example, you
1368 might compile a file @code{firstClass.C} like this:
1369
1370 @smallexample
1371 g++ -g -frepo -O -c firstClass.C
1372 @end smallexample
1373
1374 @noindent
1375 In this example, only @option{-frepo} is an option meant
1376 only for C++ programs; you can use the other options with any
1377 language supported by GCC@.
1378
1379 Here is a list of options that are @emph{only} for compiling C++ programs:
1380
1381 @table @gcctabopt
1382
1383 @item -fabi-version=@var{n}
1384 @opindex fabi-version
1385 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1386 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1387 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1388 the version that conforms most closely to the C++ ABI specification.
1389 Therefore, the ABI obtained using version 0 will change as ABI bugs
1390 are fixed.
1391
1392 The default is version 2.
1393
1394 @item -fno-access-control
1395 @opindex fno-access-control
1396 Turn off all access checking.  This switch is mainly useful for working
1397 around bugs in the access control code.
1398
1399 @item -fcheck-new
1400 @opindex fcheck-new
1401 Check that the pointer returned by @code{operator new} is non-null
1402 before attempting to modify the storage allocated.  This check is
1403 normally unnecessary because the C++ standard specifies that
1404 @code{operator new} will only return @code{0} if it is declared
1405 @samp{throw()}, in which case the compiler will always check the
1406 return value even without this option.  In all other cases, when
1407 @code{operator new} has a non-empty exception specification, memory
1408 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1409 @samp{new (nothrow)}.
1410
1411 @item -fconserve-space
1412 @opindex fconserve-space
1413 Put uninitialized or runtime-initialized global variables into the
1414 common segment, as C does.  This saves space in the executable at the
1415 cost of not diagnosing duplicate definitions.  If you compile with this
1416 flag and your program mysteriously crashes after @code{main()} has
1417 completed, you may have an object that is being destroyed twice because
1418 two definitions were merged.
1419
1420 This option is no longer useful on most targets, now that support has
1421 been added for putting variables into BSS without making them common.
1422
1423 @item -fno-const-strings
1424 @opindex fno-const-strings
1425 Give string constants type @code{char *} instead of type @code{const
1426 char *}.  By default, G++ uses type @code{const char *} as required by
1427 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1428 actually modify the value of a string constant.
1429
1430 This option might be removed in a future release of G++.  For maximum
1431 portability, you should structure your code so that it works with
1432 string constants that have type @code{const char *}.
1433
1434 @item -fno-elide-constructors
1435 @opindex fno-elide-constructors
1436 The C++ standard allows an implementation to omit creating a temporary
1437 which is only used to initialize another object of the same type.
1438 Specifying this option disables that optimization, and forces G++ to
1439 call the copy constructor in all cases.
1440
1441 @item -fno-enforce-eh-specs
1442 @opindex fno-enforce-eh-specs
1443 Don't check for violation of exception specifications at runtime.  This
1444 option violates the C++ standard, but may be useful for reducing code
1445 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1446 will still optimize based on the exception specifications.
1447
1448 @item -ffor-scope
1449 @itemx -fno-for-scope
1450 @opindex ffor-scope
1451 @opindex fno-for-scope
1452 If @option{-ffor-scope} is specified, the scope of variables declared in
1453 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1454 as specified by the C++ standard.
1455 If @option{-fno-for-scope} is specified, the scope of variables declared in
1456 a @i{for-init-statement} extends to the end of the enclosing scope,
1457 as was the case in old versions of G++, and other (traditional)
1458 implementations of C++.
1459
1460 The default if neither flag is given to follow the standard,
1461 but to allow and give a warning for old-style code that would
1462 otherwise be invalid, or have different behavior.
1463
1464 @item -fno-gnu-keywords
1465 @opindex fno-gnu-keywords
1466 Do not recognize @code{typeof} as a keyword, so that code can use this
1467 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1468 @option{-ansi} implies @option{-fno-gnu-keywords}.
1469
1470 @item -fno-implicit-templates
1471 @opindex fno-implicit-templates
1472 Never emit code for non-inline templates which are instantiated
1473 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1474 @xref{Template Instantiation}, for more information.
1475
1476 @item -fno-implicit-inline-templates
1477 @opindex fno-implicit-inline-templates
1478 Don't emit code for implicit instantiations of inline templates, either.
1479 The default is to handle inlines differently so that compiles with and
1480 without optimization will need the same set of explicit instantiations.
1481
1482 @item -fno-implement-inlines
1483 @opindex fno-implement-inlines
1484 To save space, do not emit out-of-line copies of inline functions
1485 controlled by @samp{#pragma implementation}.  This will cause linker
1486 errors if these functions are not inlined everywhere they are called.
1487
1488 @item -fms-extensions
1489 @opindex fms-extensions
1490 Disable pedantic warnings about constructs used in MFC, such as implicit
1491 int and getting a pointer to member function via non-standard syntax.
1492
1493 @item -fno-nonansi-builtins
1494 @opindex fno-nonansi-builtins
1495 Disable built-in declarations of functions that are not mandated by
1496 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1497 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1498
1499 @item -fno-operator-names
1500 @opindex fno-operator-names
1501 Do not treat the operator name keywords @code{and}, @code{bitand},
1502 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1503 synonyms as keywords.
1504
1505 @item -fno-optional-diags
1506 @opindex fno-optional-diags
1507 Disable diagnostics that the standard says a compiler does not need to
1508 issue.  Currently, the only such diagnostic issued by G++ is the one for
1509 a name having multiple meanings within a class.
1510
1511 @item -fpermissive
1512 @opindex fpermissive
1513 Downgrade some diagnostics about nonconformant code from errors to
1514 warnings.  Thus, using @option{-fpermissive} will allow some
1515 nonconforming code to compile.
1516
1517 @item -frepo
1518 @opindex frepo
1519 Enable automatic template instantiation at link time.  This option also
1520 implies @option{-fno-implicit-templates}.  @xref{Template
1521 Instantiation}, for more information.
1522
1523 @item -fno-rtti
1524 @opindex fno-rtti
1525 Disable generation of information about every class with virtual
1526 functions for use by the C++ runtime type identification features
1527 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1528 of the language, you can save some space by using this flag.  Note that
1529 exception handling uses the same information, but it will generate it as
1530 needed.
1531
1532 @item -fstats
1533 @opindex fstats
1534 Emit statistics about front-end processing at the end of the compilation.
1535 This information is generally only useful to the G++ development team.
1536
1537 @item -ftemplate-depth-@var{n}
1538 @opindex ftemplate-depth
1539 Set the maximum instantiation depth for template classes to @var{n}.
1540 A limit on the template instantiation depth is needed to detect
1541 endless recursions during template class instantiation.  ANSI/ISO C++
1542 conforming programs must not rely on a maximum depth greater than 17.
1543
1544 @item -fno-threadsafe-statics
1545 @opindex fno-threadsafe-statics
1546 Do not emit the extra code to use the routines specified in the C++
1547 ABI for thread-safe initialization of local statics.  You can use this
1548 option to reduce code size slightly in code that doesn't need to be
1549 thread-safe.
1550
1551 @item -fuse-cxa-atexit
1552 @opindex fuse-cxa-atexit
1553 Register destructors for objects with static storage duration with the
1554 @code{__cxa_atexit} function rather than the @code{atexit} function.
1555 This option is required for fully standards-compliant handling of static
1556 destructors, but will only work if your C library supports
1557 @code{__cxa_atexit}.
1558
1559 @item -fvisibility-inlines-hidden
1560 @opindex fvisibility-inlines-hidden
1561 Causes all inlined methods to be marked with
1562 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1563 appear in the export table of a DSO and do not require a PLT indirection
1564 when used within the DSO@.  Enabling this option can have a dramatic effect
1565 on load and link times of a DSO as it massively reduces the size of the
1566 dynamic export table when the library makes heavy use of templates.  While
1567 it can cause bloating through duplication of code within each DSO where
1568 it is used, often the wastage is less than the considerable space occupied
1569 by a long symbol name in the export table which is typical when using
1570 templates and namespaces.  For even more savings, combine with the
1571 @option{-fvisibility=hidden} switch.
1572
1573 @item -fno-weak
1574 @opindex fno-weak
1575 Do not use weak symbol support, even if it is provided by the linker.
1576 By default, G++ will use weak symbols if they are available.  This
1577 option exists only for testing, and should not be used by end-users;
1578 it will result in inferior code and has no benefits.  This option may
1579 be removed in a future release of G++.
1580
1581 @item -nostdinc++
1582 @opindex nostdinc++
1583 Do not search for header files in the standard directories specific to
1584 C++, but do still search the other standard directories.  (This option
1585 is used when building the C++ library.)
1586 @end table
1587
1588 In addition, these optimization, warning, and code generation options
1589 have meanings only for C++ programs:
1590
1591 @table @gcctabopt
1592 @item -fno-default-inline
1593 @opindex fno-default-inline
1594 Do not assume @samp{inline} for functions defined inside a class scope.
1595 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1596 functions will have linkage like inline functions; they just won't be
1597 inlined by default.
1598
1599 @item -Wabi @r{(C++ only)}
1600 @opindex Wabi
1601 Warn when G++ generates code that is probably not compatible with the
1602 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1603 all such cases, there are probably some cases that are not warned about,
1604 even though G++ is generating incompatible code.  There may also be
1605 cases where warnings are emitted even though the code that is generated
1606 will be compatible.
1607
1608 You should rewrite your code to avoid these warnings if you are
1609 concerned about the fact that code generated by G++ may not be binary
1610 compatible with code generated by other compilers.
1611
1612 The known incompatibilities at this point include:
1613
1614 @itemize @bullet
1615
1616 @item
1617 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1618 pack data into the same byte as a base class.  For example:
1619
1620 @smallexample
1621 struct A @{ virtual void f(); int f1 : 1; @};
1622 struct B : public A @{ int f2 : 1; @};
1623 @end smallexample
1624
1625 @noindent
1626 In this case, G++ will place @code{B::f2} into the same byte
1627 as@code{A::f1}; other compilers will not.  You can avoid this problem
1628 by explicitly padding @code{A} so that its size is a multiple of the
1629 byte size on your platform; that will cause G++ and other compilers to
1630 layout @code{B} identically.
1631
1632 @item
1633 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1634 tail padding when laying out virtual bases.  For example:
1635
1636 @smallexample
1637 struct A @{ virtual void f(); char c1; @};
1638 struct B @{ B(); char c2; @};
1639 struct C : public A, public virtual B @{@};
1640 @end smallexample
1641
1642 @noindent
1643 In this case, G++ will not place @code{B} into the tail-padding for
1644 @code{A}; other compilers will.  You can avoid this problem by
1645 explicitly padding @code{A} so that its size is a multiple of its
1646 alignment (ignoring virtual base classes); that will cause G++ and other
1647 compilers to layout @code{C} identically.
1648
1649 @item
1650 Incorrect handling of bit-fields with declared widths greater than that
1651 of their underlying types, when the bit-fields appear in a union.  For
1652 example:
1653
1654 @smallexample
1655 union U @{ int i : 4096; @};
1656 @end smallexample
1657
1658 @noindent
1659 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1660 union too small by the number of bits in an @code{int}.
1661
1662 @item
1663 Empty classes can be placed at incorrect offsets.  For example:
1664
1665 @smallexample
1666 struct A @{@};
1667
1668 struct B @{
1669   A a;
1670   virtual void f ();
1671 @};
1672
1673 struct C : public B, public A @{@};
1674 @end smallexample
1675
1676 @noindent
1677 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1678 it should be placed at offset zero.  G++ mistakenly believes that the
1679 @code{A} data member of @code{B} is already at offset zero.
1680
1681 @item
1682 Names of template functions whose types involve @code{typename} or
1683 template template parameters can be mangled incorrectly.
1684
1685 @smallexample
1686 template <typename Q>
1687 void f(typename Q::X) @{@}
1688
1689 template <template <typename> class Q>
1690 void f(typename Q<int>::X) @{@}
1691 @end smallexample
1692
1693 @noindent
1694 Instantiations of these templates may be mangled incorrectly.
1695
1696 @end itemize
1697
1698 @item -Wctor-dtor-privacy @r{(C++ only)}
1699 @opindex Wctor-dtor-privacy
1700 Warn when a class seems unusable because all the constructors or
1701 destructors in that class are private, and it has neither friends nor
1702 public static member functions.
1703
1704 @item -Wnon-virtual-dtor @r{(C++ only)}
1705 @opindex Wnon-virtual-dtor
1706 Warn when a class appears to be polymorphic, thereby requiring a virtual
1707 destructor, yet it declares a non-virtual one.
1708 This warning is enabled by @option{-Wall}.
1709
1710 @item -Wreorder @r{(C++ only)}
1711 @opindex Wreorder
1712 @cindex reordering, warning
1713 @cindex warning for reordering of member initializers
1714 Warn when the order of member initializers given in the code does not
1715 match the order in which they must be executed.  For instance:
1716
1717 @smallexample
1718 struct A @{
1719   int i;
1720   int j;
1721   A(): j (0), i (1) @{ @}
1722 @};
1723 @end smallexample
1724
1725 The compiler will rearrange the member initializers for @samp{i}
1726 and @samp{j} to match the declaration order of the members, emitting
1727 a warning to that effect.  This warning is enabled by @option{-Wall}.
1728 @end table
1729
1730 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1731
1732 @table @gcctabopt
1733 @item -Weffc++ @r{(C++ only)}
1734 @opindex Weffc++
1735 Warn about violations of the following style guidelines from Scott Meyers'
1736 @cite{Effective C++} book:
1737
1738 @itemize @bullet
1739 @item
1740 Item 11:  Define a copy constructor and an assignment operator for classes
1741 with dynamically allocated memory.
1742
1743 @item
1744 Item 12:  Prefer initialization to assignment in constructors.
1745
1746 @item
1747 Item 14:  Make destructors virtual in base classes.
1748
1749 @item
1750 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1751
1752 @item
1753 Item 23:  Don't try to return a reference when you must return an object.
1754
1755 @end itemize
1756
1757 Also warn about violations of the following style guidelines from
1758 Scott Meyers' @cite{More Effective C++} book:
1759
1760 @itemize @bullet
1761 @item
1762 Item 6:  Distinguish between prefix and postfix forms of increment and
1763 decrement operators.
1764
1765 @item
1766 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1767
1768 @end itemize
1769
1770 When selecting this option, be aware that the standard library
1771 headers do not obey all of these guidelines; use @samp{grep -v}
1772 to filter out those warnings.
1773
1774 @item -Wno-deprecated @r{(C++ only)}
1775 @opindex Wno-deprecated
1776 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1777
1778 @item -Wstrict-null-sentinel @r{(C++ only)}
1779 @opindex Wstrict-null-sentinel
1780 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1781 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1782 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1783 it is guaranteed to of the same size as a pointer.  But this use is
1784 not portable across different compilers.
1785
1786 @item -Wno-non-template-friend @r{(C++ only)}
1787 @opindex Wno-non-template-friend
1788 Disable warnings when non-templatized friend functions are declared
1789 within a template.  Since the advent of explicit template specification
1790 support in G++, if the name of the friend is an unqualified-id (i.e.,
1791 @samp{friend foo(int)}), the C++ language specification demands that the
1792 friend declare or define an ordinary, nontemplate function.  (Section
1793 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1794 could be interpreted as a particular specialization of a templatized
1795 function.  Because this non-conforming behavior is no longer the default
1796 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1797 check existing code for potential trouble spots and is on by default.
1798 This new compiler behavior can be turned off with
1799 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1800 but disables the helpful warning.
1801
1802 @item -Wold-style-cast @r{(C++ only)}
1803 @opindex Wold-style-cast
1804 Warn if an old-style (C-style) cast to a non-void type is used within
1805 a C++ program.  The new-style casts (@samp{dynamic_cast},
1806 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1807 less vulnerable to unintended effects and much easier to search for.
1808
1809 @item -Woverloaded-virtual @r{(C++ only)}
1810 @opindex Woverloaded-virtual
1811 @cindex overloaded virtual fn, warning
1812 @cindex warning for overloaded virtual fn
1813 Warn when a function declaration hides virtual functions from a
1814 base class.  For example, in:
1815
1816 @smallexample
1817 struct A @{
1818   virtual void f();
1819 @};
1820
1821 struct B: public A @{
1822   void f(int);
1823 @};
1824 @end smallexample
1825
1826 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1827 like:
1828
1829 @smallexample
1830 B* b;
1831 b->f();
1832 @end smallexample
1833
1834 will fail to compile.
1835
1836 @item -Wno-pmf-conversions @r{(C++ only)}
1837 @opindex Wno-pmf-conversions
1838 Disable the diagnostic for converting a bound pointer to member function
1839 to a plain pointer.
1840
1841 @item -Wsign-promo @r{(C++ only)}
1842 @opindex Wsign-promo
1843 Warn when overload resolution chooses a promotion from unsigned or
1844 enumerated type to a signed type, over a conversion to an unsigned type of
1845 the same size.  Previous versions of G++ would try to preserve
1846 unsignedness, but the standard mandates the current behavior.
1847
1848 @smallexample
1849 struct A @{
1850   operator int ();
1851   A& operator = (int);
1852 @};
1853
1854 main ()
1855 @{
1856   A a,b;
1857   a = b;
1858 @}
1859 @end smallexample
1860
1861 In this example, G++ will synthesize a default @samp{A& operator =
1862 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1863 @end table
1864
1865 @node Objective-C and Objective-C++ Dialect Options
1866 @section Options Controlling Objective-C and Objective-C++ Dialects
1867
1868 @cindex compiler options, Objective-C and Objective-C++
1869 @cindex Objective-C and Objective-C++ options, command line
1870 @cindex options, Objective-C and Objective-C++
1871 (NOTE: This manual does not describe the Objective-C and Objective-C++
1872 languages themselves.  See @xref{Standards,,Language Standards
1873 Supported by GCC}, for references.)
1874
1875 This section describes the command-line options that are only meaningful
1876 for Objective-C and Objective-C++ programs, but you can also use most of
1877 the language-independent GNU compiler options.
1878 For example, you might compile a file @code{some_class.m} like this:
1879
1880 @smallexample
1881 gcc -g -fgnu-runtime -O -c some_class.m
1882 @end smallexample
1883
1884 @noindent
1885 In this example, @option{-fgnu-runtime} is an option meant only for
1886 Objective-C and Objective-C++ programs; you can use the other options with
1887 any language supported by GCC@.
1888
1889 Note that since Objective-C is an extension of the C language, Objective-C
1890 compilations may also use options specific to the C front-end (e.g.,
1891 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1892 C++-specific options (e.g., @option{-Wabi}).
1893
1894 Here is a list of options that are @emph{only} for compiling Objective-C
1895 and Objective-C++ programs:
1896
1897 @table @gcctabopt
1898 @item -fconstant-string-class=@var{class-name}
1899 @opindex fconstant-string-class
1900 Use @var{class-name} as the name of the class to instantiate for each
1901 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1902 class name is @code{NXConstantString} if the GNU runtime is being used, and
1903 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1904 @option{-fconstant-cfstrings} option, if also present, will override the
1905 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1906 to be laid out as constant CoreFoundation strings.
1907
1908 @item -fgnu-runtime
1909 @opindex fgnu-runtime
1910 Generate object code compatible with the standard GNU Objective-C
1911 runtime.  This is the default for most types of systems.
1912
1913 @item -fnext-runtime
1914 @opindex fnext-runtime
1915 Generate output compatible with the NeXT runtime.  This is the default
1916 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1917 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1918 used.
1919
1920 @item -fno-nil-receivers
1921 @opindex fno-nil-receivers
1922 Assume that all Objective-C message dispatches (e.g.,
1923 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1924 is not @code{nil}.  This allows for more efficient entry points in the runtime
1925 to be used.  Currently, this option is only available in conjunction with
1926 the NeXT runtime on Mac OS X 10.3 and later.
1927
1928 @item -fobjc-call-cxx-cdtors
1929 @opindex fobjc-call-cxx-cdtors
1930 For each Objective-C class, check if any of its instance variables is a
1931 C++ object with a non-trivial default constructor.  If so, synthesize a
1932 special @code{- (id) .cxx_construct} instance method that will run
1933 non-trivial default constructors on any such instance variables, in order,
1934 and then return @code{self}.  Similarly, check if any instance variable
1935 is a C++ object with a non-trivial destructor, and if so, synthesize a
1936 special @code{- (void) .cxx_destruct} method that will run
1937 all such default destructors, in reverse order.
1938
1939 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1940 thusly generated will only operate on instance variables declared in the
1941 current Objective-C class, and not those inherited from superclasses.  It
1942 is the responsibility of the Objective-C runtime to invoke all such methods
1943 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1944 will be invoked by the runtime immediately after a new object
1945 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1946 be invoked immediately before the runtime deallocates an object instance.
1947
1948 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1949 support for invoking the @code{- (id) .cxx_construct} and
1950 @code{- (void) .cxx_destruct} methods.
1951
1952 @item -fobjc-direct-dispatch
1953 @opindex fobjc-direct-dispatch
1954 Allow fast jumps to the message dispatcher.  On Darwin this is
1955 accomplished via the comm page.
1956
1957 @item -fobjc-exceptions
1958 @opindex fobjc-exceptions
1959 Enable syntactic support for structured exception handling in Objective-C,
1960 similar to what is offered by C++ and Java.  Currently, this option is only
1961 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1962
1963 @smallexample
1964   @@try @{
1965     @dots{}
1966        @@throw expr;
1967     @dots{}
1968   @}
1969   @@catch (AnObjCClass *exc) @{
1970     @dots{}
1971       @@throw expr;
1972     @dots{}
1973       @@throw;
1974     @dots{}
1975   @}
1976   @@catch (AnotherClass *exc) @{
1977     @dots{}
1978   @}
1979   @@catch (id allOthers) @{
1980     @dots{}
1981   @}
1982   @@finally @{
1983     @dots{}
1984       @@throw expr;
1985     @dots{}
1986   @}
1987 @end smallexample
1988
1989 The @code{@@throw} statement may appear anywhere in an Objective-C or
1990 Objective-C++ program; when used inside of a @code{@@catch} block, the
1991 @code{@@throw} may appear without an argument (as shown above), in which case
1992 the object caught by the @code{@@catch} will be rethrown.
1993
1994 Note that only (pointers to) Objective-C objects may be thrown and
1995 caught using this scheme.  When an object is thrown, it will be caught
1996 by the nearest @code{@@catch} clause capable of handling objects of that type,
1997 analogously to how @code{catch} blocks work in C++ and Java.  A
1998 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1999 any and all Objective-C exceptions not caught by previous @code{@@catch}
2000 clauses (if any).
2001
2002 The @code{@@finally} clause, if present, will be executed upon exit from the
2003 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2004 regardless of whether any exceptions are thrown, caught or rethrown
2005 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2006 of the @code{finally} clause in Java.
2007
2008 There are several caveats to using the new exception mechanism:
2009
2010 @itemize @bullet
2011 @item
2012 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2013 idioms provided by the @code{NSException} class, the new
2014 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2015 systems, due to additional functionality needed in the (NeXT) Objective-C
2016 runtime.
2017
2018 @item
2019 As mentioned above, the new exceptions do not support handling
2020 types other than Objective-C objects.   Furthermore, when used from
2021 Objective-C++, the Objective-C exception model does not interoperate with C++
2022 exceptions at this time.  This means you cannot @code{@@throw} an exception
2023 from Objective-C and @code{catch} it in C++, or vice versa
2024 (i.e., @code{throw @dots{} @@catch}).
2025 @end itemize
2026
2027 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2028 blocks for thread-safe execution:
2029
2030 @smallexample
2031   @@synchronized (ObjCClass *guard) @{
2032     @dots{}
2033   @}
2034 @end smallexample
2035
2036 Upon entering the @code{@@synchronized} block, a thread of execution shall
2037 first check whether a lock has been placed on the corresponding @code{guard}
2038 object by another thread.  If it has, the current thread shall wait until
2039 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2040 the current thread will place its own lock on it, execute the code contained in
2041 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2042 making @code{guard} available to other threads).
2043
2044 Unlike Java, Objective-C does not allow for entire methods to be marked
2045 @code{@@synchronized}.  Note that throwing exceptions out of
2046 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2047 to be unlocked properly.
2048
2049 @item -fobjc-gc
2050 @opindex fobjc-gc
2051 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2052
2053 @item -freplace-objc-classes
2054 @opindex freplace-objc-classes
2055 Emit a special marker instructing @command{ld(1)} not to statically link in
2056 the resulting object file, and allow @command{dyld(1)} to load it in at
2057 run time instead.  This is used in conjunction with the Fix-and-Continue
2058 debugging mode, where the object file in question may be recompiled and
2059 dynamically reloaded in the course of program execution, without the need
2060 to restart the program itself.  Currently, Fix-and-Continue functionality
2061 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2062 and later.
2063
2064 @item -fzero-link
2065 @opindex fzero-link
2066 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2067 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2068 compile time) with static class references that get initialized at load time,
2069 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2070 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2071 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2072 for individual class implementations to be modified during program execution.
2073
2074 @item -gen-decls
2075 @opindex gen-decls
2076 Dump interface declarations for all classes seen in the source file to a
2077 file named @file{@var{sourcename}.decl}.
2078
2079 @item -Wassign-intercept
2080 @opindex Wassign-intercept
2081 Warn whenever an Objective-C assignment is being intercepted by the
2082 garbage collector.
2083
2084 @item -Wno-protocol
2085 @opindex Wno-protocol
2086 If a class is declared to implement a protocol, a warning is issued for
2087 every method in the protocol that is not implemented by the class.  The
2088 default behavior is to issue a warning for every method not explicitly
2089 implemented in the class, even if a method implementation is inherited
2090 from the superclass.  If you use the @option{-Wno-protocol} option, then
2091 methods inherited from the superclass are considered to be implemented,
2092 and no warning is issued for them.
2093
2094 @item -Wselector
2095 @opindex Wselector
2096 Warn if multiple methods of different types for the same selector are
2097 found during compilation.  The check is performed on the list of methods
2098 in the final stage of compilation.  Additionally, a check is performed
2099 for each selector appearing in a @code{@@selector(@dots{})}
2100 expression, and a corresponding method for that selector has been found
2101 during compilation.  Because these checks scan the method table only at
2102 the end of compilation, these warnings are not produced if the final
2103 stage of compilation is not reached, for example because an error is
2104 found during compilation, or because the @option{-fsyntax-only} option is
2105 being used.
2106
2107 @item -Wstrict-selector-match
2108 @opindex Wstrict-selector-match
2109 Warn if multiple methods with differing argument and/or return types are
2110 found for a given selector when attempting to send a message using this
2111 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2112 is off (which is the default behavior), the compiler will omit such warnings
2113 if any differences found are confined to types which share the same size
2114 and alignment.
2115
2116 @item -Wundeclared-selector
2117 @opindex Wundeclared-selector
2118 Warn if a @code{@@selector(@dots{})} expression referring to an
2119 undeclared selector is found.  A selector is considered undeclared if no
2120 method with that name has been declared before the
2121 @code{@@selector(@dots{})} expression, either explicitly in an
2122 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2123 an @code{@@implementation} section.  This option always performs its
2124 checks as soon as a @code{@@selector(@dots{})} expression is found,
2125 while @option{-Wselector} only performs its checks in the final stage of
2126 compilation.  This also enforces the coding style convention
2127 that methods and selectors must be declared before being used.
2128
2129 @item -print-objc-runtime-info
2130 @opindex print-objc-runtime-info
2131 Generate C header describing the largest structure that is passed by
2132 value, if any.
2133
2134 @end table
2135
2136 @node Language Independent Options
2137 @section Options to Control Diagnostic Messages Formatting
2138 @cindex options to control diagnostics formatting
2139 @cindex diagnostic messages
2140 @cindex message formatting
2141
2142 Traditionally, diagnostic messages have been formatted irrespective of
2143 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2144 below can be used to control the diagnostic messages formatting
2145 algorithm, e.g.@: how many characters per line, how often source location
2146 information should be reported.  Right now, only the C++ front end can
2147 honor these options.  However it is expected, in the near future, that
2148 the remaining front ends would be able to digest them correctly.
2149
2150 @table @gcctabopt
2151 @item -fmessage-length=@var{n}
2152 @opindex fmessage-length
2153 Try to format error messages so that they fit on lines of about @var{n}
2154 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2155 the front ends supported by GCC@.  If @var{n} is zero, then no
2156 line-wrapping will be done; each error message will appear on a single
2157 line.
2158
2159 @opindex fdiagnostics-show-location
2160 @item -fdiagnostics-show-location=once
2161 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2162 reporter to emit @emph{once} source location information; that is, in
2163 case the message is too long to fit on a single physical line and has to
2164 be wrapped, the source location won't be emitted (as prefix) again,
2165 over and over, in subsequent continuation lines.  This is the default
2166 behavior.
2167
2168 @item -fdiagnostics-show-location=every-line
2169 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2170 messages reporter to emit the same source location information (as
2171 prefix) for physical lines that result from the process of breaking
2172 a message which is too long to fit on a single line.
2173
2174 @item -fdiagnostics-show-options
2175 @opindex fdiagnostics-show-options
2176 This option instructs the diagnostic machinery to add text to each
2177 diagnostic emitted, which indicates which command line option directly
2178 controls that diagnostic, when such an option is known to the
2179 diagnostic machinery.
2180
2181 @end table
2182
2183 @node Warning Options
2184 @section Options to Request or Suppress Warnings
2185 @cindex options to control warnings
2186 @cindex warning messages
2187 @cindex messages, warning
2188 @cindex suppressing warnings
2189
2190 Warnings are diagnostic messages that report constructions which
2191 are not inherently erroneous but which are risky or suggest there
2192 may have been an error.
2193
2194 You can request many specific warnings with options beginning @samp{-W},
2195 for example @option{-Wimplicit} to request warnings on implicit
2196 declarations.  Each of these specific warning options also has a
2197 negative form beginning @samp{-Wno-} to turn off warnings;
2198 for example, @option{-Wno-implicit}.  This manual lists only one of the
2199 two forms, whichever is not the default.
2200
2201 The following options control the amount and kinds of warnings produced
2202 by GCC; for further, language-specific options also refer to
2203 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2204 Options}.
2205
2206 @table @gcctabopt
2207 @cindex syntax checking
2208 @item -fsyntax-only
2209 @opindex fsyntax-only
2210 Check the code for syntax errors, but don't do anything beyond that.
2211
2212 @item -pedantic
2213 @opindex pedantic
2214 Issue all the warnings demanded by strict ISO C and ISO C++;
2215 reject all programs that use forbidden extensions, and some other
2216 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2217 version of the ISO C standard specified by any @option{-std} option used.
2218
2219 Valid ISO C and ISO C++ programs should compile properly with or without
2220 this option (though a rare few will require @option{-ansi} or a
2221 @option{-std} option specifying the required version of ISO C)@.  However,
2222 without this option, certain GNU extensions and traditional C and C++
2223 features are supported as well.  With this option, they are rejected.
2224
2225 @option{-pedantic} does not cause warning messages for use of the
2226 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2227 warnings are also disabled in the expression that follows
2228 @code{__extension__}.  However, only system header files should use
2229 these escape routes; application programs should avoid them.
2230 @xref{Alternate Keywords}.
2231
2232 Some users try to use @option{-pedantic} to check programs for strict ISO
2233 C conformance.  They soon find that it does not do quite what they want:
2234 it finds some non-ISO practices, but not all---only those for which
2235 ISO C @emph{requires} a diagnostic, and some others for which
2236 diagnostics have been added.
2237
2238 A feature to report any failure to conform to ISO C might be useful in
2239 some instances, but would require considerable additional work and would
2240 be quite different from @option{-pedantic}.  We don't have plans to
2241 support such a feature in the near future.
2242
2243 Where the standard specified with @option{-std} represents a GNU
2244 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2245 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2246 extended dialect is based.  Warnings from @option{-pedantic} are given
2247 where they are required by the base standard.  (It would not make sense
2248 for such warnings to be given only for features not in the specified GNU
2249 C dialect, since by definition the GNU dialects of C include all
2250 features the compiler supports with the given option, and there would be
2251 nothing to warn about.)
2252
2253 @item -pedantic-errors
2254 @opindex pedantic-errors
2255 Like @option{-pedantic}, except that errors are produced rather than
2256 warnings.
2257
2258 @item -w
2259 @opindex w
2260 Inhibit all warning messages.
2261
2262 @item -Wno-import
2263 @opindex Wno-import
2264 Inhibit warning messages about the use of @samp{#import}.
2265
2266 @item -Wchar-subscripts
2267 @opindex Wchar-subscripts
2268 Warn if an array subscript has type @code{char}.  This is a common cause
2269 of error, as programmers often forget that this type is signed on some
2270 machines.
2271 This warning is enabled by @option{-Wall}.
2272
2273 @item -Wcomment
2274 @opindex Wcomment
2275 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2276 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2277 This warning is enabled by @option{-Wall}.
2278
2279 @item -Wfatal-errors
2280 @opindex Wfatal-errors
2281 This option causes the compiler to abort compilation on the first error
2282 occurred rather than trying to keep going and printing further error
2283 messages.
2284
2285 @item -Wformat
2286 @opindex Wformat
2287 @opindex ffreestanding
2288 @opindex fno-builtin
2289 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2290 the arguments supplied have types appropriate to the format string
2291 specified, and that the conversions specified in the format string make
2292 sense.  This includes standard functions, and others specified by format
2293 attributes (@pxref{Function Attributes}), in the @code{printf},
2294 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2295 not in the C standard) families (or other target-specific families).
2296 Which functions are checked without format attributes having been
2297 specified depends on the standard version selected, and such checks of
2298 functions without the attribute specified are disabled by
2299 @option{-ffreestanding} or @option{-fno-builtin}.
2300
2301 The formats are checked against the format features supported by GNU
2302 libc version 2.2.  These include all ISO C90 and C99 features, as well
2303 as features from the Single Unix Specification and some BSD and GNU
2304 extensions.  Other library implementations may not support all these
2305 features; GCC does not support warning about features that go beyond a
2306 particular library's limitations.  However, if @option{-pedantic} is used
2307 with @option{-Wformat}, warnings will be given about format features not
2308 in the selected standard version (but not for @code{strfmon} formats,
2309 since those are not in any version of the C standard).  @xref{C Dialect
2310 Options,,Options Controlling C Dialect}.
2311
2312 Since @option{-Wformat} also checks for null format arguments for
2313 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2314
2315 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2316 aspects of format checking, the options @option{-Wformat-y2k},
2317 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2318 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2319 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2320
2321 @item -Wformat-y2k
2322 @opindex Wformat-y2k
2323 If @option{-Wformat} is specified, also warn about @code{strftime}
2324 formats which may yield only a two-digit year.
2325
2326 @item -Wno-format-extra-args
2327 @opindex Wno-format-extra-args
2328 If @option{-Wformat} is specified, do not warn about excess arguments to a
2329 @code{printf} or @code{scanf} format function.  The C standard specifies
2330 that such arguments are ignored.
2331
2332 Where the unused arguments lie between used arguments that are
2333 specified with @samp{$} operand number specifications, normally
2334 warnings are still given, since the implementation could not know what
2335 type to pass to @code{va_arg} to skip the unused arguments.  However,
2336 in the case of @code{scanf} formats, this option will suppress the
2337 warning if the unused arguments are all pointers, since the Single
2338 Unix Specification says that such unused arguments are allowed.
2339
2340 @item -Wno-format-zero-length
2341 @opindex Wno-format-zero-length
2342 If @option{-Wformat} is specified, do not warn about zero-length formats.
2343 The C standard specifies that zero-length formats are allowed.
2344
2345 @item -Wformat-nonliteral
2346 @opindex Wformat-nonliteral
2347 If @option{-Wformat} is specified, also warn if the format string is not a
2348 string literal and so cannot be checked, unless the format function
2349 takes its format arguments as a @code{va_list}.
2350
2351 @item -Wformat-security
2352 @opindex Wformat-security
2353 If @option{-Wformat} is specified, also warn about uses of format
2354 functions that represent possible security problems.  At present, this
2355 warns about calls to @code{printf} and @code{scanf} functions where the
2356 format string is not a string literal and there are no format arguments,
2357 as in @code{printf (foo);}.  This may be a security hole if the format
2358 string came from untrusted input and contains @samp{%n}.  (This is
2359 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2360 in future warnings may be added to @option{-Wformat-security} that are not
2361 included in @option{-Wformat-nonliteral}.)
2362
2363 @item -Wformat=2
2364 @opindex Wformat=2
2365 Enable @option{-Wformat} plus format checks not included in
2366 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2367 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2368
2369 @item -Wnonnull
2370 @opindex Wnonnull
2371 Warn about passing a null pointer for arguments marked as
2372 requiring a non-null value by the @code{nonnull} function attribute.
2373
2374 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2375 can be disabled with the @option{-Wno-nonnull} option.
2376
2377 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2378 @opindex Winit-self
2379 Warn about uninitialized variables which are initialized with themselves.
2380 Note this option can only be used with the @option{-Wuninitialized} option,
2381 which in turn only works with @option{-O1} and above.
2382
2383 For example, GCC will warn about @code{i} being uninitialized in the
2384 following snippet only when @option{-Winit-self} has been specified:
2385 @smallexample
2386 @group
2387 int f()
2388 @{
2389   int i = i;
2390   return i;
2391 @}
2392 @end group
2393 @end smallexample
2394
2395 @item -Wimplicit-int
2396 @opindex Wimplicit-int
2397 Warn when a declaration does not specify a type.
2398 This warning is enabled by @option{-Wall}.
2399
2400 @item -Wimplicit-function-declaration
2401 @itemx -Werror-implicit-function-declaration
2402 @opindex Wimplicit-function-declaration
2403 @opindex Werror-implicit-function-declaration
2404 Give a warning (or error) whenever a function is used before being
2405 declared.  The form @option{-Wno-error-implicit-function-declaration}
2406 is not supported.
2407 This warning is enabled by @option{-Wall} (as a warning, not an error).
2408
2409 @item -Wimplicit
2410 @opindex Wimplicit
2411 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2412 This warning is enabled by @option{-Wall}.
2413
2414 @item -Wmain
2415 @opindex Wmain
2416 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2417 function with external linkage, returning int, taking either zero
2418 arguments, two, or three arguments of appropriate types.
2419 This warning is enabled by @option{-Wall}.
2420
2421 @item -Wmissing-braces
2422 @opindex Wmissing-braces
2423 Warn if an aggregate or union initializer is not fully bracketed.  In
2424 the following example, the initializer for @samp{a} is not fully
2425 bracketed, but that for @samp{b} is fully bracketed.
2426
2427 @smallexample
2428 int a[2][2] = @{ 0, 1, 2, 3 @};
2429 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2430 @end smallexample
2431
2432 This warning is enabled by @option{-Wall}.
2433
2434 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2435 @opindex Wmissing-include-dirs
2436 Warn if a user-supplied include directory does not exist.
2437
2438 @item -Wparentheses
2439 @opindex Wparentheses
2440 Warn if parentheses are omitted in certain contexts, such
2441 as when there is an assignment in a context where a truth value
2442 is expected, or when operators are nested whose precedence people
2443 often get confused about.  Only the warning for an assignment used as
2444 a truth value is supported when compiling C++; the other warnings are
2445 only supported when compiling C@.
2446
2447 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2448 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2449 interpretation from that of ordinary mathematical notation.
2450
2451 Also warn about constructions where there may be confusion to which
2452 @code{if} statement an @code{else} branch belongs.  Here is an example of
2453 such a case:
2454
2455 @smallexample
2456 @group
2457 @{
2458   if (a)
2459     if (b)
2460       foo ();
2461   else
2462     bar ();
2463 @}
2464 @end group
2465 @end smallexample
2466
2467 In C, every @code{else} branch belongs to the innermost possible @code{if}
2468 statement, which in this example is @code{if (b)}.  This is often not
2469 what the programmer expected, as illustrated in the above example by
2470 indentation the programmer chose.  When there is the potential for this
2471 confusion, GCC will issue a warning when this flag is specified.
2472 To eliminate the warning, add explicit braces around the innermost
2473 @code{if} statement so there is no way the @code{else} could belong to
2474 the enclosing @code{if}.  The resulting code would look like this:
2475
2476 @smallexample
2477 @group
2478 @{
2479   if (a)
2480     @{
2481       if (b)
2482         foo ();
2483       else
2484         bar ();
2485     @}
2486 @}
2487 @end group
2488 @end smallexample
2489
2490 This warning is enabled by @option{-Wall}.
2491
2492 @item -Wsequence-point
2493 @opindex Wsequence-point
2494 Warn about code that may have undefined semantics because of violations
2495 of sequence point rules in the C standard.
2496
2497 The C standard defines the order in which expressions in a C program are
2498 evaluated in terms of @dfn{sequence points}, which represent a partial
2499 ordering between the execution of parts of the program: those executed
2500 before the sequence point, and those executed after it.  These occur
2501 after the evaluation of a full expression (one which is not part of a
2502 larger expression), after the evaluation of the first operand of a
2503 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2504 function is called (but after the evaluation of its arguments and the
2505 expression denoting the called function), and in certain other places.
2506 Other than as expressed by the sequence point rules, the order of
2507 evaluation of subexpressions of an expression is not specified.  All
2508 these rules describe only a partial order rather than a total order,
2509 since, for example, if two functions are called within one expression
2510 with no sequence point between them, the order in which the functions
2511 are called is not specified.  However, the standards committee have
2512 ruled that function calls do not overlap.
2513
2514 It is not specified when between sequence points modifications to the
2515 values of objects take effect.  Programs whose behavior depends on this
2516 have undefined behavior; the C standard specifies that ``Between the
2517 previous and next sequence point an object shall have its stored value
2518 modified at most once by the evaluation of an expression.  Furthermore,
2519 the prior value shall be read only to determine the value to be
2520 stored.''.  If a program breaks these rules, the results on any
2521 particular implementation are entirely unpredictable.
2522
2523 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2524 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2525 diagnosed by this option, and it may give an occasional false positive
2526 result, but in general it has been found fairly effective at detecting
2527 this sort of problem in programs.
2528
2529 The present implementation of this option only works for C programs.  A
2530 future implementation may also work for C++ programs.
2531
2532 The C standard is worded confusingly, therefore there is some debate
2533 over the precise meaning of the sequence point rules in subtle cases.
2534 Links to discussions of the problem, including proposed formal
2535 definitions, may be found on the GCC readings page, at
2536 @w{@uref{http://gcc.gnu.org/readings.html}}.
2537
2538 This warning is enabled by @option{-Wall}.
2539
2540 @item -Wreturn-type
2541 @opindex Wreturn-type
2542 Warn whenever a function is defined with a return-type that defaults to
2543 @code{int}.  Also warn about any @code{return} statement with no
2544 return-value in a function whose return-type is not @code{void}.
2545
2546 For C, also warn if the return type of a function has a type qualifier
2547 such as @code{const}.  Such a type qualifier has no effect, since the
2548 value returned by a function is not an lvalue.  ISO C prohibits
2549 qualified @code{void} return types on function definitions, so such
2550 return types always receive a warning even without this option.
2551
2552 For C++, a function without return type always produces a diagnostic
2553 message, even when @option{-Wno-return-type} is specified.  The only
2554 exceptions are @samp{main} and functions defined in system headers.
2555
2556 This warning is enabled by @option{-Wall}.
2557
2558 @item -Wswitch
2559 @opindex Wswitch
2560 Warn whenever a @code{switch} statement has an index of enumerated type
2561 and lacks a @code{case} for one or more of the named codes of that
2562 enumeration.  (The presence of a @code{default} label prevents this
2563 warning.)  @code{case} labels outside the enumeration range also
2564 provoke warnings when this option is used.
2565 This warning is enabled by @option{-Wall}.
2566
2567 @item -Wswitch-default
2568 @opindex Wswitch-switch
2569 Warn whenever a @code{switch} statement does not have a @code{default}
2570 case.
2571
2572 @item -Wswitch-enum
2573 @opindex Wswitch-enum
2574 Warn whenever a @code{switch} statement has an index of enumerated type
2575 and lacks a @code{case} for one or more of the named codes of that
2576 enumeration.  @code{case} labels outside the enumeration range also
2577 provoke warnings when this option is used.
2578
2579 @item -Wtrigraphs
2580 @opindex Wtrigraphs
2581 Warn if any trigraphs are encountered that might change the meaning of
2582 the program (trigraphs within comments are not warned about).
2583 This warning is enabled by @option{-Wall}.
2584
2585 @item -Wunused-function
2586 @opindex Wunused-function
2587 Warn whenever a static function is declared but not defined or a
2588 non\-inline static function is unused.
2589 This warning is enabled by @option{-Wall}.
2590
2591 @item -Wunused-label
2592 @opindex Wunused-label
2593 Warn whenever a label is declared but not used.
2594 This warning is enabled by @option{-Wall}.
2595
2596 To suppress this warning use the @samp{unused} attribute
2597 (@pxref{Variable Attributes}).
2598
2599 @item -Wunused-parameter
2600 @opindex Wunused-parameter
2601 Warn whenever a function parameter is unused aside from its declaration.
2602
2603 To suppress this warning use the @samp{unused} attribute
2604 (@pxref{Variable Attributes}).
2605
2606 @item -Wunused-variable
2607 @opindex Wunused-variable
2608 Warn whenever a local variable or non-constant static variable is unused
2609 aside from its declaration
2610 This warning is enabled by @option{-Wall}.
2611
2612 To suppress this warning use the @samp{unused} attribute
2613 (@pxref{Variable Attributes}).
2614
2615 @item -Wunused-value
2616 @opindex Wunused-value
2617 Warn whenever a statement computes a result that is explicitly not used.
2618 This warning is enabled by @option{-Wall}.
2619
2620 To suppress this warning cast the expression to @samp{void}.
2621
2622 @item -Wunused
2623 @opindex Wunused
2624 All the above @option{-Wunused} options combined.
2625
2626 In order to get a warning about an unused function parameter, you must
2627 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2628 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2629
2630 @item -Wuninitialized
2631 @opindex Wuninitialized
2632 Warn if an automatic variable is used without first being initialized or
2633 if a variable may be clobbered by a @code{setjmp} call.
2634
2635 These warnings are possible only in optimizing compilation,
2636 because they require data flow information that is computed only
2637 when optimizing.  If you don't specify @option{-O}, you simply won't
2638 get these warnings.
2639
2640 If you want to warn about code which uses the uninitialized value of the
2641 variable in its own initializer, use the @option{-Winit-self} option.
2642
2643 These warnings occur for individual uninitialized or clobbered
2644 elements of structure, union or array variables as well as for
2645 variables which are uninitialized or clobbered as a whole.  They do
2646 not occur for variables or elements declared @code{volatile}.  Because
2647 these warnings depend on optimization, the exact variables or elements
2648 for which there are warnings will depend on the precise optimization
2649 options and version of GCC used.
2650
2651 Note that there may be no warning about a variable that is used only
2652 to compute a value that itself is never used, because such
2653 computations may be deleted by data flow analysis before the warnings
2654 are printed.
2655
2656 These warnings are made optional because GCC is not smart
2657 enough to see all the reasons why the code might be correct
2658 despite appearing to have an error.  Here is one example of how
2659 this can happen:
2660
2661 @smallexample
2662 @group
2663 @{
2664   int x;
2665   switch (y)
2666     @{
2667     case 1: x = 1;
2668       break;
2669     case 2: x = 4;
2670       break;
2671     case 3: x = 5;
2672     @}
2673   foo (x);
2674 @}
2675 @end group
2676 @end smallexample
2677
2678 @noindent
2679 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2680 always initialized, but GCC doesn't know this.  Here is
2681 another common case:
2682
2683 @smallexample
2684 @{
2685   int save_y;
2686   if (change_y) save_y = y, y = new_y;
2687   @dots{}
2688   if (change_y) y = save_y;
2689 @}
2690 @end smallexample
2691
2692 @noindent
2693 This has no bug because @code{save_y} is used only if it is set.
2694
2695 @cindex @code{longjmp} warnings
2696 This option also warns when a non-volatile automatic variable might be
2697 changed by a call to @code{longjmp}.  These warnings as well are possible
2698 only in optimizing compilation.
2699
2700 The compiler sees only the calls to @code{setjmp}.  It cannot know
2701 where @code{longjmp} will be called; in fact, a signal handler could
2702 call it at any point in the code.  As a result, you may get a warning
2703 even when there is in fact no problem because @code{longjmp} cannot
2704 in fact be called at the place which would cause a problem.
2705
2706 Some spurious warnings can be avoided if you declare all the functions
2707 you use that never return as @code{noreturn}.  @xref{Function
2708 Attributes}.
2709
2710 This warning is enabled by @option{-Wall}.
2711
2712 @item -Wunknown-pragmas
2713 @opindex Wunknown-pragmas
2714 @cindex warning for unknown pragmas
2715 @cindex unknown pragmas, warning
2716 @cindex pragmas, warning of unknown
2717 Warn when a #pragma directive is encountered which is not understood by
2718 GCC@.  If this command line option is used, warnings will even be issued
2719 for unknown pragmas in system header files.  This is not the case if
2720 the warnings were only enabled by the @option{-Wall} command line option.
2721
2722 @item -Wno-pragmas
2723 @opindex Wno-pragmas
2724 @opindex Wpragmas
2725 Do not warn about misuses of pragmas, such as incorrect parameters,
2726 invalid syntax, or conflicts between pragmas.  See also
2727 @samp{-Wunknown-pragmas}.
2728
2729 @item -Wstrict-aliasing
2730 @opindex Wstrict-aliasing
2731 This option is only active when @option{-fstrict-aliasing} is active.
2732 It warns about code which might break the strict aliasing rules that the
2733 compiler is using for optimization.  The warning does not catch all
2734 cases, but does attempt to catch the more common pitfalls.  It is
2735 included in @option{-Wall}.
2736
2737 @item -Wstrict-aliasing=2
2738 @opindex Wstrict-aliasing=2
2739 This option is only active when @option{-fstrict-aliasing} is active.
2740 It warns about code which might break the strict aliasing rules that the
2741 compiler is using for optimization.  This warning catches more cases than
2742 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2743 cases that are safe.
2744
2745 @item -Wall
2746 @opindex Wall
2747 All of the above @samp{-W} options combined.  This enables all the
2748 warnings about constructions that some users consider questionable, and
2749 that are easy to avoid (or modify to prevent the warning), even in
2750 conjunction with macros.  This also enables some language-specific
2751 warnings described in @ref{C++ Dialect Options} and
2752 @ref{Objective-C and Objective-C++ Dialect Options}.
2753 @end table
2754
2755 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2756 Some of them warn about constructions that users generally do not
2757 consider questionable, but which occasionally you might wish to check
2758 for; others warn about constructions that are necessary or hard to avoid
2759 in some cases, and there is no simple way to modify the code to suppress
2760 the warning.
2761
2762 @table @gcctabopt
2763 @item -Wextra
2764 @opindex W
2765 @opindex Wextra
2766 (This option used to be called @option{-W}.  The older name is still
2767 supported, but the newer name is more descriptive.)  Print extra warning
2768 messages for these events:
2769
2770 @itemize @bullet
2771 @item
2772 A function can return either with or without a value.  (Falling
2773 off the end of the function body is considered returning without
2774 a value.)  For example, this function would evoke such a
2775 warning:
2776
2777 @smallexample
2778 @group
2779 foo (a)
2780 @{
2781   if (a > 0)
2782     return a;
2783 @}
2784 @end group
2785 @end smallexample
2786
2787 @item
2788 An expression-statement or the left-hand side of a comma expression
2789 contains no side effects.
2790 To suppress the warning, cast the unused expression to void.
2791 For example, an expression such as @samp{x[i,j]} will cause a warning,
2792 but @samp{x[(void)i,j]} will not.
2793
2794 @item
2795 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2796
2797 @item
2798 Storage-class specifiers like @code{static} are not the first things in
2799 a declaration.  According to the C Standard, this usage is obsolescent.
2800
2801 @item
2802 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2803 arguments.
2804
2805 @item
2806 A comparison between signed and unsigned values could produce an
2807 incorrect result when the signed value is converted to unsigned.
2808 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2809
2810 @item
2811 An aggregate has an initializer which does not initialize all members.
2812 This warning can be independently controlled by
2813 @option{-Wmissing-field-initializers}.
2814
2815 @item
2816 A function parameter is declared without a type specifier in K&R-style
2817 functions:
2818
2819 @smallexample
2820 void foo(bar) @{ @}
2821 @end smallexample
2822
2823 @item
2824 An empty body occurs in an @samp{if} or @samp{else} statement.
2825
2826 @item
2827 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2828 @samp{>}, or @samp{>=}.
2829
2830 @item
2831 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2832
2833 @item
2834 Any of several floating-point events that often indicate errors, such as
2835 overflow, underflow, loss of precision, etc.
2836
2837 @item @r{(C++ only)}
2838 An enumerator and a non-enumerator both appear in a conditional expression.
2839
2840 @item @r{(C++ only)}
2841 A non-static reference or non-static @samp{const} member appears in a
2842 class without constructors.
2843
2844 @item @r{(C++ only)}
2845 Ambiguous virtual bases.
2846
2847 @item @r{(C++ only)}
2848 Subscripting an array which has been declared @samp{register}.
2849
2850 @item @r{(C++ only)}
2851 Taking the address of a variable which has been declared @samp{register}.
2852
2853 @item @r{(C++ only)}
2854 A base class is not initialized in a derived class' copy constructor.
2855 @end itemize
2856
2857 @item -Wno-div-by-zero
2858 @opindex Wno-div-by-zero
2859 @opindex Wdiv-by-zero
2860 Do not warn about compile-time integer division by zero.  Floating point
2861 division by zero is not warned about, as it can be a legitimate way of
2862 obtaining infinities and NaNs.
2863
2864 @item -Wsystem-headers
2865 @opindex Wsystem-headers
2866 @cindex warnings from system headers
2867 @cindex system headers, warnings from
2868 Print warning messages for constructs found in system header files.
2869 Warnings from system headers are normally suppressed, on the assumption
2870 that they usually do not indicate real problems and would only make the
2871 compiler output harder to read.  Using this command line option tells
2872 GCC to emit warnings from system headers as if they occurred in user
2873 code.  However, note that using @option{-Wall} in conjunction with this
2874 option will @emph{not} warn about unknown pragmas in system
2875 headers---for that, @option{-Wunknown-pragmas} must also be used.
2876
2877 @item -Wfloat-equal
2878 @opindex Wfloat-equal
2879 Warn if floating point values are used in equality comparisons.
2880
2881 The idea behind this is that sometimes it is convenient (for the
2882 programmer) to consider floating-point values as approximations to
2883 infinitely precise real numbers.  If you are doing this, then you need
2884 to compute (by analyzing the code, or in some other way) the maximum or
2885 likely maximum error that the computation introduces, and allow for it
2886 when performing comparisons (and when producing output, but that's a
2887 different problem).  In particular, instead of testing for equality, you
2888 would check to see whether the two values have ranges that overlap; and
2889 this is done with the relational operators, so equality comparisons are
2890 probably mistaken.
2891
2892 @item -Wtraditional @r{(C only)}
2893 @opindex Wtraditional
2894 Warn about certain constructs that behave differently in traditional and
2895 ISO C@.  Also warn about ISO C constructs that have no traditional C
2896 equivalent, and/or problematic constructs which should be avoided.
2897
2898 @itemize @bullet
2899 @item
2900 Macro parameters that appear within string literals in the macro body.
2901 In traditional C macro replacement takes place within string literals,
2902 but does not in ISO C@.
2903
2904 @item
2905 In traditional C, some preprocessor directives did not exist.
2906 Traditional preprocessors would only consider a line to be a directive
2907 if the @samp{#} appeared in column 1 on the line.  Therefore
2908 @option{-Wtraditional} warns about directives that traditional C
2909 understands but would ignore because the @samp{#} does not appear as the
2910 first character on the line.  It also suggests you hide directives like
2911 @samp{#pragma} not understood by traditional C by indenting them.  Some
2912 traditional implementations would not recognize @samp{#elif}, so it
2913 suggests avoiding it altogether.
2914
2915 @item
2916 A function-like macro that appears without arguments.
2917
2918 @item
2919 The unary plus operator.
2920
2921 @item
2922 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2923 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2924 constants.)  Note, these suffixes appear in macros defined in the system
2925 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2926 Use of these macros in user code might normally lead to spurious
2927 warnings, however GCC's integrated preprocessor has enough context to
2928 avoid warning in these cases.
2929
2930 @item
2931 A function declared external in one block and then used after the end of
2932 the block.
2933
2934 @item
2935 A @code{switch} statement has an operand of type @code{long}.
2936
2937 @item
2938 A non-@code{static} function declaration follows a @code{static} one.
2939 This construct is not accepted by some traditional C compilers.
2940
2941 @item
2942 The ISO type of an integer constant has a different width or
2943 signedness from its traditional type.  This warning is only issued if
2944 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2945 typically represent bit patterns, are not warned about.
2946
2947 @item
2948 Usage of ISO string concatenation is detected.
2949
2950 @item
2951 Initialization of automatic aggregates.
2952
2953 @item
2954 Identifier conflicts with labels.  Traditional C lacks a separate
2955 namespace for labels.
2956
2957 @item
2958 Initialization of unions.  If the initializer is zero, the warning is
2959 omitted.  This is done under the assumption that the zero initializer in
2960 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2961 initializer warnings and relies on default initialization to zero in the
2962 traditional C case.
2963
2964 @item
2965 Conversions by prototypes between fixed/floating point values and vice
2966 versa.  The absence of these prototypes when compiling with traditional
2967 C would cause serious problems.  This is a subset of the possible
2968 conversion warnings, for the full set use @option{-Wconversion}.
2969
2970 @item
2971 Use of ISO C style function definitions.  This warning intentionally is
2972 @emph{not} issued for prototype declarations or variadic functions
2973 because these ISO C features will appear in your code when using
2974 libiberty's traditional C compatibility macros, @code{PARAMS} and
2975 @code{VPARAMS}.  This warning is also bypassed for nested functions
2976 because that feature is already a GCC extension and thus not relevant to
2977 traditional C compatibility.
2978 @end itemize
2979
2980 @item -Wdeclaration-after-statement @r{(C only)}
2981 @opindex Wdeclaration-after-statement
2982 Warn when a declaration is found after a statement in a block.  This
2983 construct, known from C++, was introduced with ISO C99 and is by default
2984 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2985 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2986
2987 @item -Wundef
2988 @opindex Wundef
2989 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2990
2991 @item -Wno-endif-labels
2992 @opindex Wno-endif-labels
2993 @opindex Wendif-labels
2994 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2995
2996 @item -Wshadow
2997 @opindex Wshadow
2998 Warn whenever a local variable shadows another local variable, parameter or
2999 global variable or whenever a built-in function is shadowed.
3000
3001 @item -Wlarger-than-@var{len}
3002 @opindex Wlarger-than
3003 Warn whenever an object of larger than @var{len} bytes is defined.
3004
3005 @item -Wunsafe-loop-optimizations
3006 @opindex Wunsafe-loop-optimizations
3007 Warn if the loop cannot be optimized because the compiler could not
3008 assume anything on the bounds of the loop indices.  With
3009 @option{-funsafe-loop-optimizations} warn if the compiler made
3010 such assumptions.
3011
3012 @item -Wpointer-arith
3013 @opindex Wpointer-arith
3014 Warn about anything that depends on the ``size of'' a function type or
3015 of @code{void}.  GNU C assigns these types a size of 1, for
3016 convenience in calculations with @code{void *} pointers and pointers
3017 to functions.
3018
3019 @item -Wbad-function-cast @r{(C only)}
3020 @opindex Wbad-function-cast
3021 Warn whenever a function call is cast to a non-matching type.
3022 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3023
3024 @item -Wc++-compat
3025 Warn about ISO C constructs that are outside of the common subset of
3026 ISO C and ISO C++, e.g.@: request for implicit conversion from
3027 @code{void *} to a pointer to non-@code{void} type.
3028
3029 @item -Wcast-qual
3030 @opindex Wcast-qual
3031 Warn whenever a pointer is cast so as to remove a type qualifier from
3032 the target type.  For example, warn if a @code{const char *} is cast
3033 to an ordinary @code{char *}.
3034
3035 @item -Wcast-align
3036 @opindex Wcast-align
3037 Warn whenever a pointer is cast such that the required alignment of the
3038 target is increased.  For example, warn if a @code{char *} is cast to
3039 an @code{int *} on machines where integers can only be accessed at
3040 two- or four-byte boundaries.
3041
3042 @item -Wwrite-strings
3043 @opindex Wwrite-strings
3044 When compiling C, give string constants the type @code{const
3045 char[@var{length}]} so that
3046 copying the address of one into a non-@code{const} @code{char *}
3047 pointer will get a warning; when compiling C++, warn about the
3048 deprecated conversion from string constants to @code{char *}.
3049 These warnings will help you find at
3050 compile time code that can try to write into a string constant, but
3051 only if you have been very careful about using @code{const} in
3052 declarations and prototypes.  Otherwise, it will just be a nuisance;
3053 this is why we did not make @option{-Wall} request these warnings.
3054
3055 @item -Wconversion
3056 @opindex Wconversion
3057 Warn if a prototype causes a type conversion that is different from what
3058 would happen to the same argument in the absence of a prototype.  This
3059 includes conversions of fixed point to floating and vice versa, and
3060 conversions changing the width or signedness of a fixed point argument
3061 except when the same as the default promotion.
3062
3063 Also, warn if a negative integer constant expression is implicitly
3064 converted to an unsigned type.  For example, warn about the assignment
3065 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3066 casts like @code{(unsigned) -1}.
3067
3068 @item -Wsign-compare
3069 @opindex Wsign-compare
3070 @cindex warning for comparison of signed and unsigned values
3071 @cindex comparison of signed and unsigned values, warning
3072 @cindex signed and unsigned values, comparison warning
3073 Warn when a comparison between signed and unsigned values could produce
3074 an incorrect result when the signed value is converted to unsigned.
3075 This warning is also enabled by @option{-Wextra}; to get the other warnings
3076 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3077
3078 @item -Waggregate-return
3079 @opindex Waggregate-return
3080 Warn if any functions that return structures or unions are defined or
3081 called.  (In languages where you can return an array, this also elicits
3082 a warning.)
3083
3084 @item -Wno-attributes
3085 @opindex Wno-attributes
3086 @opindex Wattributes
3087 Do not warn if an unexpected @code{__attribute__} is used, such as
3088 unrecognized attributes, function attributes applied to variables,
3089 etc.  This will not stop errors for incorrect use of supported
3090 attributes.
3091
3092 @item -Wstrict-prototypes @r{(C only)}
3093 @opindex Wstrict-prototypes
3094 Warn if a function is declared or defined without specifying the
3095 argument types.  (An old-style function definition is permitted without
3096 a warning if preceded by a declaration which specifies the argument
3097 types.)
3098
3099 @item -Wold-style-definition @r{(C only)}
3100 @opindex Wold-style-definition
3101 Warn if an old-style function definition is used.  A warning is given
3102 even if there is a previous prototype.
3103
3104 @item -Wmissing-prototypes @r{(C only)}
3105 @opindex Wmissing-prototypes
3106 Warn if a global function is defined without a previous prototype
3107 declaration.  This warning is issued even if the definition itself
3108 provides a prototype.  The aim is to detect global functions that fail
3109 to be declared in header files.
3110
3111 @item -Wmissing-declarations @r{(C only)}
3112 @opindex Wmissing-declarations
3113 Warn if a global function is defined without a previous declaration.
3114 Do so even if the definition itself provides a prototype.
3115 Use this option to detect global functions that are not declared in
3116 header files.
3117
3118 @item -Wmissing-field-initializers
3119 @opindex Wmissing-field-initializers
3120 @opindex W
3121 @opindex Wextra
3122 Warn if a structure's initializer has some fields missing.  For
3123 example, the following code would cause such a warning, because
3124 @code{x.h} is implicitly zero:
3125
3126 @smallexample
3127 struct s @{ int f, g, h; @};
3128 struct s x = @{ 3, 4 @};
3129 @end smallexample
3130
3131 This option does not warn about designated initializers, so the following
3132 modification would not trigger a warning:
3133
3134 @smallexample
3135 struct s @{ int f, g, h; @};
3136 struct s x = @{ .f = 3, .g = 4 @};
3137 @end smallexample
3138
3139 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3140 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3141
3142 @item -Wmissing-noreturn
3143 @opindex Wmissing-noreturn
3144 Warn about functions which might be candidates for attribute @code{noreturn}.
3145 Note these are only possible candidates, not absolute ones.  Care should
3146 be taken to manually verify functions actually do not ever return before
3147 adding the @code{noreturn} attribute, otherwise subtle code generation
3148 bugs could be introduced.  You will not get a warning for @code{main} in
3149 hosted C environments.
3150
3151 @item -Wmissing-format-attribute
3152 @opindex Wmissing-format-attribute
3153 @opindex Wformat
3154 Warn about function pointers which might be candidates for @code{format}
3155 attributes.  Note these are only possible candidates, not absolute ones.
3156 GCC will guess that function pointers with @code{format} attributes that
3157 are used in assignment, initialization, parameter passing or return
3158 statements should have a corresponding @code{format} attribute in the
3159 resulting type.  I.e.@: the left-hand side of the assignment or
3160 initialization, the type of the parameter variable, or the return type
3161 of the containing function respectively should also have a @code{format}
3162 attribute to avoid the warning.
3163
3164 GCC will also warn about function definitions which might be
3165 candidates for @code{format} attributes.  Again, these are only
3166 possible candidates.  GCC will guess that @code{format} attributes
3167 might be appropriate for any function that calls a function like
3168 @code{vprintf} or @code{vscanf}, but this might not always be the
3169 case, and some functions for which @code{format} attributes are
3170 appropriate may not be detected.
3171
3172 @item -Wno-multichar
3173 @opindex Wno-multichar
3174 @opindex Wmultichar
3175 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3176 Usually they indicate a typo in the user's code, as they have
3177 implementation-defined values, and should not be used in portable code.
3178
3179 @item -Wnormalized=<none|id|nfc|nfkc>
3180 @opindex Wnormalized
3181 @cindex NFC
3182 @cindex NFKC
3183 @cindex character set, input normalization
3184 In ISO C and ISO C++, two identifiers are different if they are
3185 different sequences of characters.  However, sometimes when characters
3186 outside the basic ASCII character set are used, you can have two
3187 different character sequences that look the same.  To avoid confusion,
3188 the ISO 10646 standard sets out some @dfn{normalization rules} which
3189 when applied ensure that two sequences that look the same are turned into
3190 the same sequence.  GCC can warn you if you are using identifiers which
3191 have not been normalized; this option controls that warning.
3192
3193 There are four levels of warning that GCC supports.  The default is
3194 @option{-Wnormalized=nfc}, which warns about any identifier which is
3195 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3196 recommended form for most uses.
3197
3198 Unfortunately, there are some characters which ISO C and ISO C++ allow
3199 in identifiers that when turned into NFC aren't allowable as
3200 identifiers.  That is, there's no way to use these symbols in portable
3201 ISO C or C++ and have all your identifiers in NFC.
3202 @option{-Wnormalized=id} suppresses the warning for these characters.
3203 It is hoped that future versions of the standards involved will correct
3204 this, which is why this option is not the default.
3205
3206 You can switch the warning off for all characters by writing
3207 @option{-Wnormalized=none}.  You would only want to do this if you
3208 were using some other normalization scheme (like ``D''), because
3209 otherwise you can easily create bugs that are literally impossible to see.
3210
3211 Some characters in ISO 10646 have distinct meanings but look identical
3212 in some fonts or display methodologies, especially once formatting has
3213 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3214 LETTER N'', will display just like a regular @code{n} which has been
3215 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3216 normalisation scheme to convert all these into a standard form as
3217 well, and GCC will warn if your code is not in NFKC if you use
3218 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3219 about every identifier that contains the letter O because it might be
3220 confused with the digit 0, and so is not the default, but may be
3221 useful as a local coding convention if the programming environment is
3222 unable to be fixed to display these characters distinctly.
3223
3224 @item -Wno-deprecated-declarations
3225 @opindex Wno-deprecated-declarations
3226 Do not warn about uses of functions, variables, and types marked as
3227 deprecated by using the @code{deprecated} attribute.
3228 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3229 @pxref{Type Attributes}.)
3230
3231 @item -Wpacked
3232 @opindex Wpacked
3233 Warn if a structure is given the packed attribute, but the packed
3234 attribute has no effect on the layout or size of the structure.
3235 Such structures may be mis-aligned for little benefit.  For
3236 instance, in this code, the variable @code{f.x} in @code{struct bar}
3237 will be misaligned even though @code{struct bar} does not itself
3238 have the packed attribute:
3239
3240 @smallexample
3241 @group
3242 struct foo @{
3243   int x;
3244   char a, b, c, d;
3245 @} __attribute__((packed));
3246 struct bar @{
3247   char z;
3248   struct foo f;
3249 @};
3250 @end group
3251 @end smallexample
3252
3253 @item -Wpadded
3254 @opindex Wpadded
3255 Warn if padding is included in a structure, either to align an element
3256 of the structure or to align the whole structure.  Sometimes when this
3257 happens it is possible to rearrange the fields of the structure to
3258 reduce the padding and so make the structure smaller.
3259
3260 @item -Wredundant-decls
3261 @opindex Wredundant-decls
3262 Warn if anything is declared more than once in the same scope, even in
3263 cases where multiple declaration is valid and changes nothing.
3264
3265 @item -Wnested-externs @r{(C only)}
3266 @opindex Wnested-externs
3267 Warn if an @code{extern} declaration is encountered within a function.
3268
3269 @item -Wunreachable-code
3270 @opindex Wunreachable-code
3271 Warn if the compiler detects that code will never be executed.
3272
3273 This option is intended to warn when the compiler detects that at
3274 least a whole line of source code will never be executed, because
3275 some condition is never satisfied or because it is after a
3276 procedure that never returns.
3277
3278 It is possible for this option to produce a warning even though there
3279 are circumstances under which part of the affected line can be executed,
3280 so care should be taken when removing apparently-unreachable code.
3281
3282 For instance, when a function is inlined, a warning may mean that the
3283 line is unreachable in only one inlined copy of the function.
3284
3285 This option is not made part of @option{-Wall} because in a debugging
3286 version of a program there is often substantial code which checks
3287 correct functioning of the program and is, hopefully, unreachable
3288 because the program does work.  Another common use of unreachable
3289 code is to provide behavior which is selectable at compile-time.
3290
3291 @item -Winline
3292 @opindex Winline
3293 Warn if a function can not be inlined and it was declared as inline.
3294 Even with this option, the compiler will not warn about failures to
3295 inline functions declared in system headers.
3296
3297 The compiler uses a variety of heuristics to determine whether or not
3298 to inline a function.  For example, the compiler takes into account
3299 the size of the function being inlined and the amount of inlining
3300 that has already been done in the current function.  Therefore,
3301 seemingly insignificant changes in the source program can cause the
3302 warnings produced by @option{-Winline} to appear or disappear.
3303
3304 @item -Wno-invalid-offsetof @r{(C++ only)}
3305 @opindex Wno-invalid-offsetof
3306 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3307 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3308 to a non-POD type is undefined.  In existing C++ implementations,
3309 however, @samp{offsetof} typically gives meaningful results even when
3310 applied to certain kinds of non-POD types. (Such as a simple
3311 @samp{struct} that fails to be a POD type only by virtue of having a
3312 constructor.)  This flag is for users who are aware that they are
3313 writing nonportable code and who have deliberately chosen to ignore the
3314 warning about it.
3315
3316 The restrictions on @samp{offsetof} may be relaxed in a future version
3317 of the C++ standard.
3318
3319 @item -Wno-int-to-pointer-cast @r{(C only)}
3320 @opindex Wno-int-to-pointer-cast
3321 Suppress warnings from casts to pointer type of an integer of a
3322 different size.
3323
3324 @item -Wno-pointer-to-int-cast @r{(C only)}
3325 @opindex Wno-pointer-to-int-cast
3326 Suppress warnings from casts from a pointer to an integer type of a
3327 different size.
3328
3329 @item -Winvalid-pch
3330 @opindex Winvalid-pch
3331 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3332 the search path but can't be used.
3333
3334 @item -Wlong-long
3335 @opindex Wlong-long
3336 @opindex Wno-long-long
3337 Warn if @samp{long long} type is used.  This is default.  To inhibit
3338 the warning messages, use @option{-Wno-long-long}.  Flags
3339 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3340 only when @option{-pedantic} flag is used.
3341
3342 @item -Wvariadic-macros
3343 @opindex Wvariadic-macros
3344 @opindex Wno-variadic-macros
3345 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3346 alternate syntax when in pedantic ISO C99 mode.  This is default.
3347 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3348
3349 @item -Wdisabled-optimization
3350 @opindex Wdisabled-optimization
3351 Warn if a requested optimization pass is disabled.  This warning does
3352 not generally indicate that there is anything wrong with your code; it
3353 merely indicates that GCC's optimizers were unable to handle the code
3354 effectively.  Often, the problem is that your code is too big or too
3355 complex; GCC will refuse to optimize programs when the optimization
3356 itself is likely to take inordinate amounts of time.
3357
3358 @item -Wno-pointer-sign
3359 @opindex Wno-pointer-sign
3360 Don't warn for pointer argument passing or assignment with different signedness.
3361 Only useful in the negative form since this warning is enabled by default.
3362 This option is only supported for C and Objective-C@.
3363
3364 @item -Werror
3365 @opindex Werror
3366 Make all warnings into errors.
3367
3368 @item -Wstack-protector
3369 This option is only active when @option{-fstack-protector} is active.  It
3370 warns about functions that will not be protected against stack smashing.
3371
3372 @end table
3373
3374 @node Debugging Options
3375 @section Options for Debugging Your Program or GCC
3376 @cindex options, debugging
3377 @cindex debugging information options
3378
3379 GCC has various special options that are used for debugging
3380 either your program or GCC:
3381
3382 @table @gcctabopt
3383 @item -g
3384 @opindex g
3385 Produce debugging information in the operating system's native format
3386 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3387 information.
3388
3389 On most systems that use stabs format, @option{-g} enables use of extra
3390 debugging information that only GDB can use; this extra information
3391 makes debugging work better in GDB but will probably make other debuggers
3392 crash or
3393 refuse to read the program.  If you want to control for certain whether
3394 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3395 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3396
3397 GCC allows you to use @option{-g} with
3398 @option{-O}.  The shortcuts taken by optimized code may occasionally
3399 produce surprising results: some variables you declared may not exist
3400 at all; flow of control may briefly move where you did not expect it;
3401 some statements may not be executed because they compute constant
3402 results or their values were already at hand; some statements may
3403 execute in different places because they were moved out of loops.
3404
3405 Nevertheless it proves possible to debug optimized output.  This makes
3406 it reasonable to use the optimizer for programs that might have bugs.
3407
3408 The following options are useful when GCC is generated with the
3409 capability for more than one debugging format.
3410
3411 @item -ggdb
3412 @opindex ggdb
3413 Produce debugging information for use by GDB@.  This means to use the
3414 most expressive format available (DWARF 2, stabs, or the native format
3415 if neither of those are supported), including GDB extensions if at all
3416 possible.
3417
3418 @item -gstabs
3419 @opindex gstabs
3420 Produce debugging information in stabs format (if that is supported),
3421 without GDB extensions.  This is the format used by DBX on most BSD
3422 systems.  On MIPS, Alpha and System V Release 4 systems this option
3423 produces stabs debugging output which is not understood by DBX or SDB@.
3424 On System V Release 4 systems this option requires the GNU assembler.
3425
3426 @item -feliminate-unused-debug-symbols
3427 @opindex feliminate-unused-debug-symbols
3428 Produce debugging information in stabs format (if that is supported),
3429 for only symbols that are actually used.
3430
3431 @item -gstabs+
3432 @opindex gstabs+
3433 Produce debugging information in stabs format (if that is supported),
3434 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3435 use of these extensions is likely to make other debuggers crash or
3436 refuse to read the program.
3437
3438 @item -gcoff
3439 @opindex gcoff
3440 Produce debugging information in COFF format (if that is supported).
3441 This is the format used by SDB on most System V systems prior to
3442 System V Release 4.
3443
3444 @item -gxcoff
3445 @opindex gxcoff
3446 Produce debugging information in XCOFF format (if that is supported).
3447 This is the format used by the DBX debugger on IBM RS/6000 systems.
3448
3449 @item -gxcoff+
3450 @opindex gxcoff+
3451 Produce debugging information in XCOFF format (if that is supported),
3452 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3453 use of these extensions is likely to make other debuggers crash or
3454 refuse to read the program, and may cause assemblers other than the GNU
3455 assembler (GAS) to fail with an error.
3456
3457 @item -gdwarf-2
3458 @opindex gdwarf-2
3459 Produce debugging information in DWARF version 2 format (if that is
3460 supported).  This is the format used by DBX on IRIX 6.  With this
3461 option, GCC uses features of DWARF version 3 when they are useful;
3462 version 3 is upward compatible with version 2, but may still cause
3463 problems for older debuggers.
3464
3465 @item -gvms
3466 @opindex gvms
3467 Produce debugging information in VMS debug format (if that is
3468 supported).  This is the format used by DEBUG on VMS systems.
3469
3470 @item -g@var{level}
3471 @itemx -ggdb@var{level}
3472 @itemx -gstabs@var{level}
3473 @itemx -gcoff@var{level}
3474 @itemx -gxcoff@var{level}
3475 @itemx -gvms@var{level}
3476 Request debugging information and also use @var{level} to specify how
3477 much information.  The default level is 2.
3478
3479 Level 1 produces minimal information, enough for making backtraces in
3480 parts of the program that you don't plan to debug.  This includes
3481 descriptions of functions and external variables, but no information
3482 about local variables and no line numbers.
3483
3484 Level 3 includes extra information, such as all the macro definitions
3485 present in the program.  Some debuggers support macro expansion when
3486 you use @option{-g3}.
3487
3488 @option{-gdwarf-2} does not accept a concatenated debug level, because
3489 GCC used to support an option @option{-gdwarf} that meant to generate
3490 debug information in version 1 of the DWARF format (which is very
3491 different from version 2), and it would have been too confusing.  That
3492 debug format is long obsolete, but the option cannot be changed now.
3493 Instead use an additional @option{-g@var{level}} option to change the
3494 debug level for DWARF2.
3495
3496 @item -feliminate-dwarf2-dups
3497 @opindex feliminate-dwarf2-dups
3498 Compress DWARF2 debugging information by eliminating duplicated
3499 information about each symbol.  This option only makes sense when
3500 generating DWARF2 debugging information with @option{-gdwarf-2}.
3501
3502 @cindex @command{prof}
3503 @item -p
3504 @opindex p
3505 Generate extra code to write profile information suitable for the
3506 analysis program @command{prof}.  You must use this option when compiling
3507 the source files you want data about, and you must also use it when
3508 linking.
3509
3510 @cindex @command{gprof}
3511 @item -pg
3512 @opindex pg
3513 Generate extra code to write profile information suitable for the
3514 analysis program @command{gprof}.  You must use this option when compiling
3515 the source files you want data about, and you must also use it when
3516 linking.
3517
3518 @item -Q
3519 @opindex Q
3520 Makes the compiler print out each function name as it is compiled, and
3521 print some statistics about each pass when it finishes.
3522
3523 @item -ftime-report
3524 @opindex ftime-report
3525 Makes the compiler print some statistics about the time consumed by each
3526 pass when it finishes.
3527
3528 @item -fmem-report
3529 @opindex fmem-report
3530 Makes the compiler print some statistics about permanent memory
3531 allocation when it finishes.
3532
3533 @item -fprofile-arcs
3534 @opindex fprofile-arcs
3535 Add code so that program flow @dfn{arcs} are instrumented.  During
3536 execution the program records how many times each branch and call is
3537 executed and how many times it is taken or returns.  When the compiled
3538 program exits it saves this data to a file called
3539 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3540 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3541 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3542 @var{auxname} is generated from the name of the output file, if
3543 explicitly specified and it is not the final executable, otherwise it is
3544 the basename of the source file.  In both cases any suffix is removed
3545 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3546 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3547 @xref{Cross-profiling}.
3548
3549 @cindex @command{gcov}
3550 @item --coverage
3551 @opindex coverage
3552
3553 This option is used to compile and link code instrumented for coverage
3554 analysis.  The option is a synonym for @option{-fprofile-arcs}
3555 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3556 linking).  See the documentation for those options for more details.
3557
3558 @itemize
3559
3560 @item
3561 Compile the source files with @option{-fprofile-arcs} plus optimization
3562 and code generation options.  For test coverage analysis, use the
3563 additional @option{-ftest-coverage} option.  You do not need to profile
3564 every source file in a program.
3565
3566 @item
3567 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3568 (the latter implies the former).
3569
3570 @item
3571 Run the program on a representative workload to generate the arc profile
3572 information.  This may be repeated any number of times.  You can run
3573 concurrent instances of your program, and provided that the file system
3574 supports locking, the data files will be correctly updated.  Also
3575 @code{fork} calls are detected and correctly handled (double counting
3576 will not happen).
3577
3578 @item
3579 For profile-directed optimizations, compile the source files again with
3580 the same optimization and code generation options plus
3581 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3582 Control Optimization}).
3583
3584 @item
3585 For test coverage analysis, use @command{gcov} to produce human readable
3586 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3587 @command{gcov} documentation for further information.
3588
3589 @end itemize
3590
3591 With @option{-fprofile-arcs}, for each function of your program GCC
3592 creates a program flow graph, then finds a spanning tree for the graph.
3593 Only arcs that are not on the spanning tree have to be instrumented: the
3594 compiler adds code to count the number of times that these arcs are
3595 executed.  When an arc is the only exit or only entrance to a block, the
3596 instrumentation code can be added to the block; otherwise, a new basic
3597 block must be created to hold the instrumentation code.
3598
3599 @need 2000
3600 @item -ftest-coverage
3601 @opindex ftest-coverage
3602 Produce a notes file that the @command{gcov} code-coverage utility
3603 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3604 show program coverage.  Each source file's note file is called
3605 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3606 above for a description of @var{auxname} and instructions on how to
3607 generate test coverage data.  Coverage data will match the source files
3608 more closely, if you do not optimize.
3609
3610 @item -d@var{letters}
3611 @item -fdump-rtl-@var{pass}
3612 @opindex d
3613 Says to make debugging dumps during compilation at times specified by
3614 @var{letters}.    This is used for debugging the RTL-based passes of the
3615 compiler.  The file names for most of the dumps are made by appending a
3616 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3617 from the name of the output file, if explicitly specified and it is not
3618 an executable, otherwise it is the basename of the source file.