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