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