some parsey update
[official-gcc.git] / gcc / doc / install.texi
blobfc9b988ef8c77f941ff9c3ac13f9c3e56cd8f458
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 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 GNU Multiple Precision Library (GMP) version 4.3.2 (or later)
308 Necessary to build GCC@.  If you do not have it installed in your
309 library search path, you will have to configure with the
310 @option{--with-gmp} configure option.  See also @option{--with-gmp-lib}
311 and @option{--with-gmp-include}.  Alternatively, if a GMP source
312 distribution is found in a subdirectory of your GCC sources named
313 @file{gmp}, it will be built together with GCC@.
315 @item MPFR Library version 2.4.2 (or later)
317 Necessary to build GCC@.  It can be downloaded from
318 @uref{http://www.mpfr.org/}.  The @option{--with-mpfr} configure
319 option should be used if your MPFR Library is not installed in your
320 default library search path.  See also @option{--with-mpfr-lib} and
321 @option{--with-mpfr-include}.  Alternatively, if a MPFR source
322 distribution is found in a subdirectory of your GCC sources named
323 @file{mpfr}, it will be built together with GCC@.
325 @item MPC Library version 0.8.1 (or later)
327 Necessary to build GCC@.  It can be downloaded from
328 @uref{http://www.multiprecision.org/}.  The @option{--with-mpc}
329 configure option should be used if your MPC Library is not installed
330 in your default library search path.  See also @option{--with-mpc-lib}
331 and @option{--with-mpc-include}.  Alternatively, if an MPC source
332 distribution is found in a subdirectory of your GCC sources named
333 @file{mpc}, it will be built together with GCC@.
335 @item Parma Polyhedra Library (PPL) version 0.10
337 Necessary to build GCC with the Graphite loop optimizations.
338 It can be downloaded from @uref{http://www.cs.unipr.it/ppl/Download/}.
340 The @option{--with-ppl} configure option should be used if PPL is not
341 installed in your default library search path.
343 @item CLooG-PPL version 0.15
345 Necessary to build GCC with the Graphite loop optimizations.  It can
346 be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
347 The code in @file{cloog-ppl-0.15.tar.gz} comes from a branch of CLooG
348 available from @uref{http://repo.or.cz/w/cloog-ppl.git}.  CLooG-PPL
349 should be configured with @option{--with-ppl}.
351 The @option{--with-cloog} configure option should be used if CLooG is
352 not installed in your default library search path.
354 @item @command{jar}, or InfoZIP (@command{zip} and @command{unzip})
356 Necessary to build libgcj, the GCJ runtime.
358 @item libelf version 0.8.12 (or later)
360 Necessary to build link-time optimization (LTO) support.  It can be
361 downloaded from @uref{http://www.mr511.de/software/libelf-0.8.12.tar.gz},
362 though it is commonly available in several systems.  The version in
363 IRIX 6.5 doesn't work since it lacks @file{gelf.h}.  The version in
364 Solaris 2 does work.
366 The @option{--with-libelf} configure option should be used if libelf is
367 not installed in your default library search patch.
369 @end table
371 @heading Tools/packages necessary for modifying GCC
372 @table @asis
373 @item autoconf version 2.64
374 @itemx GNU m4 version 1.4.6 (or later)
376 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
377 to regenerate @file{configure} and @file{config.in} files.
379 @item automake version 1.11.1
381 Necessary when modifying a @file{Makefile.am} file to regenerate its
382 associated @file{Makefile.in}.
384 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
385 file.  Specifically this applies to the @file{gcc}, @file{intl},
386 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
387 as any of their subdirectories.
389 For directories that use automake, GCC requires the latest release in
390 the 1.11 series, which is currently 1.11.1.  When regenerating a directory
391 to a newer version, please update all the directories using an older 1.11
392 to the latest released version.
394 @item gettext version 0.14.5 (or later)
396 Needed to regenerate @file{gcc.pot}.
398 @item gperf version 2.7.2 (or later)
400 Necessary when modifying @command{gperf} input files, e.g.@:
401 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
402 @file{gcc/cp/cfns.h}.
404 @item DejaGnu 1.4.4
405 @itemx Expect
406 @itemx Tcl
408 Necessary to run the GCC testsuite; see the section on testing for details.
410 @item autogen version 5.5.4 (or later) and
411 @itemx guile version 1.4.1 (or later)
413 Necessary to regenerate @file{fixinc/fixincl.x} from
414 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
416 Necessary to run @samp{make check} for @file{fixinc}.
418 Necessary to regenerate the top level @file{Makefile.in} file from
419 @file{Makefile.tpl} and @file{Makefile.def}.
421 @item Flex version 2.5.4 (or later)
423 Necessary when modifying @file{*.l} files.
425 Necessary to build GCC during development because the generated output
426 files are not included in the SVN repository.  They are included in
427 releases.
429 @item Texinfo version 4.7 (or later)
431 Necessary for running @command{makeinfo} when modifying @file{*.texi}
432 files to test your changes.
434 Necessary for running @command{make dvi} or @command{make pdf} to
435 create printable documentation in DVI or PDF format.  Texinfo version
436 4.8 or later is required for @command{make pdf}.
438 Necessary to build GCC documentation during development because the
439 generated output files are not included in the SVN repository.  They are
440 included in releases.
442 @item @TeX{} (any working version)
444 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which 
445 are used when running @command{make dvi} or @command{make pdf} to create
446 DVI or PDF files, respectively.
448 @item SVN (any version)
449 @itemx SSH (any version)
451 Necessary to access the SVN repository.  Public releases and weekly
452 snapshots of the development sources are also available via FTP@.
454 @item Perl version 5.6.1 (or later)
456 Necessary when regenerating @file{Makefile} dependencies in libiberty.
457 Necessary when regenerating @file{libiberty/functions.texi}.
458 Necessary when generating manpages from Texinfo manuals.
459 Necessary when targetting Darwin, building @samp{libstdc++},
460 and not using @option{--disable-symvers}.
461 Necessary when targetting Solaris 2 with Sun @command{ld}, building
462 @samp{libstdc++}, and not using @option{--disable-symvers}.  A helper
463 scripts needs @samp{Glob.pm}, which is missing from @command{perl} 5.005
464 included in Solaris~8.  The bundled @command{perl} in Solaris~9 and up
465 works.
466 Used by various scripts to generate some files included in SVN (mainly
467 Unicode-related and rarely changing) from source tables.
469 @item GNU diffutils version 2.7 (or later)
471 Useful when submitting patches for the GCC source code.
473 @item patch version 2.5.4 (or later)
475 Necessary when applying patches, created with @command{diff}, to one's
476 own sources.
478 @item ecj1
479 @itemx gjavah
481 If you wish to modify @file{.java} files in libjava, you will need to
482 configure with @option{--enable-java-maintainer-mode}, and you will need
483 to have executables named @command{ecj1} and @command{gjavah} in your path.
484 The @command{ecj1} executable should run the Eclipse Java compiler via
485 the GCC-specific entry point.  You can download a suitable jar from
486 @uref{ftp://sourceware.org/pub/java/}, or by running the script
487 @command{contrib/download_ecj}.
489 @item antlr.jar version 2.7.1 (or later)
490 @itemx antlr binary
492 If you wish to build the @command{gjdoc} binary in libjava, you will
493 need to have an @file{antlr.jar} library available. The library is
494 searched in system locations but can be configured with
495 @option{--with-antlr-jar=} instead.  When configuring with
496 @option{--enable-java-maintainer-mode}, you will need to have one of
497 the executables named @command{cantlr}, @command{runantlr} or
498 @command{antlr} in your path.
500 @end table
502 @html
503 <hr />
505 @end html
506 @ifhtml
507 @uref{./index.html,,Return to the GCC Installation page}
508 @end ifhtml
509 @end ifset
511 @c ***Downloading the source**************************************************
512 @ifnothtml
513 @comment node-name,     next,          previous, up
514 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
515 @end ifnothtml
516 @ifset downloadhtml
517 @ifnothtml
518 @chapter Downloading GCC
519 @end ifnothtml
520 @cindex Downloading GCC
521 @cindex Downloading the Source
523 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
524 tarballs compressed with @command{gzip} or
525 @command{bzip2}.  It is possible to download a full distribution or specific
526 components.
528 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
529 for information on how to obtain GCC@.
531 The full distribution includes the C, C++, Objective-C, Fortran, Java,
532 and Ada (in the case of GCC 3.1 and later) compilers.  The full
533 distribution also includes runtime libraries for C++, Objective-C,
534 Fortran, and Java.  In GCC 3.0 and later versions, the GNU compiler
535 testsuites are also included in the full distribution.
537 If you choose to download specific components, you must download the core
538 GCC distribution plus any language specific distributions you wish to
539 use.  The core distribution includes the C language front end as well as the
540 shared components.  Each language has a tarball which includes the language
541 front end as well as the language runtime (when appropriate).
543 Unpack the core distribution as well as any language specific
544 distributions in the same directory.
546 If you also intend to build binutils (either to upgrade an existing
547 installation or for use in place of the corresponding tools of your
548 OS), unpack the binutils distribution either in the same directory or
549 a separate one.  In the latter case, add symbolic links to any
550 components of the binutils you intend to build alongside the compiler
551 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
552 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
554 Likewise the GMP, MPFR and MPC libraries can be automatically built
555 together with GCC.  Unpack the GMP, MPFR and/or MPC source
556 distributions in the directory containing the GCC sources and rename
557 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
558 respectively (or use symbolic links with the same name).
560 @html
561 <hr />
563 @end html
564 @ifhtml
565 @uref{./index.html,,Return to the GCC Installation page}
566 @end ifhtml
567 @end ifset
569 @c ***Configuration***********************************************************
570 @ifnothtml
571 @comment node-name,     next,          previous, up
572 @node    Configuration, Building, Downloading the source, Installing GCC
573 @end ifnothtml
574 @ifset configurehtml
575 @ifnothtml
576 @chapter Installing GCC: Configuration
577 @end ifnothtml
578 @cindex Configuration
579 @cindex Installing GCC: Configuration
581 Like most GNU software, GCC must be configured before it can be built.
582 This document describes the recommended configuration procedure
583 for both native and cross targets.
585 We use @var{srcdir} to refer to the toplevel source directory for
586 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
588 If you obtained the sources via SVN, @var{srcdir} must refer to the top
589 @file{gcc} directory, the one where the @file{MAINTAINERS} file can be
590 found, and not its @file{gcc} subdirectory, otherwise the build will fail.
592 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
593 file system, the shell's built-in @command{pwd} command will return
594 temporary pathnames.  Using these can lead to various sorts of build
595 problems.  To avoid this issue, set the @env{PWDCMD} environment
596 variable to an automounter-aware @command{pwd} command, e.g.,
597 @command{pawd} or @samp{amq -w}, during the configuration and build
598 phases.
600 First, we @strong{highly} recommend that GCC be built into a
601 separate directory from the sources which does @strong{not} reside
602 within the source tree.  This is how we generally build GCC; building
603 where @var{srcdir} == @var{objdir} should still work, but doesn't
604 get extensive testing; building where @var{objdir} is a subdirectory
605 of @var{srcdir} is unsupported.
607 If you have previously built GCC in the same directory for a
608 different target machine, do @samp{make distclean} to delete all files
609 that might be invalid.  One of the files this deletes is @file{Makefile};
610 if @samp{make distclean} complains that @file{Makefile} does not exist
611 or issues a message like ``don't know how to make distclean'' it probably
612 means that the directory is already suitably clean.  However, with the
613 recommended method of building in a separate @var{objdir}, you should
614 simply use a different @var{objdir} for each target.
616 Second, when configuring a native system, either @command{cc} or
617 @command{gcc} must be in your path or you must set @env{CC} in
618 your environment before running configure.  Otherwise the configuration
619 scripts may fail.
621 @ignore
622 Note that the bootstrap compiler and the resulting GCC must be link
623 compatible, else the bootstrap will fail with linker errors about
624 incompatible object file formats.  Several multilibed targets are
625 affected by this requirement, see
626 @ifnothtml
627 @ref{Specific, host/target specific installation notes}.
628 @end ifnothtml
629 @ifhtml
630 @uref{specific.html,,host/target specific installation notes}.
631 @end ifhtml
632 @end ignore
634 To configure GCC:
636 @smallexample
637    % mkdir @var{objdir}
638    % cd @var{objdir}
639    % @var{srcdir}/configure [@var{options}] [@var{target}]
640 @end smallexample
642 @heading Distributor options
644 If you will be distributing binary versions of GCC, with modifications
645 to the source code, you should use the options described in this
646 section to make clear that your version contains modifications.
648 @table @code
649 @item --with-pkgversion=@var{version}
650 Specify a string that identifies your package.  You may wish
651 to include a build number or build date.  This version string will be
652 included in the output of @command{gcc --version}.  This suffix does
653 not replace the default version string, only the @samp{GCC} part.
655 The default value is @samp{GCC}.
657 @item --with-bugurl=@var{url}
658 Specify the URL that users should visit if they wish to report a bug.
659 You are of course welcome to forward bugs reported to you to the FSF,
660 if you determine that they are not bugs in your modifications.
662 The default value refers to the FSF's GCC bug tracker.
664 @end table
666 @heading Target specification
667 @itemize @bullet
668 @item
669 GCC has code to correctly determine the correct value for @var{target}
670 for nearly all native systems.  Therefore, we highly recommend you do
671 not provide a configure target when configuring a native compiler.
673 @item
674 @var{target} must be specified as @option{--target=@var{target}}
675 when configuring a cross compiler; examples of valid targets would be
676 m68k-elf, sh-elf, etc.
678 @item
679 Specifying just @var{target} instead of @option{--target=@var{target}}
680 implies that the host defaults to @var{target}.
681 @end itemize
684 @heading Options specification
686 Use @var{options} to override several configure time options for
687 GCC@.  A list of supported @var{options} follows; @samp{configure
688 --help} may list other options, but those not listed below may not
689 work and should not normally be used.
691 Note that each @option{--enable} option has a corresponding
692 @option{--disable} option and that each @option{--with} option has a
693 corresponding @option{--without} option.
695 @table @code
696 @item --prefix=@var{dirname}
697 Specify the toplevel installation
698 directory.  This is the recommended way to install the tools into a directory
699 other than the default.  The toplevel installation directory defaults to
700 @file{/usr/local}.
702 We @strong{highly} recommend against @var{dirname} being the same or a
703 subdirectory of @var{objdir} or vice versa.  If specifying a directory
704 beneath a user's home directory tree, some shells will not expand
705 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
706 @env{$HOME} instead.
708 The following standard @command{autoconf} options are supported.  Normally you
709 should not need to use these options.
710 @table @code
711 @item --exec-prefix=@var{dirname}
712 Specify the toplevel installation directory for architecture-dependent
713 files.  The default is @file{@var{prefix}}.
715 @item --bindir=@var{dirname}
716 Specify the installation directory for the executables called by users
717 (such as @command{gcc} and @command{g++}).  The default is
718 @file{@var{exec-prefix}/bin}.
720 @item --libdir=@var{dirname}
721 Specify the installation directory for object code libraries and
722 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
724 @item --libexecdir=@var{dirname}
725 Specify the installation directory for internal executables of GCC@.
726 The default is @file{@var{exec-prefix}/libexec}.
728 @item --with-slibdir=@var{dirname}
729 Specify the installation directory for the shared libgcc library.  The
730 default is @file{@var{libdir}}.
732 @item --datarootdir=@var{dirname}
733 Specify the root of the directory tree for read-only architecture-independent
734 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
736 @item --infodir=@var{dirname}
737 Specify the installation directory for documentation in info format.
738 The default is @file{@var{datarootdir}/info}.
740 @item --datadir=@var{dirname}
741 Specify the installation directory for some architecture-independent
742 data files referenced by GCC@.  The default is @file{@var{datarootdir}}.
744 @item --docdir=@var{dirname}
745 Specify the installation directory for documentation files (other
746 than Info) for GCC@.  The default is @file{@var{datarootdir}/doc}.
748 @item --htmldir=@var{dirname}
749 Specify the installation directory for HTML documentation files.
750 The default is @file{@var{docdir}}.
752 @item --pdfdir=@var{dirname}
753 Specify the installation directory for PDF documentation files.
754 The default is @file{@var{docdir}}.
756 @item --mandir=@var{dirname}
757 Specify the installation directory for manual pages.  The default is
758 @file{@var{datarootdir}/man}.  (Note that the manual pages are only extracts
759 from the full GCC manuals, which are provided in Texinfo format.  The manpages
760 are derived by an automatic conversion process from parts of the full
761 manual.)
763 @item --with-gxx-include-dir=@var{dirname}
764 Specify
765 the installation directory for G++ header files.  The default depends
766 on other configuration options, and differs between cross and native
767 configurations.
769 @end table
771 @item --program-prefix=@var{prefix}
772 GCC supports some transformations of the names of its programs when
773 installing them.  This option prepends @var{prefix} to the names of
774 programs to install in @var{bindir} (see above).  For example, specifying
775 @option{--program-prefix=foo-} would result in @samp{gcc}
776 being installed as @file{/usr/local/bin/foo-gcc}.
778 @item --program-suffix=@var{suffix}
779 Appends @var{suffix} to the names of programs to install in @var{bindir}
780 (see above).  For example, specifying @option{--program-suffix=-3.1}
781 would result in @samp{gcc} being installed as
782 @file{/usr/local/bin/gcc-3.1}.
784 @item --program-transform-name=@var{pattern}
785 Applies the @samp{sed} script @var{pattern} to be applied to the names
786 of programs to install in @var{bindir} (see above).  @var{pattern} has to
787 consist of one or more basic @samp{sed} editing commands, separated by
788 semicolons.  For example, if you want the @samp{gcc} program name to be
789 transformed to the installed program @file{/usr/local/bin/myowngcc} and
790 the @samp{g++} program name to be transformed to
791 @file{/usr/local/bin/gspecial++} without changing other program names,
792 you could use the pattern
793 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
794 to achieve this effect.
796 All three options can be combined and used together, resulting in more
797 complex conversion patterns.  As a basic rule, @var{prefix} (and
798 @var{suffix}) are prepended (appended) before further transformations
799 can happen with a special transformation script @var{pattern}.
801 As currently implemented, this option only takes effect for native
802 builds; cross compiler binaries' names are not transformed even when a
803 transformation is explicitly asked for by one of these options.
805 For native builds, some of the installed programs are also installed
806 with the target alias in front of their name, as in
807 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
808 before the target alias is prepended to the name---so, specifying
809 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
810 resulting binary would be installed as
811 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
813 As a last shortcoming, none of the installed Ada programs are
814 transformed yet, which will be fixed in some time.
816 @item --with-local-prefix=@var{dirname}
817 Specify the
818 installation directory for local include files.  The default is
819 @file{/usr/local}.  Specify this option if you want the compiler to
820 search directory @file{@var{dirname}/include} for locally installed
821 header files @emph{instead} of @file{/usr/local/include}.
823 You should specify @option{--with-local-prefix} @strong{only} if your
824 site has a different convention (not @file{/usr/local}) for where to put
825 site-specific files.
827 The default value for @option{--with-local-prefix} is @file{/usr/local}
828 regardless of the value of @option{--prefix}.  Specifying
829 @option{--prefix} has no effect on which directory GCC searches for
830 local header files.  This may seem counterintuitive, but actually it is
831 logical.
833 The purpose of @option{--prefix} is to specify where to @emph{install
834 GCC}.  The local header files in @file{/usr/local/include}---if you put
835 any in that directory---are not part of GCC@.  They are part of other
836 programs---perhaps many others.  (GCC installs its own header files in
837 another directory which is based on the @option{--prefix} value.)
839 Both the local-prefix include directory and the GCC-prefix include
840 directory are part of GCC's ``system include'' directories.  Although these
841 two directories are not fixed, they need to be searched in the proper
842 order for the correct processing of the include_next directive.  The
843 local-prefix include directory is searched before the GCC-prefix
844 include directory.  Another characteristic of system include directories
845 is that pedantic warnings are turned off for headers in these directories.
847 Some autoconf macros add @option{-I @var{directory}} options to the
848 compiler command line, to ensure that directories containing installed
849 packages' headers are searched.  When @var{directory} is one of GCC's
850 system include directories, GCC will ignore the option so that system
851 directories continue to be processed in the correct order.  This
852 may result in a search order different from what was specified but the
853 directory will still be searched.
855 GCC automatically searches for ordinary libraries using
856 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
857 used for both GCC and packages, GCC will automatically search for
858 both headers and libraries.  This provides a configuration that is
859 easy to use.  GCC behaves in a manner similar to that when it is
860 installed as a system compiler in @file{/usr}.
862 Sites that need to install multiple versions of GCC may not want to
863 use the above simple configuration.  It is possible to use the
864 @option{--program-prefix}, @option{--program-suffix} and
865 @option{--program-transform-name} options to install multiple versions
866 into a single directory, but it may be simpler to use different prefixes
867 and the @option{--with-local-prefix} option to specify the location of the
868 site-specific files for each version.  It will then be necessary for
869 users to specify explicitly the location of local site libraries
870 (e.g., with @env{LIBRARY_PATH}).
872 The same value can be used for both @option{--with-local-prefix} and
873 @option{--prefix} provided it is not @file{/usr}.  This can be used
874 to avoid the default search of @file{/usr/local/include}.
876 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
877 The directory you use for @option{--with-local-prefix} @strong{must not}
878 contain any of the system's standard header files.  If it did contain
879 them, certain programs would be miscompiled (including GNU Emacs, on
880 certain targets), because this would override and nullify the header
881 file corrections made by the @command{fixincludes} script.
883 Indications are that people who use this option use it based on mistaken
884 ideas of what it is for.  People use it as if it specified where to
885 install part of GCC@.  Perhaps they make this assumption because
886 installing GCC creates the directory.
888 @item --enable-shared[=@var{package}[,@dots{}]]
889 Build shared versions of libraries, if shared libraries are supported on
890 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
891 are enabled by default on all platforms that support shared libraries.
893 If a list of packages is given as an argument, build shared libraries
894 only for the listed packages.  For other packages, only static libraries
895 will be built.  Package names currently recognized in the GCC tree are
896 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
897 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
898 @samp{ada}, @samp{libada}, @samp{libjava} and @samp{libobjc}.
899 Note @samp{libiberty} does not support shared libraries at all.
901 Use @option{--disable-shared} to build only static libraries.  Note that
902 @option{--disable-shared} does not accept a list of package names as
903 argument, only @option{--enable-shared} does.
905 @item @anchor{with-gnu-as}--with-gnu-as
906 Specify that the compiler should assume that the
907 assembler it finds is the GNU assembler.  However, this does not modify
908 the rules to find an assembler and will result in confusion if the
909 assembler found is not actually the GNU assembler.  (Confusion may also
910 result if the compiler finds the GNU assembler but has not been
911 configured with @option{--with-gnu-as}.)  If you have more than one
912 assembler installed on your system, you may want to use this option in
913 connection with @option{--with-as=@var{pathname}} or
914 @option{--with-build-time-tools=@var{pathname}}.
916 The following systems are the only ones where it makes a difference
917 whether you use the GNU assembler.  On any other system,
918 @option{--with-gnu-as} has no effect.
920 @itemize @bullet
921 @item @samp{hppa1.0-@var{any}-@var{any}}
922 @item @samp{hppa1.1-@var{any}-@var{any}}
923 @item @samp{sparc-sun-solaris2.@var{any}}
924 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
925 @end itemize
927 @item @anchor{with-as}--with-as=@var{pathname}
928 Specify that the compiler should use the assembler pointed to by
929 @var{pathname}, rather than the one found by the standard rules to find
930 an assembler, which are:
931 @itemize @bullet
932 @item
933 Unless GCC is being built with a cross compiler, check the
934 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
935 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
936 @var{exec-prefix} defaults to @var{prefix}, which
937 defaults to @file{/usr/local} unless overridden by the
938 @option{--prefix=@var{pathname}} switch described above.  @var{target}
939 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
940 @var{version} denotes the GCC version, such as 3.0.
942 @item
943 If the target system is the same that you are building on, check
944 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
945 Sun Solaris 2).
947 @item
948 Check in the @env{PATH} for a tool whose name is prefixed by the
949 target system triple.
951 @item
952 Check in the @env{PATH} for a tool whose name is not prefixed by the
953 target system triple, if the host and target system triple are
954 the same (in other words, we use a host tool if it can be used for
955 the target as well).
956 @end itemize
958 You may want to use @option{--with-as} if no assembler
959 is installed in the directories listed above, or if you have multiple
960 assemblers installed and want to choose one that is not found by the
961 above rules.
963 @item @anchor{with-gnu-ld}--with-gnu-ld
964 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
965 but for the linker.
967 @item --with-ld=@var{pathname}
968 Same as @uref{#with-as,,@option{--with-as}}
969 but for the linker.
971 @item --with-stabs
972 Specify that stabs debugging
973 information should be used instead of whatever format the host normally
974 uses.  Normally GCC uses the same debug format as the host system.
976 On MIPS based systems and on Alphas, you must specify whether you want
977 GCC to create the normal ECOFF debugging format, or to use BSD-style
978 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
979 format cannot fully handle languages other than C@.  BSD stabs format can
980 handle other languages, but it only works with the GNU debugger GDB@.
982 Normally, GCC uses the ECOFF debugging format by default; if you
983 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
985 No matter which default you choose when you configure GCC, the user
986 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
987 the debug format for a particular compilation.
989 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
990 @option{--with-gas} is used.  It selects use of stabs debugging
991 information embedded in COFF output.  This kind of debugging information
992 supports C++ well; ordinary COFF debugging information does not.
994 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
995 selects use of stabs debugging information embedded in ELF output.  The
996 C++ compiler currently (2.6.0) does not support the DWARF debugging
997 information normally used on 386 SVR4 platforms; stabs provide a
998 workable alternative.  This requires gas and gdb, as the normal SVR4
999 tools can not generate or interpret stabs.
1001 @item --disable-multilib
1002 Specify that multiple target
1003 libraries to support different target variants, calling
1004 conventions, etc.@: should not be built.  The default is to build a
1005 predefined set of them.
1007 Some targets provide finer-grained control over which multilibs are built
1008 (e.g., @option{--disable-softfloat}):
1009 @table @code
1010 @item arc-*-elf*
1011 biendian.
1013 @item arm-*-*
1014 fpu, 26bit, underscore, interwork, biendian, nofmult.
1016 @item m68*-*-*
1017 softfloat, m68881, m68000, m68020.
1019 @item mips*-*-*
1020 single-float, biendian, softfloat.
1022 @item powerpc*-*-*, rs6000*-*-*
1023 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1024 sysv, aix.
1026 @end table
1028 @item --with-multilib-list=@var{list}
1029 @itemx --without-multilib-list
1030 Specify what multilibs to build.
1031 Currently only implemented for sh*-*-*.
1033 @var{list} is a comma separated list of CPU names.  These must be of the
1034 form @code{sh*} or @code{m*} (in which case they match the compiler option
1035 for that processor).  The list should not contain any endian options -
1036 these are handled by @option{--with-endian}.
1038 If @var{list} is empty, then there will be no multilibs for extra
1039 processors.  The multilib for the secondary endian remains enabled.
1041 As a special case, if an entry in the list starts with a @code{!}
1042 (exclamation point), then it is added to the list of excluded multilibs.
1043 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1044 (once the leading @code{!} has been stripped).
1046 If @option{--with-multilib-list} is not given, then a default set of
1047 multilibs is selected based on the value of @option{--target}.  This is
1048 usually the complete set of libraries, but some targets imply a more
1049 specialized subset.
1051 Example 1: to configure a compiler for SH4A only, but supporting both
1052 endians, with little endian being the default:
1053 @smallexample
1054 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1055 @end smallexample
1057 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1058 only little endian SH4AL:
1059 @smallexample
1060 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=sh4al,!mb/m4al
1061 @end smallexample
1063 @item --with-endian=@var{endians}
1064 Specify what endians to use.
1065 Currently only implemented for sh*-*-*.
1067 @var{endians} may be one of the following:
1068 @table @code
1069 @item big
1070 Use big endian exclusively.
1071 @item little
1072 Use little endian exclusively.
1073 @item big,little
1074 Use big endian by default.  Provide a multilib for little endian.
1075 @item little,big
1076 Use little endian by default.  Provide a multilib for big endian.
1077 @end table
1079 @item --enable-threads
1080 Specify that the target
1081 supports threads.  This affects the Objective-C compiler and runtime
1082 library, and exception handling for other languages like C++ and Java.
1083 On some systems, this is the default.
1085 In general, the best (and, in many cases, the only known) threading
1086 model available will be configured for use.  Beware that on some
1087 systems, GCC has not been taught what threading models are generally
1088 available for the system.  In this case, @option{--enable-threads} is an
1089 alias for @option{--enable-threads=single}.
1091 @item --disable-threads
1092 Specify that threading support should be disabled for the system.
1093 This is an alias for @option{--enable-threads=single}.
1095 @item --enable-threads=@var{lib}
1096 Specify that
1097 @var{lib} is the thread support library.  This affects the Objective-C
1098 compiler and runtime library, and exception handling for other languages
1099 like C++ and Java.  The possibilities for @var{lib} are:
1101 @table @code
1102 @item aix
1103 AIX thread support.
1104 @item dce
1105 DCE thread support.
1106 @item gnat
1107 Ada tasking support.  For non-Ada programs, this setting is equivalent
1108 to @samp{single}.  When used in conjunction with the Ada run time, it
1109 causes GCC to use the same thread primitives as Ada uses.  This option
1110 is necessary when using both Ada and the back end exception handling,
1111 which is the default for most Ada targets.
1112 @item mach
1113 Generic MACH thread support, known to work on NeXTSTEP@.  (Please note
1114 that the file needed to support this configuration, @file{gthr-mach.h}, is
1115 missing and thus this setting will cause a known bootstrap failure.)
1116 @item no
1117 This is an alias for @samp{single}.
1118 @item posix
1119 Generic POSIX/Unix98 thread support.
1120 @item posix95
1121 Generic POSIX/Unix95 thread support.
1122 @item rtems
1123 RTEMS thread support.
1124 @item single
1125 Disable thread support, should work for all platforms.
1126 @item solaris
1127 Sun Solaris 2/Unix International thread support.  Only use this if you
1128 really need to use this legacy API instead of the default, @samp{posix}.
1129 @item vxworks
1130 VxWorks thread support.
1131 @item win32
1132 Microsoft Win32 API thread support.
1133 @item nks
1134 Novell Kernel Services thread support.
1135 @end table
1137 @item --enable-tls
1138 Specify that the target supports TLS (Thread Local Storage).  Usually
1139 configure can correctly determine if TLS is supported.  In cases where
1140 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1141 @option{--enable-tls} or @option{--disable-tls}.  This can happen if
1142 the assembler supports TLS but the C library does not, or if the
1143 assumptions made by the configure test are incorrect.
1145 @item --disable-tls
1146 Specify that the target does not support TLS.
1147 This is an alias for @option{--enable-tls=no}.
1149 @item --with-cpu=@var{cpu}
1150 @itemx --with-cpu-32=@var{cpu}
1151 @itemx --with-cpu-64=@var{cpu}
1152 Specify which cpu variant the compiler should generate code for by default.
1153 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1154 This option is only supported on some targets, including ARM, i386, M68k,
1155 PowerPC, and SPARC@.  The @option{--with-cpu-32} and
1156 @option{--with-cpu-64} options specify separate default CPUs for
1157 32-bit and 64-bit modes; these options are only supported for i386,
1158 x86-64 and PowerPC.
1160 @item --with-schedule=@var{cpu}
1161 @itemx --with-arch=@var{cpu}
1162 @itemx --with-arch-32=@var{cpu}
1163 @itemx --with-arch-64=@var{cpu}
1164 @itemx --with-tune=@var{cpu}
1165 @itemx --with-tune-32=@var{cpu}
1166 @itemx --with-tune-64=@var{cpu}
1167 @itemx --with-abi=@var{abi}
1168 @itemx --with-fpu=@var{type}
1169 @itemx --with-float=@var{type}
1170 These configure options provide default values for the @option{-mschedule=},
1171 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1172 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
1173 @option{--with-cpu}, which switches will be accepted and acceptable values
1174 of the arguments depend on the target.
1176 @item --with-mode=@var{mode}
1177 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1178 This option is only supported on ARM targets.
1180 @item --with-fpmath=sse
1181 Specify if the compiler should default to @option{-msse2} and
1182 @option{-mfpmath=sse}.  This option is only supported on i386 and
1183 x86-64 targets.
1185 @item --with-divide=@var{type}
1186 Specify how the compiler should generate code for checking for
1187 division by zero.  This option is only supported on the MIPS target.
1188 The possibilities for @var{type} are:
1189 @table @code
1190 @item traps
1191 Division by zero checks use conditional traps (this is the default on
1192 systems that support conditional traps).
1193 @item breaks
1194 Division by zero checks use the break instruction.
1195 @end table
1197 @c If you make --with-llsc the default for additional targets,
1198 @c update the --with-llsc description in the MIPS section below.
1200 @item --with-llsc
1201 On MIPS targets, make @option{-mllsc} the default when no
1202 @option{-mno-lsc} option is passed.  This is the default for
1203 Linux-based targets, as the kernel will emulate them if the ISA does
1204 not provide them.
1206 @item --without-llsc
1207 On MIPS targets, make @option{-mno-llsc} the default when no
1208 @option{-mllsc} option is passed.
1210 @item --with-synci
1211 On MIPS targets, make @option{-msynci} the default when no
1212 @option{-mno-synci} option is passed.
1214 @item --without-synci 
1215 On MIPS targets, make @option{-mno-synci} the default when no
1216 @option{-msynci} option is passed.  This is the default.
1218 @item --with-mips-plt
1219 On MIPS targets, make use of copy relocations and PLTs.
1220 These features are extensions to the traditional
1221 SVR4-based MIPS ABIs and require support from GNU binutils
1222 and the runtime C library.
1224 @item --enable-__cxa_atexit
1225 Define if you want to use __cxa_atexit, rather than atexit, to
1226 register C++ destructors for local statics and global objects.
1227 This is essential for fully standards-compliant handling of
1228 destructors, but requires __cxa_atexit in libc.  This option is currently
1229 only available on systems with GNU libc.  When enabled, this will cause
1230 @option{-fuse-cxa-atexit} to be passed by default.
1232 @item --enable-target-optspace
1233 Specify that target
1234 libraries should be optimized for code space instead of code speed.
1235 This is the default for the m32r platform.
1237 @item --with-cpp-install-dir=@var{dirname}
1238 Specify that the user visible @command{cpp} program should be installed
1239 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1241 @item --enable-comdat
1242 Enable COMDAT group support.  This is primarily used to override the
1243 automatically detected value.
1245 @item --enable-initfini-array
1246 Force the use of sections @code{.init_array} and @code{.fini_array}
1247 (instead of @code{.init} and @code{.fini}) for constructors and
1248 destructors.  Option @option{--disable-initfini-array} has the
1249 opposite effect.  If neither option is specified, the configure script
1250 will try to guess whether the @code{.init_array} and
1251 @code{.fini_array} sections are supported and, if they are, use them.
1253 @item --enable-build-with-cxx
1254 Build GCC using a C++ compiler rather than a C compiler.  This is an
1255 experimental option which may become the default in a later release.
1257 @item --enable-maintainer-mode
1258 The build rules that regenerate the Autoconf and Automake output files as
1259 well as the GCC master message catalog @file{gcc.pot} are normally
1260 disabled.  This is because it can only be rebuilt if the complete source
1261 tree is present.  If you have changed the sources and want to rebuild the
1262 catalog, configuring with @option{--enable-maintainer-mode} will enable
1263 this.  Note that you need a recent version of the @code{gettext} tools
1264 to do so.
1266 @item --disable-bootstrap
1267 For a native build, the default configuration is to perform
1268 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1269 testing that GCC can compile itself correctly.  If you want to disable
1270 this process, you can configure with @option{--disable-bootstrap}.
1272 @item --enable-bootstrap
1273 In special cases, you may want to perform a 3-stage build
1274 even if the target and host triplets are different.
1275 This is possible when the host can run code compiled for
1276 the target (e.g.@: host is i686-linux, target is i486-linux).
1277 Starting from GCC 4.2, to do this you have to configure explicitly
1278 with @option{--enable-bootstrap}.
1280 @item --enable-generated-files-in-srcdir
1281 Neither the .c and .h files that are generated from Bison and flex nor the
1282 info manuals and man pages that are built from the .texi files are present
1283 in the SVN development tree.  When building GCC from that development tree,
1284 or from one of our snapshots, those generated files are placed in your
1285 build directory, which allows for the source to be in a readonly
1286 directory.
1288 If you configure with @option{--enable-generated-files-in-srcdir} then those
1289 generated files will go into the source directory.  This is mainly intended
1290 for generating release or prerelease tarballs of the GCC sources, since it
1291 is not a requirement that the users of source releases to have flex, Bison,
1292 or makeinfo.
1294 @item --enable-version-specific-runtime-libs
1295 Specify
1296 that runtime libraries should be installed in the compiler specific
1297 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1298 addition, @samp{libstdc++}'s include files will be installed into
1299 @file{@var{libdir}} unless you overruled it by using
1300 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1301 particularly useful if you intend to use several versions of GCC in
1302 parallel.  This is currently supported by @samp{libgfortran},
1303 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1305 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1306 Specify that only a particular subset of compilers and
1307 their runtime libraries should be built.  For a list of valid values for
1308 @var{langN} you can issue the following command in the
1309 @file{gcc} directory of your GCC source tree:@*
1310 @smallexample
1311 grep language= */config-lang.in
1312 @end smallexample
1313 Currently, you can use any of the following:
1314 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran}, @code{java},
1315 @code{objc}, @code{obj-c++}.
1316 Building the Ada compiler has special requirements, see below.
1317 If you do not pass this flag, or specify the option @code{all}, then all
1318 default languages available in the @file{gcc} sub-tree will be configured.
1319 Ada and Objective-C++ are not default languages; the rest are.
1320 Re-defining @code{LANGUAGES} when calling @samp{make} @strong{does not}
1321 work anymore, as those language sub-directories might not have been
1322 configured!
1324 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1325 Specify that a particular subset of compilers and their runtime
1326 libraries should be built with the system C compiler during stage 1 of
1327 the bootstrap process, rather than only in later stages with the
1328 bootstrapped C compiler.  The list of valid values is the same as for
1329 @option{--enable-languages}, and the option @code{all} will select all
1330 of the languages enabled by @option{--enable-languages}.  This option is
1331 primarily useful for GCC development; for instance, when a development
1332 version of the compiler cannot bootstrap due to compiler bugs, or when
1333 one is debugging front ends other than the C front end.  When this
1334 option is used, one can then build the target libraries for the
1335 specified languages with the stage-1 compiler by using @command{make
1336 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1337 for the specified languages using @command{make stage1-start check-gcc}.
1339 @item --disable-libada
1340 Specify that the run-time libraries and tools used by GNAT should not
1341 be built.  This can be useful for debugging, or for compatibility with
1342 previous Ada build procedures, when it was required to explicitly
1343 do a @samp{make -C gcc gnatlib_and_tools}.
1345 @item --disable-libssp
1346 Specify that the run-time libraries for stack smashing protection
1347 should not be built.
1349 @item --disable-libgomp
1350 Specify that the run-time libraries used by GOMP should not be built.
1352 @item --with-dwarf2
1353 Specify that the compiler should
1354 use DWARF 2 debugging information as the default.
1356 @item --enable-targets=all
1357 @itemx --enable-targets=@var{target_list}
1358 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1359 These are compilers that are able to generate either 64-bit or 32-bit
1360 code.  Typically, the corresponding 32-bit target, e.g.@:
1361 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1362 option enables the 32-bit target to be a bi-arch compiler, which is
1363 useful when you want a bi-arch compiler that defaults to 32-bit, and
1364 you are building a bi-arch or multi-arch binutils in a combined tree.
1365 On mips-linux, this will build a tri-arch compiler (ABI o32/n32/64),
1366 defaulted to o32.
1367 Currently, this option only affects sparc-linux, powerpc-linux, x86-linux
1368 and mips-linux.
1370 @item --enable-secureplt
1371 This option enables @option{-msecure-plt} by default for powerpc-linux.
1372 @ifnothtml
1373 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1374 Using the GNU Compiler Collection (GCC)},
1375 @end ifnothtml
1376 @ifhtml
1377 See ``RS/6000 and PowerPC Options'' in the main manual
1378 @end ifhtml
1380 @item --enable-cld
1381 This option enables @option{-mcld} by default for 32-bit x86 targets.
1382 @ifnothtml
1383 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1384 Using the GNU Compiler Collection (GCC)},
1385 @end ifnothtml
1386 @ifhtml
1387 See ``i386 and x86-64 Options'' in the main manual
1388 @end ifhtml
1390 @item --enable-win32-registry
1391 @itemx --enable-win32-registry=@var{key}
1392 @itemx --disable-win32-registry
1393 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1394 to look up installations paths in the registry using the following key:
1396 @smallexample
1397 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1398 @end smallexample
1400 @var{key} defaults to GCC version number, and can be overridden by the
1401 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1402 who use custom installers are encouraged to provide a different key,
1403 perhaps one comprised of vendor name and GCC version number, to
1404 avoid conflict with existing installations.  This feature is enabled
1405 by default, and can be disabled by @option{--disable-win32-registry}
1406 option.  This option has no effect on the other hosts.
1408 @item --nfp
1409 Specify that the machine does not have a floating point unit.  This
1410 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1411 system, @option{--nfp} has no effect.
1413 @item --enable-werror
1414 @itemx --disable-werror
1415 @itemx --enable-werror=yes
1416 @itemx --enable-werror=no
1417 When you specify this option, it controls whether certain files in the
1418 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1419 If you don't specify it, @option{-Werror} is turned on for the main
1420 development trunk.  However it defaults to off for release branches and
1421 final releases.  The specific files which get @option{-Werror} are
1422 controlled by the Makefiles.
1424 @item --enable-checking
1425 @itemx --enable-checking=@var{list}
1426 When you specify this option, the compiler is built to perform internal
1427 consistency checks of the requested complexity.  This does not change the
1428 generated code, but adds error checking within the compiler.  This will
1429 slow down the compiler and may only work properly if you are building
1430 the compiler with GCC@.  This is @samp{yes} by default when building
1431 from SVN or snapshots, but @samp{release} for releases.  The default
1432 for building the stage1 compiler is @samp{yes}.  More control
1433 over the checks may be had by specifying @var{list}.  The categories of
1434 checks available are @samp{yes} (most common checks
1435 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1436 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1437 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1438 Individual checks can be enabled with these flags @samp{assert},
1439 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1440 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1442 The @samp{valgrind} check requires the external @command{valgrind}
1443 simulator, available from @uref{http://valgrind.org/}.  The
1444 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1445 To disable all checking, @samp{--disable-checking} or
1446 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1447 assertions will make the compiler and runtime slightly faster but
1448 increase the risk of undetected internal errors causing wrong code to be
1449 generated.
1451 @item --disable-stage1-checking
1452 @itemx --enable-stage1-checking
1453 @itemx --enable-stage1-checking=@var{list}
1454 If no @option{--enable-checking} option is specified the stage1
1455 compiler will be built with @samp{yes} checking enabled, otherwise
1456 the stage1 checking flags are the same as specified by
1457 @option{--enable-checking}.  To build the stage1 compiler with
1458 different checking options use @option{--enable-stage1-checking}.
1459 The list of checking options is the same as for @option{--enable-checking}.
1460 If your system is too slow or too small to bootstrap a released compiler
1461 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1462 to disable checking for the stage1 compiler.
1464 @item --enable-coverage
1465 @itemx --enable-coverage=@var{level}
1466 With this option, the compiler is built to collect self coverage
1467 information, every time it is run.  This is for internal development
1468 purposes, and only works when the compiler is being built with gcc.  The
1469 @var{level} argument controls whether the compiler is built optimized or
1470 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1471 want to disable optimization, for performance analysis you want to
1472 enable optimization.  When coverage is enabled, the default level is
1473 without optimization.
1475 @item --enable-gather-detailed-mem-stats
1476 When this option is specified more detailed information on memory
1477 allocation is gathered.  This information is printed when using
1478 @option{-fmem-report}.
1480 @item --with-gc
1481 @itemx --with-gc=@var{choice}
1482 With this option you can specify the garbage collector implementation
1483 used during the compilation process.  @var{choice} can be one of
1484 @samp{page} and @samp{zone}, where @samp{page} is the default.
1486 @item --enable-nls
1487 @itemx --disable-nls
1488 The @option{--enable-nls} option enables Native Language Support (NLS),
1489 which lets GCC output diagnostics in languages other than American
1490 English.  Native Language Support is enabled by default if not doing a
1491 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1493 @item --with-included-gettext
1494 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1495 procedure to prefer its copy of GNU @command{gettext}.
1497 @item --with-catgets
1498 If NLS is enabled, and if the host lacks @code{gettext} but has the
1499 inferior @code{catgets} interface, the GCC build procedure normally
1500 ignores @code{catgets} and instead uses GCC's copy of the GNU
1501 @code{gettext} library.  The @option{--with-catgets} option causes the
1502 build procedure to use the host's @code{catgets} in this situation.
1504 @item --with-libiconv-prefix=@var{dir}
1505 Search for libiconv header files in @file{@var{dir}/include} and
1506 libiconv library files in @file{@var{dir}/lib}.
1508 @item --enable-obsolete
1509 Enable configuration for an obsoleted system.  If you attempt to
1510 configure GCC for a system (build, host, or target) which has been
1511 obsoleted, and you do not specify this flag, configure will halt with an
1512 error message.
1514 All support for systems which have been obsoleted in one release of GCC
1515 is removed entirely in the next major release, unless someone steps
1516 forward to maintain the port.
1518 @item --enable-decimal-float
1519 @itemx --enable-decimal-float=yes
1520 @itemx --enable-decimal-float=no
1521 @itemx --enable-decimal-float=bid
1522 @itemx --enable-decimal-float=dpd
1523 @itemx --disable-decimal-float
1524 Enable (or disable) support for the C decimal floating point extension
1525 that is in the IEEE 754-2008 standard.  This is enabled by default only
1526 on PowerPC, i386, and x86_64 GNU/Linux systems.  Other systems may also
1527 support it, but require the user to specifically enable it.  You can
1528 optionally control which decimal floating point format is used (either
1529 @samp{bid} or @samp{dpd}).  The @samp{bid} (binary integer decimal)
1530 format is default on i386 and x86_64 systems, and the @samp{dpd}
1531 (densely packed decimal) format is default on PowerPC systems.
1533 @item --enable-fixed-point
1534 @itemx --disable-fixed-point
1535 Enable (or disable) support for C fixed-point arithmetic.
1536 This option is enabled by default for some targets (such as MIPS) which
1537 have hardware-support for fixed-point operations.  On other targets, you
1538 may enable this option manually.
1540 @item --with-long-double-128
1541 Specify if @code{long double} type should be 128-bit by default on selected
1542 GNU/Linux architectures.  If using @code{--without-long-double-128},
1543 @code{long double} will be by default 64-bit, the same as @code{double} type.
1544 When neither of these configure options are used, the default will be
1545 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1546 64-bit @code{long double} otherwise.
1548 @item --with-gmp=@var{pathname}
1549 @itemx --with-gmp-include=@var{pathname}
1550 @itemx --with-gmp-lib=@var{pathname}
1551 @itemx --with-mpfr=@var{pathname}
1552 @itemx --with-mpfr-include=@var{pathname}
1553 @itemx --with-mpfr-lib=@var{pathname}
1554 @itemx --with-mpc=@var{pathname}
1555 @itemx --with-mpc-include=@var{pathname}
1556 @itemx --with-mpc-lib=@var{pathname}
1557 If you do not have GMP (the GNU Multiple Precision library), the MPFR
1558 library and/or the MPC library installed in a standard location and
1559 you want to build GCC, you can explicitly specify the directory where
1560 they are installed (@samp{--with-gmp=@var{gmpinstalldir}},
1561 @samp{--with-mpfr=@var{mpfrinstalldir}},
1562 @samp{--with-mpc=@var{mpcinstalldir}}).  The
1563 @option{--with-gmp=@var{gmpinstalldir}} option is shorthand for
1564 @option{--with-gmp-lib=@var{gmpinstalldir}/lib} and
1565 @option{--with-gmp-include=@var{gmpinstalldir}/include}.  Likewise the
1566 @option{--with-mpfr=@var{mpfrinstalldir}} option is shorthand for
1567 @option{--with-mpfr-lib=@var{mpfrinstalldir}/lib} and
1568 @option{--with-mpfr-include=@var{mpfrinstalldir}/include}, also the
1569 @option{--with-mpc=@var{mpcinstalldir}} option is shorthand for
1570 @option{--with-mpc-lib=@var{mpcinstalldir}/lib} and
1571 @option{--with-mpc-include=@var{mpcinstalldir}/include}.  If these
1572 shorthand assumptions are not correct, you can use the explicit
1573 include and lib options directly.
1575 @item --with-ppl=@var{pathname}
1576 @itemx --with-ppl-include=@var{pathname}
1577 @itemx --with-ppl-lib=@var{pathname}
1578 @itemx --with-cloog=@var{pathname}
1579 @itemx --with-cloog-include=@var{pathname}
1580 @itemx --with-cloog-lib=@var{pathname}
1581 If you do not have PPL (the Parma Polyhedra Library) and the CLooG
1582 libraries installed in a standard location and you want to build GCC,
1583 you can explicitly specify the directory where they are installed
1584 (@samp{--with-ppl=@var{pplinstalldir}},
1585 @samp{--with-cloog=@var{clooginstalldir}}). The
1586 @option{--with-ppl=@var{pplinstalldir}} option is shorthand for
1587 @option{--with-ppl-lib=@var{pplinstalldir}/lib} and
1588 @option{--with-ppl-include=@var{pplinstalldir}/include}.  Likewise the
1589 @option{--with-cloog=@var{clooginstalldir}} option is shorthand for
1590 @option{--with-cloog-lib=@var{clooginstalldir}/lib} and
1591 @option{--with-cloog-include=@var{clooginstalldir}/include}.  If these
1592 shorthand assumptions are not correct, you can use the explicit
1593 include and lib options directly.
1595 @item --with-host-libstdcxx=@var{linker-args}
1596 If you are linking with a static copy of PPL, you can use this option
1597 to specify how the linker should find the standard C++ library used
1598 internally by PPL.  Typical values of @var{linker-args} might be
1599 @samp{-lstdc++} or @samp{-Wl,-Bstatic,-lstdc++,-Bdynamic -lm}.  If you are
1600 linking with a shared copy of PPL, you probably do not need this
1601 option; shared library dependencies will cause the linker to search
1602 for the standard C++ library automatically.
1604 @item --with-stage1-ldflags=@var{flags}
1605 This option may be used to set linker flags to be used when linking
1606 stage 1 of GCC.  These are also used when linking GCC if configured with
1607 @option{--disable-bootstrap}.  By default no special flags are used.
1609 @item --with-stage1-libs=@var{libs}
1610 This option may be used to set libraries to be used when linking stage 1
1611 of GCC.  These are also used when linking GCC if configured with
1612 @option{--disable-bootstrap}.  The default is the argument to
1613 @option{--with-host-libstdcxx}, if specified.
1615 @item --with-boot-ldflags=@var{flags}
1616 This option may be used to set linker flags to be used when linking
1617 stage 2 and later when bootstrapping GCC.  By default no special flags
1618 are used.
1620 @item --with-boot-libs=@var{libs}
1621 This option may be used to set libraries to be used when linking stage 2
1622 and later when bootstrapping GCC.  The default is the argument to
1623 @option{--with-host-libstdcxx}, if specified.
1625 @item --with-debug-prefix-map=@var{map}
1626 Convert source directory names using @option{-fdebug-prefix-map} when
1627 building runtime libraries.  @samp{@var{map}} is a space-separated
1628 list of maps of the form @samp{@var{old}=@var{new}}.
1630 @item --enable-linker-build-id
1631 Tells GCC to pass @option{--build-id} option to the linker for all final
1632 links (links performed without the @option{-r} or @option{--relocatable}
1633 option), if the linker supports it.  If you specify
1634 @option{--enable-linker-build-id}, but your linker does not
1635 support @option{--build-id} option, a warning is issued and the
1636 @option{--enable-linker-build-id} option is ignored.  The default is off.
1638 @item --enable-gnu-unique-object
1639 @itemx --disable-gnu-unique-object
1640 Tells GCC to use the gnu_unique_object relocation for C++ template
1641 static data members and inline function local statics.  Enabled by
1642 default for a native toolchain with an assembler that accepts it and
1643 GLIBC 2.11 or above, otherwise disabled.
1645 @item --enable-lto
1646 Enable support for link-time optimization (LTO).  This is enabled by
1647 default if a working libelf implementation is found (see
1648 @option{--with-libelf}).
1650 @item --with-libelf=@var{pathname}
1651 @itemx --with-libelf-include=@var{pathname}
1652 @itemx --with-libelf-lib=@var{pathname}
1653 If you do not have libelf installed in a standard location and you
1654 want to enable support for link-time optimization (LTO), you can
1655 explicitly specify the directory where libelf is installed
1656 (@samp{--with-libelf=@var{libelfinstalldir}}).  The
1657 @option{--with-libelf=@var{libelfinstalldir}} option is shorthand for
1658 @option{--with-libelf-include=@var{libelfinstalldir}/include}
1659 @option{--with-libelf-lib=@var{libelfinstalldir}/lib}.
1661 @item --enable-gold
1662 Enable support for using @command{gold} as the linker.  If gold support is
1663 enabled together with @option{--enable-lto}, an additional directory
1664 @file{lto-plugin} will be built.  The code in this directory is a
1665 plugin for gold that allows the link-time optimizer to extract object
1666 files with LTO information out of library archives.  See
1667 @option{-flto} and @option{-fwhopr} for details.
1668 @end table
1670 @subheading Cross-Compiler-Specific Options
1671 The following options only apply to building cross compilers.
1673 @table @code
1674 @item --with-sysroot
1675 @itemx --with-sysroot=@var{dir}
1676 Tells GCC to consider @var{dir} as the root of a tree that contains a
1677 (subset of) the root filesystem of the target operating system.
1678 Target system headers, libraries and run-time object files will be
1679 searched in there.  More specifically, this acts as if
1680 @option{--sysroot=@var{dir}} was added to the default options of the built
1681 compiler.  The specified directory is not copied into the
1682 install tree, unlike the options @option{--with-headers} and
1683 @option{--with-libs} that this option obsoletes.  The default value,
1684 in case @option{--with-sysroot} is not given an argument, is
1685 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1686 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1687 the GCC binaries if the installation tree is moved.
1689 This option affects the system root for the compiler used to build
1690 target libraries (which runs on the build system) and the compiler newly
1691 installed with @code{make install}; it does not affect the compiler which is
1692 used to build GCC itself.
1694 @item --with-build-sysroot
1695 @itemx --with-build-sysroot=@var{dir}
1696 Tells GCC to consider @var{dir} as the system root (see
1697 @option{--with-sysroot}) while building target libraries, instead of
1698 the directory specified with @option{--with-sysroot}.  This option is
1699 only useful when you are already using @option{--with-sysroot}.  You
1700 can use @option{--with-build-sysroot} when you are configuring with
1701 @option{--prefix} set to a directory that is different from the one in
1702 which you are installing GCC and your target libraries.  
1704 This option affects the system root for the compiler used to build
1705 target libraries (which runs on the build system); it does not affect
1706 the compiler which is used to build GCC itself.
1708 @item --with-headers
1709 @itemx --with-headers=@var{dir}
1710 Deprecated in favor of @option{--with-sysroot}.
1711 Specifies that target headers are available when building a cross compiler.
1712 The @var{dir} argument specifies a directory which has the target include
1713 files.  These include files will be copied into the @file{gcc} install
1714 directory.  @emph{This option with the @var{dir} argument is required} when
1715 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1716 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1717 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1718 will be run on these files to make them compatible with GCC@.
1720 @item --without-headers
1721 Tells GCC not use any target headers from a libc when building a cross
1722 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1723 can build the exception handling for libgcc.
1725 @item --with-libs
1726 @itemx --with-libs="@var{dir1} @var{dir2} @dots{} @var{dirN}"
1727 Deprecated in favor of @option{--with-sysroot}.
1728 Specifies a list of directories which contain the target runtime
1729 libraries.  These libraries will be copied into the @file{gcc} install
1730 directory.  If the directory list is omitted, this option has no
1731 effect.
1733 @item --with-newlib
1734 Specifies that @samp{newlib} is
1735 being used as the target C library.  This causes @code{__eprintf} to be
1736 omitted from @file{libgcc.a} on the assumption that it will be provided by
1737 @samp{newlib}.
1739 @item --with-build-time-tools=@var{dir}
1740 Specifies where to find the set of target tools (assembler, linker, etc.)
1741 that will be used while building GCC itself.  This option can be useful
1742 if the directory layouts are different between the system you are building
1743 GCC on, and the system where you will deploy it.
1745 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
1746 assembler and linker in @file{/usr/bin}, and the native tools in a
1747 different path, and build a toolchain that expects to find the
1748 native tools in @file{/usr/bin}.
1750 When you use this option, you should ensure that @var{dir} includes
1751 @command{ar}, @command{as}, @command{ld}, @command{nm},
1752 @command{ranlib} and @command{strip} if necessary, and possibly
1753 @command{objdump}.  Otherwise, GCC may use an inconsistent set of
1754 tools.
1755 @end table
1757 @subheading Java-Specific Options
1759 The following option applies to the build of the Java front end.
1761 @table @code
1762 @item --disable-libgcj
1763 Specify that the run-time libraries
1764 used by GCJ should not be built.  This is useful in case you intend
1765 to use GCJ with some other run-time, or you're going to install it
1766 separately, or it just happens not to build on your particular
1767 machine.  In general, if the Java front end is enabled, the GCJ
1768 libraries will be enabled too, unless they're known to not work on
1769 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1770 may need to port it; in this case, before modifying the top-level
1771 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1772 you may use @option{--enable-libgcj} to override the default.
1774 @end table
1776 The following options apply to building @samp{libgcj}.
1778 @subsubheading General Options
1780 @table @code
1781 @item --enable-java-maintainer-mode
1782 By default the @samp{libjava} build will not attempt to compile the
1783 @file{.java} source files to @file{.class}.  Instead, it will use the
1784 @file{.class} files from the source tree.  If you use this option you
1785 must have executables named @command{ecj1} and @command{gjavah} in your path
1786 for use by the build.  You must use this option if you intend to
1787 modify any @file{.java} files in @file{libjava}.
1789 @item --with-java-home=@var{dirname}
1790 This @samp{libjava} option overrides the default value of the
1791 @samp{java.home} system property.  It is also used to set
1792 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1793 default @samp{java.home} is set to @file{@var{prefix}} and
1794 @samp{sun.boot.class.path} to
1795 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1797 @item --with-ecj-jar=@var{filename}
1798 This option can be used to specify the location of an external jar
1799 file containing the Eclipse Java compiler.  A specially modified
1800 version of this compiler is used by @command{gcj} to parse
1801 @file{.java} source files.  If this option is given, the
1802 @samp{libjava} build will create and install an @file{ecj1} executable
1803 which uses this jar file at runtime.
1805 If this option is not given, but an @file{ecj.jar} file is found in
1806 the topmost source tree at configure time, then the @samp{libgcj}
1807 build will create and install @file{ecj1}, and will also install the
1808 discovered @file{ecj.jar} into a suitable place in the install tree.
1810 If @file{ecj1} is not installed, then the user will have to supply one
1811 on his path in order for @command{gcj} to properly parse @file{.java}
1812 source files.  A suitable jar is available from
1813 @uref{ftp://sourceware.org/pub/java/}.
1815 @item --disable-getenv-properties
1816 Don't set system properties from @env{GCJ_PROPERTIES}.
1818 @item --enable-hash-synchronization
1819 Use a global hash table for monitor locks.  Ordinarily,
1820 @samp{libgcj}'s @samp{configure} script automatically makes
1821 the correct choice for this option for your platform.  Only use
1822 this if you know you need the library to be configured differently.
1824 @item --enable-interpreter
1825 Enable the Java interpreter.  The interpreter is automatically
1826 enabled by default on all platforms that support it.  This option
1827 is really only useful if you want to disable the interpreter
1828 (using @option{--disable-interpreter}).
1830 @item --disable-java-net
1831 Disable java.net.  This disables the native part of java.net only,
1832 using non-functional stubs for native method implementations.
1834 @item --disable-jvmpi
1835 Disable JVMPI support.
1837 @item --disable-libgcj-bc
1838 Disable BC ABI compilation of certain parts of libgcj.  By default,
1839 some portions of libgcj are compiled with @option{-findirect-dispatch}
1840 and @option{-fno-indirect-classes}, allowing them to be overridden at
1841 run-time.
1843 If @option{--disable-libgcj-bc} is specified, libgcj is built without
1844 these options.  This allows the compile-time linker to resolve
1845 dependencies when statically linking to libgcj.  However it makes it
1846 impossible to override the affected portions of libgcj at run-time.
1848 @item --enable-reduced-reflection
1849 Build most of libgcj with @option{-freduced-reflection}.  This reduces
1850 the size of libgcj at the expense of not being able to do accurate
1851 reflection on the classes it contains.  This option is safe if you
1852 know that code using libgcj will never use reflection on the standard
1853 runtime classes in libgcj (including using serialization, RMI or CORBA).
1855 @item --with-ecos
1856 Enable runtime eCos target support.
1858 @item --without-libffi
1859 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1860 support as well, as these require @samp{libffi} to work.
1862 @item --enable-libgcj-debug
1863 Enable runtime debugging code.
1865 @item --enable-libgcj-multifile
1866 If specified, causes all @file{.java} source files to be
1867 compiled into @file{.class} files in one invocation of
1868 @samp{gcj}.  This can speed up build time, but is more
1869 resource-intensive.  If this option is unspecified or
1870 disabled, @samp{gcj} is invoked once for each @file{.java}
1871 file to compile into a @file{.class} file.
1873 @item --with-libiconv-prefix=DIR
1874 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1876 @item --enable-sjlj-exceptions
1877 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1878 @samp{configure} ordinarily picks the correct value based on the platform.
1879 Only use this option if you are sure you need a different setting.
1881 @item --with-system-zlib
1882 Use installed @samp{zlib} rather than that included with GCC@.
1884 @item --with-win32-nlsapi=ansi, unicows or unicode
1885 Indicates how MinGW @samp{libgcj} translates between UNICODE
1886 characters and the Win32 API@.
1888 @item --enable-java-home
1889 If enabled, this creates a JPackage compatible SDK environment during install.
1890 Note that if --enable-java-home is used, --with-arch-directory=ARCH must also
1891 be specified.
1893 @item --with-arch-directory=ARCH
1894 Specifies the name to use for the @file{jre/lib/ARCH} directory in the SDK 
1895 environment created when --enable-java-home is passed. Typical names for this 
1896 directory include i386, amd64, ia64, etc.
1898 @item --with-os-directory=DIR
1899 Specifies the OS directory for the SDK include directory. This is set to auto
1900 detect, and is typically 'linux'.
1902 @item --with-origin-name=NAME
1903 Specifies the JPackage origin name. This defaults to the 'gcj' in
1904 java-1.5.0-gcj.
1906 @item --with-arch-suffix=SUFFIX
1907 Specifies the suffix for the sdk directory. Defaults to the empty string. 
1908 Examples include '.x86_64' in 'java-1.5.0-gcj-1.5.0.0.x86_64'.
1910 @item --with-jvm-root-dir=DIR
1911 Specifies where to install the SDK. Default is $(prefix)/lib/jvm.
1913 @item --with-jvm-jar-dir=DIR
1914 Specifies where to install jars. Default is $(prefix)/lib/jvm-exports.
1916 @item --with-python-dir=DIR
1917 Specifies where to install the Python modules used for aot-compile. DIR should
1918 not include the prefix used in installation. For example, if the Python modules
1919 are to be installed in /usr/lib/python2.5/site-packages, then 
1920 --with-python-dir=/lib/python2.5/site-packages should be passed. If this is
1921 not specified, then the Python modules are installed in $(prefix)/share/python.
1923 @item --enable-aot-compile-rpm
1924 Adds aot-compile-rpm to the list of installed scripts.
1926 @item --enable-browser-plugin
1927 Build the gcjwebplugin web browser plugin.
1929 @table @code
1930 @item ansi
1931 Use the single-byte @code{char} and the Win32 A functions natively,
1932 translating to and from UNICODE when using these functions.  If
1933 unspecified, this is the default.
1935 @item unicows
1936 Use the @code{WCHAR} and Win32 W functions natively.  Adds
1937 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1938 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1939 running built executables.  @file{libunicows.a}, an open-source
1940 import library around Microsoft's @code{unicows.dll}, is obtained from
1941 @uref{http://libunicows.sourceforge.net/}, which also gives details
1942 on getting @file{unicows.dll} from Microsoft.
1944 @item unicode
1945 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
1946 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
1947 only run on Microsoft Windows NT and above.
1948 @end table
1949 @end table
1951 @subsubheading AWT-Specific Options
1953 @table @code
1954 @item --with-x
1955 Use the X Window System.
1957 @item --enable-java-awt=PEER(S)
1958 Specifies the AWT peer library or libraries to build alongside
1959 @samp{libgcj}.  If this option is unspecified or disabled, AWT
1960 will be non-functional.  Current valid values are @option{gtk} and
1961 @option{xlib}.  Multiple libraries should be separated by a
1962 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1964 @item --enable-gtk-cairo
1965 Build the cairo Graphics2D implementation on GTK@.
1967 @item --enable-java-gc=TYPE
1968 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
1970 @item --disable-gtktest
1971 Do not try to compile and run a test GTK+ program.
1973 @item --disable-glibtest
1974 Do not try to compile and run a test GLIB program.
1976 @item --with-libart-prefix=PFX
1977 Prefix where libart is installed (optional).
1979 @item --with-libart-exec-prefix=PFX
1980 Exec prefix where libart is installed (optional).
1982 @item --disable-libarttest
1983 Do not try to compile and run a test libart program.
1985 @end table
1987 @html
1988 <hr />
1990 @end html
1991 @ifhtml
1992 @uref{./index.html,,Return to the GCC Installation page}
1993 @end ifhtml
1994 @end ifset
1996 @c ***Building****************************************************************
1997 @ifnothtml
1998 @comment node-name,     next,          previous, up
1999 @node    Building, Testing, Configuration, Installing GCC
2000 @end ifnothtml
2001 @ifset buildhtml
2002 @ifnothtml
2003 @chapter Building
2004 @end ifnothtml
2005 @cindex Installing GCC: Building
2007 Now that GCC is configured, you are ready to build the compiler and
2008 runtime libraries.
2010 Some commands executed when making the compiler may fail (return a
2011 nonzero status) and be ignored by @command{make}.  These failures, which
2012 are often due to files that were not found, are expected, and can safely
2013 be ignored.
2015 It is normal to have compiler warnings when compiling certain files.
2016 Unless you are a GCC developer, you can generally ignore these warnings
2017 unless they cause compilation to fail.  Developers should attempt to fix
2018 any warnings encountered, however they can temporarily continue past
2019 warnings-as-errors by specifying the configure flag
2020 @option{--disable-werror}.
2022 On certain old systems, defining certain environment variables such as
2023 @env{CC} can interfere with the functioning of @command{make}.
2025 If you encounter seemingly strange errors when trying to build the
2026 compiler in a directory other than the source directory, it could be
2027 because you have previously configured the compiler in the source
2028 directory.  Make sure you have done all the necessary preparations.
2030 If you build GCC on a BSD system using a directory stored in an old System
2031 V file system, problems may occur in running @command{fixincludes} if the
2032 System V file system doesn't support symbolic links.  These problems
2033 result in a failure to fix the declaration of @code{size_t} in
2034 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
2035 that type mismatches occur, this could be the cause.
2037 The solution is not to use such a directory for building GCC@.
2039 Similarly, when building from SVN or snapshots, or if you modify
2040 @file{*.l} files, you need the Flex lexical analyzer generator
2041 installed.  If you do not modify @file{*.l} files, releases contain
2042 the Flex-generated files and you do not need Flex installed to build
2043 them.  There is still one Flex-based lexical analyzer (part of the
2044 build machinery, not of GCC itself) that is used even if you only
2045 build the C front end.
2047 When building from SVN or snapshots, or if you modify Texinfo
2048 documentation, you need version 4.7 or later of Texinfo installed if you
2049 want Info documentation to be regenerated.  Releases contain Info
2050 documentation pre-built for the unmodified documentation in the release.
2052 @section Building a native compiler
2054 For a native build, the default configuration is to perform
2055 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
2056 This will build the entire GCC system and ensure that it compiles
2057 itself correctly.  It can be disabled with the @option{--disable-bootstrap}
2058 parameter to @samp{configure}, but bootstrapping is suggested because
2059 the compiler will be tested more completely and could also have
2060 better performance.
2062 The bootstrapping process will complete the following steps:
2064 @itemize @bullet
2065 @item
2066 Build tools necessary to build the compiler.
2068 @item
2069 Perform a 3-stage bootstrap of the compiler.  This includes building
2070 three times the target tools for use by the compiler such as binutils
2071 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2072 individually linked or moved into the top level GCC source tree before
2073 configuring.
2075 @item
2076 Perform a comparison test of the stage2 and stage3 compilers.
2078 @item
2079 Build runtime libraries using the stage3 compiler from the previous step.
2081 @end itemize
2083 If you are short on disk space you might consider @samp{make
2084 bootstrap-lean} instead.  The sequence of compilation is the
2085 same described above, but object files from the stage1 and
2086 stage2 of the 3-stage bootstrap of the compiler are deleted as
2087 soon as they are no longer needed.
2089 If you wish to use non-default GCC flags when compiling the stage2
2090 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2091 doing @samp{make}.  For example, if you want to save additional space
2092 during the bootstrap and in the final installation as well, you can
2093 build the compiler binaries without debugging information as in the
2094 following example.  This will save roughly 40% of disk space both for
2095 the bootstrap and the final installation.  (Libraries will still contain
2096 debugging information.)
2098 @smallexample
2099      make BOOT_CFLAGS='-O' bootstrap
2100 @end smallexample
2102 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2103 are less well tested here than the default of @samp{-g -O2}, but should
2104 still work.  In a few cases, you may find that you need to specify special
2105 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2106 if the native compiler miscompiles the stage1 compiler, you may need
2107 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2108 of the stage1 compiler that were miscompiled, or by using @samp{make
2109 bootstrap4} to increase the number of stages of bootstrap.
2111 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2112 Since these are always compiled with the compiler currently being
2113 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2114 compilation flags, as for non-bootstrapped target libraries.
2115 Again, if the native compiler miscompiles the stage1 compiler, you may
2116 need to work around this by avoiding non-working parts of the stage1
2117 compiler.  Use @code{STAGE1_TFLAGS} to this end.
2119 If you used the flag @option{--enable-languages=@dots{}} to restrict
2120 the compilers to be built, only those you've actually enabled will be
2121 built.  This will of course only build those runtime libraries, for
2122 which the particular compiler has been built.  Please note,
2123 that re-defining @env{LANGUAGES} when calling @samp{make}
2124 @strong{does not} work anymore!
2126 If the comparison of stage2 and stage3 fails, this normally indicates
2127 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2128 a potentially serious bug which you should investigate and report.  (On
2129 a few systems, meaningful comparison of object files is impossible; they
2130 always appear ``different''.  If you encounter this problem, you will
2131 need to disable comparison in the @file{Makefile}.)
2133 If you do not want to bootstrap your compiler, you can configure with
2134 @option{--disable-bootstrap}.  In particular cases, you may want to
2135 bootstrap your compiler even if the target system is not the same as
2136 the one you are building on: for example, you could build a
2137 @code{powerpc-unknown-linux-gnu} toolchain on a
2138 @code{powerpc64-unknown-linux-gnu} host.  In this case, pass
2139 @option{--enable-bootstrap} to the configure script.
2141 @code{BUILD_CONFIG} can be used to bring in additional customization
2142 to the build.  It can be set to a whitespace-separated list of names.
2143 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2144 be included by the top-level @file{Makefile}, bringing in any settings
2145 it contains.  The default @code{BUILD_CONFIG} can be set using the
2146 configure option @option{--with-build-config=@code{NAME}...}.  Some
2147 examples of supported build configurations are:
2149 @table @asis
2150 @item @samp{bootstrap-O1}
2151 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2152 @option{-O1} to it.  @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2153 @samp{BOOT_CFLAGS='-g -O1'}.
2155 @item @samp{bootstrap-O3}
2156 Analogous to @code{bootstrap-O1}.
2158 @item @samp{bootstrap-lto}
2159 Enables Link-Time Optimization for host tools during bootstrapping.
2160 @samp{BUILD_CONFIG=bootstrap-lto} is equivalent to adding
2161 @option{-flto} to @samp{BOOT_CFLAGS}.
2163 @item @samp{bootstrap-debug}
2164 Verifies that the compiler generates the same executable code, whether
2165 or not it is asked to emit debug information.  To this end, this
2166 option builds stage2 host programs without debug information, and uses
2167 @file{contrib/compare-debug} to compare them with the stripped stage3
2168 object files.  If @code{BOOT_CFLAGS} is overridden so as to not enable
2169 debug information, stage2 will have it, and stage3 won't.  This option
2170 is enabled by default when GCC bootstrapping is enabled, if
2171 @code{strip} can turn object files compiled with and without debug
2172 info into identical object files.  In addition to better test
2173 coverage, this option makes default bootstraps faster and leaner.
2175 @item @samp{bootstrap-debug-big}
2176 Rather than comparing stripped object files, as in
2177 @code{bootstrap-debug}, this option saves internal compiler dumps
2178 during stage2 and stage3 and compares them as well, which helps catch
2179 additional potential problems, but at a great cost in terms of disk
2180 space.  It can be specified in addition to @samp{bootstrap-debug}.
2182 @item @samp{bootstrap-debug-lean}
2183 This option saves disk space compared with @code{bootstrap-debug-big},
2184 but at the expense of some recompilation.  Instead of saving the dumps
2185 of stage2 and stage3 until the final compare, it uses
2186 @option{-fcompare-debug} to generate, compare and remove the dumps
2187 during stage3, repeating the compilation that already took place in
2188 stage2, whose dumps were not saved.
2190 @item @samp{bootstrap-debug-lib}
2191 This option tests executable code invariance over debug information
2192 generation on target libraries, just like @code{bootstrap-debug-lean}
2193 tests it on host programs.  It builds stage3 libraries with
2194 @option{-fcompare-debug}, and it can be used along with any of the
2195 @code{bootstrap-debug} options above.
2197 There aren't @code{-lean} or @code{-big} counterparts to this option
2198 because most libraries are only build in stage3, so bootstrap compares
2199 would not get significant coverage.  Moreover, the few libraries built
2200 in stage2 are used in stage3 host programs, so we wouldn't want to
2201 compile stage2 libraries with different options for comparison purposes.
2203 @item @samp{bootstrap-debug-ckovw}
2204 Arranges for error messages to be issued if the compiler built on any
2205 stage is run without the option @option{-fcompare-debug}.  This is
2206 useful to verify the full @option{-fcompare-debug} testing coverage.  It
2207 must be used along with @code{bootstrap-debug-lean} and
2208 @code{bootstrap-debug-lib}.
2210 @item @samp{bootstrap-time}
2211 Arranges for the run time of each program started by the GCC driver,
2212 built in any stage, to be logged to @file{time.log}, in the top level of
2213 the build tree.
2215 @end table
2217 @section Building a cross compiler
2219 When building a cross compiler, it is not generally possible to do a
2220 3-stage bootstrap of the compiler.  This makes for an interesting problem
2221 as parts of GCC can only be built with GCC@.
2223 To build a cross compiler, we recommend first building and installing a
2224 native compiler.  You can then use the native GCC compiler to build the
2225 cross compiler.  The installed native compiler needs to be GCC version
2226 2.95 or later.
2228 If the cross compiler is to be built with support for the Java
2229 programming language and the ability to compile .java source files is
2230 desired, the installed native compiler used to build the cross
2231 compiler needs to be the same GCC version as the cross compiler.  In
2232 addition the cross compiler needs to be configured with
2233 @option{--with-ecj-jar=@dots{}}.
2235 Assuming you have already installed a native copy of GCC and configured
2236 your cross compiler, issue the command @command{make}, which performs the
2237 following steps:
2239 @itemize @bullet
2240 @item
2241 Build host tools necessary to build the compiler.
2243 @item
2244 Build target tools for use by the compiler such as binutils (bfd,
2245 binutils, gas, gprof, ld, and opcodes)
2246 if they have been individually linked or moved into the top level GCC source
2247 tree before configuring.
2249 @item
2250 Build the compiler (single stage only).
2252 @item
2253 Build runtime libraries using the compiler from the previous step.
2254 @end itemize
2256 Note that if an error occurs in any step the make process will exit.
2258 If you are not building GNU binutils in the same source tree as GCC,
2259 you will need a cross-assembler and cross-linker installed before
2260 configuring GCC@.  Put them in the directory
2261 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
2262 you should put in this directory:
2264 @table @file
2265 @item as
2266 This should be the cross-assembler.
2268 @item ld
2269 This should be the cross-linker.
2271 @item ar
2272 This should be the cross-archiver: a program which can manipulate
2273 archive files (linker libraries) in the target machine's format.
2275 @item ranlib
2276 This should be a program to construct a symbol table in an archive file.
2277 @end table
2279 The installation of GCC will find these programs in that directory,
2280 and copy or link them to the proper place to for the cross-compiler to
2281 find them when run later.
2283 The easiest way to provide these files is to build the Binutils package.
2284 Configure it with the same @option{--host} and @option{--target}
2285 options that you use for configuring GCC, then build and install
2286 them.  They install their executables automatically into the proper
2287 directory.  Alas, they do not support all the targets that GCC
2288 supports.
2290 If you are not building a C library in the same source tree as GCC,
2291 you should also provide the target libraries and headers before
2292 configuring GCC, specifying the directories with
2293 @option{--with-sysroot} or @option{--with-headers} and
2294 @option{--with-libs}.  Many targets also require ``start files'' such
2295 as @file{crt0.o} and
2296 @file{crtn.o} which are linked into each executable.  There may be several
2297 alternatives for @file{crt0.o}, for use with profiling or other
2298 compilation options.  Check your target's definition of
2299 @code{STARTFILE_SPEC} to find out what start files it uses.
2301 @section Building in parallel
2303 GNU Make 3.80 and above, which is necessary to build GCC, support
2304 building in parallel.  To activate this, you can use @samp{make -j 2}
2305 instead of @samp{make}.  You can also specify a bigger number, and 
2306 in most cases using a value greater than the number of processors in
2307 your machine will result in fewer and shorter I/O latency hits, thus
2308 improving overall throughput; this is especially true for slow drives
2309 and network filesystems.
2311 @section Building the Ada compiler
2313 In order to build GNAT, the Ada compiler, you need a working GNAT
2314 compiler (GCC version 4.0 or later).
2315 This includes GNAT tools such as @command{gnatmake} and
2316 @command{gnatlink}, since the Ada front end is written in Ada and
2317 uses some GNAT-specific extensions.
2319 In order to build a cross compiler, it is suggested to install
2320 the new compiler as native first, and then use it to build the cross
2321 compiler.
2323 @command{configure} does not test whether the GNAT installation works
2324 and has a sufficiently recent version; if too old a GNAT version is
2325 installed, the build will fail unless @option{--enable-languages} is
2326 used to disable building the Ada front end.
2328 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2329 must not be set when building the Ada compiler, the Ada tools, or the
2330 Ada runtime libraries. You can check that your build environment is clean
2331 by verifying that @samp{gnatls -v} lists only one explicit path in each
2332 section.
2334 @section Building with profile feedback
2336 It is possible to use profile feedback to optimize the compiler itself.  This
2337 should result in a faster compiler binary.  Experiments done on x86 using gcc
2338 3.3 showed approximately 7 percent speedup on compiling C programs.  To
2339 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2341 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2342 compiler.  This compiler is used to build a @code{stageprofile} compiler
2343 instrumented to collect execution counts of instruction and branch
2344 probabilities.  Then runtime libraries are compiled with profile collected.
2345 Finally a @code{stagefeedback} compiler is built using the information collected.
2347 Unlike standard bootstrap, several additional restrictions apply.  The
2348 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2349 It is recommended to only use GCC for this.  Also parallel make is currently
2350 not supported since collisions in profile collecting may occur.
2352 @html
2353 <hr />
2355 @end html
2356 @ifhtml
2357 @uref{./index.html,,Return to the GCC Installation page}
2358 @end ifhtml
2359 @end ifset
2361 @c ***Testing*****************************************************************
2362 @ifnothtml
2363 @comment node-name,     next,          previous, up
2364 @node    Testing, Final install, Building, Installing GCC
2365 @end ifnothtml
2366 @ifset testhtml
2367 @ifnothtml
2368 @chapter Installing GCC: Testing
2369 @end ifnothtml
2370 @cindex Testing
2371 @cindex Installing GCC: Testing
2372 @cindex Testsuite
2374 Before you install GCC, we encourage you to run the testsuites and to
2375 compare your results with results from a similar configuration that have
2376 been submitted to the
2377 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2378 Some of these archived results are linked from the build status lists
2379 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2380 reports a successful build runs the testsuites and submits the results.
2381 This step is optional and may require you to download additional software,
2382 but it can give you confidence in your new GCC installation or point out
2383 problems before you install and start using your new GCC@.
2385 First, you must have @uref{download.html,,downloaded the testsuites}.
2386 These are part of the full distribution, but if you downloaded the
2387 ``core'' compiler plus any front ends, you must download the testsuites
2388 separately.
2390 Second, you must have the testing tools installed.  This includes
2391 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2392 the DejaGnu site has links to these.
2394 If the directories where @command{runtest} and @command{expect} were
2395 installed are not in the @env{PATH}, you may need to set the following
2396 environment variables appropriately, as in the following example (which
2397 assumes that DejaGnu has been installed under @file{/usr/local}):
2399 @smallexample
2400      TCL_LIBRARY = /usr/local/share/tcl8.0
2401      DEJAGNULIBS = /usr/local/share/dejagnu
2402 @end smallexample
2404 (On systems such as Cygwin, these paths are required to be actual
2405 paths, not mounts or links; presumably this is due to some lack of
2406 portability in the DejaGnu code.)
2409 Finally, you can run the testsuite (which may take a long time):
2410 @smallexample
2411      cd @var{objdir}; make -k check
2412 @end smallexample
2414 This will test various components of GCC, such as compiler
2415 front ends and runtime libraries.  While running the testsuite, DejaGnu
2416 might emit some harmless messages resembling
2417 @samp{WARNING: Couldn't find the global config file.} or
2418 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2420 If you are testing a cross-compiler, you may want to run the testsuite
2421 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2423 @section How can you run the testsuite on selected tests?
2425 In order to run sets of tests selectively, there are targets
2426 @samp{make check-gcc} and @samp{make check-g++}
2427 in the @file{gcc} subdirectory of the object directory.  You can also
2428 just run @samp{make check} in a subdirectory of the object directory.
2431 A more selective way to just run all @command{gcc} execute tests in the
2432 testsuite is to use
2434 @smallexample
2435     make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2436 @end smallexample
2438 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2439 the testsuite with filenames matching @samp{9805*}, you would use
2441 @smallexample
2442     make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2443 @end smallexample
2445 The @file{*.exp} files are located in the testsuite directories of the GCC
2446 source, the most important ones being @file{compile.exp},
2447 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2448 To get a list of the possible @file{*.exp} files, pipe the
2449 output of @samp{make check} into a file and look at the
2450 @samp{Running @dots{}  .exp} lines.
2452 @section Passing options and running multiple testsuites
2454 You can pass multiple options to the testsuite using the
2455 @samp{--target_board} option of DejaGNU, either passed as part of
2456 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2457 work outside the makefiles.  For example,
2459 @smallexample
2460     make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2461 @end smallexample
2463 will run the standard @command{g++} testsuites (``unix'' is the target name
2464 for a standard native testsuite situation), passing
2465 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2466 slashes separate options.
2468 You can run the testsuites multiple times using combinations of options
2469 with a syntax similar to the brace expansion of popular shells:
2471 @smallexample
2472     @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2473 @end smallexample
2475 (Note the empty option caused by the trailing comma in the final group.)
2476 The following will run each testsuite eight times using the @samp{arm-sim}
2477 target, as if you had specified all possible combinations yourself:
2479 @smallexample
2480     --target_board=arm-sim/-mhard-float/-O1
2481     --target_board=arm-sim/-mhard-float/-O2
2482     --target_board=arm-sim/-mhard-float/-O3
2483     --target_board=arm-sim/-mhard-float
2484     --target_board=arm-sim/-msoft-float/-O1
2485     --target_board=arm-sim/-msoft-float/-O2
2486     --target_board=arm-sim/-msoft-float/-O3
2487     --target_board=arm-sim/-msoft-float
2488 @end smallexample
2490 They can be combined as many times as you wish, in arbitrary ways.  This
2491 list:
2493 @smallexample
2494     @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2495 @end smallexample
2497 will generate four combinations, all involving @samp{-Wextra}.
2499 The disadvantage to this method is that the testsuites are run in serial,
2500 which is a waste on multiprocessor systems.  For users with GNU Make and
2501 a shell which performs brace expansion, you can run the testsuites in
2502 parallel by having the shell perform the combinations and @command{make}
2503 do the parallel runs.  Instead of using @samp{--target_board}, use a
2504 special makefile target:
2506 @smallexample
2507     make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2508 @end smallexample
2510 For example,
2512 @smallexample
2513     make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2514 @end smallexample
2516 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2517 ten combinations as described above.  Note that this is currently only
2518 supported in the @file{gcc} subdirectory.  (To see how this works, try
2519 typing @command{echo} before the example given here.)
2522 @section Additional testing for Java Class Libraries
2524 The Java runtime tests can be executed via @samp{make check}
2525 in the @file{@var{target}/libjava/testsuite} directory in
2526 the build tree.
2528 The @uref{http://sourceware.org/mauve/,,Mauve Project} provides
2529 a suite of tests for the Java Class Libraries.  This suite can be run
2530 as part of libgcj testing by placing the Mauve tree within the libjava
2531 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
2532 specifying the location of that tree when invoking @samp{make}, as in
2533 @samp{make MAUVEDIR=~/mauve check}.
2535 @section How to interpret test results
2537 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2538 files in the testsuite subdirectories.  The @file{*.log} files contain a
2539 detailed log of the compiler invocations and the corresponding
2540 results, the @file{*.sum} files summarize the results.  These summaries
2541 contain status codes for all tests:
2543 @itemize @bullet
2544 @item
2545 PASS: the test passed as expected
2546 @item
2547 XPASS: the test unexpectedly passed
2548 @item
2549 FAIL: the test unexpectedly failed
2550 @item
2551 XFAIL: the test failed as expected
2552 @item
2553 UNSUPPORTED: the test is not supported on this platform
2554 @item
2555 ERROR: the testsuite detected an error
2556 @item
2557 WARNING: the testsuite detected a possible problem
2558 @end itemize
2560 It is normal for some tests to report unexpected failures.  At the
2561 current time the testing harness does not allow fine grained control
2562 over whether or not a test is expected to fail.  This problem should
2563 be fixed in future releases.
2566 @section Submitting test results
2568 If you want to report the results to the GCC project, use the
2569 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
2571 @smallexample
2572     @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2573         -m gcc-testresults@@gcc.gnu.org |sh
2574 @end smallexample
2576 This script uses the @command{Mail} program to send the results, so
2577 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
2578 prepended to the testsuite summary and should contain any special
2579 remarks you have on your results or your build environment.  Please
2580 do not edit the testsuite result block or the subject line, as these
2581 messages may be automatically processed.
2583 @html
2584 <hr />
2586 @end html
2587 @ifhtml
2588 @uref{./index.html,,Return to the GCC Installation page}
2589 @end ifhtml
2590 @end ifset
2592 @c ***Final install***********************************************************
2593 @ifnothtml
2594 @comment node-name,     next,          previous, up
2595 @node    Final install, , Testing, Installing GCC
2596 @end ifnothtml
2597 @ifset finalinstallhtml
2598 @ifnothtml
2599 @chapter Installing GCC: Final installation
2600 @end ifnothtml
2602 Now that GCC has been built (and optionally tested), you can install it with
2603 @smallexample
2604 cd @var{objdir}; make install
2605 @end smallexample
2607 We strongly recommend to install into a target directory where there is
2608 no previous version of GCC present.  Also, the GNAT runtime should not
2609 be stripped, as this would break certain features of the debugger that
2610 depend on this debugging information (catching Ada exceptions for
2611 instance).
2613 That step completes the installation of GCC; user level binaries can
2614 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2615 you specified with the @option{--prefix} to configure (or
2616 @file{/usr/local} by default).  (If you specified @option{--bindir},
2617 that directory will be used instead; otherwise, if you specified
2618 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2619 Headers for the C++ and Java libraries are installed in
2620 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2621 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2622 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2623 in info format in @file{@var{infodir}} (normally
2624 @file{@var{prefix}/info}).
2626 When installing cross-compilers, GCC's executables
2627 are not only installed into @file{@var{bindir}}, that
2628 is, @file{@var{exec-prefix}/bin}, but additionally into
2629 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2630 exists.  Typically, such @dfn{tooldirs} hold target-specific
2631 binutils, including assembler and linker.
2633 Installation into a temporary staging area or into a @command{chroot}
2634 jail can be achieved with the command
2636 @smallexample
2637 make DESTDIR=@var{path-to-rootdir} install
2638 @end smallexample
2640 @noindent where @var{path-to-rootdir} is the absolute path of
2641 a directory relative to which all installation paths will be
2642 interpreted.  Note that the directory specified by @code{DESTDIR}
2643 need not exist yet; it will be created if necessary.
2645 There is a subtle point with tooldirs and @code{DESTDIR}:
2646 If you relocate a cross-compiler installation with
2647 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2648 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2649 be filled with duplicated GCC executables only if it already exists,
2650 it will not be created otherwise.  This is regarded as a feature,
2651 not as a bug, because it gives slightly more control to the packagers
2652 using the @code{DESTDIR} feature.
2654 If you are bootstrapping a released version of GCC then please
2655 quickly review the build status page for your release, available from
2656 @uref{http://gcc.gnu.org/buildstat.html}.
2657 If your system is not listed for the version of GCC that you built,
2658 send a note to
2659 @email{gcc@@gcc.gnu.org} indicating
2660 that you successfully built and installed GCC@.
2661 Include the following information:
2663 @itemize @bullet
2664 @item
2665 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2666 that file itself, just the one-line output from running it.
2668 @item
2669 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2670 This tells us which version of GCC you built and the options you passed to
2671 configure.
2673 @item
2674 Whether you enabled all languages or a subset of them.  If you used a
2675 full distribution then this information is part of the configure
2676 options in the output of @samp{gcc -v}, but if you downloaded the
2677 ``core'' compiler plus additional front ends then it isn't apparent
2678 which ones you built unless you tell us about it.
2680 @item
2681 If the build was for GNU/Linux, also include:
2682 @itemize @bullet
2683 @item
2684 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2685 this information should be available from @file{/etc/issue}.
2687 @item
2688 The version of the Linux kernel, available from @samp{uname --version}
2689 or @samp{uname -a}.
2691 @item
2692 The version of glibc you used; for RPM-based systems like Red Hat,
2693 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2694 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2695 @end itemize
2696 For other systems, you can include similar information if you think it is
2697 relevant.
2699 @item
2700 Any other information that you think would be useful to people building
2701 GCC on the same configuration.  The new entry in the build status list
2702 will include a link to the archived copy of your message.
2703 @end itemize
2705 We'd also like to know if the
2706 @ifnothtml
2707 @ref{Specific, host/target specific installation notes}
2708 @end ifnothtml
2709 @ifhtml
2710 @uref{specific.html,,host/target specific installation notes}
2711 @end ifhtml
2712 didn't include your host/target information or if that information is
2713 incomplete or out of date.  Send a note to
2714 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2716 If you find a bug, please report it following the
2717 @uref{../bugs/,,bug reporting guidelines}.
2719 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2720 dvi}.  You will need to have @command{texi2dvi} (version at least 4.7)
2721 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2722 subdirectories of @file{@var{objdir}}; these may be converted for
2723 printing with programs such as @command{dvips}.  Alternately, by using
2724 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
2725 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
2726 is included with Texinfo version 4.8 and later.  You can also
2727 @uref{http://shop.fsf.org/,,buy printed manuals from the
2728 Free Software Foundation}, though such manuals may not be for the most
2729 recent version of GCC@.
2731 If you would like to generate online HTML documentation, do @samp{cd
2732 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2733 @file{@var{objdir}/gcc/HTML}.
2735 @html
2736 <hr />
2738 @end html
2739 @ifhtml
2740 @uref{./index.html,,Return to the GCC Installation page}
2741 @end ifhtml
2742 @end ifset
2744 @c ***Binaries****************************************************************
2745 @ifnothtml
2746 @comment node-name,     next,          previous, up
2747 @node    Binaries, Specific, Installing GCC, Top
2748 @end ifnothtml
2749 @ifset binarieshtml
2750 @ifnothtml
2751 @chapter Installing GCC: Binaries
2752 @end ifnothtml
2753 @cindex Binaries
2754 @cindex Installing GCC: Binaries
2756 We are often asked about pre-compiled versions of GCC@.  While we cannot
2757 provide these for all platforms, below you'll find links to binaries for
2758 various platforms where creating them by yourself is not easy due to various
2759 reasons.
2761 Please note that we did not create these binaries, nor do we
2762 support them.  If you have any problems installing them, please
2763 contact their makers.
2765 @itemize
2766 @item
2767 AIX:
2768 @itemize
2769 @item
2770 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2772 @item
2773 @uref{http://pware.hvcc.edu,,Hudson Valley Community College Open Source Software for IBM System p};
2775 @item
2776 @uref{http://www.perzl.org/aix/,,AIX 5L and 6 Open Source Packages}.
2777 @end itemize
2779 @item
2780 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2782 @item
2783 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2784 Development Tools for the Renesas H8/300[HS] Series}.
2786 @item
2787 HP-UX:
2788 @itemize
2789 @item
2790 @uref{http://hpux.cs.utah.edu/,,HP-UX Porting Center};
2792 @item
2793 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2794 @end itemize
2796 @item
2797 Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU
2798 Development Tools for the Motorola 68HC11/68HC12}.
2800 @item
2801 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2802 OpenServer/Unixware}.
2804 @item
2805 Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}.
2807 @item
2808 SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}.
2810 @item
2811 Microsoft Windows:
2812 @itemize
2813 @item
2814 The @uref{http://sourceware.org/cygwin/,,Cygwin} project;
2815 @item
2816 The @uref{http://www.mingw.org/,,MinGW} project.
2817 @end itemize
2819 @item
2820 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2821 Written Word} offers binaries for
2822 AIX 4.3.3, 5.1 and 5.2,
2823 IRIX 6.5,
2824 Tru64 UNIX 4.0D and 5.1,
2825 GNU/Linux (i386),
2826 HP-UX 10.20, 11.00, and 11.11, and
2827 Solaris/SPARC 2.5.1, 2.6, 7, 8, 9 and 10.
2829 @item
2830 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2831 number of platforms.
2833 @item
2834 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2835 links to GNU Fortran binaries for several platforms.
2836 @end itemize
2838 @html
2839 <hr />
2841 @end html
2842 @ifhtml
2843 @uref{./index.html,,Return to the GCC Installation page}
2844 @end ifhtml
2845 @end ifset
2847 @c ***Specific****************************************************************
2848 @ifnothtml
2849 @comment node-name,     next,          previous, up
2850 @node    Specific, Old, Binaries, Top
2851 @end ifnothtml
2852 @ifset specifichtml
2853 @ifnothtml
2854 @chapter Host/target specific installation notes for GCC
2855 @end ifnothtml
2856 @cindex Specific
2857 @cindex Specific installation notes
2858 @cindex Target specific installation
2859 @cindex Host specific installation
2860 @cindex Target specific installation notes
2862 Please read this document carefully @emph{before} installing the
2863 GNU Compiler Collection on your machine.
2865 Note that this list of install notes is @emph{not} a list of supported
2866 hosts or targets.  Not all supported hosts and targets are listed
2867 here, only the ones that require host-specific or target-specific
2868 information are.
2870 @ifhtml
2871 @itemize
2872 @item
2873 @uref{#alpha-x-x,,alpha*-*-*}
2874 @item
2875 @uref{#alpha-dec-osf51,,alpha*-dec-osf5.1}
2876 @item
2877 @uref{#arc-x-elf,,arc-*-elf}
2878 @item
2879 @uref{#arm-x-elf,,arm-*-elf}
2880 @item
2881 @uref{#avr,,avr}
2882 @item
2883 @uref{#bfin,,Blackfin}
2884 @item
2885 @uref{#dos,,DOS}
2886 @item
2887 @uref{#x-x-freebsd,,*-*-freebsd*}
2888 @item
2889 @uref{#h8300-hms,,h8300-hms}
2890 @item
2891 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2892 @item
2893 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2894 @item
2895 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2896 @item
2897 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2898 @item
2899 @uref{#ix86-x-linux,,i?86-*-linux*}
2900 @item
2901 @uref{#ix86-x-solaris289,,i?86-*-solaris2.[89]}
2902 @item
2903 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2904 @item
2905 @uref{#ia64-x-linux,,ia64-*-linux}
2906 @item
2907 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2908 @item
2909 @uref{#x-ibm-aix,,*-ibm-aix*}
2910 @item
2911 @uref{#iq2000-x-elf,,iq2000-*-elf}
2912 @item
2913 @uref{#lm32-x-elf,,lm32-*-elf}
2914 @item
2915 @uref{#lm32-x-uclinux,,lm32-*-uclinux}
2916 @item
2917 @uref{#m32c-x-elf,,m32c-*-elf}
2918 @item
2919 @uref{#m32r-x-elf,,m32r-*-elf}
2920 @item
2921 @uref{#m6811-elf,,m6811-elf}
2922 @item
2923 @uref{#m6812-elf,,m6812-elf}
2924 @item
2925 @uref{#m68k-x-x,,m68k-*-*}
2926 @item
2927 @uref{#m68k-uclinux,,m68k-uclinux}
2928 @item
2929 @uref{#mep-x-elf,,mep-*-elf}
2930 @item
2931 @uref{#mips-x-x,,mips-*-*}
2932 @item
2933 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
2934 @item
2935 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
2936 @item
2937 @uref{#powerpc-x-x,,powerpc*-*-*}
2938 @item
2939 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
2940 @item
2941 @uref{#powerpc-x-elf,,powerpc-*-elf}
2942 @item
2943 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
2944 @item
2945 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
2946 @item
2947 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
2948 @item
2949 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
2950 @item
2951 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
2952 @item
2953 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
2954 @item
2955 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
2956 @item
2957 @uref{#s390-x-linux,,s390-*-linux*}
2958 @item
2959 @uref{#s390x-x-linux,,s390x-*-linux*}
2960 @item
2961 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
2962 @item
2963 @uref{#x-x-solaris2,,*-*-solaris2*}
2964 @item
2965 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
2966 @item
2967 @uref{#sparc-sun-solaris210,,sparc-sun-solaris2.10}
2968 @item
2969 @uref{#sparc-x-linux,,sparc-*-linux*}
2970 @item
2971 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
2972 @item
2973 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
2974 @item
2975 @uref{#x-x-vxworks,,*-*-vxworks*}
2976 @item
2977 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
2978 @item
2979 @uref{#xtensa-x-elf,,xtensa*-*-elf}
2980 @item
2981 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
2982 @item
2983 @uref{#windows,,Microsoft Windows}
2984 @item
2985 @uref{#x-x-cygwin,,*-*-cygwin}
2986 @item
2987 @uref{#x-x-interix,,*-*-interix}
2988 @item
2989 @uref{#x-x-mingw32,,*-*-mingw32}
2990 @item
2991 @uref{#os2,,OS/2}
2992 @item
2993 @uref{#older,,Older systems}
2994 @end itemize
2996 @itemize
2997 @item
2998 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
2999 @end itemize
3000 @end ifhtml
3003 @html
3004 <!-- -------- host/target specific issues start here ---------------- -->
3005 <hr />
3006 @end html
3007 @heading @anchor{alpha-x-x}alpha*-*-*
3009 This section contains general configuration information for all
3010 alpha-based platforms using ELF (in particular, ignore this section for
3011 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
3012 section, please read all other sections that match your target.
3014 We require binutils 2.11.2 or newer.
3015 Previous binutils releases had a number of problems with DWARF 2
3016 debugging information, not the least of which is incorrect linking of
3017 shared libraries.
3019 @html
3020 <hr />
3021 @end html
3022 @heading @anchor{alpha-dec-osf51}alpha*-dec-osf5.1
3023 Systems using processors that implement the DEC Alpha architecture and
3024 are running the DEC/Compaq/HP Unix (DEC OSF/1, Digital UNIX, or Compaq/HP
3025 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
3027 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
3028 supported.  (These are the versions which identify themselves as DEC
3029 OSF/1.)  As of GCC 4.6, support for Tru64 UNIX V4.0 and V5.0 has been
3030 removed.
3032 On Tru64 UNIX, virtual memory exhausted bootstrap failures
3033 may be fixed by reconfiguring Kernel Virtual Memory and Swap parameters
3034 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
3035 or applying the patch in
3036 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.  Depending on
3037 the OS version used, you need a data segment size between 512 MB and
3038 1 GB, so simply use @command{ulimit -Sd unlimited}.
3040 As of GNU binutils 2.20.1, neither GNU @command{as} nor GNU @command{ld}
3041 are supported on Tru64 UNIX, so you must not configure GCC with
3042 @option{--with-gnu-as} or @option{--with-gnu-ld}.
3044 GCC writes a @samp{.verstamp} directive to the assembler output file
3045 unless it is built as a cross-compiler.  It gets the version to use from
3046 the system header file @file{/usr/include/stamp.h}.  If you install a
3047 new version of Tru64 UNIX, you should rebuild GCC to pick up the new version
3048 stamp.
3050 GCC now supports both the native (ECOFF) debugging format used by DBX
3051 and GDB and an encapsulated STABS format for use only with GDB@.  See the
3052 discussion of the @option{--with-stabs} option of @file{configure} above
3053 for more information on these formats and how to select them.
3054 @c FIXME: does this work at all?  If so, perhaps make default.
3056 There is a bug in DEC's assembler that produces incorrect line numbers
3057 for ECOFF format when the @samp{.align} directive is used.  To work
3058 around this problem, GCC will not emit such alignment directives
3059 while writing ECOFF format debugging information even if optimization is
3060 being performed.  Unfortunately, this has the very undesirable
3061 side-effect that code addresses when @option{-O} is specified are
3062 different depending on whether or not @option{-g} is also specified.
3064 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
3065 DBX@.  DEC is now aware of this problem with the assembler and hopes to
3066 provide a fix shortly.
3068 @c FIXME: still applicable?
3070 @html
3071 <hr />
3072 @end html
3073 @heading @anchor{arc-x-elf}arc-*-elf
3074 Argonaut ARC processor.
3075 This configuration is intended for embedded systems.
3077 @html
3078 <hr />
3079 @end html
3080 @heading @anchor{arm-x-elf}arm-*-elf
3081 ARM-family processors.  Subtargets that use the ELF object format
3082 require GNU binutils 2.13 or newer.  Such subtargets include:
3083 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux}
3084 and @code{arm-*-rtems}.
3086 @html
3087 <hr />
3088 @end html
3089 @heading @anchor{avr}avr
3091 ATMEL AVR-family micro controllers.  These are used in embedded
3092 applications.  There are no standard Unix configurations.
3093 @ifnothtml
3094 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3095 Collection (GCC)},
3096 @end ifnothtml
3097 @ifhtml
3098 See ``AVR Options'' in the main manual
3099 @end ifhtml
3100 for the list of supported MCU types.
3102 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3104 Further installation notes and other useful information about AVR tools
3105 can also be obtained from:
3107 @itemize @bullet
3108 @item
3109 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3110 @item
3111 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3112 @end itemize
3114 We @emph{strongly} recommend using binutils 2.13 or newer.
3116 The following error:
3117 @smallexample
3118   Error: register required
3119 @end smallexample
3121 indicates that you should upgrade to a newer version of the binutils.
3123 @html
3124 <hr />
3125 @end html
3126 @heading @anchor{bfin}Blackfin
3128 The Blackfin processor, an Analog Devices DSP.
3129 @ifnothtml
3130 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3131 Collection (GCC)},
3132 @end ifnothtml
3133 @ifhtml
3134 See ``Blackfin Options'' in the main manual
3135 @end ifhtml
3137 More information, and a version of binutils with support for this processor,
3138 is available at @uref{http://blackfin.uclinux.org}
3140 @html
3141 <hr />
3142 @end html
3143 @heading @anchor{cris}CRIS
3145 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3146 series.  These are used in embedded applications.
3148 @ifnothtml
3149 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3150 Collection (GCC)},
3151 @end ifnothtml
3152 @ifhtml
3153 See ``CRIS Options'' in the main manual
3154 @end ifhtml
3155 for a list of CRIS-specific options.
3157 There are a few different CRIS targets:
3158 @table @code
3159 @item cris-axis-elf
3160 Mainly for monolithic embedded systems.  Includes a multilib for the
3161 @samp{v10} core used in @samp{ETRAX 100 LX}.
3162 @item cris-axis-linux-gnu
3163 A GNU/Linux port for the CRIS architecture, currently targeting
3164 @samp{ETRAX 100 LX} by default.
3165 @end table
3167 For @code{cris-axis-elf} you need binutils 2.11
3168 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
3170 Pre-packaged tools can be obtained from
3171 @uref{ftp://ftp.axis.com/pub/axis/tools/cris/compiler-kit/}.  More
3172 information about this platform is available at
3173 @uref{http://developer.axis.com/}.
3175 @html
3176 <hr />
3177 @end html
3178 @heading @anchor{crx}CRX
3180 The CRX CompactRISC architecture is a low-power 32-bit architecture with
3181 fast context switching and architectural extensibility features.
3183 @ifnothtml
3184 @xref{CRX Options,, CRX Options, gcc, Using and Porting the GNU Compiler
3185 Collection (GCC)},
3186 @end ifnothtml
3188 @ifhtml
3189 See ``CRX Options'' in the main manual for a list of CRX-specific options.
3190 @end ifhtml
3192 Use @samp{configure --target=crx-elf --enable-languages=c,c++} to configure
3193 GCC@ for building a CRX cross-compiler. The option @samp{--target=crx-elf}
3194 is also used to build the @samp{newlib} C library for CRX.
3196 It is also possible to build libstdc++-v3 for the CRX architecture. This
3197 needs to be done in a separate step with the following configure settings:
3198 @samp{gcc/libstdc++-v3/configure --host=crx-elf --with-newlib
3199 --enable-sjlj-exceptions --enable-cxx-flags='-fexceptions -frtti'}
3201 @html
3202 <hr />
3203 @end html
3204 @heading @anchor{dos}DOS
3206 Please have a look at the @uref{binaries.html,,binaries page}.
3208 You cannot install GCC by itself on MSDOS; it will not compile under
3209 any MSDOS compiler except itself.  You need to get the complete
3210 compilation package DJGPP, which includes binaries as well as sources,
3211 and includes all the necessary compilation tools and libraries.
3213 @html
3214 <hr />
3215 @end html
3216 @heading @anchor{x-x-freebsd}*-*-freebsd*
3218 Support for FreeBSD 1 was discontinued in GCC 3.2.  Support for
3219 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3220 discontinued in GCC 4.0.
3222 In order to better utilize FreeBSD base system functionality and match
3223 the configuration of the system compiler, GCC 4.5 and above as well as
3224 GCC 4.4 past 2010-06-20 leverage SSP support in libc (which is present
3225 on FreeBSD 7 or later) and the use of @code{__cxa_atexit} by default
3226 (on FreeBSD 6 or later).  The use of @code{dl_iterate_phdr} inside
3227 @file{libgcc_s.so.1} and boehm-gc (on FreeBSD 7 or later) is enabled
3228 by GCC 4.5 and above.
3230 We support FreeBSD using the ELF file format with DWARF 2 debugging
3231 for all CPU architectures.  You may use @option{-gstabs} instead of
3232 @option{-g}, if you really want the old debugging format.  There are
3233 no known issues with mixing object files and libraries with different
3234 debugging formats.  Otherwise, this release of GCC should now match
3235 more of the configuration used in the stock FreeBSD configuration of
3236 GCC@.  In particular, @option{--enable-threads} is now configured by
3237 default.  However, as a general user, do not attempt to replace the
3238 system compiler with this release.  Known to bootstrap and check with
3239 good results on FreeBSD 7.2-STABLE@.  In the past, known to bootstrap
3240 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3241 4.5, 4.8, 4.9 and 5-CURRENT@.
3243 The version of binutils installed in @file{/usr/bin} probably works
3244 with this release of GCC@.  Bootstrapping against the latest GNU
3245 binutils and/or the version found in @file{/usr/ports/devel/binutils} has
3246 been known to enable additional features and improve overall testsuite
3247 results.  However, it is currently known that boehm-gc (which itself
3248 is required for java) may not configure properly on FreeBSD prior to
3249 the FreeBSD 7.0 release with GNU binutils after 2.16.1.
3251 @html
3252 <hr />
3253 @end html
3254 @heading @anchor{h8300-hms}h8300-hms
3255 Renesas H8/300 series of processors.
3257 Please have a look at the @uref{binaries.html,,binaries page}.
3259 The calling convention and structure layout has changed in release 2.6.
3260 All code must be recompiled.  The calling convention now passes the
3261 first three arguments in function calls in registers.  Structures are no
3262 longer a multiple of 2 bytes.
3264 @html
3265 <hr />
3266 @end html
3267 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
3268 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3270 We require using gas/binutils on all hppa platforms.  Version 2.19 or
3271 later is recommended.
3273 It may be helpful to configure GCC with the
3274 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3275 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3277 The HP assembler should not be used with GCC.  It is rarely tested and may
3278 not work.  It shouldn't be used with any languages other than C due to its
3279 many limitations.
3281 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3282 format which GCC does not know about).  It also inserts timestamps
3283 into each object file it creates, causing the 3-stage comparison test to
3284 fail during a bootstrap.  You should be able to continue by saying
3285 @samp{make all-host all-target} after getting the failure from @samp{make}.
3287 Various GCC features are not supported.  For example, it does not support weak
3288 symbols or alias definitions.  As a result, explicit template instantiations
3289 are required when using C++.  This makes it difficult if not impossible to
3290 build many C++ applications.
3292 There are two default scheduling models for instructions.  These are
3293 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
3294 architecture specified for the target machine when configuring.
3295 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
3296 the target is a @samp{hppa1*} machine.
3298 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
3299 it is important to completely specify the machine architecture when
3300 configuring if you want a model other than PROCESSOR_8000.  The macro
3301 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3302 default scheduling model is desired.
3304 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3305 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3306 This namespace change might cause problems when bootstrapping with
3307 an earlier version of GCC or the HP compiler as essentially the same
3308 namespace is required for an entire build.  This problem can be avoided
3309 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
3310 or @samp{98}.  Another way is to add an appropriate set of predefines
3311 to @env{CC}.  The description for the @option{munix=} option contains
3312 a list of the predefines used with each standard.
3314 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3316 @html
3317 <hr />
3318 @end html
3319 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
3321 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3322 @code{PHCO_19798} from HP@.  HP has two sites which provide patches free of
3323 charge:
3325 @itemize @bullet
3326 @item
3327 @html
3328 <a href="http://us.itrc.hp.com/service/home/home.do">US, Canada, Asia-Pacific, and
3329 Latin-America</a>
3330 @end html
3331 @ifnothtml
3332 @uref{http://us.itrc.hp.com/service/home/home.do,,} US, Canada, Asia-Pacific,
3333 and Latin-America.
3334 @end ifnothtml
3335 @item
3336 @uref{http://europe.itrc.hp.com/service/home/home.do,,} Europe.
3337 @end itemize
3339 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
3340 used for one-only code and data.  This resolves many of the previous
3341 problems in using C++ on this target.  However, the ABI is not compatible
3342 with the one implemented under HP-UX 11 using secondary definitions.
3344 @html
3345 <hr />
3346 @end html
3347 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
3349 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
3350 be used to compile GCC 3.0 and up.
3352 The libffi and libjava libraries haven't been ported to 64-bit HP-UX@
3353 and don't build.
3355 Refer to @uref{binaries.html,,binaries} for information about obtaining
3356 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
3357 to build the Ada language as it can't be bootstrapped using C@.  Ada is
3358 only available for the 32-bit PA-RISC runtime.
3360 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
3361 bundled compiler supports only traditional C; you will need either HP's
3362 unbundled compiler, or a binary distribution of GCC@.
3364 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3365 but the process requires several steps.  GCC 3.3 can then be used to
3366 build later versions.  The fastjar program contains ISO C code and
3367 can't be built with the HP bundled compiler.  This problem can be
3368 avoided by not building the Java language.  For example, use the
3369 @option{--enable-languages="c,c++,f77,objc"} option in your configure
3370 command.
3372 There are several possible approaches to building the distribution.
3373 Binutils can be built first using the HP tools.  Then, the GCC
3374 distribution can be built.  The second approach is to build GCC
3375 first using the HP tools, then build binutils, then rebuild GCC@.
3376 There have been problems with various binary distributions, so it
3377 is best not to start from a binary distribution.
3379 On 64-bit capable systems, there are two distinct targets.  Different
3380 installation prefixes must be used if both are to be installed on
3381 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3382 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3383 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3384 PA-RISC 2.0 architecture.
3386 The script config.guess now selects the target type based on the compiler
3387 detected during configuration.  You must define @env{PATH} or @env{CC} so
3388 that configure finds an appropriate compiler for the initial bootstrap.
3389 When @env{CC} is used, the definition should contain the options that are
3390 needed whenever @env{CC} is used.
3392 Specifically, options that determine the runtime architecture must be
3393 in @env{CC} to correctly select the target for the build.  It is also
3394 convenient to place many other compiler options in @env{CC}.  For example,
3395 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3396 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3397 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
3398 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
3399 macro definition table of cpp needs to be increased for a successful
3400 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
3401 be defined when building with the bundled compiler, or when using the
3402 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
3404 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3405 with the @option{--with-ld=@dots{}} option.  This overrides the standard
3406 search for ld.  The two linkers supported on this target require different
3407 commands.  The default linker is determined during configuration.  As a
3408 result, it's not possible to switch linkers in the middle of a GCC build.
3409 This has been reported to sometimes occur in unified builds of binutils
3410 and GCC@.
3412 A recent linker patch must be installed for the correct operation of
3413 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
3414 oldest linker patches that are known to work.  They are for HP-UX
3415 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
3416 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
3417 patches have been superseded.  Consult the HP patch database to obtain
3418 the currently recommended linker patch for your system.
3420 The patches are necessary for the support of weak symbols on the
3421 32-bit port, and for the running of initializers and finalizers.  Weak
3422 symbols are implemented using SOM secondary definition symbols.  Prior
3423 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3424 The patches correct a problem of linker core dumps creating shared
3425 libraries containing secondary symbols, as well as various other
3426 linking issues involving secondary symbols.
3428 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3429 run initializers and finalizers on the 64-bit port.  The 32-bit port
3430 uses the linker @option{+init} and @option{+fini} options for the same
3431 purpose.  The patches correct various problems with the +init/+fini
3432 options, including program core dumps.  Binutils 2.14 corrects a
3433 problem on the 64-bit port resulting from HP's non-standard use of
3434 the .init and .fini sections for array initializers and finalizers.
3436 Although the HP and GNU linkers are both supported for the
3437 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3438 HP linker be used for link editing on this target.
3440 At this time, the GNU linker does not support the creation of long
3441 branch stubs.  As a result, it can't successfully link binaries
3442 containing branch offsets larger than 8 megabytes.  In addition,
3443 there are problems linking shared libraries, linking executables
3444 with @option{-static}, and with dwarf2 unwind and exception support.
3445 It also doesn't provide stubs for internal calls to global functions
3446 in shared libraries, so these calls can't be overloaded.
3448 The HP dynamic loader does not support GNU symbol versioning, so symbol
3449 versioning is not supported.  It may be necessary to disable symbol
3450 versioning with @option{--disable-symvers} when using GNU ld.
3452 POSIX threads are the default.  The optional DCE thread library is not
3453 supported, so @option{--enable-threads=dce} does not work.
3455 @html
3456 <hr />
3457 @end html
3458 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
3460 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3461 in glibc 2.2.5 and later.  More information is available in the
3462 libstdc++-v3 documentation.
3464 @html
3465 <hr />
3466 @end html
3467 @heading @anchor{ix86-x-linux}i?86-*-linux*
3469 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3470 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3472 If you receive Signal 11 errors when building on GNU/Linux, then it is
3473 possible you have a hardware problem.  Further information on this can be
3474 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3476 @html
3477 <hr />
3478 @end html
3479 @heading @anchor{ix86-x-solaris289}i?86-*-solaris2.[89]
3480 The Sun assembler in Solaris 8 and 9 has several bugs and limitations.
3481 While GCC works around them, several features are missing, so it is
3482 @c FIXME: which ones?
3483 recommended to use the GNU assembler instead.  There is no bundled
3484 version, but the current version, from GNU binutils 2.20.1, is known to
3485 work.
3487 Solaris~2/x86 doesn't support the execution of SSE/SSE2 instructions
3488 before Solaris~9 4/04, even if the CPU supports them.  Programs will
3489 receive @code{SIGILL} if they try.  The fix is available both in
3490 Solaris~9 Update~6 and kernel patch 112234-12 or newer.  There is no
3491 corresponding patch for Solaris 8.  To avoid this problem,
3492 @option{-march} defaults to @samp{pentiumpro} on Solaris 8 and 9.  If
3493 you have the patch installed, you can configure GCC with an appropriate
3494 @option{--with-arch} option, but need GNU @command{as} for SSE2 support.
3496 @html
3497 <hr />
3498 @end html
3499 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3500 Use this for Solaris 10 or later on x86 and x86-64 systems.  This
3501 configuration is supported by GCC 4.0 and later versions only.  Unlike
3502 @samp{sparcv9-sun-solaris2*}, there is no corresponding 64-bit
3503 configuration like @samp{amd64-*-solaris2*} or @samp{x86_64-*-solaris2*}.
3504 @c FIXME: will there ever be?
3506 It is recommended that you configure GCC to use the GNU assembler, in
3507 @file{/usr/sfw/bin/gas}.  The versions included in Solaris 10, from GNU
3508 binutils 2.15, and Solaris 11, from GNU binutils 2.19, work fine,
3509 although the current version, from GNU binutils
3510 2.20.1, is known to work, too.  Recent versions of the Sun assembler in
3511 @file{/usr/ccs/bin/as} work almost as well, though.
3512 @c FIXME: as patch requirements?
3514 For linking, the Sun linker, is preferred.  If you want to use the GNU
3515 linker instead, which is available in @file{/usr/sfw/bin/gld}, note that
3516 due to a packaging bug the version in Solaris 10, from GNU binutils
3517 2.15, cannot be used, while the version in Solaris 11, from GNU binutils
3518 2.19, works, as does the latest version, from GNU binutils 2.20.1.
3520 To use GNU @command{as}, configure with the options
3521 @option{--with-gnu-as --with-as=/usr/sfw/bin/gas}.  It may be necessary
3522 to configure with @option{--without-gnu-ld --with-ld=/usr/ccs/bin/ld} to
3523 guarantee use of Sun @command{ld}.
3524 @c FIXME: why --without-gnu-ld --with-ld?
3526 @html
3527 <hr />
3528 @end html
3529 @heading @anchor{ia64-x-linux}ia64-*-linux
3530 IA-64 processor (also known as IPF, or Itanium Processor Family)
3531 running GNU/Linux.
3533 If you are using the installed system libunwind library with
3534 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3535 later.
3537 None of the following versions of GCC has an ABI that is compatible
3538 with any of the other versions in this list, with the exception that
3539 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3540 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3541 This primarily affects C++ programs and programs that create shared libraries.
3542 GCC 3.1 or later is recommended for compiling linux, the kernel.
3543 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3544 more major ABI changes are expected.
3546 @html
3547 <hr />
3548 @end html
3549 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3550 Building GCC on this target requires the GNU Assembler.  The bundled HP
3551 assembler will not work.  To prevent GCC from using the wrong assembler,
3552 the option @option{--with-gnu-as} may be necessary.
3554 The GCC libunwind library has not been ported to HPUX@.  This means that for
3555 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3556 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3557 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3558 removed and the system libunwind library will always be used.
3560 @html
3561 <hr />
3562 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3563 @end html
3564 @heading @anchor{x-ibm-aix}*-ibm-aix*
3565 Support for AIX version 3 and older was discontinued in GCC 3.4.
3566 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3568 ``out of memory'' bootstrap failures may indicate a problem with
3569 process resource limits (ulimit).  Hard limits are configured in the
3570 @file{/etc/security/limits} system configuration file.
3572 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3573 with an earlier release of GCC is recommended.  Bootstrapping with XLC
3574 requires a larger data segment, which can be enabled through the
3575 @var{LDR_CNTRL} environment variable, e.g.,
3577 @smallexample
3578    % LDR_CNTRL=MAXDATA=0x50000000
3579    % export LDR_CNTRL
3580 @end smallexample
3582 One can start with a pre-compiled version of GCC to build from
3583 sources.  One may delete GCC's ``fixed'' header files when starting
3584 with a version of GCC built for an earlier release of AIX.
3586 To speed up the configuration phases of bootstrapping and installing GCC,
3587 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3589 @smallexample
3590    % CONFIG_SHELL=/opt/freeware/bin/bash
3591    % export CONFIG_SHELL
3592 @end smallexample
3594 and then proceed as described in @uref{build.html,,the build
3595 instructions}, where we strongly recommend specifying an absolute path
3596 to invoke @var{srcdir}/configure.
3598 Because GCC on AIX is built as a 32-bit executable by default,
3599 (although it can generate 64-bit programs) the GMP and MPFR libraries
3600 required by gfortran must be 32-bit libraries.  Building GMP and MPFR
3601 as static archive libraries works better than shared libraries.
3603 Errors involving @code{alloca} when building GCC generally are due
3604 to an incorrect definition of @code{CC} in the Makefile or mixing files
3605 compiled with the native C compiler and GCC@.  During the stage1 phase of
3606 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3607 (not @command{xlc}).  Once @command{configure} has been informed of
3608 @command{xlc}, one needs to use @samp{make distclean} to remove the
3609 configure cache files and ensure that @env{CC} environment variable
3610 does not provide a definition that will confuse @command{configure}.
3611 If this error occurs during stage2 or later, then the problem most likely
3612 is the version of Make (see above).
3614 The native @command{as} and @command{ld} are recommended for bootstrapping
3615 on AIX@.  The GNU Assembler, GNU Linker, and GNU Binutils version 2.20
3616 is required to bootstrap on AIX 5@.  The native AIX tools do
3617 interoperate with GCC@.
3619 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3620 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3621 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3622 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3624 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3625 shared object and GCC installation places the @file{libstdc++.a}
3626 shared library in a common location which will overwrite the and GCC
3627 3.3 version of the shared library.  Applications either need to be
3628 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3629 versions of the @samp{libstdc++} shared object needs to be available
3630 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3631 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3632 installed for runtime dynamic loading using the following steps to set
3633 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3634 multilib @file{libstdc++.a} installed:
3636 Extract the shared objects from the currently installed
3637 @file{libstdc++.a} archive:
3638 @smallexample
3639    % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3640 @end smallexample
3642 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3643 available for runtime dynamic loading, but not linking:
3644 @smallexample
3645    % strip -e libstdc++.so.4 libstdc++.so.5
3646 @end smallexample
3648 Archive the runtime-only shared object in the GCC 3.4
3649 @file{libstdc++.a} archive:
3650 @smallexample
3651    % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3652 @end smallexample
3654 Linking executables and shared libraries may produce warnings of
3655 duplicate symbols.  The assembly files generated by GCC for AIX always
3656 have included multiple symbol definitions for certain global variable
3657 and function declarations in the original program.  The warnings should
3658 not prevent the linker from producing a correct library or runnable
3659 executable.
3661 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3662 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3663 to parse archive libraries did not handle the new format correctly.
3664 These routines are used by GCC and result in error messages during
3665 linking such as ``not a COFF file''.  The version of the routines shipped
3666 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3667 option of the archive command may be used to create archives of 32-bit
3668 objects using the original ``small format''.  A correct version of the
3669 routines is shipped with AIX 4.3.2 and above.
3671 Some versions of the AIX binder (linker) can fail with a relocation
3672 overflow severe error when the @option{-bbigtoc} option is used to link
3673 GCC-produced object files into an executable that overflows the TOC@.  A fix
3674 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3675 available from IBM Customer Support and from its
3676 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3677 website as PTF U455193.
3679 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3680 with a segmentation fault when invoked by any version of GCC@.  A fix for
3681 APAR IX87327 is available from IBM Customer Support and from its
3682 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3683 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3685 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3686 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3687 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3688 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3689 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3691 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3692 use NLS to support locale-specific representations of various data
3693 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3694 separating decimal fractions).  There have been problems reported where
3695 GCC does not produce the same floating-point formats that the assembler
3696 expects.  If one encounters this problem, set the @env{LANG}
3697 environment variable to @samp{C} or @samp{En_US}.
3699 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3700 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3702 @html
3703 <hr />
3704 @end html
3705 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3706 Vitesse IQ2000 processors.  These are used in embedded
3707 applications.  There are no standard Unix configurations.
3709 @html
3710 <hr />
3711 @end html
3712 @heading @anchor{lm32-x-elf}lm32-*-elf
3713 Lattice Mico32 processor.
3714 This configuration is intended for embedded systems.
3716 @html
3717 <hr />
3718 @end html
3719 @heading @anchor{lm32-x-uclinux}lm32-*-uclinux
3720 Lattice Mico32 processor.
3721 This configuration is intended for embedded systems running uClinux.
3723 @html
3724 <hr />
3725 @end html
3726 @heading @anchor{m32c-x-elf}m32c-*-elf
3727 Renesas M32C processor.
3728 This configuration is intended for embedded systems.
3730 @html
3731 <hr />
3732 @end html
3733 @heading @anchor{m32r-x-elf}m32r-*-elf
3734 Renesas M32R processor.
3735 This configuration is intended for embedded systems.
3737 @html
3738 <hr />
3739 @end html
3740 @heading @anchor{m6811-elf}m6811-elf
3741 Motorola 68HC11 family micro controllers.  These are used in embedded
3742 applications.  There are no standard Unix configurations.
3744 @html
3745 <hr />
3746 @end html
3747 @heading @anchor{m6812-elf}m6812-elf
3748 Motorola 68HC12 family micro controllers.  These are used in embedded
3749 applications.  There are no standard Unix configurations.
3751 @html
3752 <hr />
3753 @end html
3754 @heading @anchor{m68k-x-x}m68k-*-*
3755 By default,
3756 @samp{m68k-*-elf*}, @samp{m68k-*-rtems},  @samp{m68k-*-uclinux} and
3757 @samp{m68k-*-linux}
3758 build libraries for both M680x0 and ColdFire processors.  If you only
3759 need the M680x0 libraries, you can omit the ColdFire ones by passing
3760 @option{--with-arch=m68k} to @command{configure}.  Alternatively, you
3761 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
3762 @command{configure}.  These targets default to 5206 or 5475 code as
3763 appropriate for the target system when
3764 configured with @option{--with-arch=cf} and 68020 code otherwise.
3766 The @samp{m68k-*-netbsd} and
3767 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
3768 option.  They will generate ColdFire CFV4e code when configured with
3769 @option{--with-arch=cf} and 68020 code otherwise.
3771 You can override the default processors listed above by configuring
3772 with @option{--with-cpu=@var{target}}.  This @var{target} can either
3773 be a @option{-mcpu} argument or one of the following values:
3774 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
3775 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
3777 @html
3778 <hr />
3779 @end html
3780 @heading @anchor{m68k-x-uclinux}m68k-*-uclinux
3781 GCC 4.3 changed the uClinux configuration so that it uses the
3782 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
3783 It also added improved support for C++ and flat shared libraries,
3784 both of which were ABI changes.  However, you can still use the
3785 original ABI by configuring for @samp{m68k-uclinuxoldabi} or
3786 @samp{m68k-@var{vendor}-uclinuxoldabi}.
3789 @html
3790 <hr />
3791 @end html
3792 @heading @anchor{mep-x-elf}mep-*-elf
3793 Toshiba Media embedded Processor.
3794 This configuration is intended for embedded systems.
3796 @html
3797 <hr />
3798 @end html
3799 @heading @anchor{mips-x-x}mips-*-*
3800 If on a MIPS system you get an error message saying ``does not have gp
3801 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3802 happens whenever you use GAS with the MIPS linker, but there is not
3803 really anything wrong, and it is okay to use the output file.  You can
3804 stop such warnings by installing the GNU linker.
3806 It would be nice to extend GAS to produce the gp tables, but they are
3807 optional, and there should not be a warning about their absence.
3809 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3810 and later.  A patch went in just after the GCC 3.3 release to
3811 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3812 configure for @samp{mipsel-elf} as a workaround.  The
3813 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3814 work on this is expected in future releases.
3816 @c If you make --with-llsc the default for another target, please also
3817 @c update the description of the --with-llsc option.
3819 The built-in @code{__sync_*} functions are available on MIPS II and
3820 later systems and others that support the @samp{ll}, @samp{sc} and
3821 @samp{sync} instructions.  This can be overridden by passing
3822 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
3823 Since the Linux kernel emulates these instructions if they are
3824 missing, the default for @samp{mips*-*-linux*} targets is
3825 @option{--with-llsc}.  The @option{--with-llsc} and
3826 @option{--without-llsc} configure options may be overridden at compile
3827 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
3828 the compiler.
3830 MIPS systems check for division by zero (unless
3831 @option{-mno-check-zero-division} is passed to the compiler) by
3832 generating either a conditional trap or a break instruction.  Using
3833 trap results in smaller code, but is only supported on MIPS II and
3834 later.  Also, some versions of the Linux kernel have a bug that
3835 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3836 the use of break, use the @option{--with-divide=breaks}
3837 @command{configure} option when configuring GCC@.  The default is to
3838 use traps on systems that support them.
3840 Cross-compilers for the MIPS as target using the MIPS assembler
3841 currently do not work, because the auxiliary programs
3842 @file{mips-tdump.c} and @file{mips-tfile.c} can't be compiled on
3843 anything but a MIPS@.  It does work to cross compile for a MIPS
3844 if you use the GNU assembler and linker.
3846 The assembler from GNU binutils 2.17 and earlier has a bug in the way
3847 it sorts relocations for REL targets (o32, o64, EABI).  This can cause
3848 bad code to be generated for simple C++ programs.  Also the linker
3849 from GNU binutils versions prior to 2.17 has a bug which causes the
3850 runtime linker stubs in very large programs, like @file{libgcj.so}, to
3851 be incorrectly generated.  GNU Binutils 2.18 and later (and snapshots
3852 made after Nov. 9, 2006) should be free from both of these problems.
3854 @html
3855 <hr />
3856 @end html
3857 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3859 Support for IRIX 5 has been removed in GCC 4.6.
3861 @html
3862 <hr />
3863 @end html
3864 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3866 Support for IRIX 6 releases before 6.5 has been removed in GCC 4.6, as
3867 well as support for
3868 the O32 ABI.  It is @emph{strongly} recommended to upgrade to at least
3869 IRIX 6.5.18.  This release introduced full ISO C99 support, though for
3870 the N32 and N64 ABIs only.
3872 To build and use GCC on IRIX 6.5, you need the IRIX Development Foundation
3873 (IDF) and IRIX Development Libraries (IDL).  They are included with the
3874 IRIX 6.5 media.
3876 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3877 ensure that the N32 ABI is in use.  To test this, compile a simple C
3878 file with @command{cc} and then run @command{file} on the
3879 resulting object file.  The output should look like:
3881 @smallexample
3882 test.o: ELF N32 MSB @dots{}
3883 @end smallexample
3885 @noindent
3886 If you see:
3888 @smallexample
3889 test.o: ELF 32-bit MSB @dots{}
3890 @end smallexample
3892 @noindent
3895 @smallexample
3896 test.o: ELF 64-bit MSB @dots{}
3897 @end smallexample
3899 @noindent
3900 then your version of @command{cc} uses the O32 or N64 ABI by default.  You
3901 should set the environment variable @env{CC} to @samp{cc -n32}
3902 before configuring GCC@.
3904 If you want the resulting @command{gcc} to run on old 32-bit systems
3905 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3906 instruction set architecture (ISA) is generated.  While GCC 3.x does
3907 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3908 the ISA depending on the machine where GCC is built.  Using one of them
3909 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3910 all on @samp{mips3}-only systems.  For the test program above, you should see:
3912 @smallexample
3913 test.o: ELF N32 MSB mips-3 @dots{}
3914 @end smallexample
3916 @noindent
3917 If you get:
3919 @smallexample
3920 test.o: ELF N32 MSB mips-4 @dots{}
3921 @end smallexample
3923 @noindent
3924 instead, you should set the environment variable @env{CC} to @samp{cc
3925 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3927 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3928 @code{memcmp}.  Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3929 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3931 GCC on IRIX 6.5 is usually built to support the N32 and N64 ABIs.  If
3932 you build GCC on a system that doesn't have the N64 libraries installed
3933 or cannot run 64-bit binaries,
3934 you need to configure with @option{--disable-multilib} so GCC doesn't
3935 try to use them.
3936 Look for @file{/usr/lib64/libc.so.1} to see if you
3937 have the 64-bit libraries installed.
3939 GCC must be configured with GNU @command{as}.  The latest version, from GNU
3940 binutils 2.20.1, is known to work.  On the other hand, bootstrap fails
3941 with GNU @command{ld} at least since GNU binutils 2.17.
3943 The @option{--enable-libgcj}
3944 option is disabled by default: IRIX 6 uses a very low default limit
3945 (20480) for the command line length.  Although @command{libtool} contains a
3946 workaround for this problem, at least the N64 @samp{libgcj} is known not
3947 to build despite this, running into an internal error of the native
3948 @command{ld}.  A sure fix is to increase this limit (@samp{ncargs}) to
3949 its maximum of 262144 bytes.  If you have root access, you can use the
3950 @command{systune} command to do this.
3951 @c FIXME: does this work with current libtool?
3953 @code{wchar_t} support in @samp{libstdc++} is not available for old
3954 IRIX 6.5.x releases, @math{x < 19}.  The problem cannot be autodetected
3955 and in order to build GCC for such targets you need to configure with
3956 @option{--disable-wchar_t}.
3958 @html
3959 <hr />
3960 @end html
3961 @heading @anchor{moxie-x-elf}moxie-*-elf
3962 The moxie processor.  See @uref{http://moxielogic.org/} for more
3963 information about this processor.
3965 @html
3966 <hr />
3967 @end html
3968 @heading @anchor{powerpc-x-x}powerpc-*-*
3970 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3971 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3973 You will need
3974 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3975 or newer for a working GCC@.
3977 @html
3978 <hr />
3979 @end html
3980 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3981 PowerPC running Darwin (Mac OS X kernel).
3983 Pre-installed versions of Mac OS X may not include any developer tools,
3984 meaning that you will not be able to build GCC from source.  Tool
3985 binaries are available at
3986 @uref{http://developer.apple.com/darwin/projects/compiler/} (free
3987 registration required).
3989 This version of GCC requires at least cctools-590.36.  The
3990 cctools-590.36 package referenced from
3991 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
3992 on systems older than 10.3.9 (aka darwin7.9.0).
3994 @html
3995 <hr />
3996 @end html
3997 @heading @anchor{powerpc-x-elf}powerpc-*-elf
3998 PowerPC system in big endian mode, running System V.4.
4000 @html
4001 <hr />
4002 @end html
4003 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
4005 PowerPC system in big endian mode running Linux.
4007 @html
4008 <hr />
4009 @end html
4010 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
4011 PowerPC system in big endian mode running NetBSD@.
4013 @html
4014 <hr />
4015 @end html
4016 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
4017 Embedded PowerPC system in big endian mode for use in running under the
4018 PSIM simulator.
4020 @html
4021 <hr />
4022 @end html
4023 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
4024 Embedded PowerPC system in big endian mode.
4026 @html
4027 <hr />
4028 @end html
4029 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf
4030 PowerPC system in little endian mode, running System V.4.
4032 @html
4033 <hr />
4034 @end html
4035 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
4036 Embedded PowerPC system in little endian mode for use in running under
4037 the PSIM simulator.
4039 @html
4040 <hr />
4041 @end html
4042 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
4043 Embedded PowerPC system in little endian mode.
4045 @html
4046 <hr />
4047 @end html
4048 @heading @anchor{rx-x-elf}rx-*-elf
4049 The Renesas RX processor.  See
4050 @uref{http://eu.renesas.com/fmwk.jsp?cnt=rx600_series_landing.jsp&fp=/products/mpumcu/rx_family/rx600_series}
4051 for more information about this processor.
4053 @html
4054 <hr />
4055 @end html
4056 @heading @anchor{s390-x-linux}s390-*-linux*
4057 S/390 system running GNU/Linux for S/390@.
4059 @html
4060 <hr />
4061 @end html
4062 @heading @anchor{s390x-x-linux}s390x-*-linux*
4063 zSeries system (64-bit) running GNU/Linux for zSeries@.
4065 @html
4066 <hr />
4067 @end html
4068 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
4069 zSeries system (64-bit) running TPF@.  This platform is
4070 supported as cross-compilation target only.
4072 @html
4073 <hr />
4074 @end html
4075 @c Please use Solaris 2 to refer to all release of Solaris, starting
4076 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
4077 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
4078 @c alone is too unspecific and must be avoided.
4079 @heading @anchor{x-x-solaris2}*-*-solaris2*
4081 Support for Solaris 7 has been removed in GCC 4.6.
4083 Sun does not ship a C compiler with Solaris 2, though you can download
4084 the Sun Studio compilers for free from
4085 @uref{http://developers.sun.com/sunstudio/downloads/}.  Alternatively,
4086 you can install a pre-built GCC to bootstrap and install GCC.  See the
4087 @uref{binaries.html,,binaries page} for details.
4089 The Solaris 2 @command{/bin/sh} will often fail to configure
4090 @samp{libstdc++-v3}, @samp{boehm-gc} or @samp{libjava}.  We therefore
4091 recommend using the following initial sequence of commands
4093 @smallexample
4094    % CONFIG_SHELL=/bin/ksh
4095    % export CONFIG_SHELL
4096 @end smallexample
4098 @noindent
4099 and proceed as described in @uref{configure.html,,the configure instructions}.
4100 In addition we strongly recommend specifying an absolute path to invoke
4101 @command{@var{srcdir}/configure}.
4103 Solaris 2 comes with a number of optional OS packages.  Some of these
4104 are needed to use GCC fully, namely @code{SUNWarc},
4105 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4106 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
4107 optional packages when installing Solaris 2, you will need to verify that
4108 the packages that GCC needs are installed.
4110 To check whether an optional package is installed, use
4111 the @command{pkginfo} command.  To add an optional package, use the
4112 @command{pkgadd} command.  For further details, see the Solaris 2
4113 documentation.
4115 Trying to use the linker and other tools in
4116 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4117 For example, the linker may hang indefinitely.  The fix is to remove
4118 @file{/usr/ucb} from your @env{PATH}.
4120 The build process works more smoothly with the legacy Sun tools so, if you
4121 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4122 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4124 We recommend the use of the Sun assembler or the GNU assembler, in
4125 conjunction with the Sun linker.  The GNU @command{as}
4126 versions included in Solaris 10, from GNU binutils 2.15, and Solaris 11,
4127 from GNU binutils 2.19, are known to work.  They can be found in
4128 @file{/usr/sfw/bin/gas}.  Current versions of GNU binutils (2.20.1)
4129 are known to work as well.  Note that your mileage may vary
4130 if you use a combination of the GNU tools and the Sun tools: while the
4131 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4132 the reverse combination Sun @command{as} + GNU @command{ld} is known to
4133 cause memory corruption at runtime in some cases for C++ programs.
4134 @c FIXME: still?
4135 GNU @command{ld} usually works as well, although the version included in
4136 Solaris 10 cannot be used due to several bugs.  Again, the current
4137 version (2.20.1) is known to work, but generally lacks platform specific
4138 features, so better stay with Sun @command{ld}.
4140 To enable symbol versioning in @samp{libstdc++} with Sun @command{ld},
4141 you need to have any version of GNU @command{c++filt}, which is part of
4142 GNU binutils.  @samp{libstdc++} symbol versioning will be disabled if no
4143 appropriate version is found.  Sun @command{c++filt} from the Sun Studio
4144 compilers does @emph{not} work.
4146 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
4147 newer: @command{g++} will complain that types are missing.  These headers
4148 assume that omitting the type means @code{int}; this assumption worked for
4149 C90 but is wrong for C++, and is now wrong for C99 also.
4151 @command{g++} accepts such (invalid) constructs with the option
4152 @option{-fpermissive}; it will assume that any missing type is @code{int}
4153 (as defined by C90).
4155 There are patches for Solaris 8 (108652-24 or newer for SPARC,
4156 108653-22 for Intel) that fix this bug.
4158 Sun bug 4927647 sometimes causes random spurious testsuite failures
4159 related to missing diagnostic output.  This bug doesn't affect GCC
4160 itself, rather it is a kernel bug triggered by the @command{expect}
4161 program which is used only by the GCC testsuite driver.  When the bug
4162 causes the @command{expect} program to miss anticipated output, extra
4163 testsuite failures appear.
4165 There are patches for Solaris 8 (117350-12 or newer for SPARC,
4166 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
4167 SPARC, 117172-11 or newer for Intel) that address this problem.
4169 Solaris~8 provides an alternate implementation of the thread libraries,
4170 @samp{libpthread} and @samp{libthread}.  They are required for TLS
4171 support and have been made the default in Solaris~9, so they are always
4172 used on Solaris~8.
4174 Thread-local storage (TLS) is supported in Solaris~8 and 9, but requires
4175 some patches.  The @samp{libthread} patches provide the
4176 @code{__tls_get_addr} (SPARC, 64-bit x86) resp.@ @code{___tls_get_addr}
4177 (32-bit x86) functions.  On Solaris~8, you need 108993-26 or newer on
4178 SPARC, 108994-26 or newer on Intel.  On Solaris~9, the necessary support
4179 on SPARC is present since FCS, while 114432-05 or newer is reqired on
4180 Intel.  Additionally, on Solaris~8, patch 109147-14 or newer on SPARC or
4181 109148-22 or newer on Intel are required for the Sun @command{ld} and
4182 runtime linker (@command{ld.so.1}) support.  Again, Solaris~9/SPARC
4183 works since FCS, while 113986-02 is required on Intel.  The linker
4184 patches must be installed even if GNU @command{ld} is used. Sun
4185 @command{as} in Solaris~8 and 9 doesn't support the necessary
4186 relocations, so GNU @command{as} must be used.  The @command{configure}
4187 script checks for those prerequisites and automatically enables TLS
4188 support if they are met.  Although those minimal patch versions should
4189 work, it is recommended to use the latest patch versions which include
4190 additional bug fixes.
4192 @html
4193 <hr />
4194 @end html
4195 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
4197 When GCC is configured to use GNU binutils 2.14 or later, the binaries
4198 produced are smaller than the ones produced using Sun's native tools;
4199 this difference is quite significant for binaries containing debugging
4200 information.
4202 Starting with Solaris 7, the operating system is capable of executing
4203 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
4204 this; the @option{-m64} option enables 64-bit code generation.
4205 However, if all you want is code tuned for the UltraSPARC CPU, you
4206 should try the @option{-mtune=ultrasparc} option instead, which produces
4207 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4208 machines.
4210 When configuring on a Solaris 7 or later system that is running a kernel
4211 that supports only 32-bit binaries, one must configure with
4212 @option{--disable-multilib}, since we will not be able to build the
4213 64-bit target libraries.
4215 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
4216 the GNU compiler (especially GCC 3.0.x versions), which lead to the
4217 miscompilation of the stage1 compiler and the subsequent failure of the
4218 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
4219 stage, i.e.@: to bootstrap that compiler with the base compiler and then
4220 use it to bootstrap the final compiler.
4222 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
4223 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
4224 failure in form of a miscompilation of the stage1 compiler by the Sun
4225 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
4227 GCC 3.4 changed the default debugging format from Stabs to DWARF-2 for
4228 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
4229 change apparently runs afoul of Sun bug 4910101 (which is referenced as
4230 an x86-only problem by Sun, probably because they do not use DWARF-2).
4231 A symptom of the problem is that you cannot compile C++ programs like
4232 @command{groff} 1.19.1 without getting messages similar to the following:
4234 @smallexample
4235 ld: warning: relocation error: R_SPARC_UA32: @dots{}
4236   external symbolic relocation against non-allocatable section
4237   .debug_info cannot be processed at runtime: relocation ignored.
4238 @end smallexample
4240 @noindent
4241 To work around this problem, compile with @option{-gstabs+} instead of
4242 plain @option{-g}.
4244 When configuring the GNU Multiple Precision Library (GMP) or the MPFR
4245 library on a Solaris 7 or later system, the canonical target triplet
4246 must be specified as the @command{build} parameter on the configure
4247 line.  This triplet can be obtained by invoking @command{./config.guess} in
4248 the toplevel source directory of GCC (and not that of GMP or MPFR).
4249 For example on a Solaris 9 system:
4251 @smallexample
4252    % ./configure --build=sparc-sun-solaris2.9 --prefix=xxx
4253 @end smallexample
4255 @html
4256 <hr />
4257 @end html
4258 @heading @anchor{sparc-sun-solaris210}sparc-sun-solaris2.10
4260 There is a bug in older versions of the Sun assembler which breaks
4261 thread-local storage (TLS).  A typical error message is
4263 @smallexample
4264 ld: fatal: relocation error: R_SPARC_TLS_LE_HIX22: file /var/tmp//ccamPA1v.o:
4265   symbol <unknown>: bad symbol type SECT: symbol type must be TLS
4266 @end smallexample
4268 @noindent
4269 This bug is fixed in Sun patch 118683-03 or later.
4271 @html
4272 <hr />
4273 @end html
4274 @heading @anchor{sparc-x-linux}sparc-*-linux*
4276 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
4277 or newer on this platform.  All earlier binutils and glibc
4278 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
4281 @html
4282 <hr />
4283 @end html
4284 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
4286 When configuring the GNU Multiple Precision Library (GMP) or the
4287 MPFR library, the canonical target triplet must be specified as
4288 the @command{build} parameter on the configure line.  For example
4289 on a Solaris 9 system:
4291 @smallexample
4292    % ./configure --build=sparc64-sun-solaris2.9 --prefix=xxx
4293 @end smallexample
4295 The following compiler flags must be specified in the configure
4296 step in order to bootstrap this target with the Sun compiler:
4298 @smallexample
4299    % CC="cc -xarch=v9 -xildoff" @var{srcdir}/configure [@var{options}] [@var{target}]
4300 @end smallexample
4302 @noindent
4303 @option{-xarch=v9} specifies the SPARC-V9 architecture to the Sun toolchain
4304 and @option{-xildoff} turns off the incremental linker.
4306 @html
4307 <hr />
4308 @end html
4309 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
4311 This is a synonym for @samp{sparc64-*-solaris2*}.
4313 @html
4314 <hr />
4315 @end html
4316 @heading @anchor{x-x-vxworks}*-*-vxworks*
4317 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
4318 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4319 We welcome patches for other architectures supported by VxWorks 5.5.
4320 Support for VxWorks AE would also be welcome; we believe this is merely
4321 a matter of writing an appropriate ``configlette'' (see below).  We are
4322 not interested in supporting older, a.out or COFF-based, versions of
4323 VxWorks in GCC 3.
4325 VxWorks comes with an older version of GCC installed in
4326 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4327 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4328 Before running @command{configure}, create the directories @file{@var{prefix}}
4329 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
4330 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4331 include that directory while running both @command{configure} and
4332 @command{make}.
4334 You must give @command{configure} the
4335 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4336 find the VxWorks system headers.  Since VxWorks is a cross compilation
4337 target only, you must also specify @option{--target=@var{target}}.
4338 @command{configure} will attempt to create the directory
4339 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4340 make sure the user running @command{configure} has sufficient privilege
4341 to do so.
4343 GCC's exception handling runtime requires a special ``configlette''
4344 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
4345 that file to add the module to your kernel build.  (Future versions of
4346 VxWorks will incorporate this module.)
4348 @html
4349 <hr />
4350 @end html
4351 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
4353 GCC supports the x86-64 architecture implemented by the AMD64 processor
4354 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4355 On GNU/Linux the default is a bi-arch compiler which is able to generate
4356 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4358 @html
4359 <hr />
4360 @end html
4361 @heading @anchor{xtensa-x-elf}xtensa*-*-elf
4363 This target is intended for embedded Xtensa systems using the
4364 @samp{newlib} C library.  It uses ELF but does not support shared
4365 objects.  Designed-defined instructions specified via the
4366 Tensilica Instruction Extension (TIE) language are only supported
4367 through inline assembly.
4369 The Xtensa configuration information must be specified prior to
4370 building GCC@.  The @file{include/xtensa-config.h} header
4371 file contains the configuration information.  If you created your
4372 own Xtensa configuration with the Xtensa Processor Generator, the
4373 downloaded files include a customized copy of this header file,
4374 which you can use to replace the default header file.
4376 @html
4377 <hr />
4378 @end html
4379 @heading @anchor{xtensa-x-linux}xtensa*-*-linux*
4381 This target is for Xtensa systems running GNU/Linux.  It supports ELF
4382 shared objects and the GNU C library (glibc).  It also generates
4383 position-independent code (PIC) regardless of whether the
4384 @option{-fpic} or @option{-fPIC} options are used.  In other
4385 respects, this target is the same as the
4386 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4388 @html
4389 <hr />
4390 @end html
4391 @heading @anchor{windows}Microsoft Windows
4393 @subheading Intel 16-bit versions
4394 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not 
4395 supported.
4397 However, the 32-bit port has limited support for Microsoft 
4398 Windows 3.11 in the Win32s environment, as a target only.  See below.
4400 @subheading Intel 32-bit versions
4402 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows 
4403 XP, and Windows Vista, are supported by several different target 
4404 platforms.  These targets differ in which Windows subsystem they target 
4405 and which C libraries are used.
4407 @itemize
4408 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space 
4409 Linux API emulation layer in the Win32 subsystem.
4410 @item Interix @uref{#x-x-interix,,*-*-interix}: The Interix subsystem 
4411 provides native support for POSIX.
4412 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for 
4413 the Win32 subsystem that provides a subset of POSIX.
4414 @item MKS i386-pc-mks: NuTCracker from MKS.  See 
4415 @uref{http://www.mkssoftware.com/} for more information.
4416 @end itemize
4418 @subheading Intel 64-bit versions
4420 GCC contains support for x86-64 using the mingw-w64
4421 runtime library, available from @uref{http://mingw-w64.sourceforge.net/}.
4422 This library should be used with the target triple x86_64-pc-mingw32.
4424 Presently Windows for Itanium is not supported.
4426 @subheading Windows CE
4428 Windows CE is supported as a target only on ARM (arm-wince-pe), Hitachi 
4429 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4431 @subheading Other Windows Platforms
4433 GCC no longer supports Windows NT on the Alpha or PowerPC.
4435 GCC no longer supports the Windows POSIX subsystem.  However, it does 
4436 support the Interix subsystem.  See above.
4438 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4440 PW32 (i386-pc-pw32) support was never completed, and the project seems to 
4441 be inactive.  See @uref{http://pw32.sourceforge.net/} for more information.
4443 UWIN support has been removed due to a lack of maintenance.
4445 @html
4446 <hr />
4447 @end html
4448 @heading @anchor{x-x-cygwin}*-*-cygwin
4450 Ports of GCC are included with the
4451 @uref{http://www.cygwin.com/,,Cygwin environment}.
4453 GCC will build under Cygwin without modification; it does not build
4454 with Microsoft's C++ compiler and there are no plans to make it do so.
4456 The Cygwin native compiler can be configured to target any 32-bit x86
4457 cpu architecture desired; the default is i686-pc-cygwin.  It should be
4458 used with as up-to-date a version of binutils as possible; use either
4459 the latest official GNU binutils release in the Cygwin distribution,
4460 or version 2.20 or above if building your own.
4462 @html
4463 <hr />
4464 @end html
4465 @heading @anchor{x-x-interix}*-*-interix
4467 The Interix target is used by OpenNT, Interix, Services For UNIX (SFU), 
4468 and Subsystem for UNIX-based Applications (SUA).  Applications compiled 
4469 with this target run in the Interix subsystem, which is separate from 
4470 the Win32 subsystem.  This target was last known to work in GCC 3.3.
4472 For more information, see @uref{http://www.interix.com/}.
4474 @html
4475 <hr />
4476 @end html
4477 @heading @anchor{x-x-mingw32}*-*-mingw32
4479 GCC will build with and support only MinGW runtime 3.12 and later.
4480 Earlier versions of headers are incompatible with the new default semantics
4481 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4483 @html
4484 <hr />
4485 @end html
4486 @heading @anchor{older}Older systems
4488 GCC contains support files for many older (1980s and early
4489 1990s) Unix variants.  For the most part, support for these systems
4490 has not been deliberately removed, but it has not been maintained for
4491 several years and may suffer from bitrot.
4493 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4494 Support for these systems is still present in that release, but
4495 @command{configure} will fail unless the @option{--enable-obsolete}
4496 option is given.  Unless a maintainer steps forward, support for these
4497 systems will be removed from the next release of GCC@.
4499 Support for old systems as hosts for GCC can cause problems if the
4500 workarounds for compiler, library and operating system bugs affect the
4501 cleanliness or maintainability of the rest of GCC@.  In some cases, to
4502 bring GCC up on such a system, if still possible with current GCC, may
4503 require first installing an old version of GCC which did work on that
4504 system, and using it to compile a more recent GCC, to avoid bugs in the
4505 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
4506 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4507 sites}.  Header bugs may generally be avoided using
4508 @command{fixincludes}, but bugs or deficiencies in libraries and the
4509 operating system may still cause problems.
4511 Support for older systems as targets for cross-compilation is less
4512 problematic than support for them as hosts for GCC; if an enthusiast
4513 wishes to make such a target work again (including resurrecting any of
4514 the targets that never worked with GCC 2, starting from the last
4515 version before they were removed), patches
4516 @uref{../contribute.html,,following the usual requirements} would be
4517 likely to be accepted, since they should not affect the support for more
4518 modern targets.
4520 For some systems, old versions of GNU binutils may also be useful,
4521 and are available from @file{pub/binutils/old-releases} on
4522 @uref{http://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4524 Some of the information on specific systems above relates to
4525 such older systems, but much of the information
4526 about GCC on such systems (which may no longer be applicable to
4527 current GCC) is to be found in the GCC texinfo manual.
4529 @html
4530 <hr />
4531 @end html
4532 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
4534 C++ support is significantly better on ELF targets if you use the
4535 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4536 inlines, vtables and template instantiations will be discarded
4537 automatically.
4540 @html
4541 <hr />
4543 @end html
4544 @ifhtml
4545 @uref{./index.html,,Return to the GCC Installation page}
4546 @end ifhtml
4547 @end ifset
4549 @c ***Old documentation******************************************************
4550 @ifset oldhtml
4551 @include install-old.texi
4552 @html
4553 <hr />
4555 @end html
4556 @ifhtml
4557 @uref{./index.html,,Return to the GCC Installation page}
4558 @end ifhtml
4559 @end ifset
4561 @c ***GFDL********************************************************************
4562 @ifset gfdlhtml
4563 @include fdl.texi
4564 @html
4565 <hr />
4567 @end html
4568 @ifhtml
4569 @uref{./index.html,,Return to the GCC Installation page}
4570 @end ifhtml
4571 @end ifset
4573 @c ***************************************************************************
4574 @c Part 6 The End of the Document
4575 @ifinfo
4576 @comment node-name,     next,          previous, up
4577 @node    Concept Index, , GNU Free Documentation License, Top
4578 @end ifinfo
4580 @ifinfo
4581 @unnumbered Concept Index
4583 @printindex cp
4585 @contents
4586 @end ifinfo
4587 @bye