OSDN Git Service

a480dc5e066c39074ec26b538c0325908eeb8218
[pf3gnuchains/gcc-fork.git] / gcc / doc / install.texi
1 \input texinfo.tex    @c -*-texinfo-*-
2 @c @ifnothtml
3 @c %**start of header
4 @setfilename gccinstall.info
5 @settitle Installing GCC
6 @setchapternewpage odd
7 @c %**end of header
8 @c @end ifnothtml
9
10 @include gcc-common.texi
11
12 @c Specify title for specific html page
13 @ifset indexhtml
14 @settitle Installing GCC
15 @end ifset
16 @ifset specifichtml
17 @settitle Host/Target specific installation notes for GCC
18 @end ifset
19 @ifset prerequisiteshtml
20 @settitle Prerequisites for GCC
21 @end ifset
22 @ifset downloadhtml
23 @settitle Downloading GCC
24 @end ifset
25 @ifset configurehtml
26 @settitle Installing GCC: Configuration
27 @end ifset
28 @ifset buildhtml
29 @settitle Installing GCC: Building
30 @end ifset
31 @ifset testhtml
32 @settitle Installing GCC: Testing
33 @end ifset
34 @ifset finalinstallhtml
35 @settitle Installing GCC: Final installation
36 @end ifset
37 @ifset binarieshtml
38 @settitle Installing GCC: Binaries
39 @end ifset
40 @ifset oldhtml
41 @settitle Installing GCC: Old documentation
42 @end ifset
43 @ifset gfdlhtml
44 @settitle Installing GCC: GNU Free Documentation License
45 @end ifset
46
47 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
48 @c 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
49 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
50
51 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
52 @c test the generation of HTML documents for the gcc.gnu.org web pages.
53 @c
54 @c Do not use @footnote{} in this file as it breaks install.texi2html!
55
56 @c Include everything if we're not making html
57 @ifnothtml
58 @set indexhtml
59 @set specifichtml
60 @set prerequisiteshtml
61 @set downloadhtml
62 @set configurehtml
63 @set buildhtml
64 @set testhtml
65 @set finalinstallhtml
66 @set binarieshtml
67 @set oldhtml
68 @set gfdlhtml
69 @end ifnothtml
70
71 @c Part 2 Summary Description and Copyright
72 @copying
73 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
74 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
75 2008 Free Software Foundation, Inc.
76 @sp 1
77 Permission is granted to copy, distribute and/or modify this document
78 under the terms of the GNU Free Documentation License, Version 1.2 or
79 any later version published by the Free Software Foundation; with no
80 Invariant Sections, the Front-Cover texts being (a) (see below), and
81 with the Back-Cover Texts being (b) (see below).  A copy of the
82 license is included in the section entitled ``@uref{./gfdl.html,,GNU
83 Free Documentation License}''.
84
85 (a) The FSF's Front-Cover Text is:
86
87      A GNU Manual
88
89 (b) The FSF's Back-Cover Text is:
90
91      You have freedom to copy and modify this GNU Manual, like GNU
92      software.  Copies published by the Free Software Foundation raise
93      funds for GNU development.
94 @end copying
95 @ifinfo
96 @insertcopying
97 @end ifinfo
98 @dircategory Software development
99 @direntry
100 * gccinstall: (gccinstall).    Installing the GNU Compiler Collection.
101 @end direntry
102
103 @c Part 3 Titlepage and Copyright
104 @titlepage
105 @title Installing GCC
106 @versionsubtitle
107
108 @c The following two commands start the copyright page.
109 @page
110 @vskip 0pt plus 1filll
111 @insertcopying
112 @end titlepage
113
114 @c Part 4 Top node, Master Menu, and/or Table of Contents
115 @ifinfo
116 @node    Top, , , (dir)
117 @comment node-name, next,          Previous, up
118
119 @menu
120 * Installing GCC::  This document describes the generic installation
121                     procedure for GCC as well as detailing some target
122                     specific installation instructions.
123
124 * Specific::        Host/target specific installation notes for GCC.
125 * Binaries::        Where to get pre-compiled binaries.
126
127 * Old::             Old installation documentation.
128
129 * GNU Free Documentation License:: How you can copy and share this manual.
130 * Concept Index::   This index has two entries.
131 @end menu
132 @end ifinfo
133
134 @iftex
135 @contents
136 @end iftex
137
138 @c Part 5 The Body of the Document
139 @c ***Installing GCC**********************************************************
140 @ifnothtml
141 @comment node-name,     next,          previous, up
142 @node    Installing GCC, Binaries, , Top
143 @end ifnothtml
144 @ifset indexhtml
145 @ifnothtml
146 @chapter Installing GCC
147 @end ifnothtml
148
149 The latest version of this document is always available at
150 @uref{http://gcc.gnu.org/install/,,http://gcc.gnu.org/install/}.
151
152 This document describes the generic installation procedure for GCC as well
153 as detailing some target specific installation instructions.
154
155 GCC includes several components that previously were separate distributions
156 with their own installation instructions.  This document supersedes all
157 package specific installation instructions.
158
159 @emph{Before} starting the build/install procedure please check the
160 @ifnothtml
161 @ref{Specific, host/target specific installation notes}.
162 @end ifnothtml
163 @ifhtml
164 @uref{specific.html,,host/target specific installation notes}.
165 @end ifhtml
166 We recommend you browse the entire generic installation instructions before
167 you proceed.
168
169 Lists of successful builds for released versions of GCC are
170 available at @uref{http://gcc.gnu.org/buildstat.html}.
171 These lists are updated as new information becomes available.
172
173 The installation procedure itself is broken into five steps.
174
175 @ifinfo
176 @menu
177 * Prerequisites::
178 * Downloading the source::
179 * Configuration::
180 * Building::
181 * Testing:: (optional)
182 * Final install::
183 @end menu
184 @end ifinfo
185 @ifhtml
186 @enumerate
187 @item
188 @uref{prerequisites.html,,Prerequisites}
189 @item
190 @uref{download.html,,Downloading the source}
191 @item
192 @uref{configure.html,,Configuration}
193 @item
194 @uref{build.html,,Building}
195 @item
196 @uref{test.html,,Testing} (optional)
197 @item
198 @uref{finalinstall.html,,Final install}
199 @end enumerate
200 @end ifhtml
201
202 Please note that GCC does not support @samp{make uninstall} and probably
203 won't do so in the near future as this would open a can of worms.  Instead,
204 we suggest that you install GCC into a directory of its own and simply
205 remove that directory when you do not need that specific version of GCC
206 any longer, and, if shared libraries are installed there as well, no
207 more binaries exist that use them.
208
209 @ifhtml
210 There are also some @uref{old.html,,old installation instructions},
211 which are mostly obsolete but still contain some information which has
212 not yet been merged into the main part of this manual.
213 @end ifhtml
214
215 @html
216 <hr />
217 <p>
218 @end html
219 @ifhtml
220 @uref{./index.html,,Return to the GCC Installation page}
221
222 @insertcopying
223 @end ifhtml
224 @end ifset
225
226 @c ***Prerequisites**************************************************
227 @ifnothtml
228 @comment node-name,     next,          previous, up
229 @node    Prerequisites, Downloading the source, , Installing GCC
230 @end ifnothtml
231 @ifset prerequisiteshtml
232 @ifnothtml
233 @chapter Prerequisites
234 @end ifnothtml
235 @cindex Prerequisites
236
237 GCC requires that various tools and packages be available for use in the
238 build procedure.  Modifying GCC sources requires additional tools
239 described below.
240
241 @heading Tools/packages necessary for building GCC
242 @table @asis
243 @item ISO C90 compiler
244 Necessary to bootstrap GCC, although versions of GCC prior
245 to 3.4 also allow bootstrapping with a traditional (K&R) C compiler.
246
247 To build all languages in a cross-compiler or other configuration where
248 3-stage bootstrap is not performed, you need to start with an existing
249 GCC binary (version 2.95 or later) because source code for language
250 frontends other than C might use GCC extensions.
251
252 @item GNAT
253
254 In order to build the Ada compiler (GNAT) you must already have GNAT
255 installed because portions of the Ada frontend are written in Ada (with
256 GNAT extensions.)  Refer to the Ada installation instructions for more
257 specific information.
258
259 @item A ``working'' POSIX compatible shell, or GNU bash
260
261 Necessary when running @command{configure} because some
262 @command{/bin/sh} shells have bugs and may crash when configuring the
263 target libraries.  In other cases, @command{/bin/sh} or @command{ksh}
264 have disastrous corner-case performance problems.  This
265 can cause target @command{configure} runs to literally take days to
266 complete in some cases.
267
268 So on some platforms @command{/bin/ksh} is sufficient, on others it
269 isn't.  See the host/target specific instructions for your platform, or
270 use @command{bash} to be sure.  Then set @env{CONFIG_SHELL} in your
271 environment to your ``good'' shell prior to running
272 @command{configure}/@command{make}.
273
274 @command{zsh} is not a fully compliant POSIX shell and will not
275 work when configuring GCC@.
276
277 @item A POSIX or SVR4 awk
278
279 Necessary for creating some of the generated source files for GCC@.
280 If in doubt, use a recent GNU awk version, as some of the older ones
281 are broken.  GNU awk version 3.1.5 is known to work.
282
283 @item GNU binutils
284
285 Necessary in some circumstances, optional in others.  See the
286 host/target specific instructions for your platform for the exact
287 requirements.
288
289 @item gzip version 1.2.4 (or later) or
290 @itemx bzip2 version 1.0.2 (or later)
291
292 Necessary to uncompress GCC @command{tar} files when source code is
293 obtained via FTP mirror sites.
294
295 @item GNU make version 3.80 (or later)
296
297 You must have GNU make installed to build GCC@.
298
299 @item GNU tar version 1.14 (or later)
300
301 Necessary (only on some platforms) to untar the source code.  Many
302 systems' @command{tar} programs will also work, only try GNU
303 @command{tar} if you have problems.
304
305 @item GNU Multiple Precision Library (GMP) version 4.2 (or later)
306
307 Necessary to build GCC@.  If you do not have it installed in your
308 library search path, you will have to configure with the
309 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
310 and @option{--with-gmp-include}.  Alternatively, if a GMP source
311 distribution is found in a subdirectory of your GCC sources named
312 @file{gmp}, it will be built together with GCC@.
313
314 @item MPFR Library version 2.3.2 (or later)
315
316 Necessary to build GCC@.  It can be downloaded from
317 @uref{http://www.mpfr.org/}.  The @option{--with-mpfr} configure
318 option should be used if your MPFR Library is not installed in your
319 default library search path.  See also @option{--with-mpfr-lib} and
320 @option{--with-mpfr-include}.  Alternatively, if a MPFR source
321 distribution is found in a subdirectory of your GCC sources named
322 @file{mpfr}, it will be built together with GCC@.
323
324 @item Parma Polyhedra Library (PPL) version 0.10
325
326 Necessary to build GCC with the Graphite loop optimizations.
327 It can be downloaded from @uref{http://www.cs.unipr.it/ppl/Download/}.
328
329 The @option{--with-ppl} configure option should be used if PPL is not
330 installed in your default library search path.
331
332 @item CLooG-PPL version 0.15
333
334 Necessary to build GCC with the Graphite loop optimizations.  It can
335 be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
336 The code in @file{cloog-ppl-0.15.tar.gz} comes from a branch of CLooG
337 available from @uref{http://repo.or.cz/w/cloog-ppl.git}.  CLooG-PPL
338 should be configured with @option{--with-ppl}.
339
340 The @option{--with-cloog} configure option should be used if CLooG is
341 not installed in your default library search path.
342
343 @item @command{jar}, or InfoZIP (@command{zip} and @command{unzip})
344
345 Necessary to build libgcj, the GCJ runtime.
346
347 @item MPC Library version 0.6.0 (or later)
348
349 Optional when building GCC@.  Having this library will enable
350 additional optimizations on complex numbers.  It can be downloaded
351 from @uref{http://www.multiprecision.org/mpc/}.  The
352 @option{--with-mpc} configure option should be used if your MPC
353 Library is not installed in your default library search path.  See
354 also @option{--with-mpc-lib} and @option{--with-mpc-include}.
355 Alternatively, if an MPC source distribution is found in a
356 subdirectory of your GCC sources named @file{mpc}, it will be built
357 together with GCC@.
358
359 @end table
360
361 @heading Tools/packages necessary for modifying GCC
362 @table @asis
363 @item autoconf version 2.59
364 @itemx GNU m4 version 1.4 (or later)
365
366 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
367 to regenerate @file{configure} and @file{config.in} files.
368
369 @item automake version 1.9.6
370
371 Necessary when modifying a @file{Makefile.am} file to regenerate its
372 associated @file{Makefile.in}.
373
374 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
375 file.  Specifically this applies to the @file{gcc}, @file{intl},
376 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
377 as any of their subdirectories.
378
379 For directories that use automake, GCC requires the latest release in
380 the 1.9.x series, which is currently 1.9.6.  When regenerating a directory
381 to a newer version, please update all the directories using an older 1.9.x
382 to the latest released version.
383
384 @item gettext version 0.14.5 (or later)
385
386 Needed to regenerate @file{gcc.pot}.
387
388 @item gperf version 2.7.2 (or later)
389
390 Necessary when modifying @command{gperf} input files, e.g.@:
391 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
392 @file{gcc/cp/cfns.h}.
393
394 @item DejaGnu 1.4.4
395 @itemx Expect
396 @itemx Tcl
397
398 Necessary to run the GCC testsuite; see the section on testing for details.
399
400 @item autogen version 5.5.4 (or later) and
401 @itemx guile version 1.4.1 (or later)
402
403 Necessary to regenerate @file{fixinc/fixincl.x} from
404 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
405
406 Necessary to run @samp{make check} for @file{fixinc}.
407
408 Necessary to regenerate the top level @file{Makefile.in} file from
409 @file{Makefile.tpl} and @file{Makefile.def}.
410
411 @item Flex version 2.5.4 (or later)
412
413 Necessary when modifying @file{*.l} files.
414
415 Necessary to build GCC during development because the generated output
416 files are not included in the SVN repository.  They are included in
417 releases.
418
419 @item Texinfo version 4.7 (or later)
420
421 Necessary for running @command{makeinfo} when modifying @file{*.texi}
422 files to test your changes.
423
424 Necessary for running @command{make dvi} or @command{make pdf} to
425 create printable documentation in DVI or PDF format.  Texinfo version
426 4.8 or later is required for @command{make pdf}.
427
428 Necessary to build GCC documentation during development because the
429 generated output files are not included in the SVN repository.  They are
430 included in releases.
431
432 @item @TeX{} (any working version)
433
434 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which 
435 are used when running @command{make dvi} or @command{make pdf} to create
436 DVI or PDF files, respectively.
437
438 @item SVN (any version)
439 @itemx SSH (any version)
440
441 Necessary to access the SVN repository.  Public releases and weekly
442 snapshots of the development sources are also available via FTP@.
443
444 @item Perl version 5.6.1 (or later)
445
446 Necessary when regenerating @file{Makefile} dependencies in libiberty.
447 Necessary when regenerating @file{libiberty/functions.texi}.
448 Necessary when generating manpages from Texinfo manuals.
449 Necessary when targetting Darwin, building libstdc++,
450 and not using @option{--disable-symvers}.
451 Used by various scripts to generate some files included in SVN (mainly
452 Unicode-related and rarely changing) from source tables.
453
454 @item GNU diffutils version 2.7 (or later)
455
456 Useful when submitting patches for the GCC source code.
457
458 @item patch version 2.5.4 (or later)
459
460 Necessary when applying patches, created with @command{diff}, to one's
461 own sources.
462
463 @item ecj1
464 @itemx gjavah
465
466 If you wish to modify @file{.java} files in libjava, you will need to
467 configure with @option{--enable-java-maintainer-mode}, and you will need
468 to have executables named @command{ecj1} and @command{gjavah} in your path.
469 The @command{ecj1} executable should run the Eclipse Java compiler via
470 the GCC-specific entry point.  You can download a suitable jar from
471 @uref{ftp://sourceware.org/pub/java/}, or by running the script
472 @command{contrib/download_ecj}.
473
474 @item antlr.jar version 2.7.1 (or later)
475 @itemx antlr binary
476
477 If you wish to build the @command{gjdoc} binary in libjava, you will
478 need to have an @file{antlr.jar} library available. The library is
479 searched in system locations but can be configured with
480 @option{--with-antlr-jar=} instead.  When configuring with
481 @option{--enable-java-maintainer-mode}, you will need to have one of
482 the executables named @command{cantlr}, @command{runantlr} or
483 @command{antlr} in your path.
484
485 @end table
486
487 @html
488 <hr />
489 <p>
490 @end html
491 @ifhtml
492 @uref{./index.html,,Return to the GCC Installation page}
493 @end ifhtml
494 @end ifset
495
496 @c ***Downloading the source**************************************************
497 @ifnothtml
498 @comment node-name,     next,          previous, up
499 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
500 @end ifnothtml
501 @ifset downloadhtml
502 @ifnothtml
503 @chapter Downloading GCC
504 @end ifnothtml
505 @cindex Downloading GCC
506 @cindex Downloading the Source
507
508 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
509 tarballs compressed with @command{gzip} or
510 @command{bzip2}.  It is possible to download a full distribution or specific
511 components.
512
513 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
514 for information on how to obtain GCC@.
515
516 The full distribution includes the C, C++, Objective-C, Fortran, Java,
517 and Ada (in the case of GCC 3.1 and later) compilers.  The full
518 distribution also includes runtime libraries for C++, Objective-C,
519 Fortran, and Java.  In GCC 3.0 and later versions, the GNU compiler
520 testsuites are also included in the full distribution.
521
522 If you choose to download specific components, you must download the core
523 GCC distribution plus any language specific distributions you wish to
524 use.  The core distribution includes the C language front end as well as the
525 shared components.  Each language has a tarball which includes the language
526 front end as well as the language runtime (when appropriate).
527
528 Unpack the core distribution as well as any language specific
529 distributions in the same directory.
530
531 If you also intend to build binutils (either to upgrade an existing
532 installation or for use in place of the corresponding tools of your
533 OS), unpack the binutils distribution either in the same directory or
534 a separate one.  In the latter case, add symbolic links to any
535 components of the binutils you intend to build alongside the compiler
536 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
537 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
538
539 Likewise the GMP, MPFR and MPC libraries can be automatically built
540 together with GCC.  Unpack the GMP, MPFR and/or MPC source
541 distributions in the directory containing the GCC sources and rename
542 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
543 respectively (or use symbolic links with the same name).
544
545 @html
546 <hr />
547 <p>
548 @end html
549 @ifhtml
550 @uref{./index.html,,Return to the GCC Installation page}
551 @end ifhtml
552 @end ifset
553
554 @c ***Configuration***********************************************************
555 @ifnothtml
556 @comment node-name,     next,          previous, up
557 @node    Configuration, Building, Downloading the source, Installing GCC
558 @end ifnothtml
559 @ifset configurehtml
560 @ifnothtml
561 @chapter Installing GCC: Configuration
562 @end ifnothtml
563 @cindex Configuration
564 @cindex Installing GCC: Configuration
565
566 Like most GNU software, GCC must be configured before it can be built.
567 This document describes the recommended configuration procedure
568 for both native and cross targets.
569
570 We use @var{srcdir} to refer to the toplevel source directory for
571 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
572
573 If you obtained the sources via SVN, @var{srcdir} must refer to the top
574 @file{gcc} directory, the one where the @file{MAINTAINERS} can be found,
575 and not its @file{gcc} subdirectory, otherwise the build will fail.
576
577 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
578 file system, the shell's built-in @command{pwd} command will return
579 temporary pathnames.  Using these can lead to various sorts of build
580 problems.  To avoid this issue, set the @env{PWDCMD} environment
581 variable to an automounter-aware @command{pwd} command, e.g.,
582 @command{pawd} or @samp{amq -w}, during the configuration and build
583 phases.
584
585 First, we @strong{highly} recommend that GCC be built into a
586 separate directory than the sources which does @strong{not} reside
587 within the source tree.  This is how we generally build GCC; building
588 where @var{srcdir} == @var{objdir} should still work, but doesn't
589 get extensive testing; building where @var{objdir} is a subdirectory
590 of @var{srcdir} is unsupported.
591
592 If you have previously built GCC in the same directory for a
593 different target machine, do @samp{make distclean} to delete all files
594 that might be invalid.  One of the files this deletes is @file{Makefile};
595 if @samp{make distclean} complains that @file{Makefile} does not exist
596 or issues a message like ``don't know how to make distclean'' it probably
597 means that the directory is already suitably clean.  However, with the
598 recommended method of building in a separate @var{objdir}, you should
599 simply use a different @var{objdir} for each target.
600
601 Second, when configuring a native system, either @command{cc} or
602 @command{gcc} must be in your path or you must set @env{CC} in
603 your environment before running configure.  Otherwise the configuration
604 scripts may fail.
605
606 @ignore
607 Note that the bootstrap compiler and the resulting GCC must be link
608 compatible, else the bootstrap will fail with linker errors about
609 incompatible object file formats.  Several multilibed targets are
610 affected by this requirement, see
611 @ifnothtml
612 @ref{Specific, host/target specific installation notes}.
613 @end ifnothtml
614 @ifhtml
615 @uref{specific.html,,host/target specific installation notes}.
616 @end ifhtml
617 @end ignore
618
619 To configure GCC:
620
621 @smallexample
622    % mkdir @var{objdir}
623    % cd @var{objdir}
624    % @var{srcdir}/configure [@var{options}] [@var{target}]
625 @end smallexample
626
627 @heading Distributor options
628
629 If you will be distributing binary versions of GCC, with modifications
630 to the source code, you should use the options described in this
631 section to make clear that your version contains modifications.
632
633 @table @code
634 @item --with-pkgversion=@var{version}
635 Specify a string that identifies your package.  You may wish
636 to include a build number or build date.  This version string will be
637 included in the output of @command{gcc --version}.  This suffix does
638 not replace the default version string, only the @samp{GCC} part.
639
640 The default value is @samp{GCC}.
641
642 @item --with-bugurl=@var{url}
643 Specify the URL that users should visit if they wish to report a bug.
644 You are of course welcome to forward bugs reported to you to the FSF,
645 if you determine that they are not bugs in your modifications.
646
647 The default value refers to the FSF's GCC bug tracker.
648
649 @end table
650
651 @heading Target specification
652 @itemize @bullet
653 @item
654 GCC has code to correctly determine the correct value for @var{target}
655 for nearly all native systems.  Therefore, we highly recommend you not
656 provide a configure target when configuring a native compiler.
657
658 @item
659 @var{target} must be specified as @option{--target=@var{target}}
660 when configuring a cross compiler; examples of valid targets would be
661 m68k-elf, sh-elf, etc.
662
663 @item
664 Specifying just @var{target} instead of @option{--target=@var{target}}
665 implies that the host defaults to @var{target}.
666 @end itemize
667
668
669 @heading Options specification
670
671 Use @var{options} to override several configure time options for
672 GCC@.  A list of supported @var{options} follows; @samp{configure
673 --help} may list other options, but those not listed below may not
674 work and should not normally be used.
675
676 Note that each @option{--enable} option has a corresponding
677 @option{--disable} option and that each @option{--with} option has a
678 corresponding @option{--without} option.
679
680 @table @code
681 @item --prefix=@var{dirname}
682 Specify the toplevel installation
683 directory.  This is the recommended way to install the tools into a directory
684 other than the default.  The toplevel installation directory defaults to
685 @file{/usr/local}.
686
687 We @strong{highly} recommend against @var{dirname} being the same or a
688 subdirectory of @var{objdir} or vice versa.  If specifying a directory
689 beneath a user's home directory tree, some shells will not expand
690 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
691 @env{$HOME} instead.
692
693 The following standard @command{autoconf} options are supported.  Normally you
694 should not need to use these options.
695 @table @code
696 @item --exec-prefix=@var{dirname}
697 Specify the toplevel installation directory for architecture-dependent
698 files.  The default is @file{@var{prefix}}.
699
700 @item --bindir=@var{dirname}
701 Specify the installation directory for the executables called by users
702 (such as @command{gcc} and @command{g++}).  The default is
703 @file{@var{exec-prefix}/bin}.
704
705 @item --libdir=@var{dirname}
706 Specify the installation directory for object code libraries and
707 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
708
709 @item --libexecdir=@var{dirname}
710 Specify the installation directory for internal executables of GCC@.
711 The default is @file{@var{exec-prefix}/libexec}.
712
713 @item --with-slibdir=@var{dirname}
714 Specify the installation directory for the shared libgcc library.  The
715 default is @file{@var{libdir}}.
716
717 @item --infodir=@var{dirname}
718 Specify the installation directory for documentation in info format.
719 The default is @file{@var{prefix}/info}.
720
721 @item --datadir=@var{dirname}
722 Specify the installation directory for some architecture-independent
723 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
724
725 @item --mandir=@var{dirname}
726 Specify the installation directory for manual pages.  The default is
727 @file{@var{prefix}/man}.  (Note that the manual pages are only extracts from
728 the full GCC manuals, which are provided in Texinfo format.  The manpages
729 are derived by an automatic conversion process from parts of the full
730 manual.)
731
732 @item --with-gxx-include-dir=@var{dirname}
733 Specify
734 the installation directory for G++ header files.  The default depends
735 on other configuration options, and differs between cross and native
736 configurations.
737
738 @end table
739
740 @item --program-prefix=@var{prefix}
741 GCC supports some transformations of the names of its programs when
742 installing them.  This option prepends @var{prefix} to the names of
743 programs to install in @var{bindir} (see above).  For example, specifying
744 @option{--program-prefix=foo-} would result in @samp{gcc}
745 being installed as @file{/usr/local/bin/foo-gcc}.
746
747 @item --program-suffix=@var{suffix}
748 Appends @var{suffix} to the names of programs to install in @var{bindir}
749 (see above).  For example, specifying @option{--program-suffix=-3.1}
750 would result in @samp{gcc} being installed as
751 @file{/usr/local/bin/gcc-3.1}.
752
753 @item --program-transform-name=@var{pattern}
754 Applies the @samp{sed} script @var{pattern} to be applied to the names
755 of programs to install in @var{bindir} (see above).  @var{pattern} has to
756 consist of one or more basic @samp{sed} editing commands, separated by
757 semicolons.  For example, if you want the @samp{gcc} program name to be
758 transformed to the installed program @file{/usr/local/bin/myowngcc} and
759 the @samp{g++} program name to be transformed to
760 @file{/usr/local/bin/gspecial++} without changing other program names,
761 you could use the pattern
762 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
763 to achieve this effect.
764
765 All three options can be combined and used together, resulting in more
766 complex conversion patterns.  As a basic rule, @var{prefix} (and
767 @var{suffix}) are prepended (appended) before further transformations
768 can happen with a special transformation script @var{pattern}.
769
770 As currently implemented, this option only takes effect for native
771 builds; cross compiler binaries' names are not transformed even when a
772 transformation is explicitly asked for by one of these options.
773
774 For native builds, some of the installed programs are also installed
775 with the target alias in front of their name, as in
776 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
777 before the target alias is prepended to the name---so, specifying
778 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
779 resulting binary would be installed as
780 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
781
782 As a last shortcoming, none of the installed Ada programs are
783 transformed yet, which will be fixed in some time.
784
785 @item --with-local-prefix=@var{dirname}
786 Specify the
787 installation directory for local include files.  The default is
788 @file{/usr/local}.  Specify this option if you want the compiler to
789 search directory @file{@var{dirname}/include} for locally installed
790 header files @emph{instead} of @file{/usr/local/include}.
791
792 You should specify @option{--with-local-prefix} @strong{only} if your
793 site has a different convention (not @file{/usr/local}) for where to put
794 site-specific files.
795
796 The default value for @option{--with-local-prefix} is @file{/usr/local}
797 regardless of the value of @option{--prefix}.  Specifying
798 @option{--prefix} has no effect on which directory GCC searches for
799 local header files.  This may seem counterintuitive, but actually it is
800 logical.
801
802 The purpose of @option{--prefix} is to specify where to @emph{install
803 GCC}.  The local header files in @file{/usr/local/include}---if you put
804 any in that directory---are not part of GCC@.  They are part of other
805 programs---perhaps many others.  (GCC installs its own header files in
806 another directory which is based on the @option{--prefix} value.)
807
808 Both the local-prefix include directory and the GCC-prefix include
809 directory are part of GCC's ``system include'' directories.  Although these
810 two directories are not fixed, they need to be searched in the proper
811 order for the correct processing of the include_next directive.  The
812 local-prefix include directory is searched before the GCC-prefix
813 include directory.  Another characteristic of system include directories
814 is that pedantic warnings are turned off for headers in these directories.
815
816 Some autoconf macros add @option{-I @var{directory}} options to the
817 compiler command line, to ensure that directories containing installed
818 packages' headers are searched.  When @var{directory} is one of GCC's
819 system include directories, GCC will ignore the option so that system
820 directories continue to be processed in the correct order.  This
821 may result in a search order different from what was specified but the
822 directory will still be searched.
823
824 GCC automatically searches for ordinary libraries using
825 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
826 used for both GCC and packages, GCC will automatically search for
827 both headers and libraries.  This provides a configuration that is
828 easy to use.  GCC behaves in a manner similar to that when it is
829 installed as a system compiler in @file{/usr}.
830
831 Sites that need to install multiple versions of GCC may not want to
832 use the above simple configuration.  It is possible to use the
833 @option{--program-prefix}, @option{--program-suffix} and
834 @option{--program-transform-name} options to install multiple versions
835 into a single directory, but it may be simpler to use different prefixes
836 and the @option{--with-local-prefix} option to specify the location of the
837 site-specific files for each version.  It will then be necessary for
838 users to specify explicitly the location of local site libraries
839 (e.g., with @env{LIBRARY_PATH}).
840
841 The same value can be used for both @option{--with-local-prefix} and
842 @option{--prefix} provided it is not @file{/usr}.  This can be used
843 to avoid the default search of @file{/usr/local/include}.
844
845 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
846 The directory you use for @option{--with-local-prefix} @strong{must not}
847 contain any of the system's standard header files.  If it did contain
848 them, certain programs would be miscompiled (including GNU Emacs, on
849 certain targets), because this would override and nullify the header
850 file corrections made by the @command{fixincludes} script.
851
852 Indications are that people who use this option use it based on mistaken
853 ideas of what it is for.  People use it as if it specified where to
854 install part of GCC@.  Perhaps they make this assumption because
855 installing GCC creates the directory.
856
857 @item --enable-shared[=@var{package}[,@dots{}]]
858 Build shared versions of libraries, if shared libraries are supported on
859 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
860 are enabled by default on all platforms that support shared libraries.
861
862 If a list of packages is given as an argument, build shared libraries
863 only for the listed packages.  For other packages, only static libraries
864 will be built.  Package names currently recognized in the GCC tree are
865 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
866 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
867 @samp{ada}, @samp{libada}, @samp{libjava} and @samp{libobjc}.
868 Note @samp{libiberty} does not support shared libraries at all.
869
870 Use @option{--disable-shared} to build only static libraries.  Note that
871 @option{--disable-shared} does not accept a list of package names as
872 argument, only @option{--enable-shared} does.
873
874 @item @anchor{with-gnu-as}--with-gnu-as
875 Specify that the compiler should assume that the
876 assembler it finds is the GNU assembler.  However, this does not modify
877 the rules to find an assembler and will result in confusion if the
878 assembler found is not actually the GNU assembler.  (Confusion may also
879 result if the compiler finds the GNU assembler but has not been
880 configured with @option{--with-gnu-as}.)  If you have more than one
881 assembler installed on your system, you may want to use this option in
882 connection with @option{--with-as=@var{pathname}} or
883 @option{--with-build-time-tools=@var{pathname}}.
884
885 The following systems are the only ones where it makes a difference
886 whether you use the GNU assembler.  On any other system,
887 @option{--with-gnu-as} has no effect.
888
889 @itemize @bullet
890 @item @samp{hppa1.0-@var{any}-@var{any}}
891 @item @samp{hppa1.1-@var{any}-@var{any}}
892 @item @samp{sparc-sun-solaris2.@var{any}}
893 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
894 @end itemize
895
896 @item @anchor{with-as}--with-as=@var{pathname}
897 Specify that the compiler should use the assembler pointed to by
898 @var{pathname}, rather than the one found by the standard rules to find
899 an assembler, which are:
900 @itemize @bullet
901 @item
902 Unless GCC is being built with a cross compiler, check the
903 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
904 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
905 @var{exec-prefix} defaults to @var{prefix}, which
906 defaults to @file{/usr/local} unless overridden by the
907 @option{--prefix=@var{pathname}} switch described above.  @var{target}
908 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
909 @var{version} denotes the GCC version, such as 3.0.
910
911 @item
912 If the target system is the same that you are building on, check
913 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
914 Sun Solaris 2).
915
916 @item
917 Check in the @env{PATH} for a tool whose name is prefixed by the
918 target system triple.
919
920 @item
921 Check in the @env{PATH} for a tool whose name is not prefixed by the
922 target system triple, if the host and target system triple are
923 the same (in other words, we use a host tool if it can be used for
924 the target as well).
925 @end itemize
926
927 You may want to use @option{--with-as} if no assembler
928 is installed in the directories listed above, or if you have multiple
929 assemblers installed and want to choose one that is not found by the
930 above rules.
931
932 @item @anchor{with-gnu-ld}--with-gnu-ld
933 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
934 but for the linker.
935
936 @item --with-ld=@var{pathname}
937 Same as @uref{#with-as,,@option{--with-as}}
938 but for the linker.
939
940 @item --with-stabs
941 Specify that stabs debugging
942 information should be used instead of whatever format the host normally
943 uses.  Normally GCC uses the same debug format as the host system.
944
945 On MIPS based systems and on Alphas, you must specify whether you want
946 GCC to create the normal ECOFF debugging format, or to use BSD-style
947 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
948 format cannot fully handle languages other than C@.  BSD stabs format can
949 handle other languages, but it only works with the GNU debugger GDB@.
950
951 Normally, GCC uses the ECOFF debugging format by default; if you
952 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
953
954 No matter which default you choose when you configure GCC, the user
955 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
956 the debug format for a particular compilation.
957
958 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
959 @option{--with-gas} is used.  It selects use of stabs debugging
960 information embedded in COFF output.  This kind of debugging information
961 supports C++ well; ordinary COFF debugging information does not.
962
963 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
964 selects use of stabs debugging information embedded in ELF output.  The
965 C++ compiler currently (2.6.0) does not support the DWARF debugging
966 information normally used on 386 SVR4 platforms; stabs provide a
967 workable alternative.  This requires gas and gdb, as the normal SVR4
968 tools can not generate or interpret stabs.
969
970 @item --disable-multilib
971 Specify that multiple target
972 libraries to support different target variants, calling
973 conventions, etc.@: should not be built.  The default is to build a
974 predefined set of them.
975
976 Some targets provide finer-grained control over which multilibs are built
977 (e.g., @option{--disable-softfloat}):
978 @table @code
979 @item arc-*-elf*
980 biendian.
981
982 @item arm-*-*
983 fpu, 26bit, underscore, interwork, biendian, nofmult.
984
985 @item m68*-*-*
986 softfloat, m68881, m68000, m68020.
987
988 @item mips*-*-*
989 single-float, biendian, softfloat.
990
991 @item powerpc*-*-*, rs6000*-*-*
992 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
993 sysv, aix.
994
995 @end table
996
997 @item --with-multilib-list=@var{list}
998 @itemx --without-multilib-list
999 Specify what multilibs to build.
1000 Currently only implemented for sh*-*-*.
1001
1002 @var{list} is a comma separated list of CPU names.  These must be of the
1003 form @code{sh*} or @code{m*} (in which case they match the compiler option
1004 for that processor).  The list should not contain any endian options -
1005 these are handled by @option{--with-endian}.
1006
1007 If @var{list} is empty, then there will be no multilibs for extra
1008 processors.  The multilib for the secondary endian remains enabled.
1009
1010 As a special case, if an entry in the list starts with a @code{!}
1011 (exclamation point), then it is added to the list of excluded multilibs.
1012 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1013 (once the leading @code{!} has been stripped).
1014
1015 If @option{--with-multilib-list} is not given, then a default set of
1016 multilibs is selected based on the value of @option{--target}.  This is
1017 usually the complete set of libraries, but some targets imply a more
1018 specialized subset.
1019
1020 Example 1: to configure a compiler for SH4A only, but supporting both
1021 endians, with little endian being the default:
1022 @smallexample
1023 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1024 @end smallexample
1025
1026 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1027 only little endian SH4AL:
1028 @smallexample
1029 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=sh4al,!mb/m4al
1030 @end smallexample
1031
1032 @item --with-endian=@var{endians}
1033 Specify what endians to use.
1034 Currently only implemented for sh*-*-*.
1035
1036 @var{endians} may be one of the following:
1037 @table @code
1038 @item big
1039 Use big endian exclusively.
1040 @item little
1041 Use little endian exclusively.
1042 @item big,little
1043 Use big endian by default.  Provide a multilib for little endian.
1044 @item little,big
1045 Use little endian by default.  Provide a multilib for big endian.
1046 @end table
1047
1048 @item --enable-threads
1049 Specify that the target
1050 supports threads.  This affects the Objective-C compiler and runtime
1051 library, and exception handling for other languages like C++ and Java.
1052 On some systems, this is the default.
1053
1054 In general, the best (and, in many cases, the only known) threading
1055 model available will be configured for use.  Beware that on some
1056 systems, GCC has not been taught what threading models are generally
1057 available for the system.  In this case, @option{--enable-threads} is an
1058 alias for @option{--enable-threads=single}.
1059
1060 @item --disable-threads
1061 Specify that threading support should be disabled for the system.
1062 This is an alias for @option{--enable-threads=single}.
1063
1064 @item --enable-threads=@var{lib}
1065 Specify that
1066 @var{lib} is the thread support library.  This affects the Objective-C
1067 compiler and runtime library, and exception handling for other languages
1068 like C++ and Java.  The possibilities for @var{lib} are:
1069
1070 @table @code
1071 @item aix
1072 AIX thread support.
1073 @item dce
1074 DCE thread support.
1075 @item gnat
1076 Ada tasking support.  For non-Ada programs, this setting is equivalent
1077 to @samp{single}.  When used in conjunction with the Ada run time, it
1078 causes GCC to use the same thread primitives as Ada uses.  This option
1079 is necessary when using both Ada and the back end exception handling,
1080 which is the default for most Ada targets.
1081 @item mach
1082 Generic MACH thread support, known to work on NeXTSTEP@.  (Please note
1083 that the file needed to support this configuration, @file{gthr-mach.h}, is
1084 missing and thus this setting will cause a known bootstrap failure.)
1085 @item no
1086 This is an alias for @samp{single}.
1087 @item posix
1088 Generic POSIX/Unix98 thread support.
1089 @item posix95
1090 Generic POSIX/Unix95 thread support.
1091 @item rtems
1092 RTEMS thread support.
1093 @item single
1094 Disable thread support, should work for all platforms.
1095 @item solaris
1096 Sun Solaris 2 thread support.
1097 @item vxworks
1098 VxWorks thread support.
1099 @item win32
1100 Microsoft Win32 API thread support.
1101 @item nks
1102 Novell Kernel Services thread support.
1103 @end table
1104
1105 @item --enable-tls
1106 Specify that the target supports TLS (Thread Local Storage).  Usually
1107 configure can correctly determine if TLS is supported.  In cases where
1108 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1109 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1110 the assembler supports TLS but the C library does not, or if the
1111 assumptions made by the configure test are incorrect.
1112
1113 @item --disable-tls
1114 Specify that the target does not support TLS.
1115 This is an alias for @option{--enable-tls=no}.
1116
1117 @item --with-cpu=@var{cpu}
1118 @itemx --with-cpu-32=@var{cpu}
1119 @itemx --with-cpu-64=@var{cpu}
1120 Specify which cpu variant the compiler should generate code for by default.
1121 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1122 This option is only supported on some targets, including ARM, i386, M68k,
1123 PowerPC, and SPARC@.  The @option{--with-cpu-32} and
1124 @option{--with-cpu-64} options specify separate default CPUs for
1125 32-bit and 64-bit modes; these options are only supported for i386,
1126 x86-64 and PowerPC.
1127
1128 @item --with-schedule=@var{cpu}
1129 @itemx --with-arch=@var{cpu}
1130 @itemx --with-arch-32=@var{cpu}
1131 @itemx --with-arch-64=@var{cpu}
1132 @itemx --with-tune=@var{cpu}
1133 @itemx --with-tune-32=@var{cpu}
1134 @itemx --with-tune-64=@var{cpu}
1135 @itemx --with-abi=@var{abi}
1136 @itemx --with-fpu=@var{type}
1137 @itemx --with-float=@var{type}
1138 These configure options provide default values for the @option{-mschedule=},
1139 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1140 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1141 @option{--with-cpu}, which switches will be accepted and acceptable values
1142 of the arguments depend on the target.
1143
1144 @item --with-mode=@var{mode}
1145 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1146 This option is only supported on ARM targets.
1147
1148 @item --with-divide=@var{type}
1149 Specify how the compiler should generate code for checking for
1150 division by zero.  This option is only supported on the MIPS target.
1151 The possibilities for @var{type} are:
1152 @table @code
1153 @item traps
1154 Division by zero checks use conditional traps (this is the default on
1155 systems that support conditional traps).
1156 @item breaks
1157 Division by zero checks use the break instruction.
1158 @end table
1159
1160 @c If you make --with-llsc the default for additional targets,
1161 @c update the --with-llsc description in the MIPS section below.
1162
1163 @item --with-llsc
1164 On MIPS targets, make @option{-mllsc} the default when no
1165 @option{-mno-lsc} option is passed.  This is the default for
1166 Linux-based targets, as the kernel will emulate them if the ISA does
1167 not provide them.
1168
1169 @item --without-llsc
1170 On MIPS targets, make @option{-mno-llsc} the default when no
1171 @option{-mllsc} option is passed.
1172
1173 @item --with-synci
1174 On MIPS targets, make @option{-msynci} the default when no
1175 @option{-mno-synci} option is passed.
1176
1177 @item --without-synci 
1178 On MIPS targets, make @option{-mno-synci} the default when no
1179 @option{-msynci} option is passed.  This is the default.
1180
1181 @item --with-mips-plt
1182 On MIPS targets, make use of copy relocations and PLTs.
1183 These features are extensions to the traditional
1184 SVR4-based MIPS ABIs and require support from GNU binutils
1185 and the runtime C library.
1186
1187 @item --enable-__cxa_atexit
1188 Define if you want to use __cxa_atexit, rather than atexit, to
1189 register C++ destructors for local statics and global objects.
1190 This is essential for fully standards-compliant handling of
1191 destructors, but requires __cxa_atexit in libc.  This option is currently
1192 only available on systems with GNU libc.  When enabled, this will cause
1193 @option{-fuse-cxa-atexit} to be passed by default.
1194
1195 @item --enable-target-optspace
1196 Specify that target
1197 libraries should be optimized for code space instead of code speed.
1198 This is the default for the m32r platform.
1199
1200 @item --disable-cpp
1201 Specify that a user visible @command{cpp} program should not be installed.
1202
1203 @item --with-cpp-install-dir=@var{dirname}
1204 Specify that the user visible @command{cpp} program should be installed
1205 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1206
1207 @item --enable-initfini-array
1208 Force the use of sections @code{.init_array} and @code{.fini_array}
1209 (instead of @code{.init} and @code{.fini}) for constructors and
1210 destructors.  Option @option{--disable-initfini-array} has the
1211 opposite effect.  If neither option is specified, the configure script
1212 will try to guess whether the @code{.init_array} and
1213 @code{.fini_array} sections are supported and, if they are, use them.
1214
1215 @item --enable-build-with-cxx
1216 Build GCC using a C++ compiler rather than a C compiler.  This is an
1217 experimental option which may become the default in a later release.
1218
1219 @item --enable-maintainer-mode
1220 The build rules that
1221 regenerate the GCC master message catalog @file{gcc.pot} are normally
1222 disabled.  This is because it can only be rebuilt if the complete source
1223 tree is present.  If you have changed the sources and want to rebuild the
1224 catalog, configuring with @option{--enable-maintainer-mode} will enable
1225 this.  Note that you need a recent version of the @code{gettext} tools
1226 to do so.
1227
1228 @item --disable-bootstrap
1229 For a native build, the default configuration is to perform
1230 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1231 testing that GCC can compile itself correctly.  If you want to disable
1232 this process, you can configure with @option{--disable-bootstrap}.
1233
1234 @item --enable-bootstrap
1235 In special cases, you may want to perform a 3-stage build
1236 even if the target and host triplets are different.
1237 This could happen when the host can run code compiled for
1238 the target (e.g.@: host is i686-linux, target is i486-linux).
1239 Starting from GCC 4.2, to do this you have to configure explicitly
1240 with @option{--enable-bootstrap}.
1241
1242 @item --enable-generated-files-in-srcdir
1243 Neither the .c and .h files that are generated from Bison and flex nor the
1244 info manuals and man pages that are built from the .texi files are present
1245 in the SVN development tree.  When building GCC from that development tree,
1246 or from one of our snapshots, those generated files are placed in your
1247 build directory, which allows for the source to be in a readonly
1248 directory.
1249
1250 If you configure with @option{--enable-generated-files-in-srcdir} then those
1251 generated files will go into the source directory.  This is mainly intended
1252 for generating release or prerelease tarballs of the GCC sources, since it
1253 is not a requirement that the users of source releases to have flex, Bison,
1254 or makeinfo.
1255
1256 @item --enable-version-specific-runtime-libs
1257 Specify
1258 that runtime libraries should be installed in the compiler specific
1259 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1260 addition, @samp{libstdc++}'s include files will be installed into
1261 @file{@var{libdir}} unless you overruled it by using
1262 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1263 particularly useful if you intend to use several versions of GCC in
1264 parallel.  This is currently supported by @samp{libgfortran},
1265 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1266
1267 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1268 Specify that only a particular subset of compilers and
1269 their runtime libraries should be built.  For a list of valid values for
1270 @var{langN} you can issue the following command in the
1271 @file{gcc} directory of your GCC source tree:@*
1272 @smallexample
1273 grep language= */config-lang.in
1274 @end smallexample
1275 Currently, you can use any of the following:
1276 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran}, @code{java},
1277 @code{objc}, @code{obj-c++}.
1278 Building the Ada compiler has special requirements, see below.
1279 If you do not pass this flag, or specify the option @code{all}, then all
1280 default languages available in the @file{gcc} sub-tree will be configured.
1281 Ada and Objective-C++ are not default languages; the rest are.
1282 Re-defining @code{LANGUAGES} when calling @samp{make} @strong{does not}
1283 work anymore, as those language sub-directories might not have been
1284 configured!
1285
1286 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1287 Specify that a particular subset of compilers and their runtime
1288 libraries should be built with the system C compiler during stage 1 of
1289 the bootstrap process, rather than only in later stages with the
1290 bootstrapped C compiler.  The list of valid values is the same as for
1291 @option{--enable-languages}, and the option @code{all} will select all
1292 of the languages enabled by @option{--enable-languages}.  This option is
1293 primarily useful for GCC development; for instance, when a development
1294 version of the compiler cannot bootstrap due to compiler bugs, or when
1295 one is debugging front ends other than the C front end.  When this
1296 option is used, one can then build the target libraries for the
1297 specified languages with the stage-1 compiler by using @command{make
1298 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1299 for the specified languages using @command{make stage1-start check-gcc}.
1300
1301 @item --disable-libada
1302 Specify that the run-time libraries and tools used by GNAT should not
1303 be built.  This can be useful for debugging, or for compatibility with
1304 previous Ada build procedures, when it was required to explicitly
1305 do a @samp{make -C gcc gnatlib_and_tools}.
1306
1307 @item --disable-libssp
1308 Specify that the run-time libraries for stack smashing protection
1309 should not be built.
1310
1311 @item --disable-libgomp
1312 Specify that the run-time libraries used by GOMP should not be built.
1313
1314 @item --with-dwarf2
1315 Specify that the compiler should
1316 use DWARF 2 debugging information as the default.
1317
1318 @item --enable-targets=all
1319 @itemx --enable-targets=@var{target_list}
1320 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1321 These are compilers that are able to generate either 64-bit or 32-bit
1322 code.  Typically, the corresponding 32-bit target, e.g.@:
1323 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1324 option enables the 32-bit target to be a bi-arch compiler, which is
1325 useful when you want a bi-arch compiler that defaults to 32-bit, and
1326 you are building a bi-arch or multi-arch binutils in a combined tree.
1327 Currently, this option only affects sparc-linux, powerpc-linux and
1328 x86-linux.
1329
1330 @item --enable-secureplt
1331 This option enables @option{-msecure-plt} by default for powerpc-linux.
1332 @ifnothtml
1333 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1334 Using the GNU Compiler Collection (GCC)},
1335 @end ifnothtml
1336 @ifhtml
1337 See ``RS/6000 and PowerPC Options'' in the main manual
1338 @end ifhtml
1339
1340 @item --enable-cld
1341 This option enables @option{-mcld} by default for 32-bit x86 targets.
1342 @ifnothtml
1343 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1344 Using the GNU Compiler Collection (GCC)},
1345 @end ifnothtml
1346 @ifhtml
1347 See ``i386 and x86-64 Options'' in the main manual
1348 @end ifhtml
1349
1350 @item --enable-win32-registry
1351 @itemx --enable-win32-registry=@var{key}
1352 @itemx --disable-win32-registry
1353 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1354 to look up installations paths in the registry using the following key:
1355
1356 @smallexample
1357 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1358 @end smallexample
1359
1360 @var{key} defaults to GCC version number, and can be overridden by the
1361 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1362 who use custom installers are encouraged to provide a different key,
1363 perhaps one comprised of vendor name and GCC version number, to
1364 avoid conflict with existing installations.  This feature is enabled
1365 by default, and can be disabled by @option{--disable-win32-registry}
1366 option.  This option has no effect on the other hosts.
1367
1368 @item --nfp
1369 Specify that the machine does not have a floating point unit.  This
1370 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1371 system, @option{--nfp} has no effect.
1372
1373 @item --enable-werror
1374 @itemx --disable-werror
1375 @itemx --enable-werror=yes
1376 @itemx --enable-werror=no
1377 When you specify this option, it controls whether certain files in the
1378 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1379 If you don't specify it, @option{-Werror} is turned on for the main
1380 development trunk.  However it defaults to off for release branches and
1381 final releases.  The specific files which get @option{-Werror} are
1382 controlled by the Makefiles.
1383
1384 @item --enable-checking
1385 @itemx --enable-checking=@var{list}
1386 When you specify this option, the compiler is built to perform internal
1387 consistency checks of the requested complexity.  This does not change the
1388 generated code, but adds error checking within the compiler.  This will
1389 slow down the compiler and may only work properly if you are building
1390 the compiler with GCC@.  This is @samp{yes} by default when building
1391 from SVN or snapshots, but @samp{release} for releases.  The default
1392 for building the stage1 compiler is @samp{yes}.  More control
1393 over the checks may be had by specifying @var{list}.  The categories of
1394 checks available are @samp{yes} (most common checks
1395 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1396 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1397 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1398 Individual checks can be enabled with these flags @samp{assert},
1399 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1400 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1401
1402 The @samp{valgrind} check requires the external @command{valgrind}
1403 simulator, available from @uref{http://valgrind.org/}.  The
1404 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1405 To disable all checking, @samp{--disable-checking} or
1406 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1407 assertions will make the compiler and runtime slightly faster but
1408 increase the risk of undetected internal errors causing wrong code to be
1409 generated.
1410
1411 @item --disable-stage1-checking
1412 @item --enable-stage1-checking
1413 @itemx --enable-stage1-checking=@var{list}
1414 If no @option{--enable-checking} option is specified the stage1
1415 compiler will be built with @samp{yes} checking enabled, otherwise
1416 the stage1 checking flags are the same as specified by
1417 @option{--enable-checking}.  To build the stage1 compiler with
1418 different checking options use @option{--enable-stage1-checking}.
1419 The list of checking options is the same as for @option{--enable-checking}.
1420 If your system is too slow or too small to bootstrap a released compiler
1421 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1422 to disable checking for the stage1 compiler.
1423
1424 @item --enable-coverage
1425 @itemx --enable-coverage=@var{level}
1426 With this option, the compiler is built to collect self coverage
1427 information, every time it is run.  This is for internal development
1428 purposes, and only works when the compiler is being built with gcc.  The
1429 @var{level} argument controls whether the compiler is built optimized or
1430 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1431 want to disable optimization, for performance analysis you want to
1432 enable optimization.  When coverage is enabled, the default level is
1433 without optimization.
1434
1435 @item --enable-gather-detailed-mem-stats
1436 When this option is specified more detailed information on memory
1437 allocation is gathered.  This information is printed when using
1438 @option{-fmem-report}.
1439
1440 @item --with-gc
1441 @itemx --with-gc=@var{choice}
1442 With this option you can specify the garbage collector implementation
1443 used during the compilation process.  @var{choice} can be one of
1444 @samp{page} and @samp{zone}, where @samp{page} is the default.
1445
1446 @item --enable-nls
1447 @itemx --disable-nls
1448 The @option{--enable-nls} option enables Native Language Support (NLS),
1449 which lets GCC output diagnostics in languages other than American
1450 English.  Native Language Support is enabled by default if not doing a
1451 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1452
1453 @item --with-included-gettext
1454 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1455 procedure to prefer its copy of GNU @command{gettext}.
1456
1457 @item --with-catgets
1458 If NLS is enabled, and if the host lacks @code{gettext} but has the
1459 inferior @code{catgets} interface, the GCC build procedure normally
1460 ignores @code{catgets} and instead uses GCC's copy of the GNU
1461 @code{gettext} library.  The @option{--with-catgets} option causes the
1462 build procedure to use the host's @code{catgets} in this situation.
1463
1464 @item --with-libiconv-prefix=@var{dir}
1465 Search for libiconv header files in @file{@var{dir}/include} and
1466 libiconv library files in @file{@var{dir}/lib}.
1467
1468 @item --enable-obsolete
1469 Enable configuration for an obsoleted system.  If you attempt to
1470 configure GCC for a system (build, host, or target) which has been
1471 obsoleted, and you do not specify this flag, configure will halt with an
1472 error message.
1473
1474 All support for systems which have been obsoleted in one release of GCC
1475 is removed entirely in the next major release, unless someone steps
1476 forward to maintain the port.
1477
1478 @item --enable-decimal-float
1479 @itemx --enable-decimal-float=yes
1480 @itemx --enable-decimal-float=no
1481 @itemx --enable-decimal-float=bid
1482 @itemx --enable-decimal-float=dpd
1483 @itemx --disable-decimal-float
1484 Enable (or disable) support for the C decimal floating point extension
1485 that is in the IEEE 754-2008 standard.  This is enabled by default only
1486 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1487 support it, but require the user to specifically enable it.  You can
1488 optionally control which decimal floating point format is used (either
1489 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1490 format is default on i386 and x86_64 systems, and the @samp{dpd}
1491 (densely packed decimal) format is default on PowerPC systems.
1492
1493 @item --enable-fixed-point
1494 @itemx --disable-fixed-point
1495 Enable (or disable) support for C fixed-point arithmetic.
1496 This option is enabled by default for some targets (such as MIPS) which
1497 have hardware-support for fixed-point operations.  On other targets, you
1498 may enable this option manually.
1499
1500 @item --with-long-double-128
1501 Specify if @code{long double} type should be 128-bit by default on selected
1502 GNU/Linux architectures.  If using @code{--without-long-double-128},
1503 @code{long double} will be by default 64-bit, the same as @code{double} type.
1504 When neither of these configure options are used, the default will be
1505 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1506 64-bit @code{long double} otherwise.
1507
1508 @item --with-gmp=@var{pathname}
1509 @itemx --with-gmp-include=@var{pathname}
1510 @itemx --with-gmp-lib=@var{pathname}
1511 @itemx --with-mpfr=@var{pathname}
1512 @itemx --with-mpfr-include=@var{pathname}
1513 @itemx --with-mpfr-lib=@var{pathname}
1514 @itemx --with-mpc=@var{pathname}
1515 @itemx --with-mpc-include=@var{pathname}
1516 @itemx --with-mpc-lib=@var{pathname}
1517 If you do not have GMP (the GNU Multiple Precision library), the MPFR
1518 library and/or the MPC library installed in a standard location and
1519 you want to build GCC, you can explicitly specify the directory where
1520 they are installed (@samp{--with-gmp=@var{gmpinstalldir}},
1521 @samp{--with-mpfr=@var{mpfrinstalldir}},
1522 @samp{--with-mpc=@var{mpcinstalldir}}).  The
1523 @option{--with-gmp=@var{gmpinstalldir}} option is shorthand for
1524 @option{--with-gmp-lib=@var{gmpinstalldir}/lib} and
1525 @option{--with-gmp-include=@var{gmpinstalldir}/include}.  Likewise the
1526 @option{--with-mpfr=@var{mpfrinstalldir}} option is shorthand for
1527 @option{--with-mpfr-lib=@var{mpfrinstalldir}/lib} and
1528 @option{--with-mpfr-include=@var{mpfrinstalldir}/include}, also the
1529 @option{--with-mpc=@var{mpcinstalldir}} option is shorthand for
1530 @option{--with-mpc-lib=@var{mpcinstalldir}/lib} and
1531 @option{--with-mpc-include=@var{mpcinstalldir}/include}.  If these
1532 shorthand assumptions are not correct, you can use the explicit
1533 include and lib options directly.
1534
1535 @item --with-ppl=@var{pathname}
1536 @itemx --with-ppl-include=@var{pathname}
1537 @itemx --with-ppl-lib=@var{pathname}
1538 @itemx --with-cloog=@var{pathname}
1539 @itemx --with-cloog-include=@var{pathname}
1540 @itemx --with-cloog-lib=@var{pathname}
1541 If you do not have PPL (the Parma Polyhedra Library) and the CLooG
1542 libraries installed in a standard location and you want to build GCC,
1543 you can explicitly specify the directory where they are installed
1544 (@samp{--with-ppl=@var{pplinstalldir}},
1545 @samp{--with-cloog=@var{clooginstalldir}}). The
1546 @option{--with-ppl=@var{pplinstalldir}} option is shorthand for
1547 @option{--with-ppl-lib=@var{pplinstalldir}/lib} and
1548 @option{--with-ppl-include=@var{pplinstalldir}/include}.  Likewise the
1549 @option{--with-cloog=@var{clooginstalldir}} option is shorthand for
1550 @option{--with-cloog-lib=@var{clooginstalldir}/lib} and
1551 @option{--with-cloog-include=@var{clooginstalldir}/include}.  If these
1552 shorthand assumptions are not correct, you can use the explicit
1553 include and lib options directly.
1554
1555 @item --with-host-libstdcxx=@var{linker-args}
1556 If you are linking with a static copy of PPL, you can use this option
1557 to specify how the linker should find the standard C++ library used
1558 internally by PPL.  Typical values of @var{linker-args} might be
1559 @samp{-lstdc++} or @samp{-Wl,-Bstatic,-lstdc++,-Bdynamic -lm}.  If you are
1560 linking with a shared copy of PPL, you probably do not need this
1561 option; shared library dependencies will cause the linker to search
1562 for the standard C++ library automatically.
1563
1564 @item --with-stage1-ldflags=@var{flags}
1565 This option may be used to set linker flags to be used when linking
1566 stage 1 of GCC.  These are also used when linking GCC if configured with
1567 @option{--disable-bootstrap}.  By default no special flags are used.
1568
1569 @item --with-stage1-libs=@var{libs}
1570 This option may be used to set libraries to be used when linking stage 1
1571 of GCC.  These are also used when linking GCC if configured with
1572 @option{--disable-bootstrap}.  The default is the argument to
1573 @option{--with-host-libstdcxx}, if specified.
1574
1575 @item --with-boot-ldflags=@var{flags}
1576 This option may be used to set linker flags to be used when linking
1577 stage 2 and later when bootstrapping GCC.  By default no special flags
1578 are used.
1579
1580 @item --with-boot-libs=@var{libs}
1581 This option may be used to set libraries to be used when linking stage 2
1582 and later when bootstrapping GCC.  The default is the argument to
1583 @option{--with-host-libstdcxx}, if specified.
1584
1585 @item --with-debug-prefix-map=@var{map}
1586 Convert source directory names using @option{-fdebug-prefix-map} when
1587 building runtime libraries.  @samp{@var{map}} is a space-separated
1588 list of maps of the form @samp{@var{old}=@var{new}}.
1589
1590 @item --enable-linker-build-id
1591 Tells GCC to pass @option{--build-id} option to the linker for all final
1592 links (links performed without the @option{-r} or @option{--relocatable}
1593 option), if the linker supports it.  If you specify
1594 @option{--enable-linker-build-id}, but your linker does not
1595 support @option{--build-id} option, a warning is issued and the
1596 @option{--enable-linker-build-id} option is ignored.  The default is off.
1597
1598 @end table
1599
1600 @subheading Cross-Compiler-Specific Options
1601 The following options only apply to building cross compilers.
1602 @table @code
1603 @item --with-sysroot
1604 @itemx --with-sysroot=@var{dir}
1605 Tells GCC to consider @var{dir} as the root of a tree that contains a
1606 (subset of) the root filesystem of the target operating system.
1607 Target system headers, libraries and run-time object files will be
1608 searched in there.  The specified directory is not copied into the
1609 install tree, unlike the options @option{--with-headers} and
1610 @option{--with-libs} that this option obsoletes.  The default value,
1611 in case @option{--with-sysroot} is not given an argument, is
1612 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1613 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1614 the GCC binaries if the installation tree is moved.
1615
1616 @item --with-build-sysroot
1617 @itemx --with-build-sysroot=@var{dir}
1618 Tells GCC to consider @var{dir} as the system root (see
1619 @option{--with-sysroot}) while building target libraries, instead of
1620 the directory specified with @option{--with-sysroot}.  This option is
1621 only useful when you are already using @option{--with-sysroot}.  You
1622 can use @option{--with-build-sysroot} when you are configuring with
1623 @option{--prefix} set to a directory that is different from the one in
1624 which you are installing GCC and your target libraries.  
1625
1626 This option affects the system root for the compiler used to build
1627 target libraries (which runs on the build system); it does not affect
1628 the compiler which is used to build GCC itself.
1629
1630 @item --with-headers
1631 @itemx --with-headers=@var{dir}
1632 Deprecated in favor of @option{--with-sysroot}.
1633 Specifies that target headers are available when building a cross compiler.
1634 The @var{dir} argument specifies a directory which has the target include
1635 files.  These include files will be copied into the @file{gcc} install
1636 directory.  @emph{This option with the @var{dir} argument is required} when
1637 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1638 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1639 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1640 will be run on these files to make them compatible with GCC@.
1641
1642 @item --without-headers
1643 Tells GCC not use any target headers from a libc when building a cross
1644 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1645 can build the exception handling for libgcc.
1646
1647 @item --with-libs
1648 @itemx --with-libs=``@var{dir1} @var{dir2} @dots{} @var{dirN}''
1649 Deprecated in favor of @option{--with-sysroot}.
1650 Specifies a list of directories which contain the target runtime
1651 libraries.  These libraries will be copied into the @file{gcc} install
1652 directory.  If the directory list is omitted, this option has no
1653 effect.
1654
1655 @item --with-newlib
1656 Specifies that @samp{newlib} is
1657 being used as the target C library.  This causes @code{__eprintf} to be
1658 omitted from @file{libgcc.a} on the assumption that it will be provided by
1659 @samp{newlib}.
1660
1661 @item --with-build-time-tools=@var{dir}
1662 Specifies where to find the set of target tools (assembler, linker, etc.)
1663 that will be used while building GCC itself.  This option can be useful
1664 if the directory layouts are different between the system you are building
1665 GCC on, and the system where you will deploy it.
1666
1667 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
1668 assembler and linker in @file{/usr/bin}, and the native tools in a
1669 different path, and build a toolchain that expects to find the
1670 native tools in @file{/usr/bin}.
1671
1672 When you use this option, you should ensure that @var{dir} includes
1673 @command{ar}, @command{as}, @command{ld}, @command{nm},
1674 @command{ranlib} and @command{strip} if necessary, and possibly
1675 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
1676 tools.
1677 @end table
1678
1679 @subheading Java-Specific Options
1680
1681 The following option applies to the build of the Java front end.
1682
1683 @table @code
1684 @item --disable-libgcj
1685 Specify that the run-time libraries
1686 used by GCJ should not be built.  This is useful in case you intend
1687 to use GCJ with some other run-time, or you're going to install it
1688 separately, or it just happens not to build on your particular
1689 machine.  In general, if the Java front end is enabled, the GCJ
1690 libraries will be enabled too, unless they're known to not work on
1691 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1692 may need to port it; in this case, before modifying the top-level
1693 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1694 you may use @option{--enable-libgcj} to override the default.
1695
1696 @end table
1697
1698 The following options apply to building @samp{libgcj}.
1699
1700 @subsubheading General Options
1701
1702 @table @code
1703 @item --enable-java-maintainer-mode
1704 By default the @samp{libjava} build will not attempt to compile the
1705 @file{.java} source files to @file{.class}.  Instead, it will use the
1706 @file{.class} files from the source tree.  If you use this option you
1707 must have executables named @command{ecj1} and @command{gjavah} in your path
1708 for use by the build.  You must use this option if you intend to
1709 modify any @file{.java} files in @file{libjava}.
1710
1711 @item --with-java-home=@var{dirname}
1712 This @samp{libjava} option overrides the default value of the
1713 @samp{java.home} system property.  It is also used to set
1714 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1715 default @samp{java.home} is set to @file{@var{prefix}} and
1716 @samp{sun.boot.class.path} to
1717 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1718
1719 @item --with-ecj-jar=@var{filename}
1720 This option can be used to specify the location of an external jar
1721 file containing the Eclipse Java compiler.  A specially modified
1722 version of this compiler is used by @command{gcj} to parse
1723 @file{.java} source files.  If this option is given, the
1724 @samp{libjava} build will create and install an @file{ecj1} executable
1725 which uses this jar file at runtime.
1726
1727 If this option is not given, but an @file{ecj.jar} file is found in
1728 the topmost source tree at configure time, then the @samp{libgcj}
1729 build will create and install @file{ecj1}, and will also install the
1730 discovered @file{ecj.jar} into a suitable place in the install tree.
1731
1732 If @file{ecj1} is not installed, then the user will have to supply one
1733 on his path in order for @command{gcj} to properly parse @file{.java}
1734 source files.  A suitable jar is available from
1735 @uref{ftp://sourceware.org/pub/java/}.
1736
1737 @item --disable-getenv-properties
1738 Don't set system properties from @env{GCJ_PROPERTIES}.
1739
1740 @item --enable-hash-synchronization
1741 Use a global hash table for monitor locks.  Ordinarily,
1742 @samp{libgcj}'s @samp{configure} script automatically makes
1743 the correct choice for this option for your platform.  Only use
1744 this if you know you need the library to be configured differently.
1745
1746 @item --enable-interpreter
1747 Enable the Java interpreter.  The interpreter is automatically
1748 enabled by default on all platforms that support it.  This option
1749 is really only useful if you want to disable the interpreter
1750 (using @option{--disable-interpreter}).
1751
1752 @item --disable-java-net
1753 Disable java.net.  This disables the native part of java.net only,
1754 using non-functional stubs for native method implementations.
1755
1756 @item --disable-jvmpi
1757 Disable JVMPI support.
1758
1759 @item --disable-libgcj-bc
1760 Disable BC ABI compilation of certain parts of libgcj.  By default,
1761 some portions of libgcj are compiled with @option{-findirect-dispatch}
1762 and @option{-fno-indirect-classes}, allowing them to be overridden at
1763 run-time.
1764
1765 If @option{--disable-libgcj-bc} is specified, libgcj is built without
1766 these options.  This allows the compile-time linker to resolve
1767 dependencies when statically linking to libgcj.  However it makes it
1768 impossible to override the affected portions of libgcj at run-time.
1769
1770 @item --enable-reduced-reflection
1771 Build most of libgcj with @option{-freduced-reflection}.  This reduces
1772 the size of libgcj at the expense of not being able to do accurate
1773 reflection on the classes it contains.  This option is safe if you
1774 know that code using libgcj will never use reflection on the standard
1775 runtime classes in libgcj (including using serialization, RMI or CORBA).
1776
1777 @item --with-ecos
1778 Enable runtime eCos target support.
1779
1780 @item --without-libffi
1781 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1782 support as well, as these require @samp{libffi} to work.
1783
1784 @item --enable-libgcj-debug
1785 Enable runtime debugging code.
1786
1787 @item --enable-libgcj-multifile
1788 If specified, causes all @file{.java} source files to be
1789 compiled into @file{.class} files in one invocation of
1790 @samp{gcj}.  This can speed up build time, but is more
1791 resource-intensive.  If this option is unspecified or
1792 disabled, @samp{gcj} is invoked once for each @file{.java}
1793 file to compile into a @file{.class} file.
1794
1795 @item --with-libiconv-prefix=DIR
1796 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1797
1798 @item --enable-sjlj-exceptions
1799 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1800 @samp{configure} ordinarily picks the correct value based on the platform.
1801 Only use this option if you are sure you need a different setting.
1802
1803 @item --with-system-zlib
1804 Use installed @samp{zlib} rather than that included with GCC@.
1805
1806 @item --with-win32-nlsapi=ansi, unicows or unicode
1807 Indicates how MinGW @samp{libgcj} translates between UNICODE
1808 characters and the Win32 API@.
1809
1810 @item --enable-java-home
1811 If enabled, this creates a JPackage compatible SDK environment during install.
1812 Note that if --enable-java-home is used, --with-arch-directory=ARCH must also
1813 be specified.
1814
1815 @item --with-arch-directory=ARCH
1816 Specifies the name to use for the @file{jre/lib/ARCH} directory in the SDK 
1817 environment created when --enable-java-home is passed. Typical names for this 
1818 directory include i386, amd64, ia64, etc.
1819
1820 @item --with-os-directory=DIR
1821 Specifies the OS directory for the SDK include directory. This is set to auto
1822 detect, and is typically 'linux'.
1823
1824 @item --with-origin-name=NAME
1825 Specifies the JPackage origin name. This defaults to the 'gcj' in
1826 java-1.5.0-gcj.
1827
1828 @item --with-arch-suffix=SUFFIX
1829 Specifies the suffix for the sdk directory. Defaults to the empty string. 
1830 Examples include '.x86_64' in 'java-1.5.0-gcj-1.5.0.0.x86_64'.
1831
1832 @item --with-jvm-root-dir=DIR
1833 Specifies where to install the SDK. Default is $(prefix)/lib/jvm.
1834
1835 @item --with-jvm-jar-dir=DIR
1836 Specifies where to install jars. Default is $(prefix)/lib/jvm-exports.
1837
1838 @item --with-python-dir=DIR
1839 Specifies where to install the Python modules used for aot-compile. DIR should
1840 not include the prefix used in installation. For example, if the Python modules
1841 are to be installed in /usr/lib/python2.5/site-packages, then 
1842 --with-python-dir=/lib/python2.5/site-packages should be passed. If this is
1843 not specified, then the Python modules are installed in $(prefix)/share/python.
1844
1845 @item --enable-aot-compile-rpm
1846 Adds aot-compile-rpm to the list of installed scripts.
1847
1848 @table @code
1849 @item ansi
1850 Use the single-byte @code{char} and the Win32 A functions natively,
1851 translating to and from UNICODE when using these functions.  If
1852 unspecified, this is the default.
1853
1854 @item unicows
1855 Use the @code{WCHAR} and Win32 W functions natively.  Adds
1856 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1857 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1858 running built executables.  @file{libunicows.a}, an open-source
1859 import library around Microsoft's @code{unicows.dll}, is obtained from
1860 @uref{http://libunicows.sourceforge.net/}, which also gives details
1861 on getting @file{unicows.dll} from Microsoft.
1862
1863 @item unicode
1864 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
1865 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
1866 only run on Microsoft Windows NT and above.
1867 @end table
1868 @end table
1869
1870 @subsubheading AWT-Specific Options
1871
1872 @table @code
1873 @item --with-x
1874 Use the X Window System.
1875
1876 @item --enable-java-awt=PEER(S)
1877 Specifies the AWT peer library or libraries to build alongside
1878 @samp{libgcj}.  If this option is unspecified or disabled, AWT
1879 will be non-functional.  Current valid values are @option{gtk} and
1880 @option{xlib}.  Multiple libraries should be separated by a
1881 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1882
1883 @item --enable-gtk-cairo
1884 Build the cairo Graphics2D implementation on GTK@.
1885
1886 @item --enable-java-gc=TYPE
1887 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
1888
1889 @item --disable-gtktest
1890 Do not try to compile and run a test GTK+ program.
1891
1892 @item --disable-glibtest
1893 Do not try to compile and run a test GLIB program.
1894
1895 @item --with-libart-prefix=PFX
1896 Prefix where libart is installed (optional).
1897
1898 @item --with-libart-exec-prefix=PFX
1899 Exec prefix where libart is installed (optional).
1900
1901 @item --disable-libarttest
1902 Do not try to compile and run a test libart program.
1903
1904 @end table
1905
1906 @html
1907 <hr />
1908 <p>
1909 @end html
1910 @ifhtml
1911 @uref{./index.html,,Return to the GCC Installation page}
1912 @end ifhtml
1913 @end ifset
1914
1915 @c ***Building****************************************************************
1916 @ifnothtml
1917 @comment node-name,     next,          previous, up
1918 @node    Building, Testing, Configuration, Installing GCC
1919 @end ifnothtml
1920 @ifset buildhtml
1921 @ifnothtml
1922 @chapter Building
1923 @end ifnothtml
1924 @cindex Installing GCC: Building
1925
1926 Now that GCC is configured, you are ready to build the compiler and
1927 runtime libraries.
1928
1929 Some commands executed when making the compiler may fail (return a
1930 nonzero status) and be ignored by @command{make}.  These failures, which
1931 are often due to files that were not found, are expected, and can safely
1932 be ignored.
1933
1934 It is normal to have compiler warnings when compiling certain files.
1935 Unless you are a GCC developer, you can generally ignore these warnings
1936 unless they cause compilation to fail.  Developers should attempt to fix
1937 any warnings encountered, however they can temporarily continue past
1938 warnings-as-errors by specifying the configure flag
1939 @option{--disable-werror}.
1940
1941 On certain old systems, defining certain environment variables such as
1942 @env{CC} can interfere with the functioning of @command{make}.
1943
1944 If you encounter seemingly strange errors when trying to build the
1945 compiler in a directory other than the source directory, it could be
1946 because you have previously configured the compiler in the source
1947 directory.  Make sure you have done all the necessary preparations.
1948
1949 If you build GCC on a BSD system using a directory stored in an old System
1950 V file system, problems may occur in running @command{fixincludes} if the
1951 System V file system doesn't support symbolic links.  These problems
1952 result in a failure to fix the declaration of @code{size_t} in
1953 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
1954 that type mismatches occur, this could be the cause.
1955
1956 The solution is not to use such a directory for building GCC@.
1957
1958 Similarly, when building from SVN or snapshots, or if you modify
1959 @file{*.l} files, you need the Flex lexical analyzer generator
1960 installed.  If you do not modify @file{*.l} files, releases contain
1961 the Flex-generated files and you do not need Flex installed to build
1962 them.  There is still one Flex-based lexical analyzer (part of the
1963 build machinery, not of GCC itself) that is used even if you only
1964 build the C front end.
1965
1966 When building from SVN or snapshots, or if you modify Texinfo
1967 documentation, you need version 4.7 or later of Texinfo installed if you
1968 want Info documentation to be regenerated.  Releases contain Info
1969 documentation pre-built for the unmodified documentation in the release.
1970
1971 @section Building a native compiler
1972
1973 For a native build, the default configuration is to perform
1974 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
1975 This will build the entire GCC system and ensure that it compiles
1976 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
1977 parameter to @samp{configure}, but bootstrapping is suggested because
1978 the compiler will be tested more completely and could also have
1979 better performance.
1980
1981 The bootstrapping process will complete the following steps:
1982
1983 @itemize @bullet
1984 @item
1985 Build tools necessary to build the compiler.
1986
1987 @item
1988 Perform a 3-stage bootstrap of the compiler.  This includes building
1989 three times the target tools for use by the compiler such as binutils
1990 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
1991 individually linked or moved into the top level GCC source tree before
1992 configuring.
1993
1994 @item
1995 Perform a comparison test of the stage2 and stage3 compilers.
1996
1997 @item
1998 Build runtime libraries using the stage3 compiler from the previous step.
1999
2000 @end itemize
2001
2002 If you are short on disk space you might consider @samp{make
2003 bootstrap-lean} instead.  The sequence of compilation is the
2004 same described above, but object files from the stage1 and
2005 stage2 of the 3-stage bootstrap of the compiler are deleted as
2006 soon as they are no longer needed.
2007
2008 If you wish to use non-default GCC flags when compiling the stage2
2009 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2010 doing @samp{make}.  For example, if you want to save additional space
2011 during the bootstrap and in the final installation as well, you can
2012 build the compiler binaries without debugging information as in the
2013 following example.  This will save roughly 40% of disk space both for
2014 the bootstrap and the final installation.  (Libraries will still contain
2015 debugging information.)
2016
2017 @smallexample
2018      make BOOT_CFLAGS='-O' bootstrap
2019 @end smallexample
2020
2021 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2022 are less well tested here than the default of @samp{-g -O2}, but should
2023 still work.  In a few cases, you may find that you need to specify special
2024 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2025 if the native compiler miscompiles the stage1 compiler, you may need
2026 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2027 of the stage1 compiler that were miscompiled, or by using @samp{make
2028 bootstrap4} to increase the number of stages of bootstrap.
2029
2030 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2031 Since these are always compiled with the compiler currently being
2032 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2033 compilation flags, as for non-bootstrapped target libraries.
2034 Again, if the native compiler miscompiles the stage1 compiler, you may
2035 need to work around this by avoiding non-working parts of the stage1
2036 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2037
2038 If you used the flag @option{--enable-languages=@dots{}} to restrict
2039 the compilers to be built, only those you've actually enabled will be
2040 built.  This will of course only build those runtime libraries, for
2041 which the particular compiler has been built.  Please note,
2042 that re-defining @env{LANGUAGES} when calling @samp{make}
2043 @strong{does not} work anymore!
2044
2045 If the comparison of stage2 and stage3 fails, this normally indicates
2046 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2047 a potentially serious bug which you should investigate and report.  (On
2048 a few systems, meaningful comparison of object files is impossible; they
2049 always appear ``different''.  If you encounter this problem, you will
2050 need to disable comparison in the @file{Makefile}.)
2051
2052 If you do not want to bootstrap your compiler, you can configure with
2053 @option{--disable-bootstrap}.  In particular cases, you may want to
2054 bootstrap your compiler even if the target system is not the same as
2055 the one you are building on: for example, you could build a
2056 @code{powerpc-unknown-linux-gnu} toolchain on a
2057 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2058 @option{--enable-bootstrap} to the configure script.
2059
2060 @code{BUILD_CONFIG} can be used to bring in additional customization to
2061 the build.  It can be set to a whitespace-separated list of names.  For
2062 each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will be
2063 included by the top-level @file{Makefile}, bringing in any settings it
2064 contains.  Some examples are:
2065
2066 @table @asis
2067 @item @samp{bootstrap-O1}
2068 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2069 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2070 @samp{BOOT_CFLAGS='-g -O1'}.
2071
2072 @item @samp{bootstrap-O3}
2073 Analogous to @code{bootstrap-O1}.
2074
2075 @item @samp{bootstrap-debug}
2076 Builds stage2 without debug information, and uses
2077 @file{contrib/compare-debug} to compare object files.
2078
2079 @end table
2080
2081 @section Building a cross compiler
2082
2083 When building a cross compiler, it is not generally possible to do a
2084 3-stage bootstrap of the compiler.  This makes for an interesting problem
2085 as parts of GCC can only be built with GCC@.
2086
2087 To build a cross compiler, we first recommend building and installing a
2088 native compiler.  You can then use the native GCC compiler to build the
2089 cross compiler.  The installed native compiler needs to be GCC version
2090 2.95 or later.
2091
2092 If the cross compiler is to be built with support for the Java
2093 programming language and the ability to compile .java source files is
2094 desired, the installed native compiler used to build the cross
2095 compiler needs to be the same GCC version as the cross compiler.  In
2096 addition the cross compiler needs to be configured with
2097 @option{--with-ecj-jar=@dots{}}.
2098
2099 Assuming you have already installed a native copy of GCC and configured
2100 your cross compiler, issue the command @command{make}, which performs the
2101 following steps:
2102
2103 @itemize @bullet
2104 @item
2105 Build host tools necessary to build the compiler.
2106
2107 @item
2108 Build target tools for use by the compiler such as binutils (bfd,
2109 binutils, gas, gprof, ld, and opcodes)
2110 if they have been individually linked or moved into the top level GCC source
2111 tree before configuring.
2112
2113 @item
2114 Build the compiler (single stage only).
2115
2116 @item
2117 Build runtime libraries using the compiler from the previous step.
2118 @end itemize
2119
2120 Note that if an error occurs in any step the make process will exit.
2121
2122 If you are not building GNU binutils in the same source tree as GCC,
2123 you will need a cross-assembler and cross-linker installed before
2124 configuring GCC@.  Put them in the directory
2125 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2126 you should put in this directory:
2127
2128 @table @file
2129 @item as
2130 This should be the cross-assembler.
2131
2132 @item ld
2133 This should be the cross-linker.
2134
2135 @item ar
2136 This should be the cross-archiver: a program which can manipulate
2137 archive files (linker libraries) in the target machine's format.
2138
2139 @item ranlib
2140 This should be a program to construct a symbol table in an archive file.
2141 @end table
2142
2143 The installation of GCC will find these programs in that directory,
2144 and copy or link them to the proper place to for the cross-compiler to
2145 find them when run later.
2146
2147 The easiest way to provide these files is to build the Binutils package.
2148 Configure it with the same @option{--host} and @option{--target}
2149 options that you use for configuring GCC, then build and install
2150 them.  They install their executables automatically into the proper
2151 directory.  Alas, they do not support all the targets that GCC
2152 supports.
2153
2154 If you are not building a C library in the same source tree as GCC,
2155 you should also provide the target libraries and headers before
2156 configuring GCC, specifying the directories with
2157 @option{--with-sysroot} or @option{--with-headers} and
2158 @option{--with-libs}.  Many targets also require ``start files'' such
2159 as @file{crt0.o} and
2160 @file{crtn.o} which are linked into each executable.  There may be several
2161 alternatives for @file{crt0.o}, for use with profiling or other
2162 compilation options.  Check your target's definition of
2163 @code{STARTFILE_SPEC} to find out what start files it uses.
2164
2165 @section Building in parallel
2166
2167 GNU Make 3.79 and above, which is necessary to build GCC, support
2168 building in parallel.  To activate this, you can use @samp{make -j 2}
2169 instead of @samp{make}.  You can also specify a bigger number, and 
2170 in most cases using a value greater than the number of processors in
2171 your machine will result in fewer and shorter I/O latency hits, thus
2172 improving overall throughput; this is especially true for slow drives
2173 and network filesystems.
2174
2175 @section Building the Ada compiler
2176
2177 In order to build GNAT, the Ada compiler, you need a working GNAT
2178 compiler (GCC version 3.4 or later).
2179 This includes GNAT tools such as @command{gnatmake} and
2180 @command{gnatlink}, since the Ada front end is written in Ada and
2181 uses some GNAT-specific extensions.
2182
2183 In order to build a cross compiler, it is suggested to install
2184 the new compiler as native first, and then use it to build the cross
2185 compiler.
2186
2187 @command{configure} does not test whether the GNAT installation works
2188 and has a sufficiently recent version; if too old a GNAT version is
2189 installed, the build will fail unless @option{--enable-languages} is
2190 used to disable building the Ada front end.
2191
2192 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2193 must not be set when building the Ada compiler, the Ada tools, or the
2194 Ada runtime libraries. You can check that your build environment is clean
2195 by verifying that @samp{gnatls -v} lists only one explicit path in each
2196 section.
2197
2198 @section Building with profile feedback
2199
2200 It is possible to use profile feedback to optimize the compiler itself.  This
2201 should result in a faster compiler binary.  Experiments done on x86 using gcc
2202 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2203 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2204
2205 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2206 compiler.  This compiler is used to build a @code{stageprofile} compiler
2207 instrumented to collect execution counts of instruction and branch
2208 probabilities.  Then runtime libraries are compiled with profile collected.
2209 Finally a @code{stagefeedback} compiler is built using the information collected.
2210
2211 Unlike standard bootstrap, several additional restrictions apply.  The
2212 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2213 It is recommended to only use GCC for this.  Also parallel make is currently
2214 not supported since collisions in profile collecting may occur.
2215
2216 @html
2217 <hr />
2218 <p>
2219 @end html
2220 @ifhtml
2221 @uref{./index.html,,Return to the GCC Installation page}
2222 @end ifhtml
2223 @end ifset
2224
2225 @c ***Testing*****************************************************************
2226 @ifnothtml
2227 @comment node-name,     next,          previous, up
2228 @node    Testing, Final install, Building, Installing GCC
2229 @end ifnothtml
2230 @ifset testhtml
2231 @ifnothtml
2232 @chapter Installing GCC: Testing
2233 @end ifnothtml
2234 @cindex Testing
2235 @cindex Installing GCC: Testing
2236 @cindex Testsuite
2237
2238 Before you install GCC, we encourage you to run the testsuites and to
2239 compare your results with results from a similar configuration that have
2240 been submitted to the
2241 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2242 Some of these archived results are linked from the build status lists
2243 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2244 reports a successful build runs the testsuites and submits the results.
2245 This step is optional and may require you to download additional software,
2246 but it can give you confidence in your new GCC installation or point out
2247 problems before you install and start using your new GCC@.
2248
2249 First, you must have @uref{download.html,,downloaded the testsuites}.
2250 These are part of the full distribution, but if you downloaded the
2251 ``core'' compiler plus any front ends, you must download the testsuites
2252 separately.
2253
2254 Second, you must have the testing tools installed.  This includes
2255 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2256 the DejaGnu site has links to these.
2257
2258 If the directories where @command{runtest} and @command{expect} were
2259 installed are not in the @env{PATH}, you may need to set the following
2260 environment variables appropriately, as in the following example (which
2261 assumes that DejaGnu has been installed under @file{/usr/local}):
2262
2263 @smallexample
2264      TCL_LIBRARY = /usr/local/share/tcl8.0
2265      DEJAGNULIBS = /usr/local/share/dejagnu
2266 @end smallexample
2267
2268 (On systems such as Cygwin, these paths are required to be actual
2269 paths, not mounts or links; presumably this is due to some lack of
2270 portability in the DejaGnu code.)
2271
2272
2273 Finally, you can run the testsuite (which may take a long time):
2274 @smallexample
2275      cd @var{objdir}; make -k check
2276 @end smallexample
2277
2278 This will test various components of GCC, such as compiler
2279 front ends and runtime libraries.  While running the testsuite, DejaGnu
2280 might emit some harmless messages resembling
2281 @samp{WARNING: Couldn't find the global config file.} or
2282 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2283
2284 If you are testing a cross-compiler, you may want to run the testsuite
2285 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2286
2287 @section How can you run the testsuite on selected tests?
2288
2289 In order to run sets of tests selectively, there are targets
2290 @samp{make check-gcc} and @samp{make check-g++}
2291 in the @file{gcc} subdirectory of the object directory.  You can also
2292 just run @samp{make check} in a subdirectory of the object directory.
2293
2294
2295 A more selective way to just run all @command{gcc} execute tests in the
2296 testsuite is to use
2297
2298 @smallexample
2299     make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2300 @end smallexample
2301
2302 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2303 the testsuite with filenames matching @samp{9805*}, you would use
2304
2305 @smallexample
2306     make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2307 @end smallexample
2308
2309 The @file{*.exp} files are located in the testsuite directories of the GCC
2310 source, the most important ones being @file{compile.exp},
2311 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2312 To get a list of the possible @file{*.exp} files, pipe the
2313 output of @samp{make check} into a file and look at the
2314 @samp{Running @dots{}  .exp} lines.
2315
2316 @section Passing options and running multiple testsuites
2317
2318 You can pass multiple options to the testsuite using the
2319 @samp{--target_board} option of DejaGNU, either passed as part of
2320 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2321 work outside the makefiles.  For example,
2322
2323 @smallexample
2324     make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2325 @end smallexample
2326
2327 will run the standard @command{g++} testsuites (``unix'' is the target name
2328 for a standard native testsuite situation), passing
2329 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2330 slashes separate options.
2331
2332 You can run the testsuites multiple times using combinations of options
2333 with a syntax similar to the brace expansion of popular shells:
2334
2335 @smallexample
2336     @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2337 @end smallexample
2338
2339 (Note the empty option caused by the trailing comma in the final group.)
2340 The following will run each testsuite eight times using the @samp{arm-sim}
2341 target, as if you had specified all possible combinations yourself:
2342
2343 @smallexample
2344     --target_board=arm-sim/-mhard-float/-O1
2345     --target_board=arm-sim/-mhard-float/-O2
2346     --target_board=arm-sim/-mhard-float/-O3
2347     --target_board=arm-sim/-mhard-float
2348     --target_board=arm-sim/-msoft-float/-O1
2349     --target_board=arm-sim/-msoft-float/-O2
2350     --target_board=arm-sim/-msoft-float/-O3
2351     --target_board=arm-sim/-msoft-float
2352 @end smallexample
2353
2354 They can be combined as many times as you wish, in arbitrary ways.  This
2355 list:
2356
2357 @smallexample
2358     @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2359 @end smallexample
2360
2361 will generate four combinations, all involving @samp{-Wextra}.
2362
2363 The disadvantage to this method is that the testsuites are run in serial,
2364 which is a waste on multiprocessor systems.  For users with GNU Make and
2365 a shell which performs brace expansion, you can run the testsuites in
2366 parallel by having the shell perform the combinations and @command{make}
2367 do the parallel runs.  Instead of using @samp{--target_board}, use a
2368 special makefile target:
2369
2370 @smallexample
2371     make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2372 @end smallexample
2373
2374 For example,
2375
2376 @smallexample
2377     make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2378 @end smallexample
2379
2380 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2381 ten combinations as described above.  Note that this is currently only
2382 supported in the @file{gcc} subdirectory.  (To see how this works, try
2383 typing @command{echo} before the example given here.)
2384
2385
2386 @section Additional testing for Java Class Libraries
2387
2388 The Java runtime tests can be executed via @samp{make check}
2389 in the @file{@var{target}/libjava/testsuite} directory in
2390 the build tree.
2391
2392 The @uref{http://sourceware.org/mauve/,,Mauve Project} provides
2393 a suite of tests for the Java Class Libraries.  This suite can be run
2394 as part of libgcj testing by placing the Mauve tree within the libjava
2395 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
2396 specifying the location of that tree when invoking @samp{make}, as in
2397 @samp{make MAUVEDIR=~/mauve check}.
2398
2399 @section How to interpret test results
2400
2401 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2402 files in the testsuite subdirectories.  The @file{*.log} files contain a
2403 detailed log of the compiler invocations and the corresponding
2404 results, the @file{*.sum} files summarize the results.  These summaries
2405 contain status codes for all tests:
2406
2407 @itemize @bullet
2408 @item
2409 PASS: the test passed as expected
2410 @item
2411 XPASS: the test unexpectedly passed
2412 @item
2413 FAIL: the test unexpectedly failed
2414 @item
2415 XFAIL: the test failed as expected
2416 @item
2417 UNSUPPORTED: the test is not supported on this platform
2418 @item
2419 ERROR: the testsuite detected an error
2420 @item
2421 WARNING: the testsuite detected a possible problem
2422 @end itemize
2423
2424 It is normal for some tests to report unexpected failures.  At the
2425 current time the testing harness does not allow fine grained control
2426 over whether or not a test is expected to fail.  This problem should
2427 be fixed in future releases.
2428
2429
2430 @section Submitting test results
2431
2432 If you want to report the results to the GCC project, use the
2433 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2434
2435 @smallexample
2436     @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2437         -m gcc-testresults@@gcc.gnu.org |sh
2438 @end smallexample
2439
2440 This script uses the @command{Mail} program to send the results, so
2441 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2442 prepended to the testsuite summary and should contain any special
2443 remarks you have on your results or your build environment.  Please
2444 do not edit the testsuite result block or the subject line, as these
2445 messages may be automatically processed.
2446
2447 @html
2448 <hr />
2449 <p>
2450 @end html
2451 @ifhtml
2452 @uref{./index.html,,Return to the GCC Installation page}
2453 @end ifhtml
2454 @end ifset
2455
2456 @c ***Final install***********************************************************
2457 @ifnothtml
2458 @comment node-name,     next,          previous, up
2459 @node    Final install, , Testing, Installing GCC
2460 @end ifnothtml
2461 @ifset finalinstallhtml
2462 @ifnothtml
2463 @chapter Installing GCC: Final installation
2464 @end ifnothtml
2465
2466 Now that GCC has been built (and optionally tested), you can install it with
2467 @smallexample
2468 cd @var{objdir}; make install
2469 @end smallexample
2470
2471 We strongly recommend to install into a target directory where there is
2472 no previous version of GCC present.  Also, the GNAT runtime should not
2473 be stripped, as this would break certain features of the debugger that
2474 depend on this debugging information (catching Ada exceptions for
2475 instance).
2476
2477 That step completes the installation of GCC; user level binaries can
2478 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2479 you specified with the @option{--prefix} to configure (or
2480 @file{/usr/local} by default).  (If you specified @option{--bindir},
2481 that directory will be used instead; otherwise, if you specified
2482 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2483 Headers for the C++ and Java libraries are installed in
2484 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2485 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2486 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2487 in info format in @file{@var{infodir}} (normally
2488 @file{@var{prefix}/info}).
2489
2490 When installing cross-compilers, GCC's executables
2491 are not only installed into @file{@var{bindir}}, that
2492 is, @file{@var{exec-prefix}/bin}, but additionally into
2493 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2494 exists.  Typically, such @dfn{tooldirs} hold target-specific
2495 binutils, including assembler and linker.
2496
2497 Installation into a temporary staging area or into a @command{chroot}
2498 jail can be achieved with the command
2499
2500 @smallexample
2501 make DESTDIR=@var{path-to-rootdir} install
2502 @end smallexample
2503
2504 @noindent where @var{path-to-rootdir} is the absolute path of
2505 a directory relative to which all installation paths will be
2506 interpreted.  Note that the directory specified by @code{DESTDIR}
2507 need not exist yet; it will be created if necessary.
2508
2509 There is a subtle point with tooldirs and @code{DESTDIR}:
2510 If you relocate a cross-compiler installation with
2511 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2512 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2513 be filled with duplicated GCC executables only if it already exists,
2514 it will not be created otherwise.  This is regarded as a feature,
2515 not as a bug, because it gives slightly more control to the packagers
2516 using the @code{DESTDIR} feature.
2517
2518 If you are bootstrapping a released version of GCC then please
2519 quickly review the build status page for your release, available from
2520 @uref{http://gcc.gnu.org/buildstat.html}.
2521 If your system is not listed for the version of GCC that you built,
2522 send a note to
2523 @email{gcc@@gcc.gnu.org} indicating
2524 that you successfully built and installed GCC@.
2525 Include the following information:
2526
2527 @itemize @bullet
2528 @item
2529 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2530 that file itself, just the one-line output from running it.
2531
2532 @item
2533 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2534 This tells us which version of GCC you built and the options you passed to
2535 configure.
2536
2537 @item
2538 Whether you enabled all languages or a subset of them.  If you used a
2539 full distribution then this information is part of the configure
2540 options in the output of @samp{gcc -v}, but if you downloaded the
2541 ``core'' compiler plus additional front ends then it isn't apparent
2542 which ones you built unless you tell us about it.
2543
2544 @item
2545 If the build was for GNU/Linux, also include:
2546 @itemize @bullet
2547 @item
2548 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2549 this information should be available from @file{/etc/issue}.
2550
2551 @item
2552 The version of the Linux kernel, available from @samp{uname --version}
2553 or @samp{uname -a}.
2554
2555 @item
2556 The version of glibc you used; for RPM-based systems like Red Hat,
2557 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2558 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2559 @end itemize
2560 For other systems, you can include similar information if you think it is
2561 relevant.
2562
2563 @item
2564 Any other information that you think would be useful to people building
2565 GCC on the same configuration.  The new entry in the build status list
2566 will include a link to the archived copy of your message.
2567 @end itemize
2568
2569 We'd also like to know if the
2570 @ifnothtml
2571 @ref{Specific, host/target specific installation notes}
2572 @end ifnothtml
2573 @ifhtml
2574 @uref{specific.html,,host/target specific installation notes}
2575 @end ifhtml
2576 didn't include your host/target information or if that information is
2577 incomplete or out of date.  Send a note to
2578 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2579
2580 If you find a bug, please report it following the
2581 @uref{../bugs.html,,bug reporting guidelines}.
2582
2583 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2584 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
2585 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2586 subdirectories of @file{@var{objdir}}; these may be converted for
2587 printing with programs such as @command{dvips}.  Alternately, by using
2588 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
2589 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
2590 is included with Texinfo version 4.8 and later.  You can also
2591 @uref{http://www.gnu.org/order/order.html,,buy printed manuals from the
2592 Free Software Foundation}, though such manuals may not be for the most
2593 recent version of GCC@.
2594
2595 If you would like to generate online HTML documentation, do @samp{cd
2596 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2597 @file{@var{objdir}/gcc/HTML}.
2598
2599 @html
2600 <hr />
2601 <p>
2602 @end html
2603 @ifhtml
2604 @uref{./index.html,,Return to the GCC Installation page}
2605 @end ifhtml
2606 @end ifset
2607
2608 @c ***Binaries****************************************************************
2609 @ifnothtml
2610 @comment node-name,     next,          previous, up
2611 @node    Binaries, Specific, Installing GCC, Top
2612 @end ifnothtml
2613 @ifset binarieshtml
2614 @ifnothtml
2615 @chapter Installing GCC: Binaries
2616 @end ifnothtml
2617 @cindex Binaries
2618 @cindex Installing GCC: Binaries
2619
2620 We are often asked about pre-compiled versions of GCC@.  While we cannot
2621 provide these for all platforms, below you'll find links to binaries for
2622 various platforms where creating them by yourself is not easy due to various
2623 reasons.
2624
2625 Please note that we did not create these binaries, nor do we
2626 support them.  If you have any problems installing them, please
2627 contact their makers.
2628
2629 @itemize
2630 @item
2631 AIX:
2632 @itemize
2633 @item
2634 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2635
2636 @item
2637 @uref{http://pware.hvcc.edu,,Hudson Valley Community College Open Source Software for IBM System p};
2638
2639 @item
2640 @uref{http://www.perzl.org/aix,,AIX 5L and 6 Open Source Packages}.
2641 @end itemize
2642
2643 @item
2644 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2645
2646 @item
2647 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2648 Development Tools for the Renesas H8/300[HS] Series}.
2649
2650 @item
2651 HP-UX:
2652 @itemize
2653 @item
2654 @uref{http://hpux.cs.utah.edu/,,HP-UX Porting Center};
2655
2656 @item
2657 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2658 @end itemize
2659
2660 @item
2661 Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU
2662 Development Tools for the Motorola 68HC11/68HC12}.
2663
2664 @item
2665 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2666 OpenServer/Unixware}.
2667
2668 @item
2669 Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}.
2670
2671 @item
2672 SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}.
2673
2674 @item
2675 Microsoft Windows:
2676 @itemize
2677 @item
2678 The @uref{http://sourceware.org/cygwin/,,Cygwin} project;
2679 @item
2680 The @uref{http://www.mingw.org/,,MinGW} project.
2681 @end itemize
2682
2683 @item
2684 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2685 Written Word} offers binaries for
2686 AIX 4.3.3, 5.1 and 5.2,
2687 IRIX 6.5,
2688 Tru64 UNIX 4.0D and 5.1,
2689 GNU/Linux (i386),
2690 HP-UX 10.20, 11.00, and 11.11, and
2691 Solaris/SPARC 2.5.1, 2.6, 7, 8, 9 and 10.
2692
2693 @item
2694 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2695 number of platforms.
2696
2697 @item
2698 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2699 links to GNU Fortran binaries for several platforms.
2700 @end itemize
2701
2702 In addition to those specific offerings, you can get a binary
2703 distribution CD-ROM from the
2704 @uref{http://www.gnu.org/order/order.html,,Free Software Foundation}.
2705 It contains binaries for a number of platforms, and
2706 includes not only GCC, but other stuff as well.  The current CD does
2707 not contain the latest version of GCC, but it should allow
2708 bootstrapping the compiler.  An updated version of that disk is in the
2709 works.
2710
2711 @html
2712 <hr />
2713 <p>
2714 @end html
2715 @ifhtml
2716 @uref{./index.html,,Return to the GCC Installation page}
2717 @end ifhtml
2718 @end ifset
2719
2720 @c ***Specific****************************************************************
2721 @ifnothtml
2722 @comment node-name,     next,          previous, up
2723 @node    Specific, Old, Binaries, Top
2724 @end ifnothtml
2725 @ifset specifichtml
2726 @ifnothtml
2727 @chapter Host/target specific installation notes for GCC
2728 @end ifnothtml
2729 @cindex Specific
2730 @cindex Specific installation notes
2731 @cindex Target specific installation
2732 @cindex Host specific installation
2733 @cindex Target specific installation notes
2734
2735 Please read this document carefully @emph{before} installing the
2736 GNU Compiler Collection on your machine.
2737
2738 Note that this list of install notes is @emph{not} a list of supported
2739 hosts or targets.  Not all supported hosts and targets are listed
2740 here, only the ones that require host-specific or target-specific
2741 information are.
2742
2743 @ifhtml
2744 @itemize
2745 @item
2746 @uref{#alpha-x-x,,alpha*-*-*}
2747 @item
2748 @uref{#alpha-dec-osf,,alpha*-dec-osf*}
2749 @item
2750 @uref{#arc-x-elf,,arc-*-elf}
2751 @item
2752 @uref{#arm-x-elf,,arm-*-elf}
2753 @item
2754 @uref{#avr,,avr}
2755 @item
2756 @uref{#bfin,,Blackfin}
2757 @item
2758 @uref{#dos,,DOS}
2759 @item
2760 @uref{#x-x-freebsd,,*-*-freebsd*}
2761 @item
2762 @uref{#h8300-hms,,h8300-hms}
2763 @item
2764 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2765 @item
2766 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2767 @item
2768 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2769 @item
2770 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2771 @item
2772 @uref{#ix86-x-linux,,i?86-*-linux*}
2773 @item
2774 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2775 @item
2776 @uref{#ia64-x-linux,,ia64-*-linux}
2777 @item
2778 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2779 @item
2780 @uref{#x-ibm-aix,,*-ibm-aix*}
2781 @item
2782 @uref{#iq2000-x-elf,,iq2000-*-elf}
2783 @item
2784 @uref{#m32c-x-elf,,m32c-*-elf}
2785 @item
2786 @uref{#m32r-x-elf,,m32r-*-elf}
2787 @item
2788 @uref{#m6811-elf,,m6811-elf}
2789 @item
2790 @uref{#m6812-elf,,m6812-elf}
2791 @item
2792 @uref{#m68k-x-x,,m68k-*-*}
2793 @item
2794 @uref{#m68k-uclinux,,m68k-uclinux}
2795 @item
2796 @uref{#mep-x-elf,,mep-*-elf}
2797 @item
2798 @uref{#mips-x-x,,mips-*-*}
2799 @item
2800 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
2801 @item
2802 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
2803 @item
2804 @uref{#powerpc-x-x,,powerpc*-*-*}
2805 @item
2806 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
2807 @item
2808 @uref{#powerpc-x-elf,,powerpc-*-elf}
2809 @item
2810 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
2811 @item
2812 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
2813 @item
2814 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
2815 @item
2816 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
2817 @item
2818 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
2819 @item
2820 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
2821 @item
2822 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
2823 @item
2824 @uref{#s390-x-linux,,s390-*-linux*}
2825 @item
2826 @uref{#s390x-x-linux,,s390x-*-linux*}
2827 @item
2828 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
2829 @item
2830 @uref{#x-x-solaris2,,*-*-solaris2*}
2831 @item
2832 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
2833 @item
2834 @uref{#sparc-sun-solaris27,,sparc-sun-solaris2.7}
2835 @item
2836 @uref{#sparc-x-linux,,sparc-*-linux*}
2837 @item
2838 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
2839 @item
2840 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
2841 @item
2842 @uref{#x-x-vxworks,,*-*-vxworks*}
2843 @item
2844 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
2845 @item
2846 @uref{#xtensa-x-elf,,xtensa*-*-elf}
2847 @item
2848 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
2849 @item
2850 @uref{#windows,,Microsoft Windows}
2851 @item
2852 @uref{#x-x-cygwin,,*-*-cygwin}
2853 @item
2854 @uref{#x-x-interix,,*-*-interix}
2855 @item
2856 @uref{#x-x-mingw32,,*-*-mingw32}
2857 @item
2858 @uref{#os2,,OS/2}
2859 @item
2860 @uref{#older,,Older systems}
2861 @end itemize
2862
2863 @itemize
2864 @item
2865 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
2866 @end itemize
2867 @end ifhtml
2868
2869
2870 @html
2871 <!-- -------- host/target specific issues start here ---------------- -->
2872 <hr />
2873 @end html
2874 @heading @anchor{alpha-x-x}alpha*-*-*
2875
2876 This section contains general configuration information for all
2877 alpha-based platforms using ELF (in particular, ignore this section for
2878 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
2879 section, please read all other sections that match your target.
2880
2881 We require binutils 2.11.2 or newer.
2882 Previous binutils releases had a number of problems with DWARF 2
2883 debugging information, not the least of which is incorrect linking of
2884 shared libraries.
2885
2886 @html
2887 <hr />
2888 @end html
2889 @heading @anchor{alpha-dec-osf}alpha*-dec-osf*
2890 Systems using processors that implement the DEC Alpha architecture and
2891 are running the DEC/Compaq Unix (DEC OSF/1, Digital UNIX, or Compaq
2892 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
2893
2894 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
2895 supported.  (These are the versions which identify themselves as DEC
2896 OSF/1.)
2897
2898 In Digital Unix V4.0, virtual memory exhausted bootstrap failures
2899 may be fixed by configuring with @option{--with-gc=simple},
2900 reconfiguring Kernel Virtual Memory and Swap parameters
2901 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
2902 or applying the patch in
2903 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.
2904
2905 In Tru64 UNIX V5.1, Compaq introduced a new assembler that does not
2906 currently (2001-06-13) work with @command{mips-tfile}.  As a workaround,
2907 we need to use the old assembler, invoked via the barely documented
2908 @option{-oldas} option.  To bootstrap GCC, you either need to use the
2909 Compaq C Compiler:
2910
2911 @smallexample
2912    % CC=cc @var{srcdir}/configure [@var{options}] [@var{target}]
2913 @end smallexample
2914
2915 or you can use a copy of GCC 2.95.3 or higher built on Tru64 UNIX V4.0:
2916
2917 @smallexample
2918    % CC=gcc -Wa,-oldas @var{srcdir}/configure [@var{options}] [@var{target}]
2919 @end smallexample
2920
2921 As of GNU binutils 2.11.2, neither GNU @command{as} nor GNU @command{ld}
2922 are supported on Tru64 UNIX, so you must not configure GCC with
2923 @option{--with-gnu-as} or @option{--with-gnu-ld}.
2924
2925 GCC writes a @samp{.verstamp} directive to the assembler output file
2926 unless it is built as a cross-compiler.  It gets the version to use from
2927 the system header file @file{/usr/include/stamp.h}.  If you install a
2928 new version of DEC Unix, you should rebuild GCC to pick up the new version
2929 stamp.
2930
2931 @samp{make compare} may fail on old versions of DEC Unix unless you add
2932 @option{-save-temps} to @code{BOOT_CFLAGS}.  On these systems, the name
2933 of the assembler input file is stored in the object file, and that makes
2934 comparison fail if it differs between the @code{stage1} and
2935 @code{stage2} compilations.  The option @option{-save-temps} forces a
2936 fixed name to be used for the assembler input file, instead of a
2937 randomly chosen name in @file{/tmp}.  Do not add @option{-save-temps}
2938 unless the comparisons fail without that option.  If you add
2939 @option{-save-temps}, you will have to manually delete the @samp{.i} and
2940 @samp{.s} files after each series of compilations.
2941
2942 GCC now supports both the native (ECOFF) debugging format used by DBX
2943 and GDB and an encapsulated STABS format for use only with GDB@.  See the
2944 discussion of the @option{--with-stabs} option of @file{configure} above
2945 for more information on these formats and how to select them.
2946
2947 There is a bug in DEC's assembler that produces incorrect line numbers
2948 for ECOFF format when the @samp{.align} directive is used.  To work
2949 around this problem, GCC will not emit such alignment directives
2950 while writing ECOFF format debugging information even if optimization is
2951 being performed.  Unfortunately, this has the very undesirable
2952 side-effect that code addresses when @option{-O} is specified are
2953 different depending on whether or not @option{-g} is also specified.
2954
2955 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
2956 DBX@.  DEC is now aware of this problem with the assembler and hopes to
2957 provide a fix shortly.
2958
2959 @html
2960 <hr />
2961 @end html
2962 @heading @anchor{arc-x-elf}arc-*-elf
2963 Argonaut ARC processor.
2964 This configuration is intended for embedded systems.
2965
2966 @html
2967 <hr />
2968 @end html
2969 @heading @anchor{arm-x-elf}arm-*-elf
2970 ARM-family processors.  Subtargets that use the ELF object format
2971 require GNU binutils 2.13 or newer.  Such subtargets include:
2972 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux}
2973 and @code{arm-*-rtems}.
2974
2975 @html
2976 <hr />
2977 @end html
2978 @heading @anchor{avr}avr
2979
2980 ATMEL AVR-family micro controllers.  These are used in embedded
2981 applications.  There are no standard Unix configurations.
2982 @ifnothtml
2983 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
2984 Collection (GCC)},
2985 @end ifnothtml
2986 @ifhtml
2987 See ``AVR Options'' in the main manual
2988 @end ifhtml
2989 for the list of supported MCU types.
2990
2991 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
2992
2993 Further installation notes and other useful information about AVR tools
2994 can also be obtained from:
2995
2996 @itemize @bullet
2997 @item
2998 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
2999 @item
3000 @uref{http://home.overta.ru/users/denisc/,,http://home.overta.ru/users/denisc/}
3001 @item
3002 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3003 @end itemize
3004
3005 We @emph{strongly} recommend using binutils 2.13 or newer.
3006
3007 The following error:
3008 @smallexample
3009   Error: register required
3010 @end smallexample
3011
3012 indicates that you should upgrade to a newer version of the binutils.
3013
3014 @html
3015 <hr />
3016 @end html
3017 @heading @anchor{bfin}Blackfin
3018
3019 The Blackfin processor, an Analog Devices DSP.
3020 @ifnothtml
3021 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3022 Collection (GCC)},
3023 @end ifnothtml
3024 @ifhtml
3025 See ``Blackfin Options'' in the main manual
3026 @end ifhtml
3027
3028 More information, and a version of binutils with support for this processor,
3029 is available at @uref{http://blackfin.uclinux.org}
3030
3031 @html
3032 <hr />
3033 @end html
3034 @heading @anchor{cris}CRIS
3035
3036 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3037 series.  These are used in embedded applications.
3038
3039 @ifnothtml
3040 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3041 Collection (GCC)},
3042 @end ifnothtml
3043 @ifhtml
3044 See ``CRIS Options'' in the main manual
3045 @end ifhtml
3046 for a list of CRIS-specific options.
3047
3048 There are a few different CRIS targets:
3049 @table @code
3050 @item cris-axis-elf
3051 Mainly for monolithic embedded systems.  Includes a multilib for the
3052 @samp{v10} core used in @samp{ETRAX 100 LX}.
3053 @item cris-axis-linux-gnu
3054 A GNU/Linux port for the CRIS architecture, currently targeting
3055 @samp{ETRAX 100 LX} by default.
3056 @end table
3057
3058 For @code{cris-axis-elf} you need binutils 2.11
3059 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
3060
3061 Pre-packaged tools can be obtained from
3062 @uref{ftp://ftp.axis.com/pub/axis/tools/cris/compiler-kit/}.  More
3063 information about this platform is available at
3064 @uref{http://developer.axis.com/}.
3065
3066 @html
3067 <hr />
3068 @end html
3069 @heading @anchor{crx}CRX
3070
3071 The CRX CompactRISC architecture is a low-power 32-bit architecture with
3072 fast context switching and architectural extensibility features.
3073
3074 @ifnothtml
3075 @xref{CRX Options,, CRX Options, gcc, Using and Porting the GNU Compiler
3076 Collection (GCC)},
3077 @end ifnothtml
3078
3079 @ifhtml
3080 See ``CRX Options'' in the main manual for a list of CRX-specific options.
3081 @end ifhtml
3082
3083 Use @samp{configure --target=crx-elf --enable-languages=c,c++} to configure
3084 GCC@ for building a CRX cross-compiler. The option @samp{--target=crx-elf}
3085 is also used to build the @samp{newlib} C library for CRX.
3086
3087 It is also possible to build libstdc++-v3 for the CRX architecture. This
3088 needs to be done in a separate step with the following configure settings:
3089 @samp{gcc/libstdc++-v3/configure --host=crx-elf --with-newlib
3090 --enable-sjlj-exceptions --enable-cxx-flags='-fexceptions -frtti'}
3091
3092 @html
3093 <hr />
3094 @end html
3095 @heading @anchor{dos}DOS
3096
3097 Please have a look at the @uref{binaries.html,,binaries page}.
3098
3099 You cannot install GCC by itself on MSDOS; it will not compile under
3100 any MSDOS compiler except itself.  You need to get the complete
3101 compilation package DJGPP, which includes binaries as well as sources,
3102 and includes all the necessary compilation tools and libraries.
3103
3104 @html
3105 <hr />
3106 @end html
3107 @heading @anchor{x-x-freebsd}*-*-freebsd*
3108
3109 The version of binutils installed in @file{/usr/bin} probably works with
3110 this release of GCC@.  However, on FreeBSD 4, bootstrapping against the
3111 latest FSF binutils is known to improve overall testsuite results; and,
3112 on FreeBSD/alpha, using binutils 2.14 or later is required to build libjava.
3113
3114 Support for FreeBSD 1 was discontinued in GCC 3.2.
3115
3116 Support for FreeBSD 2 will be discontinued after GCC 3.4.  The
3117 following was true for GCC 3.1 but the current status is unknown.
3118 For FreeBSD 2 or any mutant a.out versions of FreeBSD 3: All
3119 configuration support and files as shipped with GCC 2.95 are still in
3120 place.  FreeBSD 2.2.7 has been known to bootstrap completely; however,
3121 it is unknown which version of binutils was used (it is assumed that it
3122 was the system copy in @file{/usr/bin}) and C++ EH failures were noted.
3123
3124 For FreeBSD using the ELF file format: DWARF 2 debugging is now the
3125 default for all CPU architectures.  It had been the default on
3126 FreeBSD/alpha since its inception.  You may use @option{-gstabs} instead
3127 of @option{-g}, if you really want the old debugging format.  There are
3128 no known issues with mixing object files and libraries with different
3129 debugging formats.  Otherwise, this release of GCC should now match more
3130 of the configuration used in the stock FreeBSD configuration of GCC@.  In
3131 particular, @option{--enable-threads} is now configured by default.
3132 However, as a general user, do not attempt to replace the system
3133 compiler with this release.  Known to bootstrap and check with good
3134 results on FreeBSD 4.9-STABLE and 5-CURRENT@.  In the past, known to
3135 bootstrap and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2,
3136 4.3, 4.4, 4.5, 4.8-STABLE@.
3137
3138 In principle, @option{--enable-threads} is now compatible with
3139 @option{--enable-libgcj} on FreeBSD@.  However, it has only been built
3140 and tested on @samp{i386-*-freebsd[45]} and @samp{alpha-*-freebsd[45]}.
3141 The static
3142 library may be incorrectly built (symbols are missing at link time).
3143 There is a rare timing-based startup hang (probably involves an
3144 assumption about the thread library).  Multi-threaded boehm-gc (required for
3145 libjava) exposes severe threaded signal-handling bugs on FreeBSD before
3146 4.5-RELEASE@.  Other CPU architectures
3147 supported by FreeBSD will require additional configuration tuning in, at
3148 the very least, both boehm-gc and libffi.
3149
3150 Shared @file{libgcc_s.so} is now built and installed by default.
3151
3152 @html
3153 <hr />
3154 @end html
3155 @heading @anchor{h8300-hms}h8300-hms
3156 Renesas H8/300 series of processors.
3157
3158 Please have a look at the @uref{binaries.html,,binaries page}.
3159
3160 The calling convention and structure layout has changed in release 2.6.
3161 All code must be recompiled.  The calling convention now passes the
3162 first three arguments in function calls in registers.  Structures are no
3163 longer a multiple of 2 bytes.
3164
3165 @html
3166 <hr />
3167 @end html
3168 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
3169 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3170
3171 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3172 later is recommended.
3173
3174 It may be helpful to configure GCC with the
3175 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3176 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3177
3178 The HP assembler should not be used with GCC.  It is rarely tested and may
3179 not work.  It shouldn't be used with any languages other than C due to its
3180 many limitations.
3181
3182 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3183 format which GCC does not know about).  It also inserts timestamps
3184 into each object file it creates, causing the 3-stage comparison test to
3185 fail during a bootstrap.  You should be able to continue by saying
3186 @samp{make all-host all-target} after getting the failure from @samp{make}.
3187
3188 Various GCC features are not supported.  For example, it does not support weak
3189 symbols or alias definitions.  As a result, explicit template instantiations
3190 are required when using C++.  This makes it difficult if not impossible to
3191 build many C++ applications.
3192
3193 There are two default scheduling models for instructions.  These are
3194 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3195 architecture specified for the target machine when configuring.
3196 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3197 the target is a @samp{hppa1*} machine.
3198
3199 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3200 it is important to completely specify the machine architecture when
3201 configuring if you want a model other than PROCESSOR_8000.  The macro
3202 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3203 default scheduling model is desired.
3204
3205 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3206 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3207 This namespace change might cause problems when bootstrapping with
3208 an earlier version of GCC or the HP compiler as essentially the same
3209 namespace is required for an entire build.  This problem can be avoided
3210 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3211 or @samp{98}.  Another way is to add an appropriate set of predefines
3212 to @env{CC}.  The description for the @option{munix=} option contains
3213 a list of the predefines used with each standard.
3214
3215 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3216
3217 @html
3218 <hr />
3219 @end html
3220 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
3221
3222 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3223 @code{PHCO_19798} from HP@.  HP has two sites which provide patches free of
3224 charge:
3225
3226 @itemize @bullet
3227 @item
3228 @html
3229 <a href="http://us.itrc.hp.com/service/home/home.do">US, Canada, Asia-Pacific, and
3230 Latin-America</a>
3231 @end html
3232 @ifnothtml
3233 @uref{http://us.itrc.hp.com/service/home/home.do,,} US, Canada, Asia-Pacific,
3234 and Latin-America.
3235 @end ifnothtml
3236 @item
3237 @uref{http://europe.itrc.hp.com/service/home/home.do,,} Europe.
3238 @end itemize
3239
3240 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3241 used for one-only code and data.  This resolves many of the previous
3242 problems in using C++ on this target.  However, the ABI is not compatible
3243 with the one implemented under HP-UX 11 using secondary definitions.
3244
3245 @html
3246 <hr />
3247 @end html
3248 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
3249
3250 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3251 be used to compile GCC 3.0 and up.
3252
3253 The libffi and libjava libraries haven't been ported to 64-bit HP-UX@
3254 and don't build.
3255
3256 Refer to @uref{binaries.html,,binaries} for information about obtaining
3257 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3258 to build the Ada language as it can't be bootstrapped using C@.  Ada is
3259 only available for the 32-bit PA-RISC runtime.
3260
3261 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3262 bundled compiler supports only traditional C; you will need either HP's
3263 unbundled compiler, or a binary distribution of GCC@.
3264
3265 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3266 but the process requires several steps.  GCC 3.3 can then be used to
3267 build later versions.  The fastjar program contains ISO C code and
3268 can't be built with the HP bundled compiler.  This problem can be
3269 avoided by not building the Java language.  For example, use the
3270 @option{--enable-languages="c,c++,f77,objc"} option in your configure
3271 command.
3272
3273 There are several possible approaches to building the distribution.
3274 Binutils can be built first using the HP tools.  Then, the GCC
3275 distribution can be built.  The second approach is to build GCC
3276 first using the HP tools, then build binutils, then rebuild GCC@.
3277 There have been problems with various binary distributions, so it
3278 is best not to start from a binary distribution.
3279
3280 On 64-bit capable systems, there are two distinct targets.  Different
3281 installation prefixes must be used if both are to be installed on
3282 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3283 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3284 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3285 PA-RISC 2.0 architecture.
3286
3287 The script config.guess now selects the target type based on the compiler
3288 detected during configuration.  You must define @env{PATH} or @env{CC} so
3289 that configure finds an appropriate compiler for the initial bootstrap.
3290 When @env{CC} is used, the definition should contain the options that are
3291 needed whenever @env{CC} is used.
3292
3293 Specifically, options that determine the runtime architecture must be
3294 in @env{CC} to correctly select the target for the build.  It is also
3295 convenient to place many other compiler options in @env{CC}.  For example,
3296 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3297 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3298 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3299 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3300 macro definition table of cpp needs to be increased for a successful
3301 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3302 be defined when building with the bundled compiler, or when using the
3303 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3304
3305 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3306 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3307 search for ld.  The two linkers supported on this target require different
3308 commands.  The default linker is determined during configuration.  As a
3309 result, it's not possible to switch linkers in the middle of a GCC build.
3310 This has been reported to sometimes occur in unified builds of binutils
3311 and GCC@.
3312
3313 A recent linker patch must be installed for the correct operation of
3314 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3315 oldest linker patches that are known to work.  They are for HP-UX
3316 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3317 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3318 patches have been superseded.  Consult the HP patch database to obtain
3319 the currently recommended linker patch for your system.
3320
3321 The patches are necessary for the support of weak symbols on the
3322 32-bit port, and for the running of initializers and finalizers.  Weak
3323 symbols are implemented using SOM secondary definition symbols.  Prior
3324 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3325 The patches correct a problem of linker core dumps creating shared
3326 libraries containing secondary symbols, as well as various other
3327 linking issues involving secondary symbols.
3328
3329 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3330 run initializers and finalizers on the 64-bit port.  The 32-bit port
3331 uses the linker @option{+init} and @option{+fini} options for the same
3332 purpose.  The patches correct various problems with the +init/+fini
3333 options, including program core dumps.  Binutils 2.14 corrects a
3334 problem on the 64-bit port resulting from HP's non-standard use of
3335 the .init and .fini sections for array initializers and finalizers.
3336
3337 Although the HP and GNU linkers are both supported for the
3338 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3339 HP linker be used for link editing on this target.
3340
3341 At this time, the GNU linker does not support the creation of long
3342 branch stubs.  As a result, it can't successfully link binaries
3343 containing branch offsets larger than 8 megabytes.  In addition,
3344 there are problems linking shared libraries, linking executables
3345 with @option{-static}, and with dwarf2 unwind and exception support.
3346 It also doesn't provide stubs for internal calls to global functions
3347 in shared libraries, so these calls can't be overloaded.
3348
3349 The HP dynamic loader does not support GNU symbol versioning, so symbol
3350 versioning is not supported.  It may be necessary to disable symbol
3351 versioning with @option{--disable-symvers} when using GNU ld.
3352
3353 POSIX threads are the default.  The optional DCE thread library is not
3354 supported, so @option{--enable-threads=dce} does not work.
3355
3356 @html
3357 <hr />
3358 @end html
3359 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
3360
3361 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3362 in glibc 2.2.5 and later.  More information is available in the
3363 libstdc++-v3 documentation.
3364
3365 @html
3366 <hr />
3367 @end html
3368 @heading @anchor{ix86-x-linux}i?86-*-linux*
3369
3370 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3371 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3372
3373 If you receive Signal 11 errors when building on GNU/Linux, then it is
3374 possible you have a hardware problem.  Further information on this can be
3375 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3376
3377 @html
3378 <hr />
3379 @end html
3380 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3381 Use this for Solaris 10 or later on x86 and x86-64 systems.  This
3382 configuration is supported by GCC 4.0 and later versions only.
3383
3384 It is recommended that you configure GCC to use the GNU assembler in
3385 @file{/usr/sfw/bin/gas} but the Sun linker, using the options
3386 @option{--with-gnu-as --with-as=/usr/sfw/bin/gas --without-gnu-ld
3387 --with-ld=/usr/ccs/bin/ld}.
3388
3389 @html
3390 <hr />
3391 @end html
3392 @heading @anchor{ia64-x-linux}ia64-*-linux
3393 IA-64 processor (also known as IPF, or Itanium Processor Family)
3394 running GNU/Linux.
3395
3396 If you are using the installed system libunwind library with
3397 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3398 later.
3399
3400 None of the following versions of GCC has an ABI that is compatible
3401 with any of the other versions in this list, with the exception that
3402 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3403 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3404 This primarily affects C++ programs and programs that create shared libraries.
3405 GCC 3.1 or later is recommended for compiling linux, the kernel.
3406 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3407 more major ABI changes are expected.
3408
3409 @html
3410 <hr />
3411 @end html
3412 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3413 Building GCC on this target requires the GNU Assembler.  The bundled HP
3414 assembler will not work.  To prevent GCC from using the wrong assembler,
3415 the option @option{--with-gnu-as} may be necessary.
3416
3417 The GCC libunwind library has not been ported to HPUX@.  This means that for
3418 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3419 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3420 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3421 removed and the system libunwind library will always be used.
3422
3423 @html
3424 <hr />
3425 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3426 @end html
3427 @heading @anchor{x-ibm-aix}*-ibm-aix*
3428 Support for AIX version 3 and older was discontinued in GCC 3.4.
3429 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3430
3431 ``out of memory'' bootstrap failures may indicate a problem with
3432 process resource limits (ulimit).  Hard limits are configured in the
3433 @file{/etc/security/limits} system configuration file.
3434
3435 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3436 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3437 requires a larger data segment, which can be enabled through the
3438 @var{LDR_CNTRL} environment variable, e.g.,
3439
3440 @smallexample
3441    % LDR_CNTRL=MAXDATA=0x50000000
3442    % export LDR_CNTRL
3443 @end smallexample
3444
3445 One can start with a pre-compiled version of GCC to build from
3446 sources.  One may delete GCC's ``fixed'' header files when starting
3447 with a version of GCC built for an earlier release of AIX.
3448
3449 To speed up the configuration phases of bootstrapping and installing GCC,
3450 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3451
3452 @smallexample
3453    % CONFIG_SHELL=/opt/freeware/bin/bash
3454    % export CONFIG_SHELL
3455 @end smallexample
3456
3457 and then proceed as described in @uref{build.html,,the build
3458 instructions}, where we strongly recommend specifying an absolute path
3459 to invoke @var{srcdir}/configure.
3460
3461 Because GCC on AIX is built as a 32-bit executable by default,
3462 (although it can generate 64-bit programs) the GMP and MPFR libraries
3463 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3464 as static archive libraries works better than shared libraries.
3465
3466 Errors involving @code{alloca} when building GCC generally are due
3467 to an incorrect definition of @code{CC} in the Makefile or mixing files
3468 compiled with the native C compiler and GCC@.  During the stage1 phase of
3469 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3470 (not @command{xlc}).  Once @command{configure} has been informed of
3471 @command{xlc}, one needs to use @samp{make distclean} to remove the
3472 configure cache files and ensure that @env{CC} environment variable
3473 does not provide a definition that will confuse @command{configure}.
3474 If this error occurs during stage2 or later, then the problem most likely
3475 is the version of Make (see above).
3476
3477 The native @command{as} and @command{ld} are recommended for bootstrapping
3478 on AIX@.  The GNU Assembler, GNU Linker, and GNU Binutils version 2.20
3479 is required to bootstrap on AIX 5@.  The native AIX tools do
3480 interoperate with GCC@.
3481
3482 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3483 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3484 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3485 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3486
3487 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3488 shared object and GCC installation places the @file{libstdc++.a}
3489 shared library in a common location which will overwrite the and GCC
3490 3.3 version of the shared library.  Applications either need to be
3491 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3492 versions of the @samp{libstdc++} shared object needs to be available
3493 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3494 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3495 installed for runtime dynamic loading using the following steps to set
3496 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3497 multilib @file{libstdc++.a} installed:
3498
3499 Extract the shared objects from the currently installed
3500 @file{libstdc++.a} archive:
3501 @smallexample
3502    % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3503 @end smallexample
3504
3505 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3506 available for runtime dynamic loading, but not linking:
3507 @smallexample
3508    % strip -e libstdc++.so.4 libstdc++.so.5
3509 @end smallexample
3510
3511 Archive the runtime-only shared object in the GCC 3.4
3512 @file{libstdc++.a} archive:
3513 @smallexample
3514    % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3515 @end smallexample
3516
3517 Linking executables and shared libraries may produce warnings of
3518 duplicate symbols.  The assembly files generated by GCC for AIX always
3519 have included multiple symbol definitions for certain global variable
3520 and function declarations in the original program.  The warnings should
3521 not prevent the linker from producing a correct library or runnable
3522 executable.
3523
3524 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3525 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3526 to parse archive libraries did not handle the new format correctly.
3527 These routines are used by GCC and result in error messages during
3528 linking such as ``not a COFF file''.  The version of the routines shipped
3529 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3530 option of the archive command may be used to create archives of 32-bit
3531 objects using the original ``small format''.  A correct version of the
3532 routines is shipped with AIX 4.3.2 and above.
3533
3534 Some versions of the AIX binder (linker) can fail with a relocation
3535 overflow severe error when the @option{-bbigtoc} option is used to link
3536 GCC-produced object files into an executable that overflows the TOC@.  A fix
3537 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3538 available from IBM Customer Support and from its
3539 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3540 website as PTF U455193.
3541
3542 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3543 with a segmentation fault when invoked by any version of GCC@.  A fix for
3544 APAR IX87327 is available from IBM Customer Support and from its
3545 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3546 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3547
3548 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3549 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3550 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3551 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3552 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3553
3554 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3555 use NLS to support locale-specific representations of various data
3556 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3557 separating decimal fractions).  There have been problems reported where
3558 GCC does not produce the same floating-point formats that the assembler
3559 expects.  If one encounters this problem, set the @env{LANG}
3560 environment variable to @samp{C} or @samp{En_US}.
3561
3562 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3563 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3564
3565 @html
3566 <hr />
3567 @end html
3568 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3569 Vitesse IQ2000 processors.  These are used in embedded
3570 applications.  There are no standard Unix configurations.
3571
3572 @html
3573 <hr />
3574 @end html
3575 @heading @anchor{m32c-x-elf}m32c-*-elf
3576 Renesas M32C processor.
3577 This configuration is intended for embedded systems.
3578
3579 @html
3580 <hr />
3581 @end html
3582 @heading @anchor{m32r-x-elf}m32r-*-elf
3583 Renesas M32R processor.
3584 This configuration is intended for embedded systems.
3585
3586 @html
3587 <hr />
3588 @end html
3589 @heading @anchor{m6811-elf}m6811-elf
3590 Motorola 68HC11 family micro controllers.  These are used in embedded
3591 applications.  There are no standard Unix configurations.
3592
3593 @html
3594 <hr />
3595 @end html
3596 @heading @anchor{m6812-elf}m6812-elf
3597 Motorola 68HC12 family micro controllers.  These are used in embedded
3598 applications.  There are no standard Unix configurations.
3599
3600 @html
3601 <hr />
3602 @end html
3603 @heading @anchor{m68k-x-x}m68k-*-*
3604 By default,
3605 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
3606 @samp{m68k-*-linux}
3607 build libraries for both M680x0 and ColdFire processors.  If you only
3608 need the M680x0 libraries, you can omit the ColdFire ones by passing
3609 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
3610 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
3611 @command{configure}.  These targets default to 5206 or 5475 code as
3612 appropriate for the target system when
3613 configured with @option{--with-arch=cf} and 68020 code otherwise.
3614
3615 The @samp{m68k-*-netbsd} and
3616 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
3617 option.  They will generate ColdFire CFV4e code when configured with
3618 @option{--with-arch=cf} and 68020 code otherwise.
3619
3620 You can override the default processors listed above by configuring
3621 with @option{--with-cpu=@var{target}}.  This @var{target} can either
3622 be a @option{-mcpu} argument or one of the following values:
3623 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
3624 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
3625
3626 @html
3627 <hr />
3628 @end html
3629 @heading @anchor{m68k-x-uclinux}m68k-*-uclinux
3630 GCC 4.3 changed the uClinux configuration so that it uses the
3631 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
3632 It also added improved support for C++ and flat shared libraries,
3633 both of which were ABI changes.  However, you can still use the
3634 original ABI by configuring for @samp{m68k-uclinuxoldabi} or
3635 @samp{m68k-@var{vendor}-uclinuxoldabi}.
3636
3637
3638 @html
3639 <hr />
3640 @end html
3641 @heading @anchor{mep-x-elf}mep-*-elf
3642 Toshiba Media embedded Processor.
3643 This configuration is intended for embedded systems.
3644
3645 @html
3646 <hr />
3647 @end html
3648 @heading @anchor{mips-x-x}mips-*-*
3649 If on a MIPS system you get an error message saying ``does not have gp
3650 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3651 happens whenever you use GAS with the MIPS linker, but there is not
3652 really anything wrong, and it is okay to use the output file.  You can
3653 stop such warnings by installing the GNU linker.
3654
3655 It would be nice to extend GAS to produce the gp tables, but they are
3656 optional, and there should not be a warning about their absence.
3657
3658 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3659 and later.  A patch went in just after the GCC 3.3 release to
3660 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3661 configure for @samp{mipsel-elf} as a workaround.  The
3662 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3663 work on this is expected in future releases.
3664
3665 @c If you make --with-llsc the default for another target, please also
3666 @c update the description of the --with-llsc option.
3667
3668 The built-in @code{__sync_*} functions are available on MIPS II and
3669 later systems and others that support the @samp{ll}, @samp{sc} and
3670 @samp{sync} instructions.  This can be overridden by passing
3671 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
3672 Since the Linux kernel emulates these instructions if they are
3673 missing, the default for @samp{mips*-*-linux*} targets is
3674 @option{--with-llsc}.  The @option{--with-llsc} and
3675 @option{--without-llsc} configure options may be overridden at compile
3676 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
3677 the compiler.
3678
3679 MIPS systems check for division by zero (unless
3680 @option{-mno-check-zero-division} is passed to the compiler) by
3681 generating either a conditional trap or a break instruction.  Using
3682 trap results in smaller code, but is only supported on MIPS II and
3683 later.  Also, some versions of the Linux kernel have a bug that
3684 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3685 the use of break, use the @option{--with-divide=breaks}
3686 @command{configure} option when configuring GCC@.  The default is to
3687 use traps on systems that support them.
3688
3689 Cross-compilers for the MIPS as target using the MIPS assembler
3690 currently do not work, because the auxiliary programs
3691 @file{mips-tdump.c} and @file{mips-tfile.c} can't be compiled on
3692 anything but a MIPS@.  It does work to cross compile for a MIPS
3693 if you use the GNU assembler and linker.
3694
3695 The assembler from GNU binutils 2.17 and earlier has a bug in the way
3696 it sorts relocations for REL targets (o32, o64, EABI).  This can cause
3697 bad code to be generated for simple C++ programs.  Also the linker
3698 from GNU binutils versions prior to 2.17 has a bug which causes the
3699 runtime linker stubs in very large programs, like @file{libgcj.so}, to
3700 be incorrectly generated.  GNU Binutils 2.18 and later (and snapshots
3701 made after Nov. 9, 2006) should be free from both of these problems.
3702
3703 @html
3704 <hr />
3705 @end html
3706 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3707
3708 In order to compile GCC on an SGI running IRIX 5, the @samp{compiler_dev.hdr}
3709 subsystem must be installed from the IDO CD-ROM supplied by SGI@.
3710 It is also available for download from
3711 @uref{ftp://ftp.sgi.com/sgi/IRIX5.3/iris-development-option-5.3.tardist}.
3712
3713 If you use the MIPS C compiler to bootstrap, it may be necessary
3714 to increase its table size for switch statements with the
3715 @option{-Wf,-XNg1500} option.  If you use the @option{-O2}
3716 optimization option, you also need to use @option{-Olimit 3000}.
3717
3718 To enable debugging under IRIX 5, you must use GNU binutils 2.15 or
3719 later, and use the @option{--with-gnu-ld} @command{configure} option
3720 when configuring GCC@.  You need to use GNU @command{ar} and @command{nm},
3721 also distributed with GNU binutils.
3722
3723 Some users have reported that @command{/bin/sh} will hang during bootstrap.
3724 This problem can be avoided by running the commands:
3725
3726 @smallexample
3727    % CONFIG_SHELL=/bin/ksh
3728    % export CONFIG_SHELL
3729 @end smallexample
3730
3731 before starting the build.
3732
3733 @html
3734 <hr />
3735 @end html
3736 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3737
3738 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3739 ensure that the N32 ABI is in use.  To test this, compile a simple C
3740 file with @command{cc} and then run @command{file} on the
3741 resulting object file.  The output should look like:
3742
3743 @smallexample
3744 test.o: ELF N32 MSB @dots{}
3745 @end smallexample
3746
3747 If you see:
3748
3749 @smallexample
3750 test.o: ELF 32-bit MSB @dots{}
3751 @end smallexample
3752
3753 or
3754
3755 @smallexample
3756 test.o: ELF 64-bit MSB @dots{}
3757 @end smallexample
3758
3759 then your version of @command{cc} uses the O32 or N64 ABI by default.  You
3760 should set the environment variable @env{CC} to @samp{cc -n32}
3761 before configuring GCC@.
3762
3763 If you want the resulting @command{gcc} to run on old 32-bit systems
3764 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3765 instruction set architecture (ISA) is generated.  While GCC 3.x does
3766 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3767 the ISA depending on the machine where GCC is built.  Using one of them
3768 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3769 all on @samp{mips3}-only systems.  For the test program above, you should see:
3770
3771 @smallexample
3772 test.o: ELF N32 MSB mips-3 @dots{}
3773 @end smallexample
3774
3775 If you get:
3776
3777 @smallexample
3778 test.o: ELF N32 MSB mips-4 @dots{}
3779 @end smallexample
3780
3781 instead, you should set the environment variable @env{CC} to @samp{cc
3782 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3783
3784 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3785 @code{memcmp}.  Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3786 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3787
3788 GCC on IRIX 6 is usually built to support the N32, O32 and N64 ABIs.  If
3789 you build GCC on a system that doesn't have the N64 libraries installed
3790 or cannot run 64-bit binaries,
3791 you need to configure with @option{--disable-multilib} so GCC doesn't
3792 try to use them.  This will disable building the O32 libraries, too.
3793 Look for @file{/usr/lib64/libc.so.1} to see if you
3794 have the 64-bit libraries installed.
3795
3796 To enable debugging for the O32 ABI, you must use GNU @command{as} from
3797 GNU binutils 2.15 or later.  You may also use GNU @command{ld}, but
3798 this is not required and currently causes some problems with Ada.
3799
3800 The @option{--enable-libgcj}
3801 option is disabled by default: IRIX 6 uses a very low default limit
3802 (20480) for the command line length.  Although @command{libtool} contains a
3803 workaround for this problem, at least the N64 @samp{libgcj} is known not
3804 to build despite this, running into an internal error of the native
3805 @command{ld}.  A sure fix is to increase this limit (@samp{ncargs}) to
3806 its maximum of 262144 bytes.  If you have root access, you can use the
3807 @command{systune} command to do this.
3808
3809 @code{wchar_t} support in @samp{libstdc++} is not available for old
3810 IRIX 6.5.x releases, @math{x < 19}.  The problem cannot be autodetected
3811 and in order to build GCC for such targets you need to configure with
3812 @option{--disable-wchar_t}.
3813
3814 See @uref{http://freeware.sgi.com/} for more
3815 information about using GCC on IRIX platforms.
3816
3817 @html
3818 <hr />
3819 @end html
3820 @heading @anchor{moxie-x-elf}moxie-*-elf
3821 The moxie processor.  See @uref{http://moxielogic.org/} for more
3822 information about this processor.
3823
3824 @html
3825 <hr />
3826 @end html
3827 @heading @anchor{powerpc-x-x}powerpc-*-*
3828
3829 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3830 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3831
3832 You will need
3833 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3834 or newer for a working GCC@.
3835
3836 @html
3837 <hr />
3838 @end html
3839 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3840 PowerPC running Darwin (Mac OS X kernel).
3841
3842 Pre-installed versions of Mac OS X may not include any developer tools,
3843 meaning that you will not be able to build GCC from source.  Tool
3844 binaries are available at
3845 @uref{http://developer.apple.com/darwin/projects/compiler/} (free
3846 registration required).
3847
3848 This version of GCC requires at least cctools-590.36.  The
3849 cctools-590.36 package referenced from
3850 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
3851 on systems older than 10.3.9 (aka darwin7.9.0).
3852
3853 @html
3854 <hr />
3855 @end html
3856 @heading @anchor{powerpc-x-elf}powerpc-*-elf
3857 PowerPC system in big endian mode, running System V.4.
3858
3859 @html
3860 <hr />
3861 @end html
3862 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
3863
3864 PowerPC system in big endian mode running Linux.
3865
3866 @html
3867 <hr />
3868 @end html
3869 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
3870 PowerPC system in big endian mode running NetBSD@.
3871
3872 @html
3873 <hr />
3874 @end html
3875 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
3876 Embedded PowerPC system in big endian mode for use in running under the
3877 PSIM simulator.
3878
3879 @html
3880 <hr />
3881 @end html
3882 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
3883 Embedded PowerPC system in big endian mode.
3884
3885 @html
3886 <hr />
3887 @end html
3888 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf
3889 PowerPC system in little endian mode, running System V.4.
3890
3891 @html
3892 <hr />
3893 @end html
3894 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
3895 Embedded PowerPC system in little endian mode for use in running under
3896 the PSIM simulator.
3897
3898 @html
3899 <hr />
3900 @end html
3901 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
3902 Embedded PowerPC system in little endian mode.
3903
3904 @html
3905 <hr />
3906 @end html
3907 @heading @anchor{s390-x-linux}s390-*-linux*
3908 S/390 system running GNU/Linux for S/390@.
3909
3910 @html
3911 <hr />
3912 @end html
3913 @heading @anchor{s390x-x-linux}s390x-*-linux*
3914 zSeries system (64-bit) running GNU/Linux for zSeries@.
3915
3916 @html
3917 <hr />
3918 @end html
3919 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
3920 zSeries system (64-bit) running TPF@.  This platform is
3921 supported as cross-compilation target only.
3922
3923 @html
3924 <hr />
3925 @end html
3926 @c Please use Solaris 2 to refer to all release of Solaris, starting
3927 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
3928 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
3929 @c alone is too unspecific and must be avoided.
3930 @heading @anchor{x-x-solaris2}*-*-solaris2*
3931
3932 Sun does not ship a C compiler with Solaris 2.  To bootstrap and install
3933 GCC you first have to install a pre-built compiler, see the
3934 @uref{binaries.html,,binaries page} for details.
3935
3936 The Solaris 2 @command{/bin/sh} will often fail to configure
3937 @file{libstdc++-v3}, @file{boehm-gc} or @file{libjava}.  We therefore
3938 recommend using the following initial sequence of commands
3939
3940 @smallexample
3941    % CONFIG_SHELL=/bin/ksh
3942    % export CONFIG_SHELL
3943 @end smallexample
3944
3945 and proceed as described in @uref{configure.html,,the configure instructions}.
3946 In addition we strongly recommend specifying an absolute path to invoke
3947 @var{srcdir}/configure.
3948
3949 Solaris 2 comes with a number of optional OS packages.  Some of these
3950 are needed to use GCC fully, namely @code{SUNWarc},
3951 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
3952 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
3953 optional packages when installing Solaris 2, you will need to verify that
3954 the packages that GCC needs are installed.
3955
3956 To check whether an optional package is installed, use
3957 the @command{pkginfo} command.  To add an optional package, use the
3958 @command{pkgadd} command.  For further details, see the Solaris 2
3959 documentation.
3960
3961 Trying to use the linker and other tools in
3962 @file{/usr/ucb} to install GCC has been observed to cause trouble.
3963 For example, the linker may hang indefinitely.  The fix is to remove
3964 @file{/usr/ucb} from your @env{PATH}.
3965
3966 The build process works more smoothly with the legacy Sun tools so, if you
3967 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
3968 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
3969
3970 We recommend the use of GNU binutils 2.14 or later, or the vendor tools
3971 (Sun @command{as}, Sun @command{ld}).  Note that your mileage may vary
3972 if you use a combination of the GNU tools and the Sun tools: while the
3973 combination GNU @command{as} + Sun @command{ld} should reasonably work,
3974 the reverse combination Sun @command{as} + GNU @command{ld} is known to
3975 cause memory corruption at runtime in some cases for C++ programs.
3976
3977 The stock GNU binutils 2.15 release is broken on this platform because of a
3978 single bug.  It has been fixed on the 2.15 branch in the CVS repository.
3979 You can obtain a working version by checking out the binutils-2_15-branch
3980 from the CVS repository or applying the patch
3981 @uref{http://sourceware.org/ml/binutils-cvs/2004-09/msg00036.html} to the
3982 release.
3983
3984 We recommend the use of GNU binutils 2.16 or later in conjunction with GCC
3985 4.x, or the vendor tools (Sun @command{as}, Sun @command{ld}).  However,
3986 for Solaris 10 and above, an additional patch is required in order for the
3987 GNU linker to be able to cope with a new flavor of shared libraries.  You
3988 can obtain a working version by checking out the binutils-2_16-branch from
3989 the CVS repository or applying the patch
3990 @uref{http://sourceware.org/ml/binutils-cvs/2005-07/msg00122.html} to the
3991 release.
3992
3993 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
3994 newer: @command{g++} will complain that types are missing.  These headers
3995 assume that omitting the type means @code{int}; this assumption worked for
3996 C89 but is wrong for C++, and is now wrong for C99 also.
3997
3998 @command{g++} accepts such (invalid) constructs with the option
3999 @option{-fpermissive}; it will assume that any missing type is @code{int}
4000 (as defined by C89).
4001
4002 There are patches for Solaris 7 (108376-21 or newer for SPARC,
4003 108377-20 for Intel), and Solaris 8 (108652-24 or newer for SPARC,
4004 108653-22 for Intel) that fix this bug.
4005
4006 Sun bug 4927647 sometimes causes random spurious testsuite failures
4007 related to missing diagnostic output.  This bug doesn't affect GCC
4008 itself, rather it is a kernel bug triggered by the @command{expect}
4009 program which is used only by the GCC testsuite driver.  When the bug
4010 causes the @command{expect} program to miss anticipated output, extra
4011 testsuite failures appear.
4012
4013 There are patches for Solaris 8 (117350-12 or newer for SPARC,
4014 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
4015 SPARC, 117172-11 or newer for Intel) that address this problem.
4016
4017 @html
4018 <hr />
4019 @end html
4020 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
4021
4022 When GCC is configured to use binutils 2.14 or later the binaries
4023 produced are smaller than the ones produced using Sun's native tools;
4024 this difference is quite significant for binaries containing debugging
4025 information.
4026
4027 Starting with Solaris 7, the operating system is capable of executing
4028 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4029 this; the @option{-m64} option enables 64-bit code generation.
4030 However, if all you want is code tuned for the UltraSPARC CPU, you
4031 should try the @option{-mtune=ultrasparc} option instead, which produces
4032 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4033 machines.
4034
4035 When configuring on a Solaris 7 or later system that is running a kernel
4036 that supports only 32-bit binaries, one must configure with
4037 @option{--disable-multilib}, since we will not be able to build the
4038 64-bit target libraries.
4039
4040 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
4041 the GNU compiler (especially GCC 3.0.x versions), which lead to the
4042 miscompilation of the stage1 compiler and the subsequent failure of the
4043 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
4044 stage, i.e.@: to bootstrap that compiler with the base compiler and then
4045 use it to bootstrap the final compiler.
4046
4047 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
4048 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
4049 failure in form of a miscompilation of the stage1 compiler by the Sun
4050 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
4051
4052 GCC 3.4 changed the default debugging format from STABS to DWARF-2 for
4053 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
4054 change apparently runs afoul of Sun bug 4910101 (which is referenced as
4055 an x86-only problem by Sun, probably because they do not use DWARF-2).
4056 A symptom of the problem is that you cannot compile C++ programs like
4057 @command{groff} 1.19.1 without getting messages similar to the following:
4058
4059 @smallexample
4060 ld: warning: relocation error: R_SPARC_UA32: @dots{}
4061   external symbolic relocation against non-allocatable section
4062   .debug_info cannot be processed at runtime: relocation ignored.
4063 @end smallexample
4064
4065 To work around this problem, compile with @option{-gstabs+} instead of
4066 plain @option{-g}.
4067
4068 When configuring the GNU Multiple Precision Library (GMP) or the MPFR
4069 library on a Solaris 7 or later system, the canonical target triplet
4070 must be specified as the @command{build} parameter on the configure
4071 line.  This triplet can be obtained by invoking ./config.guess in
4072 the toplevel source directory of GCC (and not that of GMP or MPFR).
4073 For example on a Solaris 7 system:
4074
4075 @smallexample
4076    % ./configure --build=sparc-sun-solaris2.7 --prefix=xxx
4077 @end smallexample
4078
4079 @html
4080 <hr />
4081 @end html
4082 @heading @anchor{sparc-sun-solaris27}sparc-sun-solaris2.7
4083
4084 Sun patch 107058-01 (1999-01-13) for Solaris 7/SPARC triggers a bug in
4085 the dynamic linker.  This problem (Sun bug 4210064) affects GCC 2.8
4086 and later, including all EGCS releases.  Sun formerly recommended
4087 107058-01 for all Solaris 7 users, but around 1999-09-01 it started to
4088 recommend it only for people who use Sun's compilers.
4089
4090 Here are some workarounds to this problem:
4091 @itemize @bullet
4092 @item
4093 Do not install Sun patch 107058-01 until after Sun releases a
4094 complete patch for bug 4210064.  This is the simplest course to take,
4095 unless you must also use Sun's C compiler.  Unfortunately 107058-01
4096 is preinstalled on some new Solaris 7-based hosts, so you may have to
4097 back it out.
4098
4099 @item
4100 Copy the original, unpatched Solaris 7
4101 @command{/usr/ccs/bin/as} into
4102 @command{/usr/local/libexec/gcc/sparc-sun-solaris2.7/3.4/as},
4103 adjusting the latter name to fit your local conventions and software
4104 version numbers.
4105
4106 @item
4107 Install Sun patch 106950-03 (1999-05-25) or later.  Nobody with
4108 both 107058-01 and 106950-03 installed has reported the bug with GCC
4109 and Sun's dynamic linker.  This last course of action is riskiest,
4110 for two reasons.  First, you must install 106950 on all hosts that
4111 run code generated by GCC; it doesn't suffice to install it only on
4112 the hosts that run GCC itself.  Second, Sun says that 106950-03 is
4113 only a partial fix for bug 4210064, but Sun doesn't know whether the
4114 partial fix is adequate for GCC@.  Revision -08 or later should fix
4115 the bug.  The current (as of 2004-05-23) revision is -24, and is included in
4116 the Solaris 7 Recommended Patch Cluster.
4117 @end itemize
4118
4119 GCC 3.3 triggers a bug in version 5.0 Alpha 03/27/98 of the Sun assembler,
4120 which causes a bootstrap failure when linking the 64-bit shared version of
4121 libgcc.  A typical error message is:
4122
4123 @smallexample
4124 ld: fatal: relocation error: R_SPARC_32: file libgcc/sparcv9/_muldi3.o:
4125   symbol <unknown>:  offset 0xffffffff7ec133e7 is non-aligned.
4126 @end smallexample
4127
4128 This bug has been fixed in the final 5.0 version of the assembler.
4129
4130 A similar problem was reported for version Sun WorkShop 6 99/08/18 of the
4131 Sun assembler, which causes a bootstrap failure with GCC 4.0.0:
4132
4133 @smallexample
4134 ld: fatal: relocation error: R_SPARC_DISP32:
4135   file .libs/libstdc++.lax/libsupc++convenience.a/vterminate.o:
4136     symbol <unknown>: offset 0xfccd33ad is non-aligned
4137 @end smallexample
4138
4139 This bug has been fixed in more recent revisions of the assembler.
4140
4141 @html
4142 <hr />
4143 @end html
4144 @heading @anchor{sparc-x-linux}sparc-*-linux*
4145
4146 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
4147 or newer on this platform.  All earlier binutils and glibc
4148 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
4149
4150
4151 @html
4152 <hr />
4153 @end html
4154 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
4155
4156 When configuring the GNU Multiple Precision Library (GMP) or the
4157 MPFR library, the canonical target triplet must be specified as
4158 the @command{build} parameter on the configure line.  For example
4159 on a Solaris 7 system:
4160
4161 @smallexample
4162    % ./configure --build=sparc64-sun-solaris2.7 --prefix=xxx
4163 @end smallexample
4164
4165 The following compiler flags must be specified in the configure
4166 step in order to bootstrap this target with the Sun compiler:
4167
4168 @smallexample
4169    % CC="cc -xarch=v9 -xildoff" @var{srcdir}/configure [@var{options}] [@var{target}]
4170 @end smallexample
4171
4172 @option{-xarch=v9} specifies the SPARC-V9 architecture to the Sun toolchain
4173 and @option{-xildoff} turns off the incremental linker.
4174
4175 @html
4176 <hr />
4177 @end html
4178 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
4179
4180 This is a synonym for sparc64-*-solaris2*.
4181
4182 @html
4183 <hr />
4184 @end html
4185 @heading @anchor{x-x-vxworks}*-*-vxworks*
4186 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4187 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4188 We welcome patches for other architectures supported by VxWorks 5.5.
4189 Support for VxWorks AE would also be welcome; we believe this is merely
4190 a matter of writing an appropriate ``configlette'' (see below).  We are
4191 not interested in supporting older, a.out or COFF-based, versions of
4192 VxWorks in GCC 3.
4193
4194 VxWorks comes with an older version of GCC installed in
4195 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4196 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4197 Before running @command{configure}, create the directories @file{@var{prefix}}
4198 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4199 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4200 include that directory while running both @command{configure} and
4201 @command{make}.
4202
4203 You must give @command{configure} the
4204 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4205 find the VxWorks system headers.  Since VxWorks is a cross compilation
4206 target only, you must also specify @option{--target=@var{target}}.
4207 @command{configure} will attempt to create the directory
4208 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4209 make sure the user running @command{configure} has sufficient privilege
4210 to do so.
4211
4212 GCC's exception handling runtime requires a special ``configlette''
4213 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4214 that file to add the module to your kernel build.  (Future versions of
4215 VxWorks will incorporate this module.)
4216
4217 @html
4218 <hr />
4219 @end html
4220 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
4221
4222 GCC supports the x86-64 architecture implemented by the AMD64 processor
4223 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4224 On GNU/Linux the default is a bi-arch compiler which is able to generate
4225 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4226
4227 @html
4228 <hr />
4229 @end html
4230 @heading @anchor{xtensa-x-elf}xtensa*-*-elf
4231
4232 This target is intended for embedded Xtensa systems using the
4233 @samp{newlib} C library.  It uses ELF but does not support shared
4234 objects.  Designed-defined instructions specified via the
4235 Tensilica Instruction Extension (TIE) language are only supported
4236 through inline assembly.
4237
4238 The Xtensa configuration information must be specified prior to
4239 building GCC@.  The @file{include/xtensa-config.h} header
4240 file contains the configuration information.  If you created your
4241 own Xtensa configuration with the Xtensa Processor Generator, the
4242 downloaded files include a customized copy of this header file,
4243 which you can use to replace the default header file.
4244
4245 @html
4246 <hr />
4247 @end html
4248 @heading @anchor{xtensa-x-linux}xtensa*-*-linux*
4249
4250 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4251 shared objects and the GNU C library (glibc).  It also generates
4252 position-independent code (PIC) regardless of whether the
4253 @option{-fpic} or @option{-fPIC} options are used.  In other
4254 respects, this target is the same as the
4255 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4256
4257 @html
4258 <hr />
4259 @end html
4260 @heading @anchor{windows}Microsoft Windows
4261
4262 @subheading Intel 16-bit versions
4263 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not 
4264 supported.
4265
4266 However, the 32-bit port has limited support for Microsoft 
4267 Windows 3.11 in the Win32s environment, as a target only.  See below.
4268
4269 @subheading Intel 32-bit versions
4270
4271 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows 
4272 XP, and Windows Vista, are supported by several different target 
4273 platforms.  These targets differ in which Windows subsystem they target 
4274 and which C libraries are used.
4275
4276 @itemize
4277 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space 
4278 Linux API emulation layer in the Win32 subsystem.
4279 @item Interix @uref{#x-x-interix,,*-*-interix}: The Interix subsystem 
4280 provides native support for POSIX.
4281 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for 
4282 the Win32 subsystem that provides a subset of POSIX.
4283 @item MKS i386-pc-mks: NuTCracker from MKS.  See 
4284 @uref{http://www.mkssoftware.com/} for more information.