* doc/install.texi (Options specification): Document --with-specs.
[official-gcc.git] / gcc / doc / install.texi
blob7ebcd924b3e3937b6d591c2ce951cc8eb9ab3f30
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/}.
153 This document describes the generic installation procedure for GCC as well
154 as detailing some target specific installation instructions.
156 GCC includes several components that previously were separate distributions
157 with their own installation instructions.  This document supersedes all
158 package specific installation instructions.
160 @emph{Before} starting the build/install procedure please check the
161 @ifnothtml
162 @ref{Specific, host/target specific installation notes}.
163 @end ifnothtml
164 @ifhtml
165 @uref{specific.html,,host/target specific installation notes}.
166 @end ifhtml
167 We recommend you browse the entire generic installation instructions before
168 you proceed.
170 Lists of successful builds for released versions of GCC are
171 available at @uref{http://gcc.gnu.org/buildstat.html}.
172 These lists are updated as new information becomes available.
174 The installation procedure itself is broken into five steps.
176 @ifinfo
177 @menu
178 * Prerequisites::
179 * Downloading the source::
180 * Configuration::
181 * Building::
182 * Testing:: (optional)
183 * Final install::
184 @end menu
185 @end ifinfo
186 @ifhtml
187 @enumerate
188 @item
189 @uref{prerequisites.html,,Prerequisites}
190 @item
191 @uref{download.html,,Downloading the source}
192 @item
193 @uref{configure.html,,Configuration}
194 @item
195 @uref{build.html,,Building}
196 @item
197 @uref{test.html,,Testing} (optional)
198 @item
199 @uref{finalinstall.html,,Final install}
200 @end enumerate
201 @end ifhtml
203 Please note that GCC does not support @samp{make uninstall} and probably
204 won't do so in the near future as this would open a can of worms.  Instead,
205 we suggest that you install GCC into a directory of its own and simply
206 remove that directory when you do not need that specific version of GCC
207 any longer, and, if shared libraries are installed there as well, no
208 more binaries exist that use them.
210 @ifhtml
211 There are also some @uref{old.html,,old installation instructions},
212 which are mostly obsolete but still contain some information which has
213 not yet been merged into the main part of this manual.
214 @end ifhtml
216 @html
217 <hr />
219 @end html
220 @ifhtml
221 @uref{./index.html,,Return to the GCC Installation page}
223 @insertcopying
224 @end ifhtml
225 @end ifset
227 @c ***Prerequisites**************************************************
228 @ifnothtml
229 @comment node-name,     next,          previous, up
230 @node    Prerequisites, Downloading the source, , Installing GCC
231 @end ifnothtml
232 @ifset prerequisiteshtml
233 @ifnothtml
234 @chapter Prerequisites
235 @end ifnothtml
236 @cindex Prerequisites
238 GCC requires that various tools and packages be available for use in the
239 build procedure.  Modifying GCC sources requires additional tools
240 described below.
242 @heading Tools/packages necessary for building GCC
243 @table @asis
244 @item ISO C90 compiler
245 Necessary to bootstrap GCC, although versions of GCC prior
246 to 3.4 also allow bootstrapping with a traditional (K&R) C compiler.
248 To build all languages in a cross-compiler or other configuration where
249 3-stage bootstrap is not performed, you need to start with an existing
250 GCC binary (version 2.95 or later) because source code for language
251 frontends other than C might use GCC extensions.
253 @item GNAT
255 In order to build the Ada compiler (GNAT) you must already have GNAT
256 installed because portions of the Ada frontend are written in Ada (with
257 GNAT extensions.)  Refer to the Ada installation instructions for more
258 specific information.
260 @item A ``working'' POSIX compatible shell, or GNU bash
262 Necessary when running @command{configure} because some
263 @command{/bin/sh} shells have bugs and may crash when configuring the
264 target libraries.  In other cases, @command{/bin/sh} or @command{ksh}
265 have disastrous corner-case performance problems.  This
266 can cause target @command{configure} runs to literally take days to
267 complete in some cases.
269 So on some platforms @command{/bin/ksh} is sufficient, on others it
270 isn't.  See the host/target specific instructions for your platform, or
271 use @command{bash} to be sure.  Then set @env{CONFIG_SHELL} in your
272 environment to your ``good'' shell prior to running
273 @command{configure}/@command{make}.
275 @command{zsh} is not a fully compliant POSIX shell and will not
276 work when configuring GCC@.
278 @item A POSIX or SVR4 awk
280 Necessary for creating some of the generated source files for GCC@.
281 If in doubt, use a recent GNU awk version, as some of the older ones
282 are broken.  GNU awk version 3.1.5 is known to work.
284 @item GNU binutils
286 Necessary in some circumstances, optional in others.  See the
287 host/target specific instructions for your platform for the exact
288 requirements.
290 @item gzip version 1.2.4 (or later) or
291 @itemx bzip2 version 1.0.2 (or later)
293 Necessary to uncompress GCC @command{tar} files when source code is
294 obtained via FTP mirror sites.
296 @item GNU make version 3.80 (or later)
298 You must have GNU make installed to build GCC@.
300 @item GNU tar version 1.14 (or later)
302 Necessary (only on some platforms) to untar the source code.  Many
303 systems' @command{tar} programs will also work, only try GNU
304 @command{tar} if you have problems.
306 @item Perl version 5.6.1 (or later)
308 Necessary when targetting Darwin, building @samp{libstdc++},
309 and not using @option{--disable-symvers}.
310 Necessary when targetting Solaris 2 with Sun @command{ld} and not using
311 @option{--disable-symvers}.  The bundled @command{perl} in Solaris@tie{}8
312 and up works.
314 Necessary when regenerating @file{Makefile} dependencies in libiberty.
315 Necessary when regenerating @file{libiberty/functions.texi}.
316 Necessary when generating manpages from Texinfo manuals.
317 Used by various scripts to generate some files included in SVN (mainly
318 Unicode-related and rarely changing) from source tables.
320 @item @command{jar}, or InfoZIP (@command{zip} and @command{unzip})
322 Necessary to build libgcj, the GCJ runtime.
324 @end table
326 Several support libraries are necessary to build GCC, some are required,
327 others optional.  While any sufficiently new version of required tools
328 usually work, library requirements are generally stricter.  Newer
329 versions may work in some cases, but it's safer to use the exact
330 versions documented.  We appreciate bug reports about problems with
331 newer versions, though.
333 @table @asis
334 @item GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
336 Necessary to build GCC@.  If you do not have it installed in your
337 library search path, you will have to configure with the
338 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
339 and @option{--with-gmp-include}.  Alternatively, if a GMP source
340 distribution is found in a subdirectory of your GCC sources named
341 @file{gmp}, it will be built together with GCC@.
343 @item MPFR Library version 2.4.2 (or later)
345 Necessary to build GCC@.  It can be downloaded from
346 @uref{http://www.mpfr.org/}.  The @option{--with-mpfr} configure
347 option should be used if your MPFR Library is not installed in your
348 default library search path.  See also @option{--with-mpfr-lib} and
349 @option{--with-mpfr-include}.  Alternatively, if a MPFR source
350 distribution is found in a subdirectory of your GCC sources named
351 @file{mpfr}, it will be built together with GCC@.
353 @item MPC Library version 0.8.1 (or later)
355 Necessary to build GCC@.  It can be downloaded from
356 @uref{http://www.multiprecision.org/}.  The @option{--with-mpc}
357 configure option should be used if your MPC Library is not installed
358 in your default library search path.  See also @option{--with-mpc-lib}
359 and @option{--with-mpc-include}.  Alternatively, if an MPC source
360 distribution is found in a subdirectory of your GCC sources named
361 @file{mpc}, it will be built together with GCC@.
363 @item Parma Polyhedra Library (PPL) version 0.11
365 Necessary to build GCC with the Graphite loop optimizations.
366 It can be downloaded from @uref{http://www.cs.unipr.it/ppl/Download/}.
368 The @option{--with-ppl} configure option should be used if PPL is not
369 installed in your default library search path.
371 @item CLooG-PPL version 0.15 or CLooG 0.16
373 Necessary to build GCC with the Graphite loop optimizations.  There
374 are two versions available.  CLooG-PPL 0.15 as well as CLooG 0.16.
375 The former is the default right now.  It can be downloaded from
376 @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/} as
377 @file{cloog-ppl-0.15.tar.gz}.
379 CLooG 0.16 support is still in testing stage, but will be the
380 default in future GCC releases.  It is also available at
381 @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/} as
382 @file{cloog-0.16.1.tar.gz}.  To use it add the additional configure
383 option @option{--enable-cloog-backend=isl}.  Even if CLooG 0.16
384 does not use PPL, PPL is still required for Graphite.
386 In both cases @option{--with-cloog} configure option should be used
387 if CLooG is not installed in your default library search path.
389 @end table
391 @heading Tools/packages necessary for modifying GCC
392 @table @asis
393 @item autoconf version 2.64
394 @itemx GNU m4 version 1.4.6 (or later)
396 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
397 to regenerate @file{configure} and @file{config.in} files.
399 @item automake version 1.11.1
401 Necessary when modifying a @file{Makefile.am} file to regenerate its
402 associated @file{Makefile.in}.
404 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
405 file.  Specifically this applies to the @file{gcc}, @file{intl},
406 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
407 as any of their subdirectories.
409 For directories that use automake, GCC requires the latest release in
410 the 1.11 series, which is currently 1.11.1.  When regenerating a directory
411 to a newer version, please update all the directories using an older 1.11
412 to the latest released version.
414 @item gettext version 0.14.5 (or later)
416 Needed to regenerate @file{gcc.pot}.
418 @item gperf version 2.7.2 (or later)
420 Necessary when modifying @command{gperf} input files, e.g.@:
421 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
422 @file{gcc/cp/cfns.h}.
424 @item DejaGnu 1.4.4
425 @itemx Expect
426 @itemx Tcl
428 Necessary to run the GCC testsuite; see the section on testing for details.
430 @item autogen version 5.5.4 (or later) and
431 @itemx guile version 1.4.1 (or later)
433 Necessary to regenerate @file{fixinc/fixincl.x} from
434 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
436 Necessary to run @samp{make check} for @file{fixinc}.
438 Necessary to regenerate the top level @file{Makefile.in} file from
439 @file{Makefile.tpl} and @file{Makefile.def}.
441 @item Flex version 2.5.4 (or later)
443 Necessary when modifying @file{*.l} files.
445 Necessary to build GCC during development because the generated output
446 files are not included in the SVN repository.  They are included in
447 releases.
449 @item Texinfo version 4.7 (or later)
451 Necessary for running @command{makeinfo} when modifying @file{*.texi}
452 files to test your changes.
454 Necessary for running @command{make dvi} or @command{make pdf} to
455 create printable documentation in DVI or PDF format.  Texinfo version
456 4.8 or later is required for @command{make pdf}.
458 Necessary to build GCC documentation during development because the
459 generated output files are not included in the SVN repository.  They are
460 included in releases.
462 @item @TeX{} (any working version)
464 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
465 are used when running @command{make dvi} or @command{make pdf} to create
466 DVI or PDF files, respectively.
468 @item SVN (any version)
469 @itemx SSH (any version)
471 Necessary to access the SVN repository.  Public releases and weekly
472 snapshots of the development sources are also available via FTP@.
474 @item GNU diffutils version 2.7 (or later)
476 Useful when submitting patches for the GCC source code.
478 @item patch version 2.5.4 (or later)
480 Necessary when applying patches, created with @command{diff}, to one's
481 own sources.
483 @item ecj1
484 @itemx gjavah
486 If you wish to modify @file{.java} files in libjava, you will need to
487 configure with @option{--enable-java-maintainer-mode}, and you will need
488 to have executables named @command{ecj1} and @command{gjavah} in your path.
489 The @command{ecj1} executable should run the Eclipse Java compiler via
490 the GCC-specific entry point.  You can download a suitable jar from
491 @uref{ftp://sourceware.org/pub/java/}, or by running the script
492 @command{contrib/download_ecj}.
494 @item antlr.jar version 2.7.1 (or later)
495 @itemx antlr binary
497 If you wish to build the @command{gjdoc} binary in libjava, you will
498 need to have an @file{antlr.jar} library available. The library is
499 searched in system locations but can be configured with
500 @option{--with-antlr-jar=} instead.  When configuring with
501 @option{--enable-java-maintainer-mode}, you will need to have one of
502 the executables named @command{cantlr}, @command{runantlr} or
503 @command{antlr} in your path.
505 @end table
507 @html
508 <hr />
510 @end html
511 @ifhtml
512 @uref{./index.html,,Return to the GCC Installation page}
513 @end ifhtml
514 @end ifset
516 @c ***Downloading the source**************************************************
517 @ifnothtml
518 @comment node-name,     next,          previous, up
519 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
520 @end ifnothtml
521 @ifset downloadhtml
522 @ifnothtml
523 @chapter Downloading GCC
524 @end ifnothtml
525 @cindex Downloading GCC
526 @cindex Downloading the Source
528 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
529 tarballs compressed with @command{gzip} or
530 @command{bzip2}.  It is possible to download a full distribution or specific
531 components.
533 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
534 for information on how to obtain GCC@.
536 The full distribution includes the C, C++, Objective-C, Fortran, Java,
537 and Ada (in the case of GCC 3.1 and later) compilers.  The full
538 distribution also includes runtime libraries for C++, Objective-C,
539 Fortran, and Java.  In GCC 3.0 and later versions, the GNU compiler
540 testsuites are also included in the full distribution.
542 If you choose to download specific components, you must download the core
543 GCC distribution plus any language specific distributions you wish to
544 use.  The core distribution includes the C language front end as well as the
545 shared components.  Each language has a tarball which includes the language
546 front end as well as the language runtime (when appropriate).
548 Unpack the core distribution as well as any language specific
549 distributions in the same directory.
551 If you also intend to build binutils (either to upgrade an existing
552 installation or for use in place of the corresponding tools of your
553 OS), unpack the binutils distribution either in the same directory or
554 a separate one.  In the latter case, add symbolic links to any
555 components of the binutils you intend to build alongside the compiler
556 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
557 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
559 Likewise the GMP, MPFR and MPC libraries can be automatically built
560 together with GCC.  Unpack the GMP, MPFR and/or MPC source
561 distributions in the directory containing the GCC sources and rename
562 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
563 respectively (or use symbolic links with the same name).
565 @html
566 <hr />
568 @end html
569 @ifhtml
570 @uref{./index.html,,Return to the GCC Installation page}
571 @end ifhtml
572 @end ifset
574 @c ***Configuration***********************************************************
575 @ifnothtml
576 @comment node-name,     next,          previous, up
577 @node    Configuration, Building, Downloading the source, Installing GCC
578 @end ifnothtml
579 @ifset configurehtml
580 @ifnothtml
581 @chapter Installing GCC: Configuration
582 @end ifnothtml
583 @cindex Configuration
584 @cindex Installing GCC: Configuration
586 Like most GNU software, GCC must be configured before it can be built.
587 This document describes the recommended configuration procedure
588 for both native and cross targets.
590 We use @var{srcdir} to refer to the toplevel source directory for
591 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
593 If you obtained the sources via SVN, @var{srcdir} must refer to the top
594 @file{gcc} directory, the one where the @file{MAINTAINERS} file can be
595 found, and not its @file{gcc} subdirectory, otherwise the build will fail.
597 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
598 file system, the shell's built-in @command{pwd} command will return
599 temporary pathnames.  Using these can lead to various sorts of build
600 problems.  To avoid this issue, set the @env{PWDCMD} environment
601 variable to an automounter-aware @command{pwd} command, e.g.,
602 @command{pawd} or @samp{amq -w}, during the configuration and build
603 phases.
605 First, we @strong{highly} recommend that GCC be built into a
606 separate directory from the sources which does @strong{not} reside
607 within the source tree.  This is how we generally build GCC; building
608 where @var{srcdir} == @var{objdir} should still work, but doesn't
609 get extensive testing; building where @var{objdir} is a subdirectory
610 of @var{srcdir} is unsupported.
612 If you have previously built GCC in the same directory for a
613 different target machine, do @samp{make distclean} to delete all files
614 that might be invalid.  One of the files this deletes is @file{Makefile};
615 if @samp{make distclean} complains that @file{Makefile} does not exist
616 or issues a message like ``don't know how to make distclean'' it probably
617 means that the directory is already suitably clean.  However, with the
618 recommended method of building in a separate @var{objdir}, you should
619 simply use a different @var{objdir} for each target.
621 Second, when configuring a native system, either @command{cc} or
622 @command{gcc} must be in your path or you must set @env{CC} in
623 your environment before running configure.  Otherwise the configuration
624 scripts may fail.
626 @ignore
627 Note that the bootstrap compiler and the resulting GCC must be link
628 compatible, else the bootstrap will fail with linker errors about
629 incompatible object file formats.  Several multilibed targets are
630 affected by this requirement, see
631 @ifnothtml
632 @ref{Specific, host/target specific installation notes}.
633 @end ifnothtml
634 @ifhtml
635 @uref{specific.html,,host/target specific installation notes}.
636 @end ifhtml
637 @end ignore
639 To configure GCC:
641 @smallexample
642 % mkdir @var{objdir}
643 % cd @var{objdir}
644 % @var{srcdir}/configure [@var{options}] [@var{target}]
645 @end smallexample
647 @heading Distributor options
649 If you will be distributing binary versions of GCC, with modifications
650 to the source code, you should use the options described in this
651 section to make clear that your version contains modifications.
653 @table @code
654 @item --with-pkgversion=@var{version}
655 Specify a string that identifies your package.  You may wish
656 to include a build number or build date.  This version string will be
657 included in the output of @command{gcc --version}.  This suffix does
658 not replace the default version string, only the @samp{GCC} part.
660 The default value is @samp{GCC}.
662 @item --with-bugurl=@var{url}
663 Specify the URL that users should visit if they wish to report a bug.
664 You are of course welcome to forward bugs reported to you to the FSF,
665 if you determine that they are not bugs in your modifications.
667 The default value refers to the FSF's GCC bug tracker.
669 @end table
671 @heading Target specification
672 @itemize @bullet
673 @item
674 GCC has code to correctly determine the correct value for @var{target}
675 for nearly all native systems.  Therefore, we highly recommend you do
676 not provide a configure target when configuring a native compiler.
678 @item
679 @var{target} must be specified as @option{--target=@var{target}}
680 when configuring a cross compiler; examples of valid targets would be
681 m68k-elf, sh-elf, etc.
683 @item
684 Specifying just @var{target} instead of @option{--target=@var{target}}
685 implies that the host defaults to @var{target}.
686 @end itemize
689 @heading Options specification
691 Use @var{options} to override several configure time options for
692 GCC@.  A list of supported @var{options} follows; @samp{configure
693 --help} may list other options, but those not listed below may not
694 work and should not normally be used.
696 Note that each @option{--enable} option has a corresponding
697 @option{--disable} option and that each @option{--with} option has a
698 corresponding @option{--without} option.
700 @table @code
701 @item --prefix=@var{dirname}
702 Specify the toplevel installation
703 directory.  This is the recommended way to install the tools into a directory
704 other than the default.  The toplevel installation directory defaults to
705 @file{/usr/local}.
707 We @strong{highly} recommend against @var{dirname} being the same or a
708 subdirectory of @var{objdir} or vice versa.  If specifying a directory
709 beneath a user's home directory tree, some shells will not expand
710 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
711 @env{$HOME} instead.
713 The following standard @command{autoconf} options are supported.  Normally you
714 should not need to use these options.
715 @table @code
716 @item --exec-prefix=@var{dirname}
717 Specify the toplevel installation directory for architecture-dependent
718 files.  The default is @file{@var{prefix}}.
720 @item --bindir=@var{dirname}
721 Specify the installation directory for the executables called by users
722 (such as @command{gcc} and @command{g++}).  The default is
723 @file{@var{exec-prefix}/bin}.
725 @item --libdir=@var{dirname}
726 Specify the installation directory for object code libraries and
727 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
729 @item --libexecdir=@var{dirname}
730 Specify the installation directory for internal executables of GCC@.
731 The default is @file{@var{exec-prefix}/libexec}.
733 @item --with-slibdir=@var{dirname}
734 Specify the installation directory for the shared libgcc library.  The
735 default is @file{@var{libdir}}.
737 @item --datarootdir=@var{dirname}
738 Specify the root of the directory tree for read-only architecture-independent
739 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
741 @item --infodir=@var{dirname}
742 Specify the installation directory for documentation in info format.
743 The default is @file{@var{datarootdir}/info}.
745 @item --datadir=@var{dirname}
746 Specify the installation directory for some architecture-independent
747 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
749 @item --docdir=@var{dirname}
750 Specify the installation directory for documentation files (other
751 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
753 @item --htmldir=@var{dirname}
754 Specify the installation directory for HTML documentation files.
755 The default is @file{@var{docdir}}.
757 @item --pdfdir=@var{dirname}
758 Specify the installation directory for PDF documentation files.
759 The default is @file{@var{docdir}}.
761 @item --mandir=@var{dirname}
762 Specify the installation directory for manual pages.  The default is
763 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
764 from the full GCC manuals, which are provided in Texinfo format.  The manpages
765 are derived by an automatic conversion process from parts of the full
766 manual.)
768 @item --with-gxx-include-dir=@var{dirname}
769 Specify
770 the installation directory for G++ header files.  The default depends
771 on other configuration options, and differs between cross and native
772 configurations.
774 @item --with-specs=@var{specs}
775 Specify additional command line driver SPECS.
776 This can be useful if you need to turn on a non-standard feature by
777 default without modifying the compiler's source code, for instance
778 @option{--with-specs=%@{!fcommon:%@{!fno-common:-fno-common@}@}}.
779 @ifnothtml
780 @xref{Spec Files,, Specifying subprocesses and the switches to pass to them,
781 gcc, Using the GNU Compiler Collection (GCC)},
782 @end ifnothtml
783 @ifhtml
784 See ``Spec Files'' in the main manual
785 @end ifhtml
787 @end table
789 @item --program-prefix=@var{prefix}
790 GCC supports some transformations of the names of its programs when
791 installing them.  This option prepends @var{prefix} to the names of
792 programs to install in @var{bindir} (see above).  For example, specifying
793 @option{--program-prefix=foo-} would result in @samp{gcc}
794 being installed as @file{/usr/local/bin/foo-gcc}.
796 @item --program-suffix=@var{suffix}
797 Appends @var{suffix} to the names of programs to install in @var{bindir}
798 (see above).  For example, specifying @option{--program-suffix=-3.1}
799 would result in @samp{gcc} being installed as
800 @file{/usr/local/bin/gcc-3.1}.
802 @item --program-transform-name=@var{pattern}
803 Applies the @samp{sed} script @var{pattern} to be applied to the names
804 of programs to install in @var{bindir} (see above).  @var{pattern} has to
805 consist of one or more basic @samp{sed} editing commands, separated by
806 semicolons.  For example, if you want the @samp{gcc} program name to be
807 transformed to the installed program @file{/usr/local/bin/myowngcc} and
808 the @samp{g++} program name to be transformed to
809 @file{/usr/local/bin/gspecial++} without changing other program names,
810 you could use the pattern
811 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
812 to achieve this effect.
814 All three options can be combined and used together, resulting in more
815 complex conversion patterns.  As a basic rule, @var{prefix} (and
816 @var{suffix}) are prepended (appended) before further transformations
817 can happen with a special transformation script @var{pattern}.
819 As currently implemented, this option only takes effect for native
820 builds; cross compiler binaries' names are not transformed even when a
821 transformation is explicitly asked for by one of these options.
823 For native builds, some of the installed programs are also installed
824 with the target alias in front of their name, as in
825 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
826 before the target alias is prepended to the name---so, specifying
827 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
828 resulting binary would be installed as
829 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
831 As a last shortcoming, none of the installed Ada programs are
832 transformed yet, which will be fixed in some time.
834 @item --with-local-prefix=@var{dirname}
835 Specify the
836 installation directory for local include files.  The default is
837 @file{/usr/local}.  Specify this option if you want the compiler to
838 search directory @file{@var{dirname}/include} for locally installed
839 header files @emph{instead} of @file{/usr/local/include}.
841 You should specify @option{--with-local-prefix} @strong{only} if your
842 site has a different convention (not @file{/usr/local}) for where to put
843 site-specific files.
845 The default value for @option{--with-local-prefix} is @file{/usr/local}
846 regardless of the value of @option{--prefix}.  Specifying
847 @option{--prefix} has no effect on which directory GCC searches for
848 local header files.  This may seem counterintuitive, but actually it is
849 logical.
851 The purpose of @option{--prefix} is to specify where to @emph{install
852 GCC}.  The local header files in @file{/usr/local/include}---if you put
853 any in that directory---are not part of GCC@.  They are part of other
854 programs---perhaps many others.  (GCC installs its own header files in
855 another directory which is based on the @option{--prefix} value.)
857 Both the local-prefix include directory and the GCC-prefix include
858 directory are part of GCC's ``system include'' directories.  Although these
859 two directories are not fixed, they need to be searched in the proper
860 order for the correct processing of the include_next directive.  The
861 local-prefix include directory is searched before the GCC-prefix
862 include directory.  Another characteristic of system include directories
863 is that pedantic warnings are turned off for headers in these directories.
865 Some autoconf macros add @option{-I @var{directory}} options to the
866 compiler command line, to ensure that directories containing installed
867 packages' headers are searched.  When @var{directory} is one of GCC's
868 system include directories, GCC will ignore the option so that system
869 directories continue to be processed in the correct order.  This
870 may result in a search order different from what was specified but the
871 directory will still be searched.
873 GCC automatically searches for ordinary libraries using
874 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
875 used for both GCC and packages, GCC will automatically search for
876 both headers and libraries.  This provides a configuration that is
877 easy to use.  GCC behaves in a manner similar to that when it is
878 installed as a system compiler in @file{/usr}.
880 Sites that need to install multiple versions of GCC may not want to
881 use the above simple configuration.  It is possible to use the
882 @option{--program-prefix}, @option{--program-suffix} and
883 @option{--program-transform-name} options to install multiple versions
884 into a single directory, but it may be simpler to use different prefixes
885 and the @option{--with-local-prefix} option to specify the location of the
886 site-specific files for each version.  It will then be necessary for
887 users to specify explicitly the location of local site libraries
888 (e.g., with @env{LIBRARY_PATH}).
890 The same value can be used for both @option{--with-local-prefix} and
891 @option{--prefix} provided it is not @file{/usr}.  This can be used
892 to avoid the default search of @file{/usr/local/include}.
894 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
895 The directory you use for @option{--with-local-prefix} @strong{must not}
896 contain any of the system's standard header files.  If it did contain
897 them, certain programs would be miscompiled (including GNU Emacs, on
898 certain targets), because this would override and nullify the header
899 file corrections made by the @command{fixincludes} script.
901 Indications are that people who use this option use it based on mistaken
902 ideas of what it is for.  People use it as if it specified where to
903 install part of GCC@.  Perhaps they make this assumption because
904 installing GCC creates the directory.
906 @item --enable-shared[=@var{package}[,@dots{}]]
907 Build shared versions of libraries, if shared libraries are supported on
908 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
909 are enabled by default on all platforms that support shared libraries.
911 If a list of packages is given as an argument, build shared libraries
912 only for the listed packages.  For other packages, only static libraries
913 will be built.  Package names currently recognized in the GCC tree are
914 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
915 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
916 @samp{ada}, @samp{libada}, @samp{libjava}, @samp{libgo}, and @samp{libobjc}.
917 Note @samp{libiberty} does not support shared libraries at all.
919 Use @option{--disable-shared} to build only static libraries.  Note that
920 @option{--disable-shared} does not accept a list of package names as
921 argument, only @option{--enable-shared} does.
923 @item @anchor{with-gnu-as}--with-gnu-as
924 Specify that the compiler should assume that the
925 assembler it finds is the GNU assembler.  However, this does not modify
926 the rules to find an assembler and will result in confusion if the
927 assembler found is not actually the GNU assembler.  (Confusion may also
928 result if the compiler finds the GNU assembler but has not been
929 configured with @option{--with-gnu-as}.)  If you have more than one
930 assembler installed on your system, you may want to use this option in
931 connection with @option{--with-as=@var{pathname}} or
932 @option{--with-build-time-tools=@var{pathname}}.
934 The following systems are the only ones where it makes a difference
935 whether you use the GNU assembler.  On any other system,
936 @option{--with-gnu-as} has no effect.
938 @itemize @bullet
939 @item @samp{hppa1.0-@var{any}-@var{any}}
940 @item @samp{hppa1.1-@var{any}-@var{any}}
941 @item @samp{sparc-sun-solaris2.@var{any}}
942 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
943 @end itemize
945 @item @anchor{with-as}--with-as=@var{pathname}
946 Specify that the compiler should use the assembler pointed to by
947 @var{pathname}, rather than the one found by the standard rules to find
948 an assembler, which are:
949 @itemize @bullet
950 @item
951 Unless GCC is being built with a cross compiler, check the
952 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
953 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
954 @var{exec-prefix} defaults to @var{prefix}, which
955 defaults to @file{/usr/local} unless overridden by the
956 @option{--prefix=@var{pathname}} switch described above.  @var{target}
957 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
958 @var{version} denotes the GCC version, such as 3.0.
960 @item
961 If the target system is the same that you are building on, check
962 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
963 Sun Solaris 2).
965 @item
966 Check in the @env{PATH} for a tool whose name is prefixed by the
967 target system triple.
969 @item
970 Check in the @env{PATH} for a tool whose name is not prefixed by the
971 target system triple, if the host and target system triple are
972 the same (in other words, we use a host tool if it can be used for
973 the target as well).
974 @end itemize
976 You may want to use @option{--with-as} if no assembler
977 is installed in the directories listed above, or if you have multiple
978 assemblers installed and want to choose one that is not found by the
979 above rules.
981 @item @anchor{with-gnu-ld}--with-gnu-ld
982 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
983 but for the linker.
985 @item --with-ld=@var{pathname}
986 Same as @uref{#with-as,,@option{--with-as}}
987 but for the linker.
989 @item --with-stabs
990 Specify that stabs debugging
991 information should be used instead of whatever format the host normally
992 uses.  Normally GCC uses the same debug format as the host system.
994 On MIPS based systems and on Alphas, you must specify whether you want
995 GCC to create the normal ECOFF debugging format, or to use BSD-style
996 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
997 format cannot fully handle languages other than C@.  BSD stabs format can
998 handle other languages, but it only works with the GNU debugger GDB@.
1000 Normally, GCC uses the ECOFF debugging format by default; if you
1001 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
1003 No matter which default you choose when you configure GCC, the user
1004 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
1005 the debug format for a particular compilation.
1007 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
1008 @option{--with-gas} is used.  It selects use of stabs debugging
1009 information embedded in COFF output.  This kind of debugging information
1010 supports C++ well; ordinary COFF debugging information does not.
1012 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
1013 selects use of stabs debugging information embedded in ELF output.  The
1014 C++ compiler currently (2.6.0) does not support the DWARF debugging
1015 information normally used on 386 SVR4 platforms; stabs provide a
1016 workable alternative.  This requires gas and gdb, as the normal SVR4
1017 tools can not generate or interpret stabs.
1019 @item --disable-multilib
1020 Specify that multiple target
1021 libraries to support different target variants, calling
1022 conventions, etc.@: should not be built.  The default is to build a
1023 predefined set of them.
1025 Some targets provide finer-grained control over which multilibs are built
1026 (e.g., @option{--disable-softfloat}):
1027 @table @code
1028 @item arm-*-*
1029 fpu, 26bit, underscore, interwork, biendian, nofmult.
1031 @item m68*-*-*
1032 softfloat, m68881, m68000, m68020.
1034 @item mips*-*-*
1035 single-float, biendian, softfloat.
1037 @item powerpc*-*-*, rs6000*-*-*
1038 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1039 sysv, aix.
1041 @end table
1043 @item --with-multilib-list=@var{list}
1044 @itemx --without-multilib-list
1045 Specify what multilibs to build.
1046 Currently only implemented for sh*-*-*.
1048 @var{list} is a comma separated list of CPU names.  These must be of the
1049 form @code{sh*} or @code{m*} (in which case they match the compiler option
1050 for that processor).  The list should not contain any endian options -
1051 these are handled by @option{--with-endian}.
1053 If @var{list} is empty, then there will be no multilibs for extra
1054 processors.  The multilib for the secondary endian remains enabled.
1056 As a special case, if an entry in the list starts with a @code{!}
1057 (exclamation point), then it is added to the list of excluded multilibs.
1058 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1059 (once the leading @code{!} has been stripped).
1061 If @option{--with-multilib-list} is not given, then a default set of
1062 multilibs is selected based on the value of @option{--target}.  This is
1063 usually the complete set of libraries, but some targets imply a more
1064 specialized subset.
1066 Example 1: to configure a compiler for SH4A only, but supporting both
1067 endians, with little endian being the default:
1068 @smallexample
1069 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1070 @end smallexample
1072 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1073 only little endian SH4AL:
1074 @smallexample
1075 --with-cpu=sh4a --with-endian=little,big \
1076 --with-multilib-list=sh4al,!mb/m4al
1077 @end smallexample
1079 @item --with-endian=@var{endians}
1080 Specify what endians to use.
1081 Currently only implemented for sh*-*-*.
1083 @var{endians} may be one of the following:
1084 @table @code
1085 @item big
1086 Use big endian exclusively.
1087 @item little
1088 Use little endian exclusively.
1089 @item big,little
1090 Use big endian by default.  Provide a multilib for little endian.
1091 @item little,big
1092 Use little endian by default.  Provide a multilib for big endian.
1093 @end table
1095 @item --enable-threads
1096 Specify that the target
1097 supports threads.  This affects the Objective-C compiler and runtime
1098 library, and exception handling for other languages like C++ and Java.
1099 On some systems, this is the default.
1101 In general, the best (and, in many cases, the only known) threading
1102 model available will be configured for use.  Beware that on some
1103 systems, GCC has not been taught what threading models are generally
1104 available for the system.  In this case, @option{--enable-threads} is an
1105 alias for @option{--enable-threads=single}.
1107 @item --disable-threads
1108 Specify that threading support should be disabled for the system.
1109 This is an alias for @option{--enable-threads=single}.
1111 @item --enable-threads=@var{lib}
1112 Specify that
1113 @var{lib} is the thread support library.  This affects the Objective-C
1114 compiler and runtime library, and exception handling for other languages
1115 like C++ and Java.  The possibilities for @var{lib} are:
1117 @table @code
1118 @item aix
1119 AIX thread support.
1120 @item dce
1121 DCE thread support.
1122 @item lynx
1123 LynxOS thread support.
1124 @item mipssde
1125 MIPS SDE thread support.
1126 @item nks
1127 Novell Kernel Services thread support.
1128 @item no
1129 This is an alias for @samp{single}.
1130 @item posix
1131 Generic POSIX/Unix98 thread support.
1132 @item posix95
1133 Generic POSIX/Unix95 thread support.
1134 @item rtems
1135 RTEMS thread support.
1136 @item single
1137 Disable thread support, should work for all platforms.
1138 @item tpf
1139 TPF thread support.
1140 @item vxworks
1141 VxWorks thread support.
1142 @item win32
1143 Microsoft Win32 API thread support.
1144 @end table
1146 @item --enable-tls
1147 Specify that the target supports TLS (Thread Local Storage).  Usually
1148 configure can correctly determine if TLS is supported.  In cases where
1149 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1150 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1151 the assembler supports TLS but the C library does not, or if the
1152 assumptions made by the configure test are incorrect.
1154 @item --disable-tls
1155 Specify that the target does not support TLS.
1156 This is an alias for @option{--enable-tls=no}.
1158 @item --with-cpu=@var{cpu}
1159 @itemx --with-cpu-32=@var{cpu}
1160 @itemx --with-cpu-64=@var{cpu}
1161 Specify which cpu variant the compiler should generate code for by default.
1162 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1163 This option is only supported on some targets, including ARM, i386, M68k,
1164 PowerPC, and SPARC@.  The @option{--with-cpu-32} and
1165 @option{--with-cpu-64} options specify separate default CPUs for
1166 32-bit and 64-bit modes; these options are only supported for i386,
1167 x86-64 and PowerPC.
1169 @item --with-schedule=@var{cpu}
1170 @itemx --with-arch=@var{cpu}
1171 @itemx --with-arch-32=@var{cpu}
1172 @itemx --with-arch-64=@var{cpu}
1173 @itemx --with-tune=@var{cpu}
1174 @itemx --with-tune-32=@var{cpu}
1175 @itemx --with-tune-64=@var{cpu}
1176 @itemx --with-abi=@var{abi}
1177 @itemx --with-fpu=@var{type}
1178 @itemx --with-float=@var{type}
1179 These configure options provide default values for the @option{-mschedule=},
1180 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1181 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1182 @option{--with-cpu}, which switches will be accepted and acceptable values
1183 of the arguments depend on the target.
1185 @item --with-mode=@var{mode}
1186 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1187 This option is only supported on ARM targets.
1189 @item --with-fpmath=@var{isa}
1190 This options sets @option{-mfpmath=sse} by default and specifies the default
1191 ISA for floating-point arithmetics.  You can select either @samp{sse} which
1192 enables @option{-msse2} or @samp{avx} which enables @option{-mavx} by default.
1193 This option is only supported on i386 and x86-64 targets.
1195 @item --with-divide=@var{type}
1196 Specify how the compiler should generate code for checking for
1197 division by zero.  This option is only supported on the MIPS target.
1198 The possibilities for @var{type} are:
1199 @table @code
1200 @item traps
1201 Division by zero checks use conditional traps (this is the default on
1202 systems that support conditional traps).
1203 @item breaks
1204 Division by zero checks use the break instruction.
1205 @end table
1207 @c If you make --with-llsc the default for additional targets,
1208 @c update the --with-llsc description in the MIPS section below.
1210 @item --with-llsc
1211 On MIPS targets, make @option{-mllsc} the default when no
1212 @option{-mno-lsc} option is passed.  This is the default for
1213 Linux-based targets, as the kernel will emulate them if the ISA does
1214 not provide them.
1216 @item --without-llsc
1217 On MIPS targets, make @option{-mno-llsc} the default when no
1218 @option{-mllsc} option is passed.
1220 @item --with-synci
1221 On MIPS targets, make @option{-msynci} the default when no
1222 @option{-mno-synci} option is passed.
1224 @item --without-synci
1225 On MIPS targets, make @option{-mno-synci} the default when no
1226 @option{-msynci} option is passed.  This is the default.
1228 @item --with-mips-plt
1229 On MIPS targets, make use of copy relocations and PLTs.
1230 These features are extensions to the traditional
1231 SVR4-based MIPS ABIs and require support from GNU binutils
1232 and the runtime C library.
1234 @item --enable-__cxa_atexit
1235 Define if you want to use __cxa_atexit, rather than atexit, to
1236 register C++ destructors for local statics and global objects.
1237 This is essential for fully standards-compliant handling of
1238 destructors, but requires __cxa_atexit in libc.  This option is currently
1239 only available on systems with GNU libc.  When enabled, this will cause
1240 @option{-fuse-cxa-atexit} to be passed by default.
1242 @item --enable-indirect-function
1243 Define if you want to enable the @code{ifunc} attribute.  This option is
1244 currently only available on systems with GNU libc on certain targets.
1246 @item --enable-target-optspace
1247 Specify that target
1248 libraries should be optimized for code space instead of code speed.
1249 This is the default for the m32r platform.
1251 @item --with-cpp-install-dir=@var{dirname}
1252 Specify that the user visible @command{cpp} program should be installed
1253 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1255 @item --enable-comdat
1256 Enable COMDAT group support.  This is primarily used to override the
1257 automatically detected value.
1259 @item --enable-initfini-array
1260 Force the use of sections @code{.init_array} and @code{.fini_array}
1261 (instead of @code{.init} and @code{.fini}) for constructors and
1262 destructors.  Option @option{--disable-initfini-array} has the
1263 opposite effect.  If neither option is specified, the configure script
1264 will try to guess whether the @code{.init_array} and
1265 @code{.fini_array} sections are supported and, if they are, use them.
1267 @item --enable-build-with-cxx
1268 Build GCC using a C++ compiler rather than a C compiler.  This is an
1269 experimental option which may become the default in a later release.
1271 @item --enable-maintainer-mode
1272 The build rules that regenerate the Autoconf and Automake output files as
1273 well as the GCC master message catalog @file{gcc.pot} are normally
1274 disabled.  This is because it can only be rebuilt if the complete source
1275 tree is present.  If you have changed the sources and want to rebuild the
1276 catalog, configuring with @option{--enable-maintainer-mode} will enable
1277 this.  Note that you need a recent version of the @code{gettext} tools
1278 to do so.
1280 @item --disable-bootstrap
1281 For a native build, the default configuration is to perform
1282 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1283 testing that GCC can compile itself correctly.  If you want to disable
1284 this process, you can configure with @option{--disable-bootstrap}.
1286 @item --enable-bootstrap
1287 In special cases, you may want to perform a 3-stage build
1288 even if the target and host triplets are different.
1289 This is possible when the host can run code compiled for
1290 the target (e.g.@: host is i686-linux, target is i486-linux).
1291 Starting from GCC 4.2, to do this you have to configure explicitly
1292 with @option{--enable-bootstrap}.
1294 @item --enable-generated-files-in-srcdir
1295 Neither the .c and .h files that are generated from Bison and flex nor the
1296 info manuals and man pages that are built from the .texi files are present
1297 in the SVN development tree.  When building GCC from that development tree,
1298 or from one of our snapshots, those generated files are placed in your
1299 build directory, which allows for the source to be in a readonly
1300 directory.
1302 If you configure with @option{--enable-generated-files-in-srcdir} then those
1303 generated files will go into the source directory.  This is mainly intended
1304 for generating release or prerelease tarballs of the GCC sources, since it
1305 is not a requirement that the users of source releases to have flex, Bison,
1306 or makeinfo.
1308 @item --enable-version-specific-runtime-libs
1309 Specify
1310 that runtime libraries should be installed in the compiler specific
1311 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1312 addition, @samp{libstdc++}'s include files will be installed into
1313 @file{@var{libdir}} unless you overruled it by using
1314 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1315 particularly useful if you intend to use several versions of GCC in
1316 parallel.  This is currently supported by @samp{libgfortran},
1317 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1319 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1320 Specify that only a particular subset of compilers and
1321 their runtime libraries should be built.  For a list of valid values for
1322 @var{langN} you can issue the following command in the
1323 @file{gcc} directory of your GCC source tree:@*
1324 @smallexample
1325 grep language= */config-lang.in
1326 @end smallexample
1327 Currently, you can use any of the following:
1328 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran},
1329 @code{go}, @code{java}, @code{objc}, @code{obj-c++}.
1330 Building the Ada compiler has special requirements, see below.
1331 If you do not pass this flag, or specify the option @code{all}, then all
1332 default languages available in the @file{gcc} sub-tree will be configured.
1333 Ada, Go and Objective-C++ are not default languages; the rest are.
1335 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1336 Specify that a particular subset of compilers and their runtime
1337 libraries should be built with the system C compiler during stage 1 of
1338 the bootstrap process, rather than only in later stages with the
1339 bootstrapped C compiler.  The list of valid values is the same as for
1340 @option{--enable-languages}, and the option @code{all} will select all
1341 of the languages enabled by @option{--enable-languages}.  This option is
1342 primarily useful for GCC development; for instance, when a development
1343 version of the compiler cannot bootstrap due to compiler bugs, or when
1344 one is debugging front ends other than the C front end.  When this
1345 option is used, one can then build the target libraries for the
1346 specified languages with the stage-1 compiler by using @command{make
1347 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1348 for the specified languages using @command{make stage1-start check-gcc}.
1350 @item --disable-libada
1351 Specify that the run-time libraries and tools used by GNAT should not
1352 be built.  This can be useful for debugging, or for compatibility with
1353 previous Ada build procedures, when it was required to explicitly
1354 do a @samp{make -C gcc gnatlib_and_tools}.
1356 @item --disable-libssp
1357 Specify that the run-time libraries for stack smashing protection
1358 should not be built.
1360 @item --disable-libquadmath
1361 Specify that the GCC quad-precision math library should not be built.
1362 On some systems, the library is required to be linkable when building
1363 the Fortran front end, unless @option{--disable-libquadmath-support}
1364 is used.
1366 @item --disable-libquadmath-support
1367 Specify that the Fortran front end and @code{libgfortran} do not add
1368 support for @code{libquadmath} on systems supporting it.
1370 @item --disable-libgomp
1371 Specify that the run-time libraries used by GOMP should not be built.
1373 @item --with-dwarf2
1374 Specify that the compiler should
1375 use DWARF 2 debugging information as the default.
1377 @item --enable-targets=all
1378 @itemx --enable-targets=@var{target_list}
1379 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1380 These are compilers that are able to generate either 64-bit or 32-bit
1381 code.  Typically, the corresponding 32-bit target, e.g.@:
1382 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1383 option enables the 32-bit target to be a bi-arch compiler, which is
1384 useful when you want a bi-arch compiler that defaults to 32-bit, and
1385 you are building a bi-arch or multi-arch binutils in a combined tree.
1386 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1387 defaulted to o32.
1388 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux
1389 and mips-linux.
1391 @item --enable-secureplt
1392 This option enables @option{-msecure-plt} by default for powerpc-linux.
1393 @ifnothtml
1394 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1395 Using the GNU Compiler Collection (GCC)},
1396 @end ifnothtml
1397 @ifhtml
1398 See ``RS/6000 and PowerPC Options'' in the main manual
1399 @end ifhtml
1401 @item --enable-cld
1402 This option enables @option{-mcld} by default for 32-bit x86 targets.
1403 @ifnothtml
1404 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1405 Using the GNU Compiler Collection (GCC)},
1406 @end ifnothtml
1407 @ifhtml
1408 See ``i386 and x86-64 Options'' in the main manual
1409 @end ifhtml
1411 @item --enable-win32-registry
1412 @itemx --enable-win32-registry=@var{key}
1413 @itemx --disable-win32-registry
1414 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1415 to look up installations paths in the registry using the following key:
1417 @smallexample
1418 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1419 @end smallexample
1421 @var{key} defaults to GCC version number, and can be overridden by the
1422 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1423 who use custom installers are encouraged to provide a different key,
1424 perhaps one comprised of vendor name and GCC version number, to
1425 avoid conflict with existing installations.  This feature is enabled
1426 by default, and can be disabled by @option{--disable-win32-registry}
1427 option.  This option has no effect on the other hosts.
1429 @item --nfp
1430 Specify that the machine does not have a floating point unit.  This
1431 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1432 system, @option{--nfp} has no effect.
1434 @item --enable-werror
1435 @itemx --disable-werror
1436 @itemx --enable-werror=yes
1437 @itemx --enable-werror=no
1438 When you specify this option, it controls whether certain files in the
1439 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1440 If you don't specify it, @option{-Werror} is turned on for the main
1441 development trunk.  However it defaults to off for release branches and
1442 final releases.  The specific files which get @option{-Werror} are
1443 controlled by the Makefiles.
1445 @item --enable-checking
1446 @itemx --enable-checking=@var{list}
1447 When you specify this option, the compiler is built to perform internal
1448 consistency checks of the requested complexity.  This does not change the
1449 generated code, but adds error checking within the compiler.  This will
1450 slow down the compiler and may only work properly if you are building
1451 the compiler with GCC@.  This is @samp{yes} by default when building
1452 from SVN or snapshots, but @samp{release} for releases.  The default
1453 for building the stage1 compiler is @samp{yes}.  More control
1454 over the checks may be had by specifying @var{list}.  The categories of
1455 checks available are @samp{yes} (most common checks
1456 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1457 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1458 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1459 Individual checks can be enabled with these flags @samp{assert},
1460 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1461 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1463 The @samp{valgrind} check requires the external @command{valgrind}
1464 simulator, available from @uref{http://valgrind.org/}.  The
1465 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1466 To disable all checking, @samp{--disable-checking} or
1467 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1468 assertions will make the compiler and runtime slightly faster but
1469 increase the risk of undetected internal errors causing wrong code to be
1470 generated.
1472 @item --disable-stage1-checking
1473 @itemx --enable-stage1-checking
1474 @itemx --enable-stage1-checking=@var{list}
1475 If no @option{--enable-checking} option is specified the stage1
1476 compiler will be built with @samp{yes} checking enabled, otherwise
1477 the stage1 checking flags are the same as specified by
1478 @option{--enable-checking}.  To build the stage1 compiler with
1479 different checking options use @option{--enable-stage1-checking}.
1480 The list of checking options is the same as for @option{--enable-checking}.
1481 If your system is too slow or too small to bootstrap a released compiler
1482 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1483 to disable checking for the stage1 compiler.
1485 @item --enable-coverage
1486 @itemx --enable-coverage=@var{level}
1487 With this option, the compiler is built to collect self coverage
1488 information, every time it is run.  This is for internal development
1489 purposes, and only works when the compiler is being built with gcc.  The
1490 @var{level} argument controls whether the compiler is built optimized or
1491 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1492 want to disable optimization, for performance analysis you want to
1493 enable optimization.  When coverage is enabled, the default level is
1494 without optimization.
1496 @item --enable-gather-detailed-mem-stats
1497 When this option is specified more detailed information on memory
1498 allocation is gathered.  This information is printed when using
1499 @option{-fmem-report}.
1501 @item --with-gc
1502 @itemx --with-gc=@var{choice}
1503 With this option you can specify the garbage collector implementation
1504 used during the compilation process.  @var{choice} can be one of
1505 @samp{page} and @samp{zone}, where @samp{page} is the default.
1507 @item --enable-nls
1508 @itemx --disable-nls
1509 The @option{--enable-nls} option enables Native Language Support (NLS),
1510 which lets GCC output diagnostics in languages other than American
1511 English.  Native Language Support is enabled by default if not doing a
1512 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1514 @item --with-included-gettext
1515 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1516 procedure to prefer its copy of GNU @command{gettext}.
1518 @item --with-catgets
1519 If NLS is enabled, and if the host lacks @code{gettext} but has the
1520 inferior @code{catgets} interface, the GCC build procedure normally
1521 ignores @code{catgets} and instead uses GCC's copy of the GNU
1522 @code{gettext} library.  The @option{--with-catgets} option causes the
1523 build procedure to use the host's @code{catgets} in this situation.
1525 @item --with-libiconv-prefix=@var{dir}
1526 Search for libiconv header files in @file{@var{dir}/include} and
1527 libiconv library files in @file{@var{dir}/lib}.
1529 @item --enable-obsolete
1530 Enable configuration for an obsoleted system.  If you attempt to
1531 configure GCC for a system (build, host, or target) which has been
1532 obsoleted, and you do not specify this flag, configure will halt with an
1533 error message.
1535 All support for systems which have been obsoleted in one release of GCC
1536 is removed entirely in the next major release, unless someone steps
1537 forward to maintain the port.
1539 @item --enable-decimal-float
1540 @itemx --enable-decimal-float=yes
1541 @itemx --enable-decimal-float=no
1542 @itemx --enable-decimal-float=bid
1543 @itemx --enable-decimal-float=dpd
1544 @itemx --disable-decimal-float
1545 Enable (or disable) support for the C decimal floating point extension
1546 that is in the IEEE 754-2008 standard.  This is enabled by default only
1547 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1548 support it, but require the user to specifically enable it.  You can
1549 optionally control which decimal floating point format is used (either
1550 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1551 format is default on i386 and x86_64 systems, and the @samp{dpd}
1552 (densely packed decimal) format is default on PowerPC systems.
1554 @item --enable-fixed-point
1555 @itemx --disable-fixed-point
1556 Enable (or disable) support for C fixed-point arithmetic.
1557 This option is enabled by default for some targets (such as MIPS) which
1558 have hardware-support for fixed-point operations.  On other targets, you
1559 may enable this option manually.
1561 @item --with-long-double-128
1562 Specify if @code{long double} type should be 128-bit by default on selected
1563 GNU/Linux architectures.  If using @code{--without-long-double-128},
1564 @code{long double} will be by default 64-bit, the same as @code{double} type.
1565 When neither of these configure options are used, the default will be
1566 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1567 64-bit @code{long double} otherwise.
1569 @item --with-gmp=@var{pathname}
1570 @itemx --with-gmp-include=@var{pathname}
1571 @itemx --with-gmp-lib=@var{pathname}
1572 @itemx --with-mpfr=@var{pathname}
1573 @itemx --with-mpfr-include=@var{pathname}
1574 @itemx --with-mpfr-lib=@var{pathname}
1575 @itemx --with-mpc=@var{pathname}
1576 @itemx --with-mpc-include=@var{pathname}
1577 @itemx --with-mpc-lib=@var{pathname}
1578 If you do not have GMP (the GNU Multiple Precision library), the MPFR
1579 library and/or the MPC library installed in a standard location and
1580 you want to build GCC, you can explicitly specify the directory where
1581 they are installed (@samp{--with-gmp=@var{gmpinstalldir}},
1582 @samp{--with-mpfr=@/@var{mpfrinstalldir}},
1583 @samp{--with-mpc=@/@var{mpcinstalldir}}).  The
1584 @option{--with-gmp=@/@var{gmpinstalldir}} option is shorthand for
1585 @option{--with-gmp-lib=@/@var{gmpinstalldir}/lib} and
1586 @option{--with-gmp-include=@/@var{gmpinstalldir}/include}.  Likewise the
1587 @option{--with-mpfr=@/@var{mpfrinstalldir}} option is shorthand for
1588 @option{--with-mpfr-lib=@/@var{mpfrinstalldir}/lib} and
1589 @option{--with-mpfr-include=@/@var{mpfrinstalldir}/include}, also the
1590 @option{--with-mpc=@/@var{mpcinstalldir}} option is shorthand for
1591 @option{--with-mpc-lib=@/@var{mpcinstalldir}/lib} and
1592 @option{--with-mpc-include=@/@var{mpcinstalldir}/include}.  If these
1593 shorthand assumptions are not correct, you can use the explicit
1594 include and lib options directly.  You might also need to ensure the
1595 shared libraries can be found by the dynamic linker when building and
1596 using GCC, for example by setting the runtime shared library path
1597 variable (@env{LD_LIBRARY_PATH} on GNU/Linux and Solaris systems).
1599 These flags are applicable to the host platform only.  When building
1600 a cross compiler, they will not be used to configure target libraries.
1602 @item --with-ppl=@var{pathname}
1603 @itemx --with-ppl-include=@var{pathname}
1604 @itemx --with-ppl-lib=@var{pathname}
1605 @itemx --with-cloog=@var{pathname}
1606 @itemx --with-cloog-include=@var{pathname}
1607 @itemx --with-cloog-lib=@var{pathname}
1608 If you do not have PPL (the Parma Polyhedra Library) and the CLooG
1609 libraries installed in a standard location and you want to build GCC,
1610 you can explicitly specify the directory where they are installed
1611 (@samp{--with-ppl=@/@var{pplinstalldir}},
1612 @samp{--with-cloog=@/@var{clooginstalldir}}). The
1613 @option{--with-ppl=@/@var{pplinstalldir}} option is shorthand for
1614 @option{--with-ppl-lib=@/@var{pplinstalldir}/lib} and
1615 @option{--with-ppl-include=@/@var{pplinstalldir}/include}.  Likewise the
1616 @option{--with-cloog=@/@var{clooginstalldir}} option is shorthand for
1617 @option{--with-cloog-lib=@/@var{clooginstalldir}/lib} and
1618 @option{--with-cloog-include=@/@var{clooginstalldir}/include}.  If these
1619 shorthand assumptions are not correct, you can use the explicit
1620 include and lib options directly.
1622 These flags are applicable to the host platform only.  When building
1623 a cross compiler, they will not be used to configure target libraries.
1625 @item --with-host-libstdcxx=@var{linker-args}
1626 If you are linking with a static copy of PPL, you can use this option
1627 to specify how the linker should find the standard C++ library used
1628 internally by PPL.  Typical values of @var{linker-args} might be
1629 @samp{-lstdc++} or @samp{-Wl,-Bstatic,-lstdc++,-Bdynamic -lm}.  If you are
1630 linking with a shared copy of PPL, you probably do not need this
1631 option; shared library dependencies will cause the linker to search
1632 for the standard C++ library automatically.
1634 @item --with-stage1-ldflags=@var{flags}
1635 This option may be used to set linker flags to be used when linking
1636 stage 1 of GCC.  These are also used when linking GCC if configured with
1637 @option{--disable-bootstrap}.  By default no special flags are used.
1639 @item --with-stage1-libs=@var{libs}
1640 This option may be used to set libraries to be used when linking stage 1
1641 of GCC.  These are also used when linking GCC if configured with
1642 @option{--disable-bootstrap}.  The default is the argument to
1643 @option{--with-host-libstdcxx}, if specified.
1645 @item --with-boot-ldflags=@var{flags}
1646 This option may be used to set linker flags to be used when linking
1647 stage 2 and later when bootstrapping GCC.  If neither --with-boot-libs
1648 nor --with-host-libstdcxx is set to a value, then the default is
1649 @samp{-static-libstdc++ -static-libgcc}.
1651 @item --with-boot-libs=@var{libs}
1652 This option may be used to set libraries to be used when linking stage 2
1653 and later when bootstrapping GCC.  The default is the argument to
1654 @option{--with-host-libstdcxx}, if specified.
1656 @item --with-debug-prefix-map=@var{map}
1657 Convert source directory names using @option{-fdebug-prefix-map} when
1658 building runtime libraries.  @samp{@var{map}} is a space-separated
1659 list of maps of the form @samp{@var{old}=@var{new}}.
1661 @item --enable-linker-build-id
1662 Tells GCC to pass @option{--build-id} option to the linker for all final
1663 links (links performed without the @option{-r} or @option{--relocatable}
1664 option), if the linker supports it.  If you specify
1665 @option{--enable-linker-build-id}, but your linker does not
1666 support @option{--build-id} option, a warning is issued and the
1667 @option{--enable-linker-build-id} option is ignored.  The default is off.
1669 @item --with-linker-hash-style=@var{choice}
1670 Tells GCC to pass @option{--hash-style=@var{choice}} option to the
1671 linker for all final links. @var{choice} can be one of
1672 @samp{sysv}, @samp{gnu}, and @samp{both} where @samp{sysv} is the default.
1674 @item --enable-gnu-unique-object
1675 @itemx --disable-gnu-unique-object
1676 Tells GCC to use the gnu_unique_object relocation for C++ template
1677 static data members and inline function local statics.  Enabled by
1678 default for a native toolchain with an assembler that accepts it and
1679 GLIBC 2.11 or above, otherwise disabled.
1681 @item --enable-lto
1682 @itemx --disable-lto
1683 Enable support for link-time optimization (LTO).  This is enabled by
1684 default, and may be disabled using @option{--disable-lto}.
1686 @item --with-plugin-ld=@var{pathname}
1687 Enable an alternate linker to be used at link-time optimization (LTO)
1688 link time when @option{-fuse-linker-plugin} is enabled.
1689 This linker should have plugin support such as gold starting with
1690 version 2.20 or GNU ld starting with version 2.21.
1691 See @option{-fuse-linker-plugin} for details.
1692 @end table
1694 @subheading Cross-Compiler-Specific Options
1695 The following options only apply to building cross compilers.
1697 @table @code
1698 @item --with-sysroot
1699 @itemx --with-sysroot=@var{dir}
1700 Tells GCC to consider @var{dir} as the root of a tree that contains
1701 (a subset of) the root filesystem of the target operating system.
1702 Target system headers, libraries and run-time object files will be
1703 searched in there.  More specifically, this acts as if
1704 @option{--sysroot=@var{dir}} was added to the default options of the built
1705 compiler.  The specified directory is not copied into the
1706 install tree, unlike the options @option{--with-headers} and
1707 @option{--with-libs} that this option obsoletes.  The default value,
1708 in case @option{--with-sysroot} is not given an argument, is
1709 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1710 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1711 the GCC binaries if the installation tree is moved.
1713 This option affects the system root for the compiler used to build
1714 target libraries (which runs on the build system) and the compiler newly
1715 installed with @code{make install}; it does not affect the compiler which is
1716 used to build GCC itself.
1718 @item --with-build-sysroot
1719 @itemx --with-build-sysroot=@var{dir}
1720 Tells GCC to consider @var{dir} as the system root (see
1721 @option{--with-sysroot}) while building target libraries, instead of
1722 the directory specified with @option{--with-sysroot}.  This option is
1723 only useful when you are already using @option{--with-sysroot}.  You
1724 can use @option{--with-build-sysroot} when you are configuring with
1725 @option{--prefix} set to a directory that is different from the one in
1726 which you are installing GCC and your target libraries.
1728 This option affects the system root for the compiler used to build
1729 target libraries (which runs on the build system); it does not affect
1730 the compiler which is used to build GCC itself.
1732 @item --with-headers
1733 @itemx --with-headers=@var{dir}
1734 Deprecated in favor of @option{--with-sysroot}.
1735 Specifies that target headers are available when building a cross compiler.
1736 The @var{dir} argument specifies a directory which has the target include
1737 files.  These include files will be copied into the @file{gcc} install
1738 directory.  @emph{This option with the @var{dir} argument is required} when
1739 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1740 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1741 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1742 will be run on these files to make them compatible with GCC@.
1744 @item --without-headers
1745 Tells GCC not use any target headers from a libc when building a cross
1746 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1747 can build the exception handling for libgcc.
1749 @item --with-libs
1750 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
1751 Deprecated in favor of @option{--with-sysroot}.
1752 Specifies a list of directories which contain the target runtime
1753 libraries.  These libraries will be copied into the @file{gcc} install
1754 directory.  If the directory list is omitted, this option has no
1755 effect.
1757 @item --with-newlib
1758 Specifies that @samp{newlib} is
1759 being used as the target C library.  This causes @code{__eprintf} to be
1760 omitted from @file{libgcc.a} on the assumption that it will be provided by
1761 @samp{newlib}.
1763 @item --with-build-time-tools=@var{dir}
1764 Specifies where to find the set of target tools (assembler, linker, etc.)
1765 that will be used while building GCC itself.  This option can be useful
1766 if the directory layouts are different between the system you are building
1767 GCC on, and the system where you will deploy it.
1769 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
1770 assembler and linker in @file{/usr/bin}, and the native tools in a
1771 different path, and build a toolchain that expects to find the
1772 native tools in @file{/usr/bin}.
1774 When you use this option, you should ensure that @var{dir} includes
1775 @command{ar}, @command{as}, @command{ld}, @command{nm},
1776 @command{ranlib} and @command{strip} if necessary, and possibly
1777 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
1778 tools.
1779 @end table
1781 @subheading Java-Specific Options
1783 The following option applies to the build of the Java front end.
1785 @table @code
1786 @item --disable-libgcj
1787 Specify that the run-time libraries
1788 used by GCJ should not be built.  This is useful in case you intend
1789 to use GCJ with some other run-time, or you're going to install it
1790 separately, or it just happens not to build on your particular
1791 machine.  In general, if the Java front end is enabled, the GCJ
1792 libraries will be enabled too, unless they're known to not work on
1793 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1794 may need to port it; in this case, before modifying the top-level
1795 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1796 you may use @option{--enable-libgcj} to override the default.
1798 @end table
1800 The following options apply to building @samp{libgcj}.
1802 @subsubheading General Options
1804 @table @code
1805 @item --enable-java-maintainer-mode
1806 By default the @samp{libjava} build will not attempt to compile the
1807 @file{.java} source files to @file{.class}.  Instead, it will use the
1808 @file{.class} files from the source tree.  If you use this option you
1809 must have executables named @command{ecj1} and @command{gjavah} in your path
1810 for use by the build.  You must use this option if you intend to
1811 modify any @file{.java} files in @file{libjava}.
1813 @item --with-java-home=@var{dirname}
1814 This @samp{libjava} option overrides the default value of the
1815 @samp{java.home} system property.  It is also used to set
1816 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1817 default @samp{java.home} is set to @file{@var{prefix}} and
1818 @samp{sun.boot.class.path} to
1819 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1821 @item --with-ecj-jar=@var{filename}
1822 This option can be used to specify the location of an external jar
1823 file containing the Eclipse Java compiler.  A specially modified
1824 version of this compiler is used by @command{gcj} to parse
1825 @file{.java} source files.  If this option is given, the
1826 @samp{libjava} build will create and install an @file{ecj1} executable
1827 which uses this jar file at runtime.
1829 If this option is not given, but an @file{ecj.jar} file is found in
1830 the topmost source tree at configure time, then the @samp{libgcj}
1831 build will create and install @file{ecj1}, and will also install the
1832 discovered @file{ecj.jar} into a suitable place in the install tree.
1834 If @file{ecj1} is not installed, then the user will have to supply one
1835 on his path in order for @command{gcj} to properly parse @file{.java}
1836 source files.  A suitable jar is available from
1837 @uref{ftp://sourceware.org/pub/java/}.
1839 @item --disable-getenv-properties
1840 Don't set system properties from @env{GCJ_PROPERTIES}.
1842 @item --enable-hash-synchronization
1843 Use a global hash table for monitor locks.  Ordinarily,
1844 @samp{libgcj}'s @samp{configure} script automatically makes
1845 the correct choice for this option for your platform.  Only use
1846 this if you know you need the library to be configured differently.
1848 @item --enable-interpreter
1849 Enable the Java interpreter.  The interpreter is automatically
1850 enabled by default on all platforms that support it.  This option
1851 is really only useful if you want to disable the interpreter
1852 (using @option{--disable-interpreter}).
1854 @item --disable-java-net
1855 Disable java.net.  This disables the native part of java.net only,
1856 using non-functional stubs for native method implementations.
1858 @item --disable-jvmpi
1859 Disable JVMPI support.
1861 @item --disable-libgcj-bc
1862 Disable BC ABI compilation of certain parts of libgcj.  By default,
1863 some portions of libgcj are compiled with @option{-findirect-dispatch}
1864 and @option{-fno-indirect-classes}, allowing them to be overridden at
1865 run-time.
1867 If @option{--disable-libgcj-bc} is specified, libgcj is built without
1868 these options.  This allows the compile-time linker to resolve
1869 dependencies when statically linking to libgcj.  However it makes it
1870 impossible to override the affected portions of libgcj at run-time.
1872 @item --enable-reduced-reflection
1873 Build most of libgcj with @option{-freduced-reflection}.  This reduces
1874 the size of libgcj at the expense of not being able to do accurate
1875 reflection on the classes it contains.  This option is safe if you
1876 know that code using libgcj will never use reflection on the standard
1877 runtime classes in libgcj (including using serialization, RMI or CORBA).
1879 @item --with-ecos
1880 Enable runtime eCos target support.
1882 @item --without-libffi
1883 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1884 support as well, as these require @samp{libffi} to work.
1886 @item --enable-libgcj-debug
1887 Enable runtime debugging code.
1889 @item --enable-libgcj-multifile
1890 If specified, causes all @file{.java} source files to be
1891 compiled into @file{.class} files in one invocation of
1892 @samp{gcj}.  This can speed up build time, but is more
1893 resource-intensive.  If this option is unspecified or
1894 disabled, @samp{gcj} is invoked once for each @file{.java}
1895 file to compile into a @file{.class} file.
1897 @item --with-libiconv-prefix=DIR
1898 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1900 @item --enable-sjlj-exceptions
1901 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1902 @samp{configure} ordinarily picks the correct value based on the platform.
1903 Only use this option if you are sure you need a different setting.
1905 @item --with-system-zlib
1906 Use installed @samp{zlib} rather than that included with GCC@.
1908 @item --with-win32-nlsapi=ansi, unicows or unicode
1909 Indicates how MinGW @samp{libgcj} translates between UNICODE
1910 characters and the Win32 API@.
1912 @item --enable-java-home
1913 If enabled, this creates a JPackage compatible SDK environment during install.
1914 Note that if --enable-java-home is used, --with-arch-directory=ARCH must also
1915 be specified.
1917 @item --with-arch-directory=ARCH
1918 Specifies the name to use for the @file{jre/lib/ARCH} directory in the SDK
1919 environment created when --enable-java-home is passed. Typical names for this
1920 directory include i386, amd64, ia64, etc.
1922 @item --with-os-directory=DIR
1923 Specifies the OS directory for the SDK include directory. This is set to auto
1924 detect, and is typically 'linux'.
1926 @item --with-origin-name=NAME
1927 Specifies the JPackage origin name. This defaults to the 'gcj' in
1928 java-1.5.0-gcj.
1930 @item --with-arch-suffix=SUFFIX
1931 Specifies the suffix for the sdk directory. Defaults to the empty string.
1932 Examples include '.x86_64' in 'java-1.5.0-gcj-1.5.0.0.x86_64'.
1934 @item --with-jvm-root-dir=DIR
1935 Specifies where to install the SDK. Default is $(prefix)/lib/jvm.
1937 @item --with-jvm-jar-dir=DIR
1938 Specifies where to install jars. Default is $(prefix)/lib/jvm-exports.
1940 @item --with-python-dir=DIR
1941 Specifies where to install the Python modules used for aot-compile. DIR should
1942 not include the prefix used in installation. For example, if the Python modules
1943 are to be installed in /usr/lib/python2.5/site-packages, then
1944 --with-python-dir=/lib/python2.5/site-packages should be passed. If this is
1945 not specified, then the Python modules are installed in $(prefix)/share/python.
1947 @item --enable-aot-compile-rpm
1948 Adds aot-compile-rpm to the list of installed scripts.
1950 @item --enable-browser-plugin
1951 Build the gcjwebplugin web browser plugin.
1953 @table @code
1954 @item ansi
1955 Use the single-byte @code{char} and the Win32 A functions natively,
1956 translating to and from UNICODE when using these functions.  If
1957 unspecified, this is the default.
1959 @item unicows
1960 Use the @code{WCHAR} and Win32 W functions natively.  Adds
1961 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1962 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1963 running built executables.  @file{libunicows.a}, an open-source
1964 import library around Microsoft's @code{unicows.dll}, is obtained from
1965 @uref{http://libunicows.sourceforge.net/}, which also gives details
1966 on getting @file{unicows.dll} from Microsoft.
1968 @item unicode
1969 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
1970 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
1971 only run on Microsoft Windows NT and above.
1972 @end table
1973 @end table
1975 @subsubheading AWT-Specific Options
1977 @table @code
1978 @item --with-x
1979 Use the X Window System.
1981 @item --enable-java-awt=PEER(S)
1982 Specifies the AWT peer library or libraries to build alongside
1983 @samp{libgcj}.  If this option is unspecified or disabled, AWT
1984 will be non-functional.  Current valid values are @option{gtk} and
1985 @option{xlib}.  Multiple libraries should be separated by a
1986 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1988 @item --enable-gtk-cairo
1989 Build the cairo Graphics2D implementation on GTK@.
1991 @item --enable-java-gc=TYPE
1992 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
1994 @item --disable-gtktest
1995 Do not try to compile and run a test GTK+ program.
1997 @item --disable-glibtest
1998 Do not try to compile and run a test GLIB program.
2000 @item --with-libart-prefix=PFX
2001 Prefix where libart is installed (optional).
2003 @item --with-libart-exec-prefix=PFX
2004 Exec prefix where libart is installed (optional).
2006 @item --disable-libarttest
2007 Do not try to compile and run a test libart program.
2009 @end table
2011 @subsubheading Overriding @command{configure} test results
2013 Sometimes, it might be necessary to override the result of some
2014 @command{configure} test, for example in order to ease porting to a new
2015 system or work around a bug in a test.  The toplevel @command{configure}
2016 script provides three variables for this:
2018 @table @code
2020 @item build_configargs
2021 @cindex @code{build_configargs}
2022 The contents of this variable is passed to all build @command{configure}
2023 scripts.
2025 @item host_configargs
2026 @cindex @code{host_configargs}
2027 The contents of this variable is passed to all host @command{configure}
2028 scripts.
2030 @item target_configargs
2031 @cindex @code{target_configargs}
2032 The contents of this variable is passed to all target @command{configure}
2033 scripts.
2035 @end table
2037 In order to avoid shell and @command{make} quoting issues for complex
2038 overrides, you can pass a setting for @env{CONFIG_SITE} and set
2039 variables in the site file.
2041 @html
2042 <hr />
2044 @end html
2045 @ifhtml
2046 @uref{./index.html,,Return to the GCC Installation page}
2047 @end ifhtml
2048 @end ifset
2050 @c ***Building****************************************************************
2051 @ifnothtml
2052 @comment node-name,     next,          previous, up
2053 @node    Building, Testing, Configuration, Installing GCC
2054 @end ifnothtml
2055 @ifset buildhtml
2056 @ifnothtml
2057 @chapter Building
2058 @end ifnothtml
2059 @cindex Installing GCC: Building
2061 Now that GCC is configured, you are ready to build the compiler and
2062 runtime libraries.
2064 Some commands executed when making the compiler may fail (return a
2065 nonzero status) and be ignored by @command{make}.  These failures, which
2066 are often due to files that were not found, are expected, and can safely
2067 be ignored.
2069 It is normal to have compiler warnings when compiling certain files.
2070 Unless you are a GCC developer, you can generally ignore these warnings
2071 unless they cause compilation to fail.  Developers should attempt to fix
2072 any warnings encountered, however they can temporarily continue past
2073 warnings-as-errors by specifying the configure flag
2074 @option{--disable-werror}.
2076 On certain old systems, defining certain environment variables such as
2077 @env{CC} can interfere with the functioning of @command{make}.
2079 If you encounter seemingly strange errors when trying to build the
2080 compiler in a directory other than the source directory, it could be
2081 because you have previously configured the compiler in the source
2082 directory.  Make sure you have done all the necessary preparations.
2084 If you build GCC on a BSD system using a directory stored in an old System
2085 V file system, problems may occur in running @command{fixincludes} if the
2086 System V file system doesn't support symbolic links.  These problems
2087 result in a failure to fix the declaration of @code{size_t} in
2088 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2089 that type mismatches occur, this could be the cause.
2091 The solution is not to use such a directory for building GCC@.
2093 Similarly, when building from SVN or snapshots, or if you modify
2094 @file{*.l} files, you need the Flex lexical analyzer generator
2095 installed.  If you do not modify @file{*.l} files, releases contain
2096 the Flex-generated files and you do not need Flex installed to build
2097 them.  There is still one Flex-based lexical analyzer (part of the
2098 build machinery, not of GCC itself) that is used even if you only
2099 build the C front end.
2101 When building from SVN or snapshots, or if you modify Texinfo
2102 documentation, you need version 4.7 or later of Texinfo installed if you
2103 want Info documentation to be regenerated.  Releases contain Info
2104 documentation pre-built for the unmodified documentation in the release.
2106 @section Building a native compiler
2108 For a native build, the default configuration is to perform
2109 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2110 This will build the entire GCC system and ensure that it compiles
2111 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2112 parameter to @samp{configure}, but bootstrapping is suggested because
2113 the compiler will be tested more completely and could also have
2114 better performance.
2116 The bootstrapping process will complete the following steps:
2118 @itemize @bullet
2119 @item
2120 Build tools necessary to build the compiler.
2122 @item
2123 Perform a 3-stage bootstrap of the compiler.  This includes building
2124 three times the target tools for use by the compiler such as binutils
2125 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2126 individually linked or moved into the top level GCC source tree before
2127 configuring.
2129 @item
2130 Perform a comparison test of the stage2 and stage3 compilers.
2132 @item
2133 Build runtime libraries using the stage3 compiler from the previous step.
2135 @end itemize
2137 If you are short on disk space you might consider @samp{make
2138 bootstrap-lean} instead.  The sequence of compilation is the
2139 same described above, but object files from the stage1 and
2140 stage2 of the 3-stage bootstrap of the compiler are deleted as
2141 soon as they are no longer needed.
2143 If you wish to use non-default GCC flags when compiling the stage2
2144 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2145 doing @samp{make}.  For example, if you want to save additional space
2146 during the bootstrap and in the final installation as well, you can
2147 build the compiler binaries without debugging information as in the
2148 following example.  This will save roughly 40% of disk space both for
2149 the bootstrap and the final installation.  (Libraries will still contain
2150 debugging information.)
2152 @smallexample
2153 make BOOT_CFLAGS='-O' bootstrap
2154 @end smallexample
2156 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2157 are less well tested here than the default of @samp{-g -O2}, but should
2158 still work.  In a few cases, you may find that you need to specify special
2159 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2160 if the native compiler miscompiles the stage1 compiler, you may need
2161 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2162 of the stage1 compiler that were miscompiled, or by using @samp{make
2163 bootstrap4} to increase the number of stages of bootstrap.
2165 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2166 Since these are always compiled with the compiler currently being
2167 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2168 compilation flags, as for non-bootstrapped target libraries.
2169 Again, if the native compiler miscompiles the stage1 compiler, you may
2170 need to work around this by avoiding non-working parts of the stage1
2171 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2173 If you used the flag @option{--enable-languages=@dots{}} to restrict
2174 the compilers to be built, only those you've actually enabled will be
2175 built.  This will of course only build those runtime libraries, for
2176 which the particular compiler has been built.  Please note,
2177 that re-defining @env{LANGUAGES} when calling @samp{make}
2178 @strong{does not} work anymore!
2180 If the comparison of stage2 and stage3 fails, this normally indicates
2181 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2182 a potentially serious bug which you should investigate and report.  (On
2183 a few systems, meaningful comparison of object files is impossible; they
2184 always appear ``different''.  If you encounter this problem, you will
2185 need to disable comparison in the @file{Makefile}.)
2187 If you do not want to bootstrap your compiler, you can configure with
2188 @option{--disable-bootstrap}.  In particular cases, you may want to
2189 bootstrap your compiler even if the target system is not the same as
2190 the one you are building on: for example, you could build a
2191 @code{powerpc-unknown-linux-gnu} toolchain on a
2192 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2193 @option{--enable-bootstrap} to the configure script.
2195 @code{BUILD_CONFIG} can be used to bring in additional customization
2196 to the build.  It can be set to a whitespace-separated list of names.
2197 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2198 be included by the top-level @file{Makefile}, bringing in any settings
2199 it contains.  The default @code{BUILD_CONFIG} can be set using the
2200 configure option @option{--with-build-config=@code{NAME}...}.  Some
2201 examples of supported build configurations are:
2203 @table @asis
2204 @item @samp{bootstrap-O1}
2205 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2206 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2207 @samp{BOOT_CFLAGS='-g -O1'}.
2209 @item @samp{bootstrap-O3}
2210 Analogous to @code{bootstrap-O1}.
2212 @item @samp{bootstrap-lto}
2213 Enables Link-Time Optimization for host tools during bootstrapping.
2214 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2215 @option{-flto} to @samp{BOOT_CFLAGS}.
2217 @item @samp{bootstrap-debug}
2218 Verifies that the compiler generates the same executable code, whether
2219 or not it is asked to emit debug information.  To this end, this
2220 option builds stage2 host programs without debug information, and uses
2221 @file{contrib/compare-debug} to compare them with the stripped stage3
2222 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2223 debug information, stage2 will have it, and stage3 won't.  This option
2224 is enabled by default when GCC bootstrapping is enabled, if
2225 @code{strip} can turn object files compiled with and without debug
2226 info into identical object files.  In addition to better test
2227 coverage, this option makes default bootstraps faster and leaner.
2229 @item @samp{bootstrap-debug-big}
2230 Rather than comparing stripped object files, as in
2231 @code{bootstrap-debug}, this option saves internal compiler dumps
2232 during stage2 and stage3 and compares them as well, which helps catch
2233 additional potential problems, but at a great cost in terms of disk
2234 space.  It can be specified in addition to @samp{bootstrap-debug}.
2236 @item @samp{bootstrap-debug-lean}
2237 This option saves disk space compared with @code{bootstrap-debug-big},
2238 but at the expense of some recompilation.  Instead of saving the dumps
2239 of stage2 and stage3 until the final compare, it uses
2240 @option{-fcompare-debug} to generate, compare and remove the dumps
2241 during stage3, repeating the compilation that already took place in
2242 stage2, whose dumps were not saved.
2244 @item @samp{bootstrap-debug-lib}
2245 This option tests executable code invariance over debug information
2246 generation on target libraries, just like @code{bootstrap-debug-lean}
2247 tests it on host programs.  It builds stage3 libraries with
2248 @option{-fcompare-debug}, and it can be used along with any of the
2249 @code{bootstrap-debug} options above.
2251 There aren't @code{-lean} or @code{-big} counterparts to this option
2252 because most libraries are only build in stage3, so bootstrap compares
2253 would not get significant coverage.  Moreover, the few libraries built
2254 in stage2 are used in stage3 host programs, so we wouldn't want to
2255 compile stage2 libraries with different options for comparison purposes.
2257 @item @samp{bootstrap-debug-ckovw}
2258 Arranges for error messages to be issued if the compiler built on any
2259 stage is run without the option @option{-fcompare-debug}.  This is
2260 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2261 must be used along with @code{bootstrap-debug-lean} and
2262 @code{bootstrap-debug-lib}.
2264 @item @samp{bootstrap-time}
2265 Arranges for the run time of each program started by the GCC driver,
2266 built in any stage, to be logged to @file{time.log}, in the top level of
2267 the build tree.
2269 @end table
2271 @section Building a cross compiler
2273 When building a cross compiler, it is not generally possible to do a
2274 3-stage bootstrap of the compiler.  This makes for an interesting problem
2275 as parts of GCC can only be built with GCC@.
2277 To build a cross compiler, we recommend first building and installing a
2278 native compiler.  You can then use the native GCC compiler to build the
2279 cross compiler.  The installed native compiler needs to be GCC version
2280 2.95 or later.
2282 If the cross compiler is to be built with support for the Java
2283 programming language and the ability to compile .java source files is
2284 desired, the installed native compiler used to build the cross
2285 compiler needs to be the same GCC version as the cross compiler.  In
2286 addition the cross compiler needs to be configured with
2287 @option{--with-ecj-jar=@dots{}}.
2289 Assuming you have already installed a native copy of GCC and configured
2290 your cross compiler, issue the command @command{make}, which performs the
2291 following steps:
2293 @itemize @bullet
2294 @item
2295 Build host tools necessary to build the compiler.
2297 @item
2298 Build target tools for use by the compiler such as binutils (bfd,
2299 binutils, gas, gprof, ld, and opcodes)
2300 if they have been individually linked or moved into the top level GCC source
2301 tree before configuring.
2303 @item
2304 Build the compiler (single stage only).
2306 @item
2307 Build runtime libraries using the compiler from the previous step.
2308 @end itemize
2310 Note that if an error occurs in any step the make process will exit.
2312 If you are not building GNU binutils in the same source tree as GCC,
2313 you will need a cross-assembler and cross-linker installed before
2314 configuring GCC@.  Put them in the directory
2315 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2316 you should put in this directory:
2318 @table @file
2319 @item as
2320 This should be the cross-assembler.
2322 @item ld
2323 This should be the cross-linker.
2325 @item ar
2326 This should be the cross-archiver: a program which can manipulate
2327 archive files (linker libraries) in the target machine's format.
2329 @item ranlib
2330 This should be a program to construct a symbol table in an archive file.
2331 @end table
2333 The installation of GCC will find these programs in that directory,
2334 and copy or link them to the proper place to for the cross-compiler to
2335 find them when run later.
2337 The easiest way to provide these files is to build the Binutils package.
2338 Configure it with the same @option{--host} and @option{--target}
2339 options that you use for configuring GCC, then build and install
2340 them.  They install their executables automatically into the proper
2341 directory.  Alas, they do not support all the targets that GCC
2342 supports.
2344 If you are not building a C library in the same source tree as GCC,
2345 you should also provide the target libraries and headers before
2346 configuring GCC, specifying the directories with
2347 @option{--with-sysroot} or @option{--with-headers} and
2348 @option{--with-libs}.  Many targets also require ``start files'' such
2349 as @file{crt0.o} and
2350 @file{crtn.o} which are linked into each executable.  There may be several
2351 alternatives for @file{crt0.o}, for use with profiling or other
2352 compilation options.  Check your target's definition of
2353 @code{STARTFILE_SPEC} to find out what start files it uses.
2355 @section Building in parallel
2357 GNU Make 3.80 and above, which is necessary to build GCC, support
2358 building in parallel.  To activate this, you can use @samp{make -j 2}
2359 instead of @samp{make}.  You can also specify a bigger number, and
2360 in most cases using a value greater than the number of processors in
2361 your machine will result in fewer and shorter I/O latency hits, thus
2362 improving overall throughput; this is especially true for slow drives
2363 and network filesystems.
2365 @section Building the Ada compiler
2367 In order to build GNAT, the Ada compiler, you need a working GNAT
2368 compiler (GCC version 4.0 or later).
2369 This includes GNAT tools such as @command{gnatmake} and
2370 @command{gnatlink}, since the Ada front end is written in Ada and
2371 uses some GNAT-specific extensions.
2373 In order to build a cross compiler, it is suggested to install
2374 the new compiler as native first, and then use it to build the cross
2375 compiler.
2377 @command{configure} does not test whether the GNAT installation works
2378 and has a sufficiently recent version; if too old a GNAT version is
2379 installed, the build will fail unless @option{--enable-languages} is
2380 used to disable building the Ada front end.
2382 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2383 must not be set when building the Ada compiler, the Ada tools, or the
2384 Ada runtime libraries. You can check that your build environment is clean
2385 by verifying that @samp{gnatls -v} lists only one explicit path in each
2386 section.
2388 @section Building with profile feedback
2390 It is possible to use profile feedback to optimize the compiler itself.  This
2391 should result in a faster compiler binary.  Experiments done on x86 using gcc
2392 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2393 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2395 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2396 compiler.  This compiler is used to build a @code{stageprofile} compiler
2397 instrumented to collect execution counts of instruction and branch
2398 probabilities.  Then runtime libraries are compiled with profile collected.
2399 Finally a @code{stagefeedback} compiler is built using the information collected.
2401 Unlike standard bootstrap, several additional restrictions apply.  The
2402 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2403 It is recommended to only use GCC for this.  Also parallel make is currently
2404 not supported since collisions in profile collecting may occur.
2406 @html
2407 <hr />
2409 @end html
2410 @ifhtml
2411 @uref{./index.html,,Return to the GCC Installation page}
2412 @end ifhtml
2413 @end ifset
2415 @c ***Testing*****************************************************************
2416 @ifnothtml
2417 @comment node-name,     next,          previous, up
2418 @node    Testing, Final install, Building, Installing GCC
2419 @end ifnothtml
2420 @ifset testhtml
2421 @ifnothtml
2422 @chapter Installing GCC: Testing
2423 @end ifnothtml
2424 @cindex Testing
2425 @cindex Installing GCC: Testing
2426 @cindex Testsuite
2428 Before you install GCC, we encourage you to run the testsuites and to
2429 compare your results with results from a similar configuration that have
2430 been submitted to the
2431 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2432 Some of these archived results are linked from the build status lists
2433 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2434 reports a successful build runs the testsuites and submits the results.
2435 This step is optional and may require you to download additional software,
2436 but it can give you confidence in your new GCC installation or point out
2437 problems before you install and start using your new GCC@.
2439 First, you must have @uref{download.html,,downloaded the testsuites}.
2440 These are part of the full distribution, but if you downloaded the
2441 ``core'' compiler plus any front ends, you must download the testsuites
2442 separately.
2444 Second, you must have the testing tools installed.  This includes
2445 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2446 the DejaGnu site has links to these.
2448 If the directories where @command{runtest} and @command{expect} were
2449 installed are not in the @env{PATH}, you may need to set the following
2450 environment variables appropriately, as in the following example (which
2451 assumes that DejaGnu has been installed under @file{/usr/local}):
2453 @smallexample
2454 TCL_LIBRARY = /usr/local/share/tcl8.0
2455 DEJAGNULIBS = /usr/local/share/dejagnu
2456 @end smallexample
2458 (On systems such as Cygwin, these paths are required to be actual
2459 paths, not mounts or links; presumably this is due to some lack of
2460 portability in the DejaGnu code.)
2463 Finally, you can run the testsuite (which may take a long time):
2464 @smallexample
2465 cd @var{objdir}; make -k check
2466 @end smallexample
2468 This will test various components of GCC, such as compiler
2469 front ends and runtime libraries.  While running the testsuite, DejaGnu
2470 might emit some harmless messages resembling
2471 @samp{WARNING: Couldn't find the global config file.} or
2472 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2474 If you are testing a cross-compiler, you may want to run the testsuite
2475 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2477 @section How can you run the testsuite on selected tests?
2479 In order to run sets of tests selectively, there are targets
2480 @samp{make check-gcc} and @samp{make check-g++}
2481 in the @file{gcc} subdirectory of the object directory.  You can also
2482 just run @samp{make check} in a subdirectory of the object directory.
2485 A more selective way to just run all @command{gcc} execute tests in the
2486 testsuite is to use
2488 @smallexample
2489 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2490 @end smallexample
2492 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2493 the testsuite with filenames matching @samp{9805*}, you would use
2495 @smallexample
2496 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2497 @end smallexample
2499 The @file{*.exp} files are located in the testsuite directories of the GCC
2500 source, the most important ones being @file{compile.exp},
2501 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2502 To get a list of the possible @file{*.exp} files, pipe the
2503 output of @samp{make check} into a file and look at the
2504 @samp{Running @dots{}  .exp} lines.
2506 @section Passing options and running multiple testsuites
2508 You can pass multiple options to the testsuite using the
2509 @samp{--target_board} option of DejaGNU, either passed as part of
2510 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2511 work outside the makefiles.  For example,
2513 @smallexample
2514 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2515 @end smallexample
2517 will run the standard @command{g++} testsuites (``unix'' is the target name
2518 for a standard native testsuite situation), passing
2519 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2520 slashes separate options.
2522 You can run the testsuites multiple times using combinations of options
2523 with a syntax similar to the brace expansion of popular shells:
2525 @smallexample
2526 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2527 @end smallexample
2529 (Note the empty option caused by the trailing comma in the final group.)
2530 The following will run each testsuite eight times using the @samp{arm-sim}
2531 target, as if you had specified all possible combinations yourself:
2533 @smallexample
2534 --target_board=arm-sim/-mhard-float/-O1
2535 --target_board=arm-sim/-mhard-float/-O2
2536 --target_board=arm-sim/-mhard-float/-O3
2537 --target_board=arm-sim/-mhard-float
2538 --target_board=arm-sim/-msoft-float/-O1
2539 --target_board=arm-sim/-msoft-float/-O2
2540 --target_board=arm-sim/-msoft-float/-O3
2541 --target_board=arm-sim/-msoft-float
2542 @end smallexample
2544 They can be combined as many times as you wish, in arbitrary ways.  This
2545 list:
2547 @smallexample
2548 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2549 @end smallexample
2551 will generate four combinations, all involving @samp{-Wextra}.
2553 The disadvantage to this method is that the testsuites are run in serial,
2554 which is a waste on multiprocessor systems.  For users with GNU Make and
2555 a shell which performs brace expansion, you can run the testsuites in
2556 parallel by having the shell perform the combinations and @command{make}
2557 do the parallel runs.  Instead of using @samp{--target_board}, use a
2558 special makefile target:
2560 @smallexample
2561 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2562 @end smallexample
2564 For example,
2566 @smallexample
2567 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2568 @end smallexample
2570 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2571 ten combinations as described above.  Note that this is currently only
2572 supported in the @file{gcc} subdirectory.  (To see how this works, try
2573 typing @command{echo} before the example given here.)
2576 @section Additional testing for Java Class Libraries
2578 The Java runtime tests can be executed via @samp{make check}
2579 in the @file{@var{target}/libjava/testsuite} directory in
2580 the build tree.
2582 The @uref{http://sourceware.org/mauve/,,Mauve Project} provides
2583 a suite of tests for the Java Class Libraries.  This suite can be run
2584 as part of libgcj testing by placing the Mauve tree within the libjava
2585 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
2586 specifying the location of that tree when invoking @samp{make}, as in
2587 @samp{make MAUVEDIR=~/mauve check}.
2589 @section How to interpret test results
2591 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2592 files in the testsuite subdirectories.  The @file{*.log} files contain a
2593 detailed log of the compiler invocations and the corresponding
2594 results, the @file{*.sum} files summarize the results.  These summaries
2595 contain status codes for all tests:
2597 @itemize @bullet
2598 @item
2599 PASS: the test passed as expected
2600 @item
2601 XPASS: the test unexpectedly passed
2602 @item
2603 FAIL: the test unexpectedly failed
2604 @item
2605 XFAIL: the test failed as expected
2606 @item
2607 UNSUPPORTED: the test is not supported on this platform
2608 @item
2609 ERROR: the testsuite detected an error
2610 @item
2611 WARNING: the testsuite detected a possible problem
2612 @end itemize
2614 It is normal for some tests to report unexpected failures.  At the
2615 current time the testing harness does not allow fine grained control
2616 over whether or not a test is expected to fail.  This problem should
2617 be fixed in future releases.
2620 @section Submitting test results
2622 If you want to report the results to the GCC project, use the
2623 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2625 @smallexample
2626 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2627     -m gcc-testresults@@gcc.gnu.org |sh
2628 @end smallexample
2630 This script uses the @command{Mail} program to send the results, so
2631 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2632 prepended to the testsuite summary and should contain any special
2633 remarks you have on your results or your build environment.  Please
2634 do not edit the testsuite result block or the subject line, as these
2635 messages may be automatically processed.
2637 @html
2638 <hr />
2640 @end html
2641 @ifhtml
2642 @uref{./index.html,,Return to the GCC Installation page}
2643 @end ifhtml
2644 @end ifset
2646 @c ***Final install***********************************************************
2647 @ifnothtml
2648 @comment node-name,     next,          previous, up
2649 @node    Final install, , Testing, Installing GCC
2650 @end ifnothtml
2651 @ifset finalinstallhtml
2652 @ifnothtml
2653 @chapter Installing GCC: Final installation
2654 @end ifnothtml
2656 Now that GCC has been built (and optionally tested), you can install it with
2657 @smallexample
2658 cd @var{objdir} && make install
2659 @end smallexample
2661 We strongly recommend to install into a target directory where there is
2662 no previous version of GCC present.  Also, the GNAT runtime should not
2663 be stripped, as this would break certain features of the debugger that
2664 depend on this debugging information (catching Ada exceptions for
2665 instance).
2667 That step completes the installation of GCC; user level binaries can
2668 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2669 you specified with the @option{--prefix} to configure (or
2670 @file{/usr/local} by default).  (If you specified @option{--bindir},
2671 that directory will be used instead; otherwise, if you specified
2672 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2673 Headers for the C++ and Java libraries are installed in
2674 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2675 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2676 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2677 in info format in @file{@var{infodir}} (normally
2678 @file{@var{prefix}/info}).
2680 When installing cross-compilers, GCC's executables
2681 are not only installed into @file{@var{bindir}}, that
2682 is, @file{@var{exec-prefix}/bin}, but additionally into
2683 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2684 exists.  Typically, such @dfn{tooldirs} hold target-specific
2685 binutils, including assembler and linker.
2687 Installation into a temporary staging area or into a @command{chroot}
2688 jail can be achieved with the command
2690 @smallexample
2691 make DESTDIR=@var{path-to-rootdir} install
2692 @end smallexample
2694 @noindent
2695 where @var{path-to-rootdir} is the absolute path of
2696 a directory relative to which all installation paths will be
2697 interpreted.  Note that the directory specified by @code{DESTDIR}
2698 need not exist yet; it will be created if necessary.
2700 There is a subtle point with tooldirs and @code{DESTDIR}:
2701 If you relocate a cross-compiler installation with
2702 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2703 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2704 be filled with duplicated GCC executables only if it already exists,
2705 it will not be created otherwise.  This is regarded as a feature,
2706 not as a bug, because it gives slightly more control to the packagers
2707 using the @code{DESTDIR} feature.
2709 You can install stripped programs and libraries with
2711 @smallexample
2712 make install-strip
2713 @end smallexample
2715 If you are bootstrapping a released version of GCC then please
2716 quickly review the build status page for your release, available from
2717 @uref{http://gcc.gnu.org/buildstat.html}.
2718 If your system is not listed for the version of GCC that you built,
2719 send a note to
2720 @email{gcc@@gcc.gnu.org} indicating
2721 that you successfully built and installed GCC@.
2722 Include the following information:
2724 @itemize @bullet
2725 @item
2726 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2727 that file itself, just the one-line output from running it.
2729 @item
2730 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2731 This tells us which version of GCC you built and the options you passed to
2732 configure.
2734 @item
2735 Whether you enabled all languages or a subset of them.  If you used a
2736 full distribution then this information is part of the configure
2737 options in the output of @samp{gcc -v}, but if you downloaded the
2738 ``core'' compiler plus additional front ends then it isn't apparent
2739 which ones you built unless you tell us about it.
2741 @item
2742 If the build was for GNU/Linux, also include:
2743 @itemize @bullet
2744 @item
2745 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2746 this information should be available from @file{/etc/issue}.
2748 @item
2749 The version of the Linux kernel, available from @samp{uname --version}
2750 or @samp{uname -a}.
2752 @item
2753 The version of glibc you used; for RPM-based systems like Red Hat,
2754 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2755 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2756 @end itemize
2757 For other systems, you can include similar information if you think it is
2758 relevant.
2760 @item
2761 Any other information that you think would be useful to people building
2762 GCC on the same configuration.  The new entry in the build status list
2763 will include a link to the archived copy of your message.
2764 @end itemize
2766 We'd also like to know if the
2767 @ifnothtml
2768 @ref{Specific, host/target specific installation notes}
2769 @end ifnothtml
2770 @ifhtml
2771 @uref{specific.html,,host/target specific installation notes}
2772 @end ifhtml
2773 didn't include your host/target information or if that information is
2774 incomplete or out of date.  Send a note to
2775 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2777 If you find a bug, please report it following the
2778 @uref{../bugs/,,bug reporting guidelines}.
2780 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2781 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
2782 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2783 subdirectories of @file{@var{objdir}}; these may be converted for
2784 printing with programs such as @command{dvips}.  Alternately, by using
2785 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
2786 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
2787 is included with Texinfo version 4.8 and later.  You can also
2788 @uref{http://shop.fsf.org/,,buy printed manuals from the
2789 Free Software Foundation}, though such manuals may not be for the most
2790 recent version of GCC@.
2792 If you would like to generate online HTML documentation, do @samp{cd
2793 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2794 @file{@var{objdir}/gcc/HTML}.
2796 @html
2797 <hr />
2799 @end html
2800 @ifhtml
2801 @uref{./index.html,,Return to the GCC Installation page}
2802 @end ifhtml
2803 @end ifset
2805 @c ***Binaries****************************************************************
2806 @ifnothtml
2807 @comment node-name,     next,          previous, up
2808 @node    Binaries, Specific, Installing GCC, Top
2809 @end ifnothtml
2810 @ifset binarieshtml
2811 @ifnothtml
2812 @chapter Installing GCC: Binaries
2813 @end ifnothtml
2814 @cindex Binaries
2815 @cindex Installing GCC: Binaries
2817 We are often asked about pre-compiled versions of GCC@.  While we cannot
2818 provide these for all platforms, below you'll find links to binaries for
2819 various platforms where creating them by yourself is not easy due to various
2820 reasons.
2822 Please note that we did not create these binaries, nor do we
2823 support them.  If you have any problems installing them, please
2824 contact their makers.
2826 @itemize
2827 @item
2828 AIX:
2829 @itemize
2830 @item
2831 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2833 @item
2834 @uref{http://pware.hvcc.edu,,Hudson Valley Community College Open Source Software for IBM System p};
2836 @item
2837 @uref{http://www.perzl.org/aix/,,AIX 5L and 6 Open Source Packages}.
2838 @end itemize
2840 @item
2841 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2843 @item
2844 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2845 Development Tools for the Renesas H8/300[HS] Series}.
2847 @item
2848 HP-UX:
2849 @itemize
2850 @item
2851 @uref{http://hpux.connect.org.uk/,,HP-UX Porting Center};
2853 @item
2854 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2855 @end itemize
2857 @item
2858 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2859 OpenServer/Unixware}.
2861 @item
2862 Solaris 2 (SPARC, Intel):
2863 @itemize
2864 @item
2865 @uref{http://www.sunfreeware.com/,,Sunfreeware}
2867 @item
2868 @uref{http://www.blastwave.org/,,Blastwave}
2870 @item
2871 @uref{http://www.opencsw.org/,,OpenCSW}
2873 @item
2874 @uref{http://jupiterrise.com/tgcware/,,TGCware}
2875 @end itemize
2877 @item
2878 SGI IRIX:
2879 @itemize
2880 @item
2881 @uref{http://nekochan.net/,,Nekoware}
2883 @item
2884 @uref{http://jupiterrise.com/tgcware/,,TGCware}
2885 @end itemize
2887 @item
2888 Microsoft Windows:
2889 @itemize
2890 @item
2891 The @uref{http://sourceware.org/cygwin/,,Cygwin} project;
2892 @item
2893 The @uref{http://www.mingw.org/,,MinGW} project.
2894 @end itemize
2896 @item
2897 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2898 Written Word} offers binaries for
2899 AIX 4.3.3, 5.1 and 5.2,
2900 IRIX 6.5,
2901 Tru64 UNIX 4.0D and 5.1,
2902 GNU/Linux (i386),
2903 HP-UX 10.20, 11.00, and 11.11, and
2904 Solaris/SPARC 2.5.1, 2.6, 7, 8, 9 and 10.
2906 @item
2907 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2908 number of platforms.
2910 @item
2911 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2912 links to GNU Fortran binaries for several platforms.
2913 @end itemize
2915 @html
2916 <hr />
2918 @end html
2919 @ifhtml
2920 @uref{./index.html,,Return to the GCC Installation page}
2921 @end ifhtml
2922 @end ifset
2924 @c ***Specific****************************************************************
2925 @ifnothtml
2926 @comment node-name,     next,          previous, up
2927 @node    Specific, Old, Binaries, Top
2928 @end ifnothtml
2929 @ifset specifichtml
2930 @ifnothtml
2931 @chapter Host/target specific installation notes for GCC
2932 @end ifnothtml
2933 @cindex Specific
2934 @cindex Specific installation notes
2935 @cindex Target specific installation
2936 @cindex Host specific installation
2937 @cindex Target specific installation notes
2939 Please read this document carefully @emph{before} installing the
2940 GNU Compiler Collection on your machine.
2942 Note that this list of install notes is @emph{not} a list of supported
2943 hosts or targets.  Not all supported hosts and targets are listed
2944 here, only the ones that require host-specific or target-specific
2945 information are.
2947 @ifhtml
2948 @itemize
2949 @item
2950 @uref{#alpha-x-x,,alpha*-*-*}
2951 @item
2952 @uref{#alpha-dec-osf51,,alpha*-dec-osf5.1}
2953 @item
2954 @uref{#arm-x-elf,,arm-*-elf}
2955 @item
2956 @uref{#avr,,avr}
2957 @item
2958 @uref{#bfin,,Blackfin}
2959 @item
2960 @uref{#dos,,DOS}
2961 @item
2962 @uref{#x-x-freebsd,,*-*-freebsd*}
2963 @item
2964 @uref{#h8300-hms,,h8300-hms}
2965 @item
2966 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2967 @item
2968 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2969 @item
2970 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2971 @item
2972 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2973 @item
2974 @uref{#ix86-x-linux,,i?86-*-linux*}
2975 @item
2976 @uref{#ix86-x-solaris289,,i?86-*-solaris2.[89]}
2977 @item
2978 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2979 @item
2980 @uref{#ia64-x-linux,,ia64-*-linux}
2981 @item
2982 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2983 @item
2984 @uref{#x-ibm-aix,,*-ibm-aix*}
2985 @item
2986 @uref{#iq2000-x-elf,,iq2000-*-elf}
2987 @item
2988 @uref{#lm32-x-elf,,lm32-*-elf}
2989 @item
2990 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
2991 @item
2992 @uref{#m32c-x-elf,,m32c-*-elf}
2993 @item
2994 @uref{#m32r-x-elf,,m32r-*-elf}
2995 @item
2996 @uref{#m68k-x-x,,m68k-*-*}
2997 @item
2998 @uref{#m68k-uclinux,,m68k-uclinux}
2999 @item
3000 @uref{#mep-x-elf,,mep-*-elf}
3001 @item
3002 @uref{#microblaze-x-elf,,microblaze-*-elf}
3003 @item
3004 @uref{#mips-x-x,,mips-*-*}
3005 @item
3006 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
3007 @item
3008 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
3009 @item
3010 @uref{#powerpc-x-x,,powerpc*-*-*}
3011 @item
3012 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
3013 @item
3014 @uref{#powerpc-x-elf,,powerpc-*-elf}
3015 @item
3016 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
3017 @item
3018 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
3019 @item
3020 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
3021 @item
3022 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
3023 @item
3024 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
3025 @item
3026 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
3027 @item
3028 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
3029 @item
3030 @uref{#s390-x-linux,,s390-*-linux*}
3031 @item
3032 @uref{#s390x-x-linux,,s390x-*-linux*}
3033 @item
3034 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
3035 @item
3036 @uref{#x-x-solaris2,,*-*-solaris2*}
3037 @item
3038 @uref{#sparc-x-x,,sparc*-*-*}
3039 @item
3040 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
3041 @item
3042 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
3043 @item
3044 @uref{#sparc-x-linux,,sparc-*-linux*}
3045 @item
3046 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
3047 @item
3048 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
3049 @item
3050 @uref{#x-x-vxworks,,*-*-vxworks*}
3051 @item
3052 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
3053 @item
3054 @uref{#xtensa-x-elf,,xtensa*-*-elf}
3055 @item
3056 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
3057 @item
3058 @uref{#windows,,Microsoft Windows}
3059 @item
3060 @uref{#x-x-cygwin,,*-*-cygwin}
3061 @item
3062 @uref{#x-x-interix,,*-*-interix}
3063 @item
3064 @uref{#x-x-mingw32,,*-*-mingw32}
3065 @item
3066 @uref{#os2,,OS/2}
3067 @item
3068 @uref{#older,,Older systems}
3069 @end itemize
3071 @itemize
3072 @item
3073 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
3074 @end itemize
3075 @end ifhtml
3078 @html
3079 <!-- -------- host/target specific issues start here ---------------- -->
3080 <hr />
3081 @end html
3082 @heading @anchor{alpha-x-x}alpha*-*-*
3084 This section contains general configuration information for all
3085 alpha-based platforms using ELF (in particular, ignore this section for
3086 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
3087 section, please read all other sections that match your target.
3089 We require binutils 2.11.2 or newer.
3090 Previous binutils releases had a number of problems with DWARF 2
3091 debugging information, not the least of which is incorrect linking of
3092 shared libraries.
3094 @html
3095 <hr />
3096 @end html
3097 @heading @anchor{alpha-dec-osf51}alpha*-dec-osf5.1
3098 Systems using processors that implement the DEC Alpha architecture and
3099 are running the DEC/Compaq/HP Unix (DEC OSF/1, Digital UNIX, or Compaq/HP
3100 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
3102 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
3103 supported.  (These are the versions which identify themselves as DEC
3104 OSF/1.)  As of GCC 4.6, support for Tru64 UNIX V4.0 and V5.0 has been
3105 removed.
3107 On Tru64 UNIX, virtual memory exhausted bootstrap failures
3108 may be fixed by reconfiguring Kernel Virtual Memory and Swap parameters
3109 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
3110 or applying the patch in
3111 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.  Depending on
3112 the OS version used, you need a data segment size between 512 MB and
3113 1 GB, so simply use @command{ulimit -Sd unlimited}.
3115 As of GNU binutils 2.21, neither GNU @command{as} nor GNU @command{ld}
3116 are supported on Tru64 UNIX, so you must not configure GCC with
3117 @option{--with-gnu-as} or @option{--with-gnu-ld}.
3119 Cross-compilers for the Tru64 UNIX target currently do not work because
3120 the auxiliary programs @command{mips-tdump} and @command{mips-tfile} can't
3121 be compiled on anything but Tru64 UNIX.
3123 GCC writes a @samp{.verstamp} directive to the assembler output file
3124 unless it is built as a cross-compiler.  It gets the version to use from
3125 the system header file @file{/usr/include/stamp.h}.  If you install a
3126 new version of Tru64 UNIX, you should rebuild GCC to pick up the new version
3127 stamp.
3129 GCC now supports both the native (ECOFF) debugging format used by DBX
3130 and GDB and an encapsulated STABS format for use only with GDB@.  See the
3131 discussion of the @option{--with-stabs} option of @file{configure} above
3132 for more information on these formats and how to select them.
3133 @c FIXME: does this work at all?  If so, perhaps make default.
3135 There is a bug in DEC's assembler that produces incorrect line numbers
3136 for ECOFF format when the @samp{.align} directive is used.  To work
3137 around this problem, GCC will not emit such alignment directives
3138 while writing ECOFF format debugging information even if optimization is
3139 being performed.  Unfortunately, this has the very undesirable
3140 side-effect that code addresses when @option{-O} is specified are
3141 different depending on whether or not @option{-g} is also specified.
3143 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
3144 DBX@.  DEC is now aware of this problem with the assembler and hopes to
3145 provide a fix shortly.
3147 @c FIXME: still applicable?
3149 @html
3150 <hr />
3151 @end html
3152 @heading @anchor{arm-x-elf}arm-*-elf
3153 ARM-family processors.  Subtargets that use the ELF object format
3154 require GNU binutils 2.13 or newer.  Such subtargets include:
3155 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux}
3156 and @code{arm-*-rtems}.
3158 @html
3159 <hr />
3160 @end html
3161 @heading @anchor{avr}avr
3163 ATMEL AVR-family micro controllers.  These are used in embedded
3164 applications.  There are no standard Unix configurations.
3165 @ifnothtml
3166 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3167 Collection (GCC)},
3168 @end ifnothtml
3169 @ifhtml
3170 See ``AVR Options'' in the main manual
3171 @end ifhtml
3172 for the list of supported MCU types.
3174 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3176 Further installation notes and other useful information about AVR tools
3177 can also be obtained from:
3179 @itemize @bullet
3180 @item
3181 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3182 @item
3183 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3184 @end itemize
3186 We @emph{strongly} recommend using binutils 2.13 or newer.
3188 The following error:
3189 @smallexample
3190 Error: register required
3191 @end smallexample
3193 indicates that you should upgrade to a newer version of the binutils.
3195 @html
3196 <hr />
3197 @end html
3198 @heading @anchor{bfin}Blackfin
3200 The Blackfin processor, an Analog Devices DSP.
3201 @ifnothtml
3202 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3203 Collection (GCC)},
3204 @end ifnothtml
3205 @ifhtml
3206 See ``Blackfin Options'' in the main manual
3207 @end ifhtml
3209 More information, and a version of binutils with support for this processor,
3210 is available at @uref{http://blackfin.uclinux.org}
3212 @html
3213 <hr />
3214 @end html
3215 @heading @anchor{cris}CRIS
3217 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3218 series.  These are used in embedded applications.
3220 @ifnothtml
3221 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3222 Collection (GCC)},
3223 @end ifnothtml
3224 @ifhtml
3225 See ``CRIS Options'' in the main manual
3226 @end ifhtml
3227 for a list of CRIS-specific options.
3229 There are a few different CRIS targets:
3230 @table @code
3231 @item cris-axis-elf
3232 Mainly for monolithic embedded systems.  Includes a multilib for the
3233 @samp{v10} core used in @samp{ETRAX 100 LX}.
3234 @item cris-axis-linux-gnu
3235 A GNU/Linux port for the CRIS architecture, currently targeting
3236 @samp{ETRAX 100 LX} by default.
3237 @end table
3239 For @code{cris-axis-elf} you need binutils 2.11
3240 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
3242 Pre-packaged tools can be obtained from
3243 @uref{ftp://ftp.axis.com/@/pub/@/axis/@/tools/@/cris/@/compiler-kit/}.  More
3244 information about this platform is available at
3245 @uref{http://developer.axis.com/}.
3247 @html
3248 <hr />
3249 @end html
3250 @heading @anchor{dos}DOS
3252 Please have a look at the @uref{binaries.html,,binaries page}.
3254 You cannot install GCC by itself on MSDOS; it will not compile under
3255 any MSDOS compiler except itself.  You need to get the complete
3256 compilation package DJGPP, which includes binaries as well as sources,
3257 and includes all the necessary compilation tools and libraries.
3259 @html
3260 <hr />
3261 @end html
3262 @heading @anchor{x-x-freebsd}*-*-freebsd*
3264 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3265 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3266 discontinued in GCC 4.0.
3268 In order to better utilize FreeBSD base system functionality and match
3269 the configuration of the system compiler, GCC 4.5 and above as well as
3270 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3271 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3272 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3273 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3274 by GCC 4.5 and above.
3276 We support FreeBSD using the ELF file format with DWARF 2 debugging
3277 for all CPU architectures.  You may use @option{-gstabs} instead of
3278 @option{-g}, if you really want the old debugging format.  There are
3279 no known issues with mixing object files and libraries with different
3280 debugging formats.  Otherwise, this release of GCC should now match
3281 more of the configuration used in the stock FreeBSD configuration of
3282 GCC@.  In particular, @option{--enable-threads} is now configured by
3283 default.  However, as a general user, do not attempt to replace the
3284 system compiler with this release.  Known to bootstrap and check with
3285 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3286 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3287 4.5, 4.8, 4.9 and 5-CURRENT@.
3289 The version of binutils installed in @file{/usr/bin} probably works
3290 with this release of GCC@.  Bootstrapping against the latest GNU
3291 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3292 been known to enable additional features and improve overall testsuite
3293 results.  However, it is currently known that boehm-gc (which itself
3294 is required for java) may not configure properly on FreeBSD prior to
3295 the FreeBSD 7.0 release with GNU binutils after 2.16.1.
3297 @html
3298 <hr />
3299 @end html
3300 @heading @anchor{h8300-hms}h8300-hms
3301 Renesas H8/300 series of processors.
3303 Please have a look at the @uref{binaries.html,,binaries page}.
3305 The calling convention and structure layout has changed in release 2.6.
3306 All code must be recompiled.  The calling convention now passes the
3307 first three arguments in function calls in registers.  Structures are no
3308 longer a multiple of 2 bytes.
3310 @html
3311 <hr />
3312 @end html
3313 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
3314 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3316 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3317 later is recommended.
3319 It may be helpful to configure GCC with the
3320 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3321 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3323 The HP assembler should not be used with GCC.  It is rarely tested and may
3324 not work.  It shouldn't be used with any languages other than C due to its
3325 many limitations.
3327 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3328 format which GCC does not know about).  It also inserts timestamps
3329 into each object file it creates, causing the 3-stage comparison test to
3330 fail during a bootstrap.  You should be able to continue by saying
3331 @samp{make all-host all-target} after getting the failure from @samp{make}.
3333 Various GCC features are not supported.  For example, it does not support weak
3334 symbols or alias definitions.  As a result, explicit template instantiations
3335 are required when using C++.  This makes it difficult if not impossible to
3336 build many C++ applications.
3338 There are two default scheduling models for instructions.  These are
3339 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3340 architecture specified for the target machine when configuring.
3341 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3342 the target is a @samp{hppa1*} machine.
3344 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3345 it is important to completely specify the machine architecture when
3346 configuring if you want a model other than PROCESSOR_8000.  The macro
3347 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3348 default scheduling model is desired.
3350 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3351 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3352 This namespace change might cause problems when bootstrapping with
3353 an earlier version of GCC or the HP compiler as essentially the same
3354 namespace is required for an entire build.  This problem can be avoided
3355 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3356 or @samp{98}.  Another way is to add an appropriate set of predefines
3357 to @env{CC}.  The description for the @option{munix=} option contains
3358 a list of the predefines used with each standard.
3360 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3362 @html
3363 <hr />
3364 @end html
3365 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
3367 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3368 @code{PHCO_19798} from HP@.
3370 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3371 used for one-only code and data.  This resolves many of the previous
3372 problems in using C++ on this target.  However, the ABI is not compatible
3373 with the one implemented under HP-UX 11 using secondary definitions.
3375 @html
3376 <hr />
3377 @end html
3378 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
3380 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3381 be used to compile GCC 3.0 and up.
3383 The libffi and libjava libraries haven't been ported to 64-bit HP-UX@
3384 and don't build.
3386 Refer to @uref{binaries.html,,binaries} for information about obtaining
3387 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3388 to build the Ada language as it can't be bootstrapped using C@.  Ada is
3389 only available for the 32-bit PA-RISC runtime.
3391 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3392 bundled compiler supports only traditional C; you will need either HP's
3393 unbundled compiler, or a binary distribution of GCC@.
3395 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3396 but the process requires several steps.  GCC 3.3 can then be used to
3397 build later versions.  The fastjar program contains ISO C code and
3398 can't be built with the HP bundled compiler.  This problem can be
3399 avoided by not building the Java language.  For example, use the
3400 @option{--enable-languages="c,c++,f77,objc"} option in your configure
3401 command.
3403 There are several possible approaches to building the distribution.
3404 Binutils can be built first using the HP tools.  Then, the GCC
3405 distribution can be built.  The second approach is to build GCC
3406 first using the HP tools, then build binutils, then rebuild GCC@.
3407 There have been problems with various binary distributions, so it
3408 is best not to start from a binary distribution.
3410 On 64-bit capable systems, there are two distinct targets.  Different
3411 installation prefixes must be used if both are to be installed on
3412 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3413 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3414 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3415 PA-RISC 2.0 architecture.
3417 The script config.guess now selects the target type based on the compiler
3418 detected during configuration.  You must define @env{PATH} or @env{CC} so
3419 that configure finds an appropriate compiler for the initial bootstrap.
3420 When @env{CC} is used, the definition should contain the options that are
3421 needed whenever @env{CC} is used.
3423 Specifically, options that determine the runtime architecture must be
3424 in @env{CC} to correctly select the target for the build.  It is also
3425 convenient to place many other compiler options in @env{CC}.  For example,
3426 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3427 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3428 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3429 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3430 macro definition table of cpp needs to be increased for a successful
3431 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3432 be defined when building with the bundled compiler, or when using the
3433 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3435 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3436 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3437 search for ld.  The two linkers supported on this target require different
3438 commands.  The default linker is determined during configuration.  As a
3439 result, it's not possible to switch linkers in the middle of a GCC build.
3440 This has been reported to sometimes occur in unified builds of binutils
3441 and GCC@.
3443 A recent linker patch must be installed for the correct operation of
3444 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3445 oldest linker patches that are known to work.  They are for HP-UX
3446 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3447 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3448 patches have been superseded.  Consult the HP patch database to obtain
3449 the currently recommended linker patch for your system.
3451 The patches are necessary for the support of weak symbols on the
3452 32-bit port, and for the running of initializers and finalizers.  Weak
3453 symbols are implemented using SOM secondary definition symbols.  Prior
3454 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3455 The patches correct a problem of linker core dumps creating shared
3456 libraries containing secondary symbols, as well as various other
3457 linking issues involving secondary symbols.
3459 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3460 run initializers and finalizers on the 64-bit port.  The 32-bit port
3461 uses the linker @option{+init} and @option{+fini} options for the same
3462 purpose.  The patches correct various problems with the +init/+fini
3463 options, including program core dumps.  Binutils 2.14 corrects a
3464 problem on the 64-bit port resulting from HP's non-standard use of
3465 the .init and .fini sections for array initializers and finalizers.
3467 Although the HP and GNU linkers are both supported for the
3468 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3469 HP linker be used for link editing on this target.
3471 At this time, the GNU linker does not support the creation of long
3472 branch stubs.  As a result, it can't successfully link binaries
3473 containing branch offsets larger than 8 megabytes.  In addition,
3474 there are problems linking shared libraries, linking executables
3475 with @option{-static}, and with dwarf2 unwind and exception support.
3476 It also doesn't provide stubs for internal calls to global functions
3477 in shared libraries, so these calls can't be overloaded.
3479 The HP dynamic loader does not support GNU symbol versioning, so symbol
3480 versioning is not supported.  It may be necessary to disable symbol
3481 versioning with @option{--disable-symvers} when using GNU ld.
3483 POSIX threads are the default.  The optional DCE thread library is not
3484 supported, so @option{--enable-threads=dce} does not work.
3486 @html
3487 <hr />
3488 @end html
3489 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
3491 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3492 in glibc 2.2.5 and later.  More information is available in the
3493 libstdc++-v3 documentation.
3495 @html
3496 <hr />
3497 @end html
3498 @heading @anchor{ix86-x-linux}i?86-*-linux*
3500 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3501 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3503 If you receive Signal 11 errors when building on GNU/Linux, then it is
3504 possible you have a hardware problem.  Further information on this can be
3505 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3507 @html
3508 <hr />
3509 @end html
3510 @heading @anchor{ix86-x-solaris289}i?86-*-solaris2.[89]
3511 The Sun assembler in Solaris 8 and 9 has several bugs and limitations.
3512 While GCC works around them, several features are missing, so it is
3513 @c FIXME: which ones?
3514 recommended to use the GNU assembler instead.  There is no bundled
3515 version, but the current version, from GNU binutils 2.21, is known to
3516 work.
3518 Solaris@tie{}2/x86 doesn't support the execution of SSE/SSE2 instructions
3519 before Solaris@tie{}9 4/04, even if the CPU supports them.  Programs will
3520 receive @code{SIGILL} if they try.  The fix is available both in
3521 Solaris@tie{}9 Update@tie{}6 and kernel patch 112234-12 or newer.  There is no
3522 corresponding patch for Solaris 8.  To avoid this problem,
3523 @option{-march} defaults to @samp{pentiumpro} on Solaris 8 and 9.  If
3524 you have the patch installed, you can configure GCC with an appropriate
3525 @option{--with-arch} option, but need GNU @command{as} for SSE2 support.
3527 @html
3528 <hr />
3529 @end html
3530 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3531 Use this for Solaris 10 or later on x86 and x86-64 systems.  This
3532 configuration is supported by GCC 4.0 and later versions only.  Unlike
3533 @samp{sparcv9-sun-solaris2*}, there is no corresponding 64-bit
3534 configuration like @samp{amd64-*-solaris2*} or @samp{x86_64-*-solaris2*}.
3535 @c FIXME: will there ever be?
3537 It is recommended that you configure GCC to use the GNU assembler, in
3538 @file{/usr/sfw/bin/gas}.  The versions included in Solaris 10, from GNU
3539 binutils 2.15, and Solaris 11, from GNU binutils 2.19, work fine,
3540 although the current version, from GNU binutils
3541 2.21, is known to work, too.  Recent versions of the Sun assembler in
3542 @file{/usr/ccs/bin/as} work almost as well, though.
3543 @c FIXME: as patch requirements?
3545 For linking, the Sun linker, is preferred.  If you want to use the GNU
3546 linker instead, which is available in @file{/usr/sfw/bin/gld}, note that
3547 due to a packaging bug the version in Solaris 10, from GNU binutils
3548 2.15, cannot be used, while the version in Solaris 11, from GNU binutils
3549 2.19, works, as does the latest version, from GNU binutils 2.21.
3551 To use GNU @command{as}, configure with the options
3552 @option{--with-gnu-as --with-as=@//usr/@/sfw/@/bin/@/gas}.  It may be necessary
3553 to configure with @option{--without-gnu-ld --with-ld=@//usr/@/ccs/@/bin/@/ld} to
3554 guarantee use of Sun @command{ld}.
3555 @c FIXME: why --without-gnu-ld --with-ld?
3557 @html
3558 <hr />
3559 @end html
3560 @heading @anchor{ia64-x-linux}ia64-*-linux
3561 IA-64 processor (also known as IPF, or Itanium Processor Family)
3562 running GNU/Linux.
3564 If you are using the installed system libunwind library with
3565 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3566 later.
3568 None of the following versions of GCC has an ABI that is compatible
3569 with any of the other versions in this list, with the exception that
3570 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3571 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3572 This primarily affects C++ programs and programs that create shared libraries.
3573 GCC 3.1 or later is recommended for compiling linux, the kernel.
3574 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3575 more major ABI changes are expected.
3577 @html
3578 <hr />
3579 @end html
3580 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3581 Building GCC on this target requires the GNU Assembler.  The bundled HP
3582 assembler will not work.  To prevent GCC from using the wrong assembler,
3583 the option @option{--with-gnu-as} may be necessary.
3585 The GCC libunwind library has not been ported to HPUX@.  This means that for
3586 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3587 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3588 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3589 removed and the system libunwind library will always be used.
3591 @html
3592 <hr />
3593 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3594 @end html
3595 @heading @anchor{x-ibm-aix}*-ibm-aix*
3596 Support for AIX version 3 and older was discontinued in GCC 3.4.
3597 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3599 ``out of memory'' bootstrap failures may indicate a problem with
3600 process resource limits (ulimit).  Hard limits are configured in the
3601 @file{/etc/security/limits} system configuration file.
3603 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3604 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3605 requires a larger data segment, which can be enabled through the
3606 @var{LDR_CNTRL} environment variable, e.g.,
3608 @smallexample
3609 % LDR_CNTRL=MAXDATA=0x50000000
3610 % export LDR_CNTRL
3611 @end smallexample
3613 One can start with a pre-compiled version of GCC to build from
3614 sources.  One may delete GCC's ``fixed'' header files when starting
3615 with a version of GCC built for an earlier release of AIX.
3617 To speed up the configuration phases of bootstrapping and installing GCC,
3618 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3620 @smallexample
3621 % CONFIG_SHELL=/opt/freeware/bin/bash
3622 % export CONFIG_SHELL
3623 @end smallexample
3625 and then proceed as described in @uref{build.html,,the build
3626 instructions}, where we strongly recommend specifying an absolute path
3627 to invoke @var{srcdir}/configure.
3629 Because GCC on AIX is built as a 32-bit executable by default,
3630 (although it can generate 64-bit programs) the GMP and MPFR libraries
3631 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3632 as static archive libraries works better than shared libraries.
3634 Errors involving @code{alloca} when building GCC generally are due
3635 to an incorrect definition of @code{CC} in the Makefile or mixing files
3636 compiled with the native C compiler and GCC@.  During the stage1 phase of
3637 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3638 (not @command{xlc}).  Once @command{configure} has been informed of
3639 @command{xlc}, one needs to use @samp{make distclean} to remove the
3640 configure cache files and ensure that @env{CC} environment variable
3641 does not provide a definition that will confuse @command{configure}.
3642 If this error occurs during stage2 or later, then the problem most likely
3643 is the version of Make (see above).
3645 The native @command{as} and @command{ld} are recommended for bootstrapping
3646 on AIX@.  The GNU Assembler, GNU Linker, and GNU Binutils version 2.20
3647 is required to bootstrap on AIX 5@.  The native AIX tools do
3648 interoperate with GCC@.
3650 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3651 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3652 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3653 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3655 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3656 shared object and GCC installation places the @file{libstdc++.a}
3657 shared library in a common location which will overwrite the and GCC
3658 3.3 version of the shared library.  Applications either need to be
3659 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3660 versions of the @samp{libstdc++} shared object needs to be available
3661 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3662 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3663 installed for runtime dynamic loading using the following steps to set
3664 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3665 multilib @file{libstdc++.a} installed:
3667 Extract the shared objects from the currently installed
3668 @file{libstdc++.a} archive:
3669 @smallexample
3670 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3671 @end smallexample
3673 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3674 available for runtime dynamic loading, but not linking:
3675 @smallexample
3676 % strip -e libstdc++.so.4 libstdc++.so.5
3677 @end smallexample
3679 Archive the runtime-only shared object in the GCC 3.4
3680 @file{libstdc++.a} archive:
3681 @smallexample
3682 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3683 @end smallexample
3685 Linking executables and shared libraries may produce warnings of
3686 duplicate symbols.  The assembly files generated by GCC for AIX always
3687 have included multiple symbol definitions for certain global variable
3688 and function declarations in the original program.  The warnings should
3689 not prevent the linker from producing a correct library or runnable
3690 executable.
3692 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3693 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3694 to parse archive libraries did not handle the new format correctly.
3695 These routines are used by GCC and result in error messages during
3696 linking such as ``not a COFF file''.  The version of the routines shipped
3697 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3698 option of the archive command may be used to create archives of 32-bit
3699 objects using the original ``small format''.  A correct version of the
3700 routines is shipped with AIX 4.3.2 and above.
3702 Some versions of the AIX binder (linker) can fail with a relocation
3703 overflow severe error when the @option{-bbigtoc} option is used to link
3704 GCC-produced object files into an executable that overflows the TOC@.  A fix
3705 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3706 available from IBM Customer Support and from its
3707 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3708 website as PTF U455193.
3710 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3711 with a segmentation fault when invoked by any version of GCC@.  A fix for
3712 APAR IX87327 is available from IBM Customer Support and from its
3713 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3714 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3716 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3717 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3718 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3719 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3720 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3722 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3723 use NLS to support locale-specific representations of various data
3724 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3725 separating decimal fractions).  There have been problems reported where
3726 GCC does not produce the same floating-point formats that the assembler
3727 expects.  If one encounters this problem, set the @env{LANG}
3728 environment variable to @samp{C} or @samp{En_US}.
3730 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3731 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3733 @html
3734 <hr />
3735 @end html
3736 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3737 Vitesse IQ2000 processors.  These are used in embedded
3738 applications.  There are no standard Unix configurations.
3740 @html
3741 <hr />
3742 @end html
3743 @heading @anchor{lm32-x-elf}lm32-*-elf
3744 Lattice Mico32 processor.
3745 This configuration is intended for embedded systems.
3747 @html
3748 <hr />
3749 @end html
3750 @heading @anchor{lm32-x-uclinux}lm32-*-uclinux
3751 Lattice Mico32 processor.
3752 This configuration is intended for embedded systems running uClinux.
3754 @html
3755 <hr />
3756 @end html
3757 @heading @anchor{m32c-x-elf}m32c-*-elf
3758 Renesas M32C processor.
3759 This configuration is intended for embedded systems.
3761 @html
3762 <hr />
3763 @end html
3764 @heading @anchor{m32r-x-elf}m32r-*-elf
3765 Renesas M32R processor.
3766 This configuration is intended for embedded systems.
3768 @html
3769 <hr />
3770 @end html
3771 @heading @anchor{m68k-x-x}m68k-*-*
3772 By default,
3773 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
3774 @samp{m68k-*-linux}
3775 build libraries for both M680x0 and ColdFire processors.  If you only
3776 need the M680x0 libraries, you can omit the ColdFire ones by passing
3777 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
3778 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
3779 @command{configure}.  These targets default to 5206 or 5475 code as
3780 appropriate for the target system when
3781 configured with @option{--with-arch=cf} and 68020 code otherwise.
3783 The @samp{m68k-*-netbsd} and
3784 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
3785 option.  They will generate ColdFire CFV4e code when configured with
3786 @option{--with-arch=cf} and 68020 code otherwise.
3788 You can override the default processors listed above by configuring
3789 with @option{--with-cpu=@var{target}}.  This @var{target} can either
3790 be a @option{-mcpu} argument or one of the following values:
3791 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
3792 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
3794 GCC requires at least binutils version 2.17 on these targets.
3796 @html
3797 <hr />
3798 @end html
3799 @heading @anchor{m68k-x-uclinux}m68k-*-uclinux
3800 GCC 4.3 changed the uClinux configuration so that it uses the
3801 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
3802 It also added improved support for C++ and flat shared libraries,
3803 both of which were ABI changes.
3806 @html
3807 <hr />
3808 @end html
3809 @heading @anchor{mep-x-elf}mep-*-elf
3810 Toshiba Media embedded Processor.
3811 This configuration is intended for embedded systems.
3813 @html
3814 <hr />
3815 @end html
3816 @heading @anchor{microblaze-x-elf}microblaze-*-elf
3817 Xilinx MicroBlaze processor.
3818 This configuration is intended for embedded systems.
3820 @html
3821 <hr />
3822 @end html
3823 @heading @anchor{mips-x-x}mips-*-*
3824 If on a MIPS system you get an error message saying ``does not have gp
3825 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3826 happens whenever you use GAS with the MIPS linker, but there is not
3827 really anything wrong, and it is okay to use the output file.  You can
3828 stop such warnings by installing the GNU linker.
3830 It would be nice to extend GAS to produce the gp tables, but they are
3831 optional, and there should not be a warning about their absence.
3833 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3834 and later.  A patch went in just after the GCC 3.3 release to
3835 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3836 configure for @samp{mipsel-elf} as a workaround.  The
3837 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3838 work on this is expected in future releases.
3840 @c If you make --with-llsc the default for another target, please also
3841 @c update the description of the --with-llsc option.
3843 The built-in @code{__sync_*} functions are available on MIPS II and
3844 later systems and others that support the @samp{ll}, @samp{sc} and
3845 @samp{sync} instructions.  This can be overridden by passing
3846 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
3847 Since the Linux kernel emulates these instructions if they are
3848 missing, the default for @samp{mips*-*-linux*} targets is
3849 @option{--with-llsc}.  The @option{--with-llsc} and
3850 @option{--without-llsc} configure options may be overridden at compile
3851 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
3852 the compiler.
3854 MIPS systems check for division by zero (unless
3855 @option{-mno-check-zero-division} is passed to the compiler) by
3856 generating either a conditional trap or a break instruction.  Using
3857 trap results in smaller code, but is only supported on MIPS II and
3858 later.  Also, some versions of the Linux kernel have a bug that
3859 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3860 the use of break, use the @option{--with-divide=breaks}
3861 @command{configure} option when configuring GCC@.  The default is to
3862 use traps on systems that support them.
3864 The assembler from GNU binutils 2.17 and earlier has a bug in the way
3865 it sorts relocations for REL targets (o32, o64, EABI).  This can cause
3866 bad code to be generated for simple C++ programs.  Also the linker
3867 from GNU binutils versions prior to 2.17 has a bug which causes the
3868 runtime linker stubs in very large programs, like @file{libgcj.so}, to
3869 be incorrectly generated.  GNU Binutils 2.18 and later (and snapshots
3870 made after Nov. 9, 2006) should be free from both of these problems.
3872 @html
3873 <hr />
3874 @end html
3875 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3877 Support for IRIX 5 has been removed in GCC 4.6.
3879 @html
3880 <hr />
3881 @end html
3882 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3884 Support for IRIX 6 releases before 6.5 has been removed in GCC 4.6, as
3885 well as support for
3886 the O32 ABI.  It is @emph{strongly} recommended to upgrade to at least
3887 IRIX 6.5.18.  This release introduced full ISO C99 support, though for
3888 the N32 and N64 ABIs only.
3890 To build and use GCC on IRIX 6.5, you need the IRIX Development Foundation
3891 (IDF) and IRIX Development Libraries (IDL).  They are included with the
3892 IRIX 6.5 media.
3894 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3895 ensure that the N32 ABI is in use.  To test this, compile a simple C
3896 file with @command{cc} and then run @command{file} on the
3897 resulting object file.  The output should look like:
3899 @smallexample
3900 test.o: ELF N32 MSB @dots{}
3901 @end smallexample
3903 @noindent
3904 If you see:
3906 @smallexample
3907 test.o: ELF 32-bit MSB @dots{}
3908 @end smallexample
3910 @noindent
3913 @smallexample
3914 test.o: ELF 64-bit MSB @dots{}
3915 @end smallexample
3917 @noindent
3918 then your version of @command{cc} uses the O32 or N64 ABI by default.  You
3919 should set the environment variable @env{CC} to @samp{cc -n32}
3920 before configuring GCC@.
3922 If you want the resulting @command{gcc} to run on old 32-bit systems
3923 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3924 instruction set architecture (ISA) is generated.  While GCC 3.x does
3925 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3926 the ISA depending on the machine where GCC is built.  Using one of them
3927 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3928 all on @samp{mips3}-only systems.  For the test program above, you should see:
3930 @smallexample
3931 test.o: ELF N32 MSB mips-3 @dots{}
3932 @end smallexample
3934 @noindent
3935 If you get:
3937 @smallexample
3938 test.o: ELF N32 MSB mips-4 @dots{}
3939 @end smallexample
3941 @noindent
3942 instead, you should set the environment variable @env{CC} to @samp{cc
3943 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3945 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3946 @code{memcmp}.  Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3947 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3949 GCC on IRIX 6.5 is usually built to support the N32 and N64 ABIs.  If
3950 you build GCC on a system that doesn't have the N64 libraries installed
3951 or cannot run 64-bit binaries,
3952 you need to configure with @option{--disable-multilib} so GCC doesn't
3953 try to use them.
3954 Look for @file{/usr/lib64/libc.so.1} to see if you
3955 have the 64-bit libraries installed.
3957 GCC must be configured with GNU @command{as}.  The latest version, from GNU
3958 binutils 2.21, is known to work.  On the other hand, bootstrap fails
3959 with GNU @command{ld} at least since GNU binutils 2.17.
3961 The @option{--enable-libgcj}
3962 option is disabled by default: IRIX 6 uses a very low default limit
3963 (20480) for the command line length.  Although @command{libtool} contains a
3964 workaround for this problem, at least the N64 @samp{libgcj} is known not
3965 to build despite this, running into an internal error of the native
3966 @command{ld}.  A sure fix is to increase this limit (@samp{ncargs}) to
3967 its maximum of 262144 bytes.  If you have root access, you can use the
3968 @command{systune} command to do this.
3969 @c FIXME: does this work with current libtool?
3971 @code{wchar_t} support in @samp{libstdc++} is not available for old
3972 IRIX 6.5.x releases, @math{x < 19}.  The problem cannot be autodetected
3973 and in order to build GCC for such targets you need to configure with
3974 @option{--disable-wchar_t}.
3976 @html
3977 <hr />
3978 @end html
3979 @heading @anchor{moxie-x-elf}moxie-*-elf
3980 The moxie processor.  See @uref{http://moxielogic.org/} for more
3981 information about this processor.
3983 @html
3984 <hr />
3985 @end html
3986 @heading @anchor{powerpc-x-x}powerpc-*-*
3988 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3989 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3991 You will need
3992 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3993 or newer for a working GCC@.
3995 @html
3996 <hr />
3997 @end html
3998 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3999 PowerPC running Darwin (Mac OS X kernel).
4001 Pre-installed versions of Mac OS X may not include any developer tools,
4002 meaning that you will not be able to build GCC from source.  Tool
4003 binaries are available at
4004 @uref{http://opensource.apple.com/}.
4006 This version of GCC requires at least cctools-590.36.  The
4007 cctools-590.36 package referenced from
4008 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
4009 on systems older than 10.3.9 (aka darwin7.9.0).
4011 @html
4012 <hr />
4013 @end html
4014 @heading @anchor{powerpc-x-elf}powerpc-*-elf
4015 PowerPC system in big endian mode, running System V.4.
4017 @html
4018 <hr />
4019 @end html
4020 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
4022 PowerPC system in big endian mode running Linux.
4024 @html
4025 <hr />
4026 @end html
4027 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
4028 PowerPC system in big endian mode running NetBSD@.
4030 @html
4031 <hr />
4032 @end html
4033 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
4034 Embedded PowerPC system in big endian mode for use in running under the
4035 PSIM simulator.
4037 @html
4038 <hr />
4039 @end html
4040 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
4041 Embedded PowerPC system in big endian mode.
4043 @html
4044 <hr />
4045 @end html
4046 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf
4047 PowerPC system in little endian mode, running System V.4.
4049 @html
4050 <hr />
4051 @end html
4052 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
4053 Embedded PowerPC system in little endian mode for use in running under
4054 the PSIM simulator.
4056 @html
4057 <hr />
4058 @end html
4059 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
4060 Embedded PowerPC system in little endian mode.
4062 @html
4063 <hr />
4064 @end html
4065 @heading @anchor{rx-x-elf}rx-*-elf
4066 The Renesas RX processor.  See
4067 @uref{http://eu.renesas.com/fmwk.jsp?cnt=rx600_series_landing.jsp&fp=/products/mpumcu/rx_family/rx600_series}
4068 for more information about this processor.
4070 @html
4071 <hr />
4072 @end html
4073 @heading @anchor{s390-x-linux}s390-*-linux*
4074 S/390 system running GNU/Linux for S/390@.
4076 @html
4077 <hr />
4078 @end html
4079 @heading @anchor{s390x-x-linux}s390x-*-linux*
4080 zSeries system (64-bit) running GNU/Linux for zSeries@.
4082 @html
4083 <hr />
4084 @end html
4085 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
4086 zSeries system (64-bit) running TPF@.  This platform is
4087 supported as cross-compilation target only.
4089 @html
4090 <hr />
4091 @end html
4092 @c Please use Solaris 2 to refer to all release of Solaris, starting
4093 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4094 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4095 @c alone is too unspecific and must be avoided.
4096 @heading @anchor{x-x-solaris2}*-*-solaris2*
4098 Support for Solaris 8 has been obsoleted in GCC 4.7, but can still be
4099 enabled by configuring with @option{--enable-obsolete}.  Support will be
4100 removed in GCC 4.8.  Support for Solaris 7 has been removed in GCC 4.6.
4102 Sun does not ship a C compiler with Solaris 2, though you can download
4103 the Sun Studio compilers for free.  Alternatively,
4104 you can install a pre-built GCC to bootstrap and install GCC.  See the
4105 @uref{binaries.html,,binaries page} for details.
4107 The Solaris 2 @command{/bin/sh} will often fail to configure
4108 @samp{libstdc++-v3}, @samp{boehm-gc} or @samp{libjava}.  We therefore
4109 recommend using the following initial sequence of commands
4111 @smallexample
4112 % CONFIG_SHELL=/bin/ksh
4113 % export CONFIG_SHELL
4114 @end smallexample
4116 @noindent
4117 and proceed as described in @uref{configure.html,,the configure instructions}.
4118 In addition we strongly recommend specifying an absolute path to invoke
4119 @command{@var{srcdir}/configure}.
4121 Solaris 2 comes with a number of optional OS packages.  Some of these
4122 are needed to use GCC fully, namely @code{SUNWarc},
4123 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4124 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4125 optional packages when installing Solaris 2, you will need to verify that
4126 the packages that GCC needs are installed.
4128 To check whether an optional package is installed, use
4129 the @command{pkginfo} command.  To add an optional package, use the
4130 @command{pkgadd} command.  For further details, see the Solaris 2
4131 documentation.
4133 Trying to use the linker and other tools in
4134 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4135 For example, the linker may hang indefinitely.  The fix is to remove
4136 @file{/usr/ucb} from your @env{PATH}.
4138 The build process works more smoothly with the legacy Sun tools so, if you
4139 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4140 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4142 We recommend the use of the Sun assembler or the GNU assembler, in
4143 conjunction with the Sun linker.  The GNU @command{as}
4144 versions included in Solaris 10, from GNU binutils 2.15, and Solaris 11,
4145 from GNU binutils 2.19, are known to work.  They can be found in
4146 @file{/usr/sfw/bin/gas}.  Current versions of GNU binutils (2.21)
4147 are known to work as well.  Note that your mileage may vary
4148 if you use a combination of the GNU tools and the Sun tools: while the
4149 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4150 the reverse combination Sun @command{as} + GNU @command{ld} is known to
4151 cause memory corruption at runtime in some cases for C++ programs.
4152 @c FIXME: still?
4153 GNU @command{ld} usually works as well, although the version included in
4154 Solaris 10 cannot be used due to several bugs.  Again, the current
4155 version (2.21) is known to work, but generally lacks platform specific
4156 features, so better stay with Sun @command{ld}.
4158 To enable symbol versioning in @samp{libstdc++} with Sun @command{ld},
4159 you need to have any version of GNU @command{c++filt}, which is part of
4160 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4161 appropriate version is found.  Sun @command{c++filt} from the Sun Studio
4162 compilers does @emph{not} work.
4164 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
4165 newer: @command{g++} will complain that types are missing.  These headers
4166 assume that omitting the type means @code{int}; this assumption worked for
4167 C90 but is wrong for C++, and is now wrong for C99 also.
4169 @command{g++} accepts such (invalid) constructs with the option
4170 @option{-fpermissive}; it will assume that any missing type is @code{int}
4171 (as defined by C90).
4173 There are patches for Solaris 8 (108652-24 or newer for SPARC,
4174 108653-22 for Intel) that fix this bug.
4176 Sun bug 4927647 sometimes causes random spurious testsuite failures
4177 related to missing diagnostic output.  This bug doesn't affect GCC
4178 itself, rather it is a kernel bug triggered by the @command{expect}
4179 program which is used only by the GCC testsuite driver.  When the bug
4180 causes the @command{expect} program to miss anticipated output, extra
4181 testsuite failures appear.
4183 There are patches for Solaris 8 (117350-12 or newer for SPARC,
4184 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
4185 SPARC, 117172-11 or newer for Intel) that address this problem.
4187 Solaris@tie{}8 provides an alternate implementation of the thread libraries,
4188 @samp{libpthread} and @samp{libthread}.  They are required for TLS
4189 support and have been made the default in Solaris@tie{}9, so they are always
4190 used on Solaris@tie{}8.
4192 Thread-local storage (TLS) is supported in Solaris@tie{}8 and 9, but requires
4193 some patches.  The @samp{libthread} patches provide the
4194 @code{__tls_get_addr} (SPARC, 64-bit x86) resp.@ @code{___tls_get_addr}
4195 (32-bit x86) functions.  On Solaris@tie{}8, you need 108993-26 or newer on
4196 SPARC, 108994-26 or newer on Intel.  On Solaris@tie{}9, the necessary support
4197 on SPARC is present since FCS, while 114432-05 or newer is required on
4198 Intel.  Additionally, on Solaris@tie{}8, patch 109147-14 or newer on SPARC or
4199 109148-22 or newer on Intel are required for the Sun @command{ld} and
4200 runtime linker (@command{ld.so.1}) support.  Again, Solaris@tie{}9/SPARC
4201 works since FCS, while 113986-02 is required on Intel.  The linker
4202 patches must be installed even if GNU @command{ld} is used. Sun
4203 @command{as} in Solaris@tie{}8 and 9 doesn't support the necessary
4204 relocations, so GNU @command{as} must be used.  The @command{configure}
4205 script checks for those prerequisites and automatically enables TLS
4206 support if they are met.  Although those minimal patch versions should
4207 work, it is recommended to use the latest patch versions which include
4208 additional bug fixes.
4210 @html
4211 <hr />
4212 @end html
4213 @heading @anchor{sparc-x-x}sparc*-*-*
4215 This section contains general configuration information for all
4216 SPARC-based platforms.  In addition to reading this section, please
4217 read all other sections that match your target.
4219 Newer versions of the GNU Multiple Precision Library (GMP), the MPFR
4220 library and the MPC library are known to be miscompiled by earlier
4221 versions of GCC on these platforms.  We therefore recommend the use
4222 of the exact versions of these libraries listed as minimal versions
4223 in @uref{prerequisites.html,,the prerequisites}.
4225 @html
4226 <hr />
4227 @end html
4228 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
4230 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4231 produced are smaller than the ones produced using Sun's native tools;
4232 this difference is quite significant for binaries containing debugging
4233 information.
4235 Starting with Solaris 7, the operating system is capable of executing
4236 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4237 this; the @option{-m64} option enables 64-bit code generation.
4238 However, if all you want is code tuned for the UltraSPARC CPU, you
4239 should try the @option{-mtune=ultrasparc} option instead, which produces
4240 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4241 machines.
4243 When configuring on a Solaris 7 or later system that is running a kernel
4244 that supports only 32-bit binaries, one must configure with
4245 @option{--disable-multilib}, since we will not be able to build the
4246 64-bit target libraries.
4248 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
4249 the GNU compiler (especially GCC 3.0.x versions), which lead to the
4250 miscompilation of the stage1 compiler and the subsequent failure of the
4251 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
4252 stage, i.e.@: to bootstrap that compiler with the base compiler and then
4253 use it to bootstrap the final compiler.
4255 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
4256 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
4257 failure in form of a miscompilation of the stage1 compiler by the Sun
4258 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
4260 GCC 3.4 changed the default debugging format from Stabs to DWARF-2 for
4261 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
4262 change apparently runs afoul of Sun bug 4910101 (which is referenced as
4263 an x86-only problem by Sun, probably because they do not use DWARF-2).
4264 A symptom of the problem is that you cannot compile C++ programs like
4265 @command{groff} 1.19.1 without getting messages similar to the following:
4267 @smallexample
4268 ld: warning: relocation error: R_SPARC_UA32: @dots{}
4269   external symbolic relocation against non-allocatable section
4270   .debug_info cannot be processed at runtime: relocation ignored.
4271 @end smallexample
4273 @noindent
4274 To work around this problem, compile with @option{-gstabs+} instead of
4275 plain @option{-g}.
4277 When configuring the GNU Multiple Precision Library (GMP), the MPFR
4278 library or the MPC library on a Solaris 7 or later system, the canonical
4279 target triplet must be specified as the @command{build} parameter on the
4280 configure line.  This target triplet can be obtained by invoking @command{./config.guess} in the toplevel source directory of GCC (and
4281 not that of GMP or MPFR or MPC).  For example on a Solaris 9 system:
4283 @smallexample
4284 % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4285 @end smallexample
4287 @html
4288 <hr />
4289 @end html
4290 @heading @anchor{sparc-sun-solaris210}sparc-sun-solaris2.10
4292 There is a bug in older versions of the Sun assembler which breaks
4293 thread-local storage (TLS).  A typical error message is
4295 @smallexample
4296 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4297   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4298 @end smallexample
4300 @noindent
4301 This bug is fixed in Sun patch 118683-03 or later.
4303 @html
4304 <hr />
4305 @end html
4306 @heading @anchor{sparc-x-linux}sparc-*-linux*
4308 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
4309 or newer on this platform.  All earlier binutils and glibc
4310 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
4313 @html
4314 <hr />
4315 @end html
4316 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
4318 When configuring the GNU Multiple Precision Library (GMP) or the
4319 MPFR library, the canonical target triplet must be specified as
4320 the @command{build} parameter on the configure line.  For example
4321 on a Solaris 9 system:
4323 @smallexample
4324 % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4325 @end smallexample
4327 The following compiler flags must be specified in the configure
4328 step in order to bootstrap this target with the Sun compiler:
4330 @smallexample
4331 % CC="cc -xarch=v9 -xildoff" @var{srcdir}/configure [@var{options}] [@var{target}]
4332 @end smallexample
4334 @noindent
4335 @option{-xarch=v9} specifies the SPARC-V9 architecture to the Sun toolchain
4336 and @option{-xildoff} turns off the incremental linker.
4338 @html
4339 <hr />
4340 @end html
4341 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
4343 This is a synonym for @samp{sparc64-*-solaris2*}.
4345 @html
4346 <hr />
4347 @end html
4348 @heading @anchor{x-x-vxworks}*-*-vxworks*
4349 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4350 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4351 We welcome patches for other architectures supported by VxWorks 5.5.
4352 Support for VxWorks AE would also be welcome; we believe this is merely
4353 a matter of writing an appropriate ``configlette'' (see below).  We are
4354 not interested in supporting older, a.out or COFF-based, versions of
4355 VxWorks in GCC 3.
4357 VxWorks comes with an older version of GCC installed in
4358 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4359 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4360 Before running @command{configure}, create the directories @file{@var{prefix}}
4361 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4362 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4363 include that directory while running both @command{configure} and
4364 @command{make}.
4366 You must give @command{configure} the
4367 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4368 find the VxWorks system headers.  Since VxWorks is a cross compilation
4369 target only, you must also specify @option{--target=@var{target}}.
4370 @command{configure} will attempt to create the directory
4371 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4372 make sure the user running @command{configure} has sufficient privilege
4373 to do so.
4375 GCC's exception handling runtime requires a special ``configlette''
4376 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4377 that file to add the module to your kernel build.  (Future versions of
4378 VxWorks will incorporate this module.)
4380 @html
4381 <hr />
4382 @end html
4383 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
4385 GCC supports the x86-64 architecture implemented by the AMD64 processor
4386 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4387 On GNU/Linux the default is a bi-arch compiler which is able to generate
4388 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4390 @html
4391 <hr />
4392 @end html
4393 @heading @anchor{xtensa-x-elf}xtensa*-*-elf
4395 This target is intended for embedded Xtensa systems using the
4396 @samp{newlib} C library.  It uses ELF but does not support shared
4397 objects.  Designed-defined instructions specified via the
4398 Tensilica Instruction Extension (TIE) language are only supported
4399 through inline assembly.
4401 The Xtensa configuration information must be specified prior to
4402 building GCC@.  The @file{include/xtensa-config.h} header
4403 file contains the configuration information.  If you created your
4404 own Xtensa configuration with the Xtensa Processor Generator, the
4405 downloaded files include a customized copy of this header file,
4406 which you can use to replace the default header file.
4408 @html
4409 <hr />
4410 @end html
4411 @heading @anchor{xtensa-x-linux}xtensa*-*-linux*
4413 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4414 shared objects and the GNU C library (glibc).  It also generates
4415 position-independent code (PIC) regardless of whether the
4416 @option{-fpic} or @option{-fPIC} options are used.  In other
4417 respects, this target is the same as the
4418 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4420 @html
4421 <hr />
4422 @end html
4423 @heading @anchor{windows}Microsoft Windows
4425 @subheading Intel 16-bit versions
4426 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4427 supported.
4429 However, the 32-bit port has limited support for Microsoft
4430 Windows 3.11 in the Win32s environment, as a target only.  See below.
4432 @subheading Intel 32-bit versions
4434 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4435 XP, and Windows Vista, are supported by several different target
4436 platforms.  These targets differ in which Windows subsystem they target
4437 and which C libraries are used.
4439 @itemize
4440 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4441 Linux API emulation layer in the Win32 subsystem.
4442 @item Interix @uref{#x-x-interix,,*-*-interix}: The Interix subsystem
4443 provides native support for POSIX.
4444 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4445 the Win32 subsystem that provides a subset of POSIX.
4446 @item MKS i386-pc-mks: NuTCracker from MKS.  See
4447 @uref{http://www.mkssoftware.com/} for more information.
4448 @end itemize
4450 @subheading Intel 64-bit versions
4452 GCC contains support for x86-64 using the mingw-w64
4453 runtime library, available from @uref{http://mingw-w64.sourceforge.net/}.
4454 This library should be used with the target triple x86_64-pc-mingw32.
4456 Presently Windows for Itanium is not supported.
4458 @subheading Windows CE
4460 Windows CE is supported as a target only on ARM (arm-wince-pe), Hitachi
4461 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4463 @subheading Other Windows Platforms
4465 GCC no longer supports Windows NT on the Alpha or PowerPC.
4467 GCC no longer supports the Windows POSIX subsystem.  However, it does
4468 support the Interix subsystem.  See above.
4470 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4472 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4473 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4475 UWIN support has been removed due to a lack of maintenance.
4477 @html
4478 <hr />
4479 @end html
4480 @heading @anchor{x-x-cygwin}*-*-cygwin
4482 Ports of GCC are included with the
4483 @uref{http://www.cygwin.com/,,Cygwin environment}.
4485 GCC will build under Cygwin without modification; it does not build
4486 with Microsoft's C++ compiler and there are no plans to make it do so.
4488 The Cygwin native compiler can be configured to target any 32-bit x86
4489 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4490 used with as up-to-date a version of binutils as possible; use either
4491 the latest official GNU binutils release in the Cygwin distribution,
4492 or version 2.20 or above if building your own.
4494 @html
4495 <hr />
4496 @end html
4497 @heading @anchor{x-x-interix}*-*-interix
4499 The Interix target is used by OpenNT, Interix, Services For UNIX (SFU),
4500 and Subsystem for UNIX-based Applications (SUA).  Applications compiled
4501 with this target run in the Interix subsystem, which is separate from
4502 the Win32 subsystem.  This target was last known to work in GCC 3.3.
4504 @html
4505 <hr />
4506 @end html
4507 @heading @anchor{x-x-mingw32}*-*-mingw32
4509 GCC will build with and support only MinGW runtime 3.12 and later.
4510 Earlier versions of headers are incompatible with the new default semantics
4511 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4513 @html
4514 <hr />
4515 @end html
4516 @heading @anchor{older}Older systems
4518 GCC contains support files for many older (1980s and early
4519 1990s) Unix variants.  For the most part, support for these systems
4520 has not been deliberately removed, but it has not been maintained for
4521 several years and may suffer from bitrot.
4523 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4524 Support for these systems is still present in that release, but
4525 @command{configure} will fail unless the @option{--enable-obsolete}
4526 option is given.  Unless a maintainer steps forward, support for these
4527 systems will be removed from the next release of GCC@.
4529 Support for old systems as hosts for GCC can cause problems if the
4530 workarounds for compiler, library and operating system bugs affect the
4531 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4532 bring GCC up on such a system, if still possible with current GCC, may
4533 require first installing an old version of GCC which did work on that
4534 system, and using it to compile a more recent GCC, to avoid bugs in the
4535 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4536 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4537 sites}.  Header bugs may generally be avoided using
4538 @command{fixincludes}, but bugs or deficiencies in libraries and the
4539 operating system may still cause problems.
4541 Support for older systems as targets for cross-compilation is less
4542 problematic than support for them as hosts for GCC; if an enthusiast
4543 wishes to make such a target work again (including resurrecting any of
4544 the targets that never worked with GCC 2, starting from the last
4545 version before they were removed), patches
4546 @uref{../contribute.html,,following the usual requirements} would be
4547 likely to be accepted, since they should not affect the support for more
4548 modern targets.
4550 For some systems, old versions of GNU binutils may also be useful,
4551 and are available from @file{pub/binutils/old-releases} on
4552 @uref{http://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4554 Some of the information on specific systems above relates to
4555 such older systems, but much of the information
4556 about GCC on such systems (which may no longer be applicable to
4557 current GCC) is to be found in the GCC texinfo manual.
4559 @html
4560 <hr />
4561 @end html
4562 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
4564 C++ support is significantly better on ELF targets if you use the
4565 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4566 inlines, vtables and template instantiations will be discarded
4567 automatically.
4570 @html
4571 <hr />
4573 @end html
4574 @ifhtml
4575 @uref{./index.html,,Return to the GCC Installation page}
4576 @end ifhtml
4577 @end ifset
4579 @c ***Old documentation******************************************************
4580 @ifset oldhtml
4581 @include install-old.texi
4582 @html
4583 <hr />
4585 @end html
4586 @ifhtml
4587 @uref{./index.html,,Return to the GCC Installation page}
4588 @end ifhtml
4589 @end ifset
4591 @c ***GFDL********************************************************************
4592 @ifset gfdlhtml
4593 @include fdl.texi
4594 @html
4595 <hr />
4597 @end html
4598 @ifhtml
4599 @uref{./index.html,,Return to the GCC Installation page}
4600 @end ifhtml
4601 @end ifset
4603 @c ***************************************************************************
4604 @c Part 6 The End of the Document
4605 @ifinfo
4606 @comment node-name,     next,          previous, up
4607 @node    Concept Index, , GNU Free Documentation License, Top
4608 @end ifinfo
4610 @ifinfo
4611 @unnumbered Concept Index
4613 @printindex cp
4615 @contents
4616 @end ifinfo
4617 @bye