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