commit changelogs for previous change
[official-gcc.git] / gcc / doc / install.texi
blob8947ff04428e6bcc7cd6414a99cda7cb27d0eacc
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 --with-cpu=@var{cpu}
949 Specify which cpu variant the compiler should generate code for by default.
950 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
951 This option is only supported on some targets, including ARM, i386, PowerPC,
952 and SPARC@.
954 @item --with-schedule=@var{cpu}
955 @itemx --with-arch=@var{cpu}
956 @itemx --with-tune=@var{cpu}
957 @itemx --with-abi=@var{abi}
958 @itemx --with-fpu=@var{type}
959 @itemx --with-float=@var{type}
960 These configure options provide default values for the @option{-mschedule=},
961 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
962 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
963 @option{--with-cpu}, which switches will be accepted and acceptable values
964 of the arguments depend on the target.
966 @item --with-divide=@var{type}
967 Specify how the compiler should generate code for checking for
968 division by zero.  This option is only supported on the MIPS target.
969 The possibilities for @var{type} are:
970 @table @code
971 @item traps
972 Division by zero checks use conditional traps (this is the default on
973 systems that support conditional traps).
974 @item breaks
975 Division by zero checks use the break instruction.
976 @end table
978 @item --enable-__cxa_atexit
979 Define if you want to use __cxa_atexit, rather than atexit, to
980 register C++ destructors for local statics and global objects.
981 This is essential for fully standards-compliant handling of
982 destructors, but requires __cxa_atexit in libc.  This option is currently
983 only available on systems with GNU libc.  When enabled, this will cause
984 @option{-fuse-cxa-exit} to be passed by default.
986 @item --enable-target-optspace
987 Specify that target
988 libraries should be optimized for code space instead of code speed.
989 This is the default for the m32r platform.
991 @item --disable-cpp
992 Specify that a user visible @command{cpp} program should not be installed.
994 @item --with-cpp-install-dir=@var{dirname}
995 Specify that the user visible @command{cpp} program should be installed
996 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
998 @item --enable-initfini-array
999 Force the use of sections @code{.init_array} and @code{.fini_array}
1000 (instead of @code{.init} and @code{.fini}) for constructors and
1001 destructors.  Option @option{--disable-initfini-array} has the
1002 opposite effect.  If neither option is specified, the configure script
1003 will try to guess whether the @code{.init_array} and
1004 @code{.fini_array} sections are supported and, if they are, use them.
1006 @item --enable-maintainer-mode
1007 The build rules that
1008 regenerate the GCC master message catalog @file{gcc.pot} are normally
1009 disabled.  This is because it can only be rebuilt if the complete source
1010 tree is present.  If you have changed the sources and want to rebuild the
1011 catalog, configuring with @option{--enable-maintainer-mode} will enable
1012 this.  Note that you need a recent version of the @code{gettext} tools
1013 to do so.
1015 @item --enable-generated-files-in-srcdir
1016 Neither the .c and .h files that are generated from bison and flex nor the
1017 info manuals and man pages that are built from the .texi files are present
1018 in the CVS development tree.  When building GCC from that development tree,
1019 or from a snapshot which are created from CVS, then those generated files
1020 are placed in your build directory, which allows for the source to be in a
1021 readonly directory.
1023 If you configure with @option{--enable-generated-files-in-srcdir} then those
1024 generated files will go into the source directory.  This is mainly intended
1025 for generating release or prerelease tarballs of the GCC sources, since it
1026 is not a requirement that the users of source releases to have flex, bison, or
1027 makeinfo.
1029 @item --enable-version-specific-runtime-libs
1030 Specify
1031 that runtime libraries should be installed in the compiler specific
1032 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1033 addition, @samp{libstdc++}'s include files will be installed into
1034 @file{@var{libdir}} unless you overruled it by using
1035 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1036 particularly useful if you intend to use several versions of GCC in
1037 parallel.  This is currently supported by @samp{libgfortran},
1038 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1040 @item --with-java-home=@var{dirname}
1041 This @samp{libjava} option overrides the default value of the
1042 @samp{java.home} system property.  It is also used to set
1043 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1044 default @samp{java.home} is set to @file{@var{prefix}} and
1045 @samp{sun.boot.class.path} to
1046 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1048 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1049 Specify that only a particular subset of compilers and
1050 their runtime libraries should be built.  For a list of valid values for
1051 @var{langN} you can issue the following command in the
1052 @file{gcc} directory of your GCC source tree:@*
1053 @smallexample
1054 grep language= */config-lang.in
1055 @end smallexample
1056 Currently, you can use any of the following:
1057 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran}, @code{java},
1058 @code{objc}, @code{obj-c++}, @code{treelang}.
1059 Building the Ada compiler has special requirements, see below.
1060 If you do not pass this flag, or specify the option @code{all}, then all
1061 default languages available in the @file{gcc} sub-tree will be configured.
1062 Ada, Objective-C++, and treelang are not default languages; the rest are.
1063 Re-defining @code{LANGUAGES} when calling @samp{make bootstrap}
1064 @strong{does not} work anymore, as those language sub-directories might
1065 not have been configured!
1067 @item --disable-libada
1068 Specify that the run-time libraries and tools used by GNAT should not
1069 be built.  This can be useful for debugging, or for compatibility with
1070 previous Ada build procedures, when it was required to explicitly
1071 do a @samp{make -C gcc gnatlib_and_tools}.
1073 @item --disable-libssp
1074 Specify that the run-time libraries for stack smashing protection
1075 should not be built.
1077 @item --with-dwarf2
1078 Specify that the compiler should
1079 use DWARF 2 debugging information as the default.
1081 @item --enable-targets=all
1082 @itemx --enable-targets=@var{target_list}
1083 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1084 These are compilers that are able to generate either 64-bit or 32-bit
1085 code.  Typically, the corresponding 32-bit target, e.g.@:
1086 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1087 option enables the 32-bit target to be a bi-arch compiler, which is
1088 useful when you want a bi-arch compiler that defaults to 32-bit, and
1089 you are building a bi-arch or multi-arch binutils in a combined tree.
1090 Currently, this option only affects powerpc-linux.
1092 @item --enable-secureplt
1093 This option enables @option{-msecure-plt} by default for powerpc-linux.
1094 @ifnothtml
1095 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1096 Using the GNU Compiler Collection (GCC)},
1097 @end ifnothtml
1098 @ifhtml
1099 See ``RS/6000 and PowerPC Options'' in the main manual
1100 @end ifhtml
1102 @item --enable-win32-registry
1103 @itemx --enable-win32-registry=@var{key}
1104 @itemx --disable-win32-registry
1105 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1106 to look up installations paths in the registry using the following key:
1108 @smallexample
1109 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1110 @end smallexample
1112 @var{key} defaults to GCC version number, and can be overridden by the
1113 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1114 who use custom installers are encouraged to provide a different key,
1115 perhaps one comprised of vendor name and GCC version number, to
1116 avoid conflict with existing installations.  This feature is enabled
1117 by default, and can be disabled by @option{--disable-win32-registry}
1118 option.  This option has no effect on the other hosts.
1120 @item --nfp
1121 Specify that the machine does not have a floating point unit.  This
1122 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1123 system, @option{--nfp} has no effect.
1125 @item --enable-werror
1126 @itemx --disable-werror
1127 @itemx --enable-werror=yes
1128 @itemx --enable-werror=no
1129 When you specify this option, it controls whether certain files in the
1130 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1131 If you don't specify it, @option{-Werror} is turned on for the main
1132 development trunk.  However it defaults to off for release branches and
1133 final releases.  The specific files which get @option{-Werror} are
1134 controlled by the Makefiles.
1136 @item --enable-checking
1137 @itemx --enable-checking=@var{list}
1138 When you specify this option, the compiler is built to perform internal
1139 consistency checks of the requested complexity.  This does not change the
1140 generated code, but adds error checking within the compiler.  This will
1141 slow down the compiler and may only work properly if you are building
1142 the compiler with GCC@.  This is @samp{yes} by default when building
1143 from CVS or snapshots, but @samp{release} for releases.  More control
1144 over the checks may be had by specifying @var{list}.  The categories of
1145 checks available are @samp{yes} (most common checks
1146 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1147 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1148 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1149 Individual checks can be enabled with these flags @samp{assert},
1150 @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1151 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1153 The @samp{valgrind} check requires the external @command{valgrind}
1154 simulator, available from @uref{http://valgrind.org/}.  The
1155 @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1156 To disable all checking, @samp{--disable-checking} or
1157 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1158 assertions will make the compiler and runtime slightly faster but
1159 increase the risk of undetected internal errors causing wrong code to be
1160 generated.
1162 @item --enable-coverage
1163 @itemx --enable-coverage=@var{level}
1164 With this option, the compiler is built to collect self coverage
1165 information, every time it is run.  This is for internal development
1166 purposes, and only works when the compiler is being built with gcc.  The
1167 @var{level} argument controls whether the compiler is built optimized or
1168 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1169 want to disable optimization, for performance analysis you want to
1170 enable optimization.  When coverage is enabled, the default level is
1171 without optimization.
1173 @item --enable-gather-detailed-mem-stats
1174 When this option is specified more detailed information on memory
1175 allocation is gathered.  This information is printed when using
1176 @option{-fmem-report}.
1178 @item --with-gc
1179 @itemx --with-gc=@var{choice}
1180 With this option you can specify the garbage collector implementation
1181 used during the compilation process.  @var{choice} can be one of
1182 @samp{page} and @samp{zone}, where @samp{page} is the default.
1184 @item --enable-nls
1185 @itemx --disable-nls
1186 The @option{--enable-nls} option enables Native Language Support (NLS),
1187 which lets GCC output diagnostics in languages other than American
1188 English.  Native Language Support is enabled by default if not doing a
1189 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1191 @item --with-included-gettext
1192 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1193 procedure to prefer its copy of GNU @command{gettext}.
1195 @item --with-catgets
1196 If NLS is enabled, and if the host lacks @code{gettext} but has the
1197 inferior @code{catgets} interface, the GCC build procedure normally
1198 ignores @code{catgets} and instead uses GCC's copy of the GNU
1199 @code{gettext} library.  The @option{--with-catgets} option causes the
1200 build procedure to use the host's @code{catgets} in this situation.
1202 @item --with-libiconv-prefix=@var{dir}
1203 Search for libiconv header files in @file{@var{dir}/include} and
1204 libiconv library files in @file{@var{dir}/lib}.
1206 @item --enable-obsolete
1207 Enable configuration for an obsoleted system.  If you attempt to
1208 configure GCC for a system (build, host, or target) which has been
1209 obsoleted, and you do not specify this flag, configure will halt with an
1210 error message.
1212 All support for systems which have been obsoleted in one release of GCC
1213 is removed entirely in the next major release, unless someone steps
1214 forward to maintain the port.
1215 @end table
1217 @subheading Cross-Compiler-Specific Options
1218 The following options only apply to building cross compilers.
1219 @table @code
1220 @item --with-sysroot
1221 @itemx --with-sysroot=@var{dir}
1222 Tells GCC to consider @var{dir} as the root of a tree that contains a
1223 (subset of) the root filesystem of the target operating system.
1224 Target system headers, libraries and run-time object files will be
1225 searched in there.  The specified directory is not copied into the
1226 install tree, unlike the options @option{--with-headers} and
1227 @option{--with-libs} that this option obsoletes.  The default value,
1228 in case @option{--with-sysroot} is not given an argument, is
1229 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1230 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1231 the GCC binaries if the installation tree is moved.
1233 @item --with-build-sysroot
1234 @itemx --with-build-sysroot=@var{dir}
1235 Tells GCC to consider @var{dir} as the system root (see
1236 @option{--with-sysroot}) while building target libraries, instead of
1237 the directory specified with @option{--with-sysroot}.  This option is
1238 only useful when you are already using @option{--with-sysroot}.  You
1239 can use @option{--with-build-sysroot} when you are configuring with
1240 @option{--prefix} set to a directory that is different from the one in
1241 which you are installing GCC and your target libraries.  
1243 This option affects the system root for the compiler used to build
1244 target libraries (which runs on the build system); it does not affect
1245 the compiler which is used to build GCC itself.
1247 @item --with-headers
1248 @itemx --with-headers=@var{dir}
1249 Deprecated in favor of @option{--with-sysroot}.
1250 Specifies that target headers are available when building a cross compiler.
1251 The @var{dir} argument specifies a directory which has the target include
1252 files.  These include files will be copied into the @file{gcc} install
1253 directory.  @emph{This option with the @var{dir} argument is required} when
1254 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1255 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1256 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1257 will be run on these files to make them compatible with GCC@.
1259 @item --without-headers
1260 Tells GCC not use any target headers from a libc when building a cross
1261 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1262 can build the exception handling for libgcc.
1263 See @uref{http://www.objsw.com/CrossGCC/,,CrossGCC} for more information
1264 on this option.
1266 @item --with-libs
1267 @itemx --with-libs=``@var{dir1} @var{dir2} @dots{} @var{dirN}''
1268 Deprecated in favor of @option{--with-sysroot}.
1269 Specifies a list of directories which contain the target runtime
1270 libraries.  These libraries will be copied into the @file{gcc} install
1271 directory.  If the directory list is omitted, this option has no
1272 effect.
1273 @item --with-newlib
1274 Specifies that @samp{newlib} is
1275 being used as the target C library.  This causes @code{__eprintf} to be
1276 omitted from @file{libgcc.a} on the assumption that it will be provided by
1277 @samp{newlib}.
1278 @end table
1280 @subheading Fortran-Specific Options
1282 The following options apply to the build of the Fortran front end.
1284 @table @code
1286 @item --with-gmp=@var{pathname}
1287 @itemx --with-mpfr=@var{pathname}
1288 @itemx --with-gmp-dir=@var{pathname}
1289 @itemx --with-mpfr-dir=@var{pathname}
1290 If you don't have GMP (the GNU Multiple Precision library) and the MPFR
1291 Libraries installed in a standard location and you want to build the Fortran
1292 front-end, you can explicitly specify the directory where they are installed
1293 (@samp{--with-gmp=gmpinstalldir}, @samp{--with-mpfr=mpfrinstalldir}) or where
1294 you built them without installing (@samp{--with-gmp-dir=gmpbuilddir},
1295 @samp{--with-mpfr-dir=gmpbuilddir}).
1297 @end table
1299 @subheading Java-Specific Options
1301 The following option applies to the build of the Java front end.
1303 @table @code
1304 @item --disable-libgcj
1305 Specify that the run-time libraries
1306 used by GCJ should not be built.  This is useful in case you intend
1307 to use GCJ with some other run-time, or you're going to install it
1308 separately, or it just happens not to build on your particular
1309 machine.  In general, if the Java front end is enabled, the GCJ
1310 libraries will be enabled too, unless they're known to not work on
1311 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1312 may need to port it; in this case, before modifying the top-level
1313 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1314 you may use @option{--enable-libgcj} to override the default.
1316 @end table
1318 The following options apply to building @samp{libgcj}.
1320 @subsubheading General Options
1322 @table @code
1323 @item --disable-getenv-properties
1324 Don't set system properties from @env{GCJ_PROPERTIES}.
1326 @item --enable-hash-synchronization
1327 Use a global hash table for monitor locks.  Ordinarily,
1328 @samp{libgcj}'s @samp{configure} script automatically makes
1329 the correct choice for this option for your platform.  Only use
1330 this if you know you need the library to be configured differently.
1332 @item --enable-interpreter
1333 Enable the Java interpreter.  The interpreter is automatically
1334 enabled by default on all platforms that support it.  This option
1335 is really only useful if you want to disable the interpreter
1336 (using @option{--disable-interpreter}).
1338 @item --disable-java-net
1339 Disable java.net.  This disables the native part of java.net only,
1340 using non-functional stubs for native method implementations.
1342 @item --disable-jvmpi
1343 Disable JVMPI support.
1345 @item --with-ecos
1346 Enable runtime eCos target support.
1348 @item --without-libffi
1349 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1350 support as well, as these require @samp{libffi} to work.
1352 @item --enable-libgcj-debug
1353 Enable runtime debugging code.
1355 @item --enable-libgcj-multifile
1356 If specified, causes all @file{.java} source files to be
1357 compiled into @file{.class} files in one invocation of
1358 @samp{gcj}.  This can speed up build time, but is more
1359 resource-intensive.  If this option is unspecified or
1360 disabled, @samp{gcj} is invoked once for each @file{.java}
1361 file to compile into a @file{.class} file.
1363 @item --with-libiconv-prefix=DIR
1364 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1366 @item --enable-sjlj-exceptions
1367 Force use of @code{builtin_setjmp} for exceptions.  @samp{configure}
1368 ordinarily picks the correct value based on the platform.  Only use
1369 this option if you are sure you need a different setting.
1371 @item --with-system-zlib
1372 Use installed @samp{zlib} rather than that included with GCC@.
1374 @item --with-win32-nlsapi=ansi, unicows or unicode
1375 Indicates how MinGW @samp{libgcj} translates between UNICODE
1376 characters and the Win32 API@.
1377 @table @code
1378 @item ansi
1379 Use the single-byte @code{char} and the Win32 A functions natively,
1380 translating to and from UNICODE when using these functions.  If
1381 unspecified, this is the default.
1383 @item unicows
1384 Use the @code{WCHAR} and Win32 W functions natively.  Adds
1385 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1386 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1387 running built executables.  @file{libunicows.a}, an open-source
1388 import library around Microsoft's @code{unicows.dll}, is obtained from
1389 @uref{http://libunicows.sourceforge.net/}, which also gives details
1390 on getting @file{unicows.dll} from Microsoft.
1392 @item unicode
1393 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
1394 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
1395 only run on Microsoft Windows NT and above.
1396 @end table
1397 @end table
1399 @subsubheading AWT-Specific Options
1401 @table @code
1402 @item --with-x
1403 Use the X Window System.
1405 @item --enable-java-awt=PEER(S)
1406 Specifies the AWT peer library or libraries to build alongside
1407 @samp{libgcj}.  If this option is unspecified or disabled, AWT
1408 will be non-functional.  Current valid values are @option{gtk} and
1409 @option{xlib}.  Multiple libraries should be separated by a
1410 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1412 @item --enable-gtk-cairo
1413 Build the cairo Graphics2D implementation on GTK@.
1415 @item --enable-java-gc=TYPE
1416 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
1418 @item --disable-gtktest
1419 Do not try to compile and run a test GTK+ program.
1421 @item --disable-glibtest
1422 Do not try to compile and run a test GLIB program.
1424 @item --with-libart-prefix=PFX
1425 Prefix where libart is installed (optional).
1427 @item --with-libart-exec-prefix=PFX
1428 Exec prefix where libart is installed (optional).
1430 @item --disable-libarttest
1431 Do not try to compile and run a test libart program.
1433 @end table
1435 @html
1436 <hr />
1438 @end html
1439 @ifhtml
1440 @uref{./index.html,,Return to the GCC Installation page}
1441 @end ifhtml
1442 @end ifset
1444 @c ***Building****************************************************************
1445 @ifnothtml
1446 @comment node-name,     next,          previous, up
1447 @node    Building, Testing, Configuration, Installing GCC
1448 @end ifnothtml
1449 @ifset buildhtml
1450 @ifnothtml
1451 @chapter Building
1452 @end ifnothtml
1453 @cindex Installing GCC: Building
1455 Now that GCC is configured, you are ready to build the compiler and
1456 runtime libraries.
1458 Some commands executed when making the compiler may fail (return a
1459 nonzero status) and be ignored by @command{make}.  These failures, which
1460 are often due to files that were not found, are expected, and can safely
1461 be ignored.
1463 It is normal to have compiler warnings when compiling certain files.
1464 Unless you are a GCC developer, you can generally ignore these warnings
1465 unless they cause compilation to fail.  Developers should attempt to fix
1466 any warnings encountered, however they can temporarily continue past
1467 warnings-as-errors by specifying the configure flag
1468 @option{--disable-werror}.
1470 On certain old systems, defining certain environment variables such as
1471 @env{CC} can interfere with the functioning of @command{make}.
1473 If you encounter seemingly strange errors when trying to build the
1474 compiler in a directory other than the source directory, it could be
1475 because you have previously configured the compiler in the source
1476 directory.  Make sure you have done all the necessary preparations.
1478 If you build GCC on a BSD system using a directory stored in an old System
1479 V file system, problems may occur in running @command{fixincludes} if the
1480 System V file system doesn't support symbolic links.  These problems
1481 result in a failure to fix the declaration of @code{size_t} in
1482 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
1483 that type mismatches occur, this could be the cause.
1485 The solution is not to use such a directory for building GCC@.
1487 When building from CVS or snapshots, or if you modify parser sources,
1488 you need the Bison parser generator installed.  Any version 1.25 or
1489 later should work; older versions may also work.  If you do not modify
1490 parser sources, releases contain the Bison-generated files and you do
1491 not need Bison installed to build them.
1493 When building from CVS or snapshots, or if you modify Texinfo
1494 documentation, you need version 4.4 or later of Texinfo installed if you
1495 want Info documentation to be regenerated.  Releases contain Info
1496 documentation pre-built for the unmodified documentation in the release.
1498 @section Building a native compiler
1500 For a native build issue the command @samp{make bootstrap}.  This
1501 will build the entire GCC system, which includes the following steps:
1503 @itemize @bullet
1504 @item
1505 Build host tools necessary to build the compiler such as texinfo, bison,
1506 gperf.
1508 @item
1509 Build target tools for use by the compiler such as binutils (bfd,
1510 binutils, gas, gprof, ld, and opcodes)
1511 if they have been individually linked
1512 or moved into the top level GCC source tree before configuring.
1514 @item
1515 Perform a 3-stage bootstrap of the compiler.
1517 @item
1518 Perform a comparison test of the stage2 and stage3 compilers.
1520 @item
1521 Build runtime libraries using the stage3 compiler from the previous step.
1523 @end itemize
1525 If you are short on disk space you might consider @samp{make
1526 bootstrap-lean} instead.  This is identical to @samp{make
1527 bootstrap} except that object files from the stage1 and
1528 stage2 of the 3-stage bootstrap of the compiler are deleted as
1529 soon as they are no longer needed.
1531 If you want to save additional space during the bootstrap and in
1532 the final installation as well, you can build the compiler binaries
1533 without debugging information as in the following example.  This will save
1534 roughly 40% of disk space both for the bootstrap and the final installation.
1535 (Libraries will still contain debugging information.)
1537 @smallexample
1538      make CFLAGS='-O' LIBCFLAGS='-g -O2' \
1539        LIBCXXFLAGS='-g -O2 -fno-implicit-templates' bootstrap
1540 @end smallexample
1542 If you wish to use non-default GCC flags when compiling the stage2 and
1543 stage3 compilers, set @code{BOOT_CFLAGS} on the command line when doing
1544 @samp{make bootstrap}.  Non-default optimization flags are less well
1545 tested here than the default of @samp{-g -O2}, but should still work.
1546 In a few cases, you may find that you need to specify special flags such
1547 as @option{-msoft-float} here to complete the bootstrap; or, if the
1548 native compiler miscompiles the stage1 compiler, you may need to work
1549 around this, by choosing @code{BOOT_CFLAGS} to avoid the parts of the
1550 stage1 compiler that were miscompiled, or by using @samp{make
1551 bootstrap4} to increase the number of stages of bootstrap.
1553 Note that using non-standard @code{CFLAGS} can cause bootstrap to fail in
1554 @file{libiberty}, if these trigger a warning with the new compiler.  For
1555 example using @samp{-O2 -g -mcpu=i686} on @code{i686-pc-linux-gnu} will
1556 cause bootstrap failure as @option{-mcpu=} is deprecated in 3.4.0 and above.
1559 If you used the flag @option{--enable-languages=@dots{}} to restrict
1560 the compilers to be built, only those you've actually enabled will be
1561 built.  This will of course only build those runtime libraries, for
1562 which the particular compiler has been built.  Please note,
1563 that re-defining @env{LANGUAGES} when calling @samp{make bootstrap}
1564 @strong{does not} work anymore!
1566 If the comparison of stage2 and stage3 fails, this normally indicates
1567 that the stage2 compiler has compiled GCC incorrectly, and is therefore
1568 a potentially serious bug which you should investigate and report.  (On
1569 a few systems, meaningful comparison of object files is impossible; they
1570 always appear ``different''.  If you encounter this problem, you will
1571 need to disable comparison in the @file{Makefile}.)
1573 @section Building a cross compiler
1575 We recommend reading the
1576 @uref{http://www.objsw.com/CrossGCC/,,crossgcc FAQ}
1577 for information about building cross compilers.
1579 When building a cross compiler, it is not generally possible to do a
1580 3-stage bootstrap of the compiler.  This makes for an interesting problem
1581 as parts of GCC can only be built with GCC@.
1583 To build a cross compiler, we first recommend building and installing a
1584 native compiler.  You can then use the native GCC compiler to build the
1585 cross compiler.  The installed native compiler needs to be GCC version
1586 2.95 or later.
1588 Assuming you have already installed a native copy of GCC and configured
1589 your cross compiler, issue the command @command{make}, which performs the
1590 following steps:
1592 @itemize @bullet
1593 @item
1594 Build host tools necessary to build the compiler such as texinfo, bison,
1595 gperf.
1597 @item
1598 Build target tools for use by the compiler such as binutils (bfd,
1599 binutils, gas, gprof, ld, and opcodes)
1600 if they have been individually linked or moved into the top level GCC source
1601 tree before configuring.
1603 @item
1604 Build the compiler (single stage only).
1606 @item
1607 Build runtime libraries using the compiler from the previous step.
1608 @end itemize
1610 Note that if an error occurs in any step the make process will exit.
1612 If you are not building GNU binutils in the same source tree as GCC,
1613 you will need a cross-assembler and cross-linker installed before
1614 configuring GCC@.  Put them in the directory
1615 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
1616 you should put in this directory:
1618 @table @file
1619 @item as
1620 This should be the cross-assembler.
1622 @item ld
1623 This should be the cross-linker.
1625 @item ar
1626 This should be the cross-archiver: a program which can manipulate
1627 archive files (linker libraries) in the target machine's format.
1629 @item ranlib
1630 This should be a program to construct a symbol table in an archive file.
1631 @end table
1633 The installation of GCC will find these programs in that directory,
1634 and copy or link them to the proper place to for the cross-compiler to
1635 find them when run later.
1637 The easiest way to provide these files is to build the Binutils package.
1638 Configure it with the same @option{--host} and @option{--target}
1639 options that you use for configuring GCC, then build and install
1640 them.  They install their executables automatically into the proper
1641 directory.  Alas, they do not support all the targets that GCC
1642 supports.
1644 If you are not building a C library in the same source tree as GCC,
1645 you should also provide the target libraries and headers before
1646 configuring GCC, specifying the directories with
1647 @option{--with-sysroot} or @option{--with-headers} and
1648 @option{--with-libs}.  Many targets also require ``start files'' such
1649 as @file{crt0.o} and
1650 @file{crtn.o} which are linked into each executable.  There may be several
1651 alternatives for @file{crt0.o}, for use with profiling or other
1652 compilation options.  Check your target's definition of
1653 @code{STARTFILE_SPEC} to find out what start files it uses.
1655 @section Building in parallel
1657 You can use @samp{make bootstrap MAKE="make -j 2" -j 2}, or just
1658 @samp{make -j 2 bootstrap} for GNU Make 3.79 and above, instead of
1659 @samp{make bootstrap} to build GCC in parallel.
1660 You can also specify a bigger number, and in most cases using a value
1661 greater than the number of processors in your machine will result in
1662 fewer and shorter I/O latency hits, thus improving overall throughput;
1663 this is especially true for slow drives and network filesystems.
1665 @section Building the Ada compiler
1667 In order to build GNAT, the Ada compiler, you need a working GNAT
1668 compiler (GNAT version 3.14 or later, or GCC version 3.1 or later),
1669 including GNAT tools such as @command{gnatmake} and @command{gnatlink},
1670 since the Ada front end is written in Ada (with some
1671 GNAT-specific extensions), and GNU make.
1673 @command{configure} does not test whether the GNAT installation works
1674 and has a sufficiently recent version; if too old a GNAT version is
1675 installed, the build will fail unless @option{--enable-languages} is
1676 used to disable building the Ada front end.
1678 @section Building with profile feedback
1680 It is possible to use profile feedback to optimize the compiler itself.  This
1681 should result in a faster compiler binary.  Experiments done on x86 using gcc
1682 3.3 showed approximately 7 percent speedup on compiling C programs.  To
1683 bootstrap compiler with profile feedback, use @code{make profiledbootstrap}.
1685 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
1686 compiler.  This compiler is used to build a @code{stageprofile} compiler
1687 instrumented to collect execution counts of instruction and branch
1688 probabilities.  Then runtime libraries are compiled with profile collected.
1689 Finally a @code{stagefeedback} compiler is built using the information collected.
1691 Unlike @samp{make bootstrap} several additional restrictions apply.  The
1692 compiler used to build @code{stage1} needs to support a 64-bit integral type.
1693 It is recommended to only use GCC for this.  Also parallel make is currently
1694 not supported since collisions in profile collecting may occur.
1696 @html
1697 <hr />
1699 @end html
1700 @ifhtml
1701 @uref{./index.html,,Return to the GCC Installation page}
1702 @end ifhtml
1703 @end ifset
1705 @c ***Testing*****************************************************************
1706 @ifnothtml
1707 @comment node-name,     next,          previous, up
1708 @node    Testing, Final install, Building, Installing GCC
1709 @end ifnothtml
1710 @ifset testhtml
1711 @ifnothtml
1712 @chapter Installing GCC: Testing
1713 @end ifnothtml
1714 @cindex Testing
1715 @cindex Installing GCC: Testing
1716 @cindex Testsuite
1718 Before you install GCC, we encourage you to run the testsuites and to
1719 compare your results with results from a similar configuration that have
1720 been submitted to the
1721 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
1722 Some of these archived results are linked from the build status lists
1723 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
1724 reports a successful build runs the testsuites and submits the results.
1725 This step is optional and may require you to download additional software,
1726 but it can give you confidence in your new GCC installation or point out
1727 problems before you install and start using your new GCC@.
1729 First, you must have @uref{download.html,,downloaded the testsuites}.
1730 These are part of the full distribution, but if you downloaded the
1731 ``core'' compiler plus any front ends, you must download the testsuites
1732 separately.
1734 Second, you must have the testing tools installed.  This includes
1735 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu} 1.4.4 and later,
1736 Tcl, and Expect; the DejaGnu site has links to these.
1738 If the directories where @command{runtest} and @command{expect} were
1739 installed are not in the @env{PATH}, you may need to set the following
1740 environment variables appropriately, as in the following example (which
1741 assumes that DejaGnu has been installed under @file{/usr/local}):
1743 @smallexample
1744      TCL_LIBRARY = /usr/local/share/tcl8.0
1745      DEJAGNULIBS = /usr/local/share/dejagnu
1746 @end smallexample
1748 (On systems such as Cygwin, these paths are required to be actual
1749 paths, not mounts or links; presumably this is due to some lack of
1750 portability in the DejaGnu code.)
1753 Finally, you can run the testsuite (which may take a long time):
1754 @smallexample
1755      cd @var{objdir}; make -k check
1756 @end smallexample
1758 This will test various components of GCC, such as compiler
1759 front ends and runtime libraries.  While running the testsuite, DejaGnu
1760 might emit some harmless messages resembling
1761 @samp{WARNING: Couldn't find the global config file.} or
1762 @samp{WARNING: Couldn't find tool init file} that can be ignored.
1764 @section How can you run the testsuite on selected tests?
1766 In order to run sets of tests selectively, there are targets
1767 @samp{make check-gcc} and @samp{make check-g++}
1768 in the @file{gcc} subdirectory of the object directory.  You can also
1769 just run @samp{make check} in a subdirectory of the object directory.
1772 A more selective way to just run all @command{gcc} execute tests in the
1773 testsuite is to use
1775 @smallexample
1776     make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
1777 @end smallexample
1779 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
1780 the testsuite with filenames matching @samp{9805*}, you would use
1782 @smallexample
1783     make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
1784 @end smallexample
1786 The @file{*.exp} files are located in the testsuite directories of the GCC
1787 source, the most important ones being @file{compile.exp},
1788 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
1789 To get a list of the possible @file{*.exp} files, pipe the
1790 output of @samp{make check} into a file and look at the
1791 @samp{Running @dots{}  .exp} lines.
1793 @section Passing options and running multiple testsuites
1795 You can pass multiple options to the testsuite using the
1796 @samp{--target_board} option of DejaGNU, either passed as part of
1797 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
1798 work outside the makefiles.  For example,
1800 @smallexample
1801     make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fno-strength-reduce"
1802 @end smallexample
1804 will run the standard @command{g++} testsuites (``unix'' is the target name
1805 for a standard native testsuite situation), passing
1806 @samp{-O3 -fno-strength-reduce} to the compiler on every test, i.e.,
1807 slashes separate options.
1809 You can run the testsuites multiple times using combinations of options
1810 with a syntax similar to the brace expansion of popular shells:
1812 @smallexample
1813     @dots{}"--target_board=arm-sim/@{-mhard-float,-msoft-float@}@{-O1,-O2,-O3,@}"
1814 @end smallexample
1816 (Note the empty option caused by the trailing comma in the final group.)
1817 The following will run each testsuite eight times using the @samp{arm-sim}
1818 target, as if you had specified all possible combinations yourself:
1820 @smallexample
1821     --target_board=arm-sim/-mhard-float/-O1
1822     --target_board=arm-sim/-mhard-float/-O2
1823     --target_board=arm-sim/-mhard-float/-O3
1824     --target_board=arm-sim/-mhard-float
1825     --target_board=arm-sim/-msoft-float/-O1
1826     --target_board=arm-sim/-msoft-float/-O2
1827     --target_board=arm-sim/-msoft-float/-O3
1828     --target_board=arm-sim/-msoft-float
1829 @end smallexample
1831 They can be combined as many times as you wish, in arbitrary ways.  This
1832 list:
1834 @smallexample
1835     @dots{}"--target_board=unix/-Wextra@{-O3,-fno-strength-reduce@}@{-fomit-frame-pointer,@}"
1836 @end smallexample
1838 will generate four combinations, all involving @samp{-Wextra}.
1840 The disadvantage to this method is that the testsuites are run in serial,
1841 which is a waste on multiprocessor systems.  For users with GNU Make and
1842 a shell which performs brace expansion, you can run the testsuites in
1843 parallel by having the shell perform the combinations and @command{make}
1844 do the parallel runs.  Instead of using @samp{--target_board}, use a
1845 special makefile target:
1847 @smallexample
1848     make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
1849 @end smallexample
1851 For example,
1853 @smallexample
1854     make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
1855 @end smallexample
1857 will run three concurrent ``make-gcc'' testsuites, eventually testing all
1858 ten combinations as described above.  Note that this is currently only
1859 supported in the @file{gcc} subdirectory.  (To see how this works, try
1860 typing @command{echo} before the example given here.)
1863 @section Additional testing for Java Class Libraries
1865 The Java runtime tests can be executed via @samp{make check}
1866 in the @file{@var{target}/libjava/testsuite} directory in
1867 the build tree.
1869 The @uref{http://sources.redhat.com/mauve/,,Mauve Project} provides
1870 a suite of tests for the Java Class Libraries.  This suite can be run
1871 as part of libgcj testing by placing the Mauve tree within the libjava
1872 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
1873 specifying the location of that tree when invoking @samp{make}, as in
1874 @samp{make MAUVEDIR=~/mauve check}.
1876 @uref{http://sources.redhat.com/mauve/jacks.html,,Jacks}
1877 is a free testsuite that tests Java compiler front ends.  This suite
1878 can be run as part of libgcj testing by placing the Jacks tree within
1879 the libjava testsuite at @file{libjava/testsuite/libjava.jacks/jacks}.
1881 @section How to interpret test results
1883 The result of running the testsuite are various @file{*.sum} and @file{*.log}
1884 files in the testsuite subdirectories.  The @file{*.log} files contain a
1885 detailed log of the compiler invocations and the corresponding
1886 results, the @file{*.sum} files summarize the results.  These summaries
1887 contain status codes for all tests:
1889 @itemize @bullet
1890 @item
1891 PASS: the test passed as expected
1892 @item
1893 XPASS: the test unexpectedly passed
1894 @item
1895 FAIL: the test unexpectedly failed
1896 @item
1897 XFAIL: the test failed as expected
1898 @item
1899 UNSUPPORTED: the test is not supported on this platform
1900 @item
1901 ERROR: the testsuite detected an error
1902 @item
1903 WARNING: the testsuite detected a possible problem
1904 @end itemize
1906 It is normal for some tests to report unexpected failures.  At the
1907 current time the testing harness does not allow fine grained control
1908 over whether or not a test is expected to fail.  This problem should
1909 be fixed in future releases.
1912 @section Submitting test results
1914 If you want to report the results to the GCC project, use the
1915 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
1917 @smallexample
1918     @var{srcdir}/contrib/test_summary -p your_commentary.txt \
1919         -m gcc-testresults@@gcc.gnu.org |sh
1920 @end smallexample
1922 This script uses the @command{Mail} program to send the results, so
1923 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
1924 prepended to the testsuite summary and should contain any special
1925 remarks you have on your results or your build environment.  Please
1926 do not edit the testsuite result block or the subject line, as these
1927 messages may be automatically processed.
1929 @html
1930 <hr />
1932 @end html
1933 @ifhtml
1934 @uref{./index.html,,Return to the GCC Installation page}
1935 @end ifhtml
1936 @end ifset
1938 @c ***Final install***********************************************************
1939 @ifnothtml
1940 @comment node-name,     next,          previous, up
1941 @node    Final install, , Testing, Installing GCC
1942 @end ifnothtml
1943 @ifset finalinstallhtml
1944 @ifnothtml
1945 @chapter Installing GCC: Final installation
1946 @end ifnothtml
1948 Now that GCC has been built (and optionally tested), you can install it with
1949 @smallexample
1950 cd @var{objdir}; make install
1951 @end smallexample
1953 We strongly recommend to install into a target directory where there is
1954 no previous version of GCC present.
1956 That step completes the installation of GCC; user level binaries can
1957 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
1958 you specified with the @option{--prefix} to configure (or
1959 @file{/usr/local} by default).  (If you specified @option{--bindir},
1960 that directory will be used instead; otherwise, if you specified
1961 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
1962 Headers for the C++ and Java libraries are installed in
1963 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
1964 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
1965 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
1966 in info format in @file{@var{infodir}} (normally
1967 @file{@var{prefix}/info}).
1969 When installing cross-compilers, GCC's executables
1970 are not only installed into @file{@var{bindir}}, that
1971 is, @file{@var{exec-prefix}/bin}, but additionally into
1972 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
1973 exists.  Typically, such @dfn{tooldirs} hold target-specific
1974 binutils, including assembler and linker.
1976 Installation into a temporary staging area or into a @command{chroot}
1977 jail can be achieved with the command
1979 @smallexample
1980 make DESTDIR=@var{path-to-rootdir} install
1981 @end smallexample
1983 @noindent where @var{path-to-rootdir} is the absolute path of
1984 a directory relative to which all installation paths will be
1985 interpreted.  Note that the directory specified by @code{DESTDIR}
1986 need not exist yet; it will be created if necessary.
1988 There is a subtle point with tooldirs and @code{DESTDIR}:
1989 If you relocate a cross-compiler installation with
1990 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
1991 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
1992 be filled with duplicated GCC executables only if it already exists,
1993 it will not be created otherwise.  This is regarded as a feature,
1994 not as a bug, because it gives slightly more control to the packagers
1995 using the @code{DESTDIR} feature.
1997 If you built a released version of GCC using @samp{make bootstrap} then please
1998 quickly review the build status page for your release, available from
1999 @uref{http://gcc.gnu.org/buildstat.html}.
2000 If your system is not listed for the version of GCC that you built,
2001 send a note to
2002 @email{gcc@@gcc.gnu.org} indicating
2003 that you successfully built and installed GCC@.
2004 Include the following information:
2006 @itemize @bullet
2007 @item
2008 Output from running @file{@var{srcdir}/config.guess}.  Do not send
2009 that file itself, just the one-line output from running it.
2011 @item
2012 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2013 This tells us which version of GCC you built and the options you passed to
2014 configure.
2016 @item
2017 Whether you enabled all languages or a subset of them.  If you used a
2018 full distribution then this information is part of the configure
2019 options in the output of @samp{gcc -v}, but if you downloaded the
2020 ``core'' compiler plus additional front ends then it isn't apparent
2021 which ones you built unless you tell us about it.
2023 @item
2024 If the build was for GNU/Linux, also include:
2025 @itemize @bullet
2026 @item
2027 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2028 this information should be available from @file{/etc/issue}.
2030 @item
2031 The version of the Linux kernel, available from @samp{uname --version}
2032 or @samp{uname -a}.
2034 @item
2035 The version of glibc you used; for RPM-based systems like Red Hat,
2036 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2037 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2038 @end itemize
2039 For other systems, you can include similar information if you think it is
2040 relevant.
2042 @item
2043 Any other information that you think would be useful to people building
2044 GCC on the same configuration.  The new entry in the build status list
2045 will include a link to the archived copy of your message.
2046 @end itemize
2048 We'd also like to know if the
2049 @ifnothtml
2050 @ref{Specific, host/target specific installation notes}
2051 @end ifnothtml
2052 @ifhtml
2053 @uref{specific.html,,host/target specific installation notes}
2054 @end ifhtml
2055 didn't include your host/target information or if that information is
2056 incomplete or out of date.  Send a note to
2057 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2059 If you find a bug, please report it following the
2060 @uref{../bugs.html,,bug reporting guidelines}.
2062 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2063 dvi}.  You will need to have @command{texi2dvi} (version at least 4.4)
2064 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2065 subdirectories of @file{@var{objdir}}; these may be converted for
2066 printing with programs such as @command{dvips}.  You can also
2067 @uref{http://www.gnu.org/order/order.html,,buy printed manuals from the
2068 Free Software Foundation}, though such manuals may not be for the most
2069 recent version of GCC@.
2071 If you would like to generate online HTML documentation, do @samp{cd
2072 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2073 @file{@var{objdir}/gcc/HTML}.
2075 @html
2076 <hr />
2078 @end html
2079 @ifhtml
2080 @uref{./index.html,,Return to the GCC Installation page}
2081 @end ifhtml
2082 @end ifset
2084 @c ***Binaries****************************************************************
2085 @ifnothtml
2086 @comment node-name,     next,          previous, up
2087 @node    Binaries, Specific, Installing GCC, Top
2088 @end ifnothtml
2089 @ifset binarieshtml
2090 @ifnothtml
2091 @chapter Installing GCC: Binaries
2092 @end ifnothtml
2093 @cindex Binaries
2094 @cindex Installing GCC: Binaries
2096 We are often asked about pre-compiled versions of GCC@.  While we cannot
2097 provide these for all platforms, below you'll find links to binaries for
2098 various platforms where creating them by yourself is not easy due to various
2099 reasons.
2101 Please note that we did not create these binaries, nor do we
2102 support them.  If you have any problems installing them, please
2103 contact their makers.
2105 @itemize
2106 @item
2107 AIX:
2108 @itemize
2109 @item
2110 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2112 @item
2113 @uref{http://aixpdslib.seas.ucla.edu,,UCLA Software Library for AIX}.
2114 @end itemize
2116 @item
2117 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2119 @item
2120 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2121 Development Tools for the Renesas H8/300[HS] Series}.
2123 @item
2124 HP-UX:
2125 @itemize
2126 @item
2127 @uref{http://hpux.cs.utah.edu/,,HP-UX Porting Center};
2129 @item
2130 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2131 @end itemize
2133 @item
2134 Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU
2135 Development Tools for the Motorola 68HC11/68HC12}.
2137 @item
2138 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2139 OpenServer/Unixware}.
2141 @item
2142 Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}.
2144 @item
2145 SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}.
2147 @item
2148 Microsoft Windows:
2149 @itemize
2150 @item
2151 The @uref{http://sources.redhat.com/cygwin/,,Cygwin} project;
2152 @item
2153 The @uref{http://www.mingw.org/,,MinGW} project.
2154 @end itemize
2156 @item
2157 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2158 Written Word} offers binaries for
2159 AIX 4.3.2.
2160 IRIX 6.5,
2161 Digital UNIX 4.0D and 5.1,
2162 GNU/Linux (i386),
2163 HP-UX 10.20, 11.00, and 11.11, and
2164 Solaris/SPARC 2.5.1, 2.6, 7, 8, and 9.
2166 @item
2167 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2168 number of platforms.
2170 @item
2171 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2172 links to gfortran binaries for several platforms.
2173 @end itemize
2175 In addition to those specific offerings, you can get a binary
2176 distribution CD-ROM from the
2177 @uref{http://www.gnu.org/order/order.html,,Free Software Foundation}.
2178 It contains binaries for a number of platforms, and
2179 includes not only GCC, but other stuff as well.  The current CD does
2180 not contain the latest version of GCC, but it should allow
2181 bootstrapping the compiler.  An updated version of that disk is in the
2182 works.
2184 @html
2185 <hr />
2187 @end html
2188 @ifhtml
2189 @uref{./index.html,,Return to the GCC Installation page}
2190 @end ifhtml
2191 @end ifset
2193 @c ***Specific****************************************************************
2194 @ifnothtml
2195 @comment node-name,     next,          previous, up
2196 @node    Specific, Old, Binaries, Top
2197 @end ifnothtml
2198 @ifset specifichtml
2199 @ifnothtml
2200 @chapter Host/target specific installation notes for GCC
2201 @end ifnothtml
2202 @cindex Specific
2203 @cindex Specific installation notes
2204 @cindex Target specific installation
2205 @cindex Host specific installation
2206 @cindex Target specific installation notes
2208 Please read this document carefully @emph{before} installing the
2209 GNU Compiler Collection on your machine.
2211 @ifhtml
2212 @itemize
2213 @item
2214 @uref{#alpha-x-x,,alpha*-*-*}
2215 @item
2216 @uref{#alpha-dec-osf,,alpha*-dec-osf*}
2217 @item
2218 @uref{#alphaev5-cray-unicosmk,,alphaev5-cray-unicosmk*}
2219 @item
2220 @uref{#arc-x-elf,,arc-*-elf}
2221 @item
2222 @uref{#arm-x-elf,,arm-*-elf}
2223 @uref{#arm-x-coff,,arm-*-coff}
2224 @uref{#arm-x-aout,,arm-*-aout}
2225 @item
2226 @uref{#xscale-x-x,,xscale-*-*}
2227 @item
2228 @uref{#avr,,avr}
2229 @item
2230 @uref{#bfin,,Blackfin}
2231 @item
2232 @uref{#c4x,,c4x}
2233 @item
2234 @uref{#dos,,DOS}
2235 @item
2236 @uref{#x-x-freebsd,,*-*-freebsd*}
2237 @item
2238 @uref{#h8300-hms,,h8300-hms}
2239 @item
2240 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2241 @item
2242 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2243 @item
2244 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2245 @item
2246 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2247 @item
2248 @uref{#ix86-x-linuxaout,,i?86-*-linux*aout}
2249 @item
2250 @uref{#ix86-x-linux,,i?86-*-linux*}
2251 @item
2252 @uref{#ix86-x-sco32v5,,i?86-*-sco3.2v5*}
2253 @item
2254 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2255 @item
2256 @uref{#ix86-x-udk,,i?86-*-udk}
2257 @item
2258 @uref{#ia64-x-linux,,ia64-*-linux}
2259 @item
2260 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2261 @item
2262 @uref{#x-ibm-aix,,*-ibm-aix*}
2263 @item
2264 @uref{#iq2000-x-elf,,iq2000-*-elf}
2265 @item
2266 @uref{#m32c-x-elf,,m32c-*-elf}
2267 @item
2268 @uref{#m32r-x-elf,,m32r-*-elf}
2269 @item
2270 @uref{#m6811-elf,,m6811-elf}
2271 @item
2272 @uref{#m6812-elf,,m6812-elf}
2273 @item
2274 @uref{#m68k-hp-hpux,,m68k-hp-hpux}
2275 @item
2276 @uref{#mips-x-x,,mips-*-*}
2277 @item
2278 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
2279 @item
2280 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
2281 @item
2282 @uref{#powerpc-x-x,,powerpc*-*-*, powerpc-*-sysv4}
2283 @item
2284 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
2285 @item
2286 @uref{#powerpc-x-elf,,powerpc-*-elf, powerpc-*-sysv4}
2287 @item
2288 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
2289 @item
2290 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
2291 @item
2292 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
2293 @item
2294 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
2295 @item
2296 @uref{#powerpcle-x-elf,,powerpcle-*-elf, powerpcle-*-sysv4}
2297 @item
2298 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
2299 @item
2300 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
2301 @item
2302 @uref{#s390-x-linux,,s390-*-linux*}
2303 @item
2304 @uref{#s390x-x-linux,,s390x-*-linux*}
2305 @item
2306 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
2307 @item
2308 @uref{#x-x-solaris2,,*-*-solaris2*}
2309 @item
2310 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
2311 @item
2312 @uref{#sparc-sun-solaris27,,sparc-sun-solaris2.7}
2313 @item
2314 @uref{#sparc-x-linux,,sparc-*-linux*}
2315 @item
2316 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
2317 @item
2318 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
2319 @item
2320 @uref{#x-x-sysv,,*-*-sysv*}
2321 @item
2322 @uref{#vax-dec-ultrix,,vax-dec-ultrix}
2323 @item
2324 @uref{#x-x-vxworks,,*-*-vxworks*}
2325 @item
2326 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
2327 @item
2328 @uref{#xtensa-x-elf,,xtensa-*-elf}
2329 @item
2330 @uref{#xtensa-x-linux,,xtensa-*-linux*}
2331 @item
2332 @uref{#windows,,Microsoft Windows}
2333 @item
2334 @uref{#os2,,OS/2}
2335 @item
2336 @uref{#older,,Older systems}
2337 @end itemize
2339 @itemize
2340 @item
2341 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
2342 @end itemize
2343 @end ifhtml
2346 @html
2347 <!-- -------- host/target specific issues start here ---------------- -->
2348 <hr />
2349 @end html
2350 @heading @anchor{alpha-x-x}alpha*-*-*
2352 This section contains general configuration information for all
2353 alpha-based platforms using ELF (in particular, ignore this section for
2354 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
2355 section, please read all other sections that match your target.
2357 We require binutils 2.11.2 or newer.
2358 Previous binutils releases had a number of problems with DWARF 2
2359 debugging information, not the least of which is incorrect linking of
2360 shared libraries.
2362 @html
2363 <hr />
2364 @end html
2365 @heading @anchor{alpha-dec-osf}alpha*-dec-osf*
2366 Systems using processors that implement the DEC Alpha architecture and
2367 are running the DEC/Compaq Unix (DEC OSF/1, Digital UNIX, or Compaq
2368 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
2370 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
2371 supported.  (These are the versions which identify themselves as DEC
2372 OSF/1.)
2374 In Digital Unix V4.0, virtual memory exhausted bootstrap failures
2375 may be fixed by configuring with @option{--with-gc=simple},
2376 reconfiguring Kernel Virtual Memory and Swap parameters
2377 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
2378 or applying the patch in
2379 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.
2381 In Tru64 UNIX V5.1, Compaq introduced a new assembler that does not
2382 currently (2001-06-13) work with @command{mips-tfile}.  As a workaround,
2383 we need to use the old assembler, invoked via the barely documented
2384 @option{-oldas} option.  To bootstrap GCC, you either need to use the
2385 Compaq C Compiler:
2387 @smallexample
2388    % CC=cc @var{srcdir}/configure [@var{options}] [@var{target}]
2389 @end smallexample
2391 or you can use a copy of GCC 2.95.3 or higher built on Tru64 UNIX V4.0:
2393 @smallexample
2394    % CC=gcc -Wa,-oldas @var{srcdir}/configure [@var{options}] [@var{target}]
2395 @end smallexample
2397 As of GNU binutils 2.11.2, neither GNU @command{as} nor GNU @command{ld}
2398 are supported on Tru64 UNIX, so you must not configure GCC with
2399 @option{--with-gnu-as} or @option{--with-gnu-ld}.
2401 GCC writes a @samp{.verstamp} directive to the assembler output file
2402 unless it is built as a cross-compiler.  It gets the version to use from
2403 the system header file @file{/usr/include/stamp.h}.  If you install a
2404 new version of DEC Unix, you should rebuild GCC to pick up the new version
2405 stamp.
2407 Note that since the Alpha is a 64-bit architecture, cross-compilers from
2408 32-bit machines will not generate code as efficient as that generated
2409 when the compiler is running on a 64-bit machine because many
2410 optimizations that depend on being able to represent a word on the
2411 target in an integral value on the host cannot be performed.  Building
2412 cross-compilers on the Alpha for 32-bit machines has only been tested in
2413 a few cases and may not work properly.
2415 @samp{make compare} may fail on old versions of DEC Unix unless you add
2416 @option{-save-temps} to @code{CFLAGS}.  On these systems, the name of the
2417 assembler input file is stored in the object file, and that makes
2418 comparison fail if it differs between the @code{stage1} and
2419 @code{stage2} compilations.  The option @option{-save-temps} forces a
2420 fixed name to be used for the assembler input file, instead of a
2421 randomly chosen name in @file{/tmp}.  Do not add @option{-save-temps}
2422 unless the comparisons fail without that option.  If you add
2423 @option{-save-temps}, you will have to manually delete the @samp{.i} and
2424 @samp{.s} files after each series of compilations.
2426 GCC now supports both the native (ECOFF) debugging format used by DBX
2427 and GDB and an encapsulated STABS format for use only with GDB@.  See the
2428 discussion of the @option{--with-stabs} option of @file{configure} above
2429 for more information on these formats and how to select them.
2431 There is a bug in DEC's assembler that produces incorrect line numbers
2432 for ECOFF format when the @samp{.align} directive is used.  To work
2433 around this problem, GCC will not emit such alignment directives
2434 while writing ECOFF format debugging information even if optimization is
2435 being performed.  Unfortunately, this has the very undesirable
2436 side-effect that code addresses when @option{-O} is specified are
2437 different depending on whether or not @option{-g} is also specified.
2439 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
2440 DBX@.  DEC is now aware of this problem with the assembler and hopes to
2441 provide a fix shortly.
2443 @html
2444 <hr />
2445 @end html
2446 @heading @anchor{alphaev5-cray-unicosmk}alphaev5-cray-unicosmk*
2447 Cray T3E systems running Unicos/Mk.
2449 This port is incomplete and has many known bugs.  We hope to improve the
2450 support for this target soon.  Currently, only the C front end is supported,
2451 and it is not possible to build parallel applications.  Cray modules are not
2452 supported; in particular, Craylibs are assumed to be in
2453 @file{/opt/ctl/craylibs/craylibs}.
2455 You absolutely @strong{must} use GNU make on this platform.  Also, you
2456 need to tell GCC where to find the assembler and the linker.  The
2457 simplest way to do so is by providing @option{--with-as} and
2458 @option{--with-ld} to @file{configure}, e.g.@:
2460 @smallexample
2461     configure --with-as=/opt/ctl/bin/cam --with-ld=/opt/ctl/bin/cld \
2462       --enable-languages=c
2463 @end smallexample
2465 The comparison test during @samp{make bootstrap} fails on Unicos/Mk
2466 because the assembler inserts timestamps into object files.  You should
2467 be able to work around this by doing @samp{make all} after getting this
2468 failure.
2470 @html
2471 <hr />
2472 @end html
2473 @heading @anchor{arc-x-elf}arc-*-elf
2474 Argonaut ARC processor.
2475 This configuration is intended for embedded systems.
2477 @html
2478 <hr />
2479 @end html
2480 @heading @anchor{arm-x-elf}arm-*-elf
2481 @heading @anchor{xscale-x-x}xscale-*-*
2482 ARM-family processors.  Subtargets that use the ELF object format
2483 require GNU binutils 2.13 or newer.  Such subtargets include:
2484 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux},
2485 @code{arm-*-rtems} and @code{arm-*-kaos}.
2487 @html
2488 <hr />
2489 @end html
2490 @heading @anchor{arm-x-coff}arm-*-coff
2491 ARM-family processors.  Note that there are two different varieties
2492 of PE format subtarget supported: @code{arm-wince-pe} and
2493 @code{arm-pe} as well as a standard COFF target @code{arm-*-coff}.
2495 @html
2496 <hr />
2497 @end html
2498 @heading @anchor{arm-x-aout}arm-*-aout
2499 ARM-family processors.  These targets support the AOUT file format:
2500 @code{arm-*-aout}, @code{arm-*-netbsd}.
2502 @html
2503 <hr />
2504 @end html
2505 @heading @anchor{avr}avr
2507 ATMEL AVR-family micro controllers.  These are used in embedded
2508 applications.  There are no standard Unix configurations.
2509 @ifnothtml
2510 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
2511 Collection (GCC)},
2512 @end ifnothtml
2513 @ifhtml
2514 See ``AVR Options'' in the main manual
2515 @end ifhtml
2516 for the list of supported MCU types.
2518 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
2520 Further installation notes and other useful information about AVR tools
2521 can also be obtained from:
2523 @itemize @bullet
2524 @item
2525 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
2526 @item
2527 @uref{http://home.overta.ru/users/denisc/,,http://home.overta.ru/users/denisc/}
2528 @item
2529 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
2530 @end itemize
2532 We @emph{strongly} recommend using binutils 2.13 or newer.
2534 The following error:
2535 @smallexample
2536   Error: register required
2537 @end smallexample
2539 indicates that you should upgrade to a newer version of the binutils.
2541 @html
2542 <hr />
2543 @end html
2544 @heading @anchor{bfin}Blackfin
2546 The Blackfin processor, an Analog Devices DSP.
2547 @ifnothtml
2548 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
2549 Collection (GCC)},
2550 @end ifnothtml
2551 @ifhtml
2552 See ``Blackfin Options'' in the main manual
2553 @end ifhtml
2555 More information, and a version of binutils with support for this processor,
2556 is available at @uref{http://blackfin.uclinux.org}
2558 @html
2559 <hr />
2560 @end html
2561 @heading @anchor{c4x}c4x
2563 Texas Instruments TMS320C3x and TMS320C4x Floating Point Digital Signal
2564 Processors.  These are used in embedded applications.  There are no
2565 standard Unix configurations.
2566 @ifnothtml
2567 @xref{TMS320C3x/C4x Options,, TMS320C3x/C4x Options, gcc, Using the
2568 GNU Compiler Collection (GCC)},
2569 @end ifnothtml
2570 @ifhtml
2571 See ``TMS320C3x/C4x Options'' in the main manual
2572 @end ifhtml
2573 for the list of supported MCU types.
2575 GCC can be configured as a cross compiler for both the C3x and C4x
2576 architectures on the same system.  Use @samp{configure --target=c4x
2577 --enable-languages="c,c++"} to configure.
2580 Further installation notes and other useful information about C4x tools
2581 can also be obtained from:
2583 @itemize @bullet
2584 @item
2585 @uref{http://www.elec.canterbury.ac.nz/c4x/,,http://www.elec.canterbury.ac.nz/c4x/}
2586 @end itemize
2588 @html
2589 <hr />
2590 @end html
2591 @heading @anchor{cris}CRIS
2593 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
2594 series.  These are used in embedded applications.
2596 @ifnothtml
2597 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
2598 Collection (GCC)},
2599 @end ifnothtml
2600 @ifhtml
2601 See ``CRIS Options'' in the main manual
2602 @end ifhtml
2603 for a list of CRIS-specific options.
2605 There are a few different CRIS targets:
2606 @table @code
2607 @item cris-axis-aout
2608 Old target.  Includes a multilib for the @samp{elinux} a.out-based
2609 target.  No multilibs for newer architecture variants.
2610 @item cris-axis-elf
2611 Mainly for monolithic embedded systems.  Includes a multilib for the
2612 @samp{v10} core used in @samp{ETRAX 100 LX}.
2613 @item cris-axis-linux-gnu
2614 A GNU/Linux port for the CRIS architecture, currently targeting
2615 @samp{ETRAX 100 LX} by default.
2616 @end table
2618 For @code{cris-axis-aout} and @code{cris-axis-elf} you need binutils 2.11
2619 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
2621 Pre-packaged tools can be obtained from
2622 @uref{ftp://ftp.axis.com/pub/axis/tools/cris/compiler-kit/}.  More
2623 information about this platform is available at
2624 @uref{http://developer.axis.com/}.
2626 @html
2627 <hr />
2628 @end html
2629 @heading @anchor{crx}CRX
2631 The CRX CompactRISC architecture is a low-power 32-bit architecture with
2632 fast context switching and architectural extensibility features.
2634 @ifnothtml
2635 @xref{CRX Options,, CRX Options, gcc, Using and Porting the GNU Compiler
2636 Collection (GCC)},
2637 @end ifnothtml
2639 @ifhtml
2640 See ``CRX Options'' in the main manual for a list of CRX-specific options.
2641 @end ifhtml
2643 Use @samp{configure --target=crx-elf --enable-languages=c,c++} to configure
2644 GCC@ for building a CRX cross-compiler. The option @samp{--target=crx-elf}
2645 is also used to build the @samp{newlib} C library for CRX.
2647 It is also possible to build libstdc++-v3 for the CRX architecture. This
2648 needs to be done in a separate step with the following configure settings:
2649 @samp{gcc/libstdc++-v3/configure --host=crx-elf --with-newlib
2650 --enable-sjlj-exceptions --enable-cxx-flags='-fexceptions -frtti'}
2652 @html
2653 <hr />
2654 @end html
2655 @heading @anchor{dos}DOS
2657 Please have a look at the @uref{binaries.html,,binaries page}.
2659 You cannot install GCC by itself on MSDOS; it will not compile under
2660 any MSDOS compiler except itself.  You need to get the complete
2661 compilation package DJGPP, which includes binaries as well as sources,
2662 and includes all the necessary compilation tools and libraries.
2664 @html
2665 <hr />
2666 @end html
2667 @heading @anchor{x-x-freebsd}*-*-freebsd*
2669 The version of binutils installed in @file{/usr/bin} probably works with
2670 this release of GCC@.  However, on FreeBSD 4, bootstrapping against the
2671 latest FSF binutils is known to improve overall testsuite results; and,
2672 on FreeBSD/alpha, using binutils 2.14 or later is required to build libjava.
2674 Support for FreeBSD 1 was discontinued in GCC 3.2.
2676 Support for FreeBSD 2 will be discontinued after GCC 3.4.  The
2677 following was true for GCC 3.1 but the current status is unknown.
2678 For FreeBSD 2 or any mutant a.out versions of FreeBSD 3: All
2679 configuration support and files as shipped with GCC 2.95 are still in
2680 place.  FreeBSD 2.2.7 has been known to bootstrap completely; however,
2681 it is unknown which version of binutils was used (it is assumed that it
2682 was the system copy in @file{/usr/bin}) and C++ EH failures were noted.
2684 For FreeBSD using the ELF file format: DWARF 2 debugging is now the
2685 default for all CPU architectures.  It had been the default on
2686 FreeBSD/alpha since its inception.  You may use @option{-gstabs} instead
2687 of @option{-g}, if you really want the old debugging format.  There are
2688 no known issues with mixing object files and libraries with different
2689 debugging formats.  Otherwise, this release of GCC should now match more
2690 of the configuration used in the stock FreeBSD configuration of GCC@.  In
2691 particular, @option{--enable-threads} is now configured by default.
2692 However, as a general user, do not attempt to replace the system
2693 compiler with this release.  Known to bootstrap and check with good
2694 results on FreeBSD 4.9-STABLE and 5-CURRENT@.  In the past, known to
2695 bootstrap and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2,
2696 4.3, 4.4, 4.5, 4.8-STABLE@.
2698 In principle, @option{--enable-threads} is now compatible with
2699 @option{--enable-libgcj} on FreeBSD@.  However, it has only been built
2700 and tested on @samp{i386-*-freebsd[45]} and @samp{alpha-*-freebsd[45]}.
2701 The static
2702 library may be incorrectly built (symbols are missing at link time).
2703 There is a rare timing-based startup hang (probably involves an
2704 assumption about the thread library).  Multi-threaded boehm-gc (required for
2705 libjava) exposes severe threaded signal-handling bugs on FreeBSD before
2706 4.5-RELEASE@.  Other CPU architectures
2707 supported by FreeBSD will require additional configuration tuning in, at
2708 the very least, both boehm-gc and libffi.
2710 Shared @file{libgcc_s.so} is now built and installed by default.
2712 @html
2713 <hr />
2714 @end html
2715 @heading @anchor{h8300-hms}h8300-hms
2716 Renesas H8/300 series of processors.
2718 Please have a look at the @uref{binaries.html,,binaries page}.
2720 The calling convention and structure layout has changed in release 2.6.
2721 All code must be recompiled.  The calling convention now passes the
2722 first three arguments in function calls in registers.  Structures are no
2723 longer a multiple of 2 bytes.
2725 @html
2726 <hr />
2727 @end html
2728 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
2729 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
2731 We require using gas/binutils on all hppa platforms;
2732 you may encounter a variety of problems if you try to use the HP assembler.
2734 Specifically, @option{-g} does not work on HP-UX (since that system
2735 uses a peculiar debugging format which GCC does not know about), unless
2736 you use GAS and GDB@.  It may be helpful to configure GCC with the
2737 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
2738 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
2740 If you wish to use the pa-risc 2.0 architecture support with a 32-bit
2741 runtime, you must use gas/binutils 2.11 or newer.
2743 There are two default scheduling models for instructions.  These are
2744 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
2745 architecture specified for the target machine when configuring.
2746 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
2747 the target is a @samp{hppa1*} machine.
2749 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
2750 it is important to completely specify the machine architecture when
2751 configuring if you want a model other than PROCESSOR_8000.  The macro
2752 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
2753 default scheduling model is desired.
2755 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
2756 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
2757 This namespace change might cause problems when bootstrapping with
2758 an earlier version of GCC or the HP compiler as essentially the same
2759 namespace is required for an entire build.  This problem can be avoided
2760 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
2761 or @samp{98}.  Another way is to add an appropriate set of predefines
2762 to @env{CC}.  The description for the @option{munix=} option contains
2763 a list of the predefines used with each standard.
2765 More specific information to @samp{hppa*-hp-hpux*} targets follows.
2767 @html
2768 <hr />
2769 @end html
2770 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
2772 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
2773 @code{PHCO_19798} from HP@.  HP has two sites which provide patches free of
2774 charge:
2776 @itemize @bullet
2777 @item
2778 @html
2779 <a href="http://us.itrc.hp.com/service/home/home.do">US, Canada, Asia-Pacific, and
2780 Latin-America</a>
2781 @end html
2782 @ifnothtml
2783 @uref{http://us.itrc.hp.com/service/home/home.do,,} US, Canada, Asia-Pacific,
2784 and Latin-America.
2785 @end ifnothtml
2786 @item
2787 @uref{http://europe.itrc.hp.com/service/home/home.do,,} Europe.
2788 @end itemize
2790 The HP assembler on these systems has some problems.  Most notably the
2791 assembler inserts timestamps into each object file it creates, causing
2792 the 3-stage comparison test to fail during a @samp{make bootstrap}.
2793 You should be able to continue by saying @samp{make all} after getting
2794 the failure from @samp{make bootstrap}.
2796 GCC 4.0 requires CVS binutils as of April 28, 2004 or later.  Earlier
2797 versions require binutils 2.8 or later.
2799 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
2800 used for one-only code and data.  This resolves many of the previous
2801 problems in using C++ on this target.  However, the ABI is not compatible
2802 with the one implemented under HP-UX 11 using secondary definitions.
2804 @html
2805 <hr />
2806 @end html
2807 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
2809 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
2810 be used to compile GCC 3.0 and up.
2812 Refer to @uref{binaries.html,,binaries} for information about obtaining
2813 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
2814 to build the Ada language as it can't be bootstrapped using C@.  Ada is
2815 only available for the 32-bit PA-RISC runtime.  The libffi and libjava
2816 haven't been ported to HP-UX and don't build.
2818 It is possible to build GCC 3.3 starting with the bundled HP compiler,
2819 but the process requires several steps.  GCC 3.3 can then be used to
2820 build later versions.  The fastjar program contains ISO C code and
2821 can't be built with the HP bundled compiler.  This problem can be
2822 avoided by not building the Java language.  For example, use the
2823 @option{--enable-languages="c,c++,f77,objc"} option in your configure
2824 command.
2826 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
2827 bundled compiler supports only traditional C; you will need either HP's
2828 unbundled compiler, or a binary distribution of GCC@.
2830 There are several possible approaches to building the distribution.
2831 Binutils can be built first using the HP tools.  Then, the GCC
2832 distribution can be built.  The second approach is to build GCC
2833 first using the HP tools, then build binutils, then rebuild GCC@.
2834 There have been problems with various binary distributions, so it
2835 is best not to start from a binary distribution.
2837 On 64-bit capable systems, there are two distinct targets.  Different
2838 installation prefixes must be used if both are to be installed on
2839 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
2840 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
2841 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
2842 PA-RISC 2.0 architecture.  The HP and GNU linkers are both supported
2843 for this target.
2845 The script config.guess now selects the target type based on the compiler
2846 detected during configuration.  You must define @env{PATH} or @env{CC} so
2847 that configure finds an appropriate compiler for the initial bootstrap.
2848 When @env{CC} is used, the definition should contain the options that are
2849 needed whenever @env{CC} is used.
2851 Specifically, options that determine the runtime architecture must be
2852 in @env{CC} to correctly select the target for the build.  It is also
2853 convenient to place many other compiler options in @env{CC}.  For example,
2854 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
2855 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
2856 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
2857 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
2858 macro definition table of cpp needs to be increased for a successful
2859 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
2860 be defined when building with the bundled compiler, or when using the
2861 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
2863 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
2864 with the @option{--with-ld=@dots{}} option.  This overrides the standard
2865 search for ld.  The two linkers supported on this target require different
2866 commands.  The default linker is determined during configuration.  As a
2867 result, it's not possible to switch linkers in the middle of a GCC build.
2868 This has been been reported to sometimes occur in unified builds of
2869 binutils and GCC@.
2871 GCC 3.0 through 3.2 require binutils 2.11 or above.  GCC 3.3 through
2872 GCC 4.0 require binutils 2.14 or later.
2874 Although the HP assembler can be used for an initial build, it shouldn't
2875 be used with any languages other than C and perhaps Fortran due to its
2876 many limitations.  For example, it does not support weak symbols or alias
2877 definitions.  As a result, explicit template instantiations are required
2878 when using C++.  This makes it difficult if not impossible to build many
2879 C++ applications.  You can't generate debugging information when using
2880 the HP assembler.  Finally, @samp{make bootstrap} fails in the final
2881 comparison of object modules due to the time stamps that it inserts into
2882 the modules.  The bootstrap can be continued from this point with
2883 @samp{make all}.
2885 A recent linker patch must be installed for the correct operation of
2886 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
2887 oldest linker patches that are known to work.  They are for HP-UX
2888 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
2889 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
2890 patches have been superseded.  Consult the HP patch database to obtain
2891 the currently recommended linker patch for your system.
2893 The patches are necessary for the support of weak symbols on the
2894 32-bit port, and for the running of initializers and finalizers.  Weak
2895 symbols are implemented using SOM secondary definition symbols.  Prior
2896 to HP-UX 11, there are bugs in the linker support for secondary symbols.
2897 The patches correct a problem of linker core dumps creating shared
2898 libraries containing secondary symbols, as well as various other
2899 linking issues involving secondary symbols.
2901 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
2902 run initializers and finalizers on the 64-bit port.  The 32-bit port
2903 uses the linker @option{+init} and @option{+fini} options for the same
2904 purpose.  The patches correct various problems with the +init/+fini
2905 options, including program core dumps.  Binutils 2.14 corrects a
2906 problem on the 64-bit port resulting from HP's non-standard use of
2907 the .init and .fini sections for array initializers and finalizers.
2909 There are a number of issues to consider in selecting which linker to
2910 use with the 64-bit port.  The GNU 64-bit linker can only create dynamic
2911 binaries.  The @option{-static} option causes linking with archive
2912 libraries but doesn't produce a truly static binary.  Dynamic binaries
2913 still require final binding by the dynamic loader to resolve a set of
2914 dynamic-loader-defined symbols.  The default behavior of the HP linker
2915 is the same as the GNU linker.  However, it can generate true 64-bit
2916 static binaries using the @option{+compat} option.
2918 The HP 64-bit linker doesn't support linkonce semantics.  As a
2919 result, C++ programs have many more sections than they should.
2921 The GNU 64-bit linker has some issues with shared library support
2922 and exceptions.  As a result, we only support libgcc in archive
2923 format.  For similar reasons, dwarf2 unwind and exception support
2924 are disabled.  The GNU linker also has problems creating binaries
2925 with @option{-static}.  It doesn't provide stubs for internal
2926 calls to global functions in shared libraries, so these calls
2927 can't be overloaded.
2929 Thread support is not implemented in GCC 3.0 through 3.2, so the
2930 @option{--enable-threads} configure option does not work.  In 3.3
2931 and later, POSIX threads are supported.  The optional DCE thread
2932 library is not supported.
2934 This port still is undergoing significant development.
2936 @html
2937 <hr />
2938 @end html
2939 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
2941 Versions of libstdc++-v3 starting with 3.2.1 require bugfixes present
2942 in glibc 2.2.5 and later.  More information is available in the
2943 libstdc++-v3 documentation.
2945 @html
2946 <hr />
2947 @end html
2948 @heading @anchor{ix86-x-linuxaout}i?86-*-linux*aout
2949 Use this configuration to generate @file{a.out} binaries on Linux-based
2950 GNU systems.  This configuration is being superseded.
2952 @html
2953 <hr />
2954 @end html
2955 @heading @anchor{ix86-x-linux}i?86-*-linux*
2957 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
2958 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
2960 If you receive Signal 11 errors when building on GNU/Linux, then it is
2961 possible you have a hardware problem.  Further information on this can be
2962 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
2964 @html
2965 <hr />
2966 @end html
2967 @heading @anchor{ix86-x-sco32v5}i?86-*-sco3.2v5*
2968 Use this for the SCO OpenServer Release 5 family of operating systems.
2970 Unlike earlier versions of GCC, the ability to generate COFF with this
2971 target is no longer provided.
2973 Earlier versions of GCC emitted DWARF 1 when generating ELF to allow
2974 the system debugger to be used.  That support was too burdensome to
2975 maintain.  GCC now emits only DWARF 2 for this target.  This means you
2976 may use either the UDK debugger or GDB to debug programs built by this
2977 version of GCC@.
2979 GCC is now only supported on releases 5.0.4 and later, and requires that
2980 you install Support Level Supplement OSS646B or later, and Support Level
2981 Supplement OSS631C or later.  If you are using release 5.0.7 of
2982 OpenServer, you must have at least the first maintenance pack installed
2983 (this includes the relevant portions of OSS646).  OSS646, also known as
2984 the ``Execution Environment Update'', provides updated link editors and
2985 assemblers, as well as updated standard C and math libraries.  The C
2986 startup modules are also updated to support the System V gABI draft, and
2987 GCC relies on that behavior.  OSS631 provides a collection of commonly
2988 used open source libraries, some of which GCC depends on (such as GNU
2989 gettext and zlib).  SCO OpenServer Release 5.0.7 has all of this built
2990 in by default, but OSS631C and later also apply to that release.  Please
2991 visit
2992 @uref{ftp://ftp.sco.com/pub/openserver5,,ftp://ftp.sco.com/pub/openserver5}
2993 for the latest versions of these (and other potentially useful)
2994 supplements.
2996 Although there is support for using the native assembler, it is
2997 recommended that you configure GCC to use the GNU assembler.  You do
2998 this by using the flags
2999 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}}.  You should
3000 use a modern version of GNU binutils.  Version 2.13.2.1 was used for all
3001 testing.  In general, only the @option{--with-gnu-as} option is tested.
3002 A modern bintuils (as well as a plethora of other development related
3003 GNU utilities) can be found in Support Level Supplement OSS658A, the
3004 ``GNU Development Tools'' package.  See the SCO web and ftp sites for details.
3005 That package also contains the currently ``officially supported'' version of
3006 GCC, version 2.95.3.  It is useful for bootstrapping this version.
3008 @html
3009 <hr />
3010 @end html
3011 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3012 Use this for Solaris 10 or later on x86 and x86-64 systems.  This
3013 configuration is supported by GCC 4.0 and later versions only.
3015 It is recommended that you configure GCC to use the GNU assembler in
3016 @file{/usr/sfw/bin/gas} but the Sun linker, using the options
3017 @option{--with-gnu-as --with-as=/usr/sfw/bin/gas --without-gnu-ld
3018 --with-ld=/usr/ccs/bin/ld}.
3020 @html
3021 <hr />
3022 @end html
3023 @heading @anchor{ix86-x-udk}i?86-*-udk
3025 This target emulates the SCO Universal Development Kit and requires that
3026 package be installed.  (If it is installed, you will have a
3027 @file{/udk/usr/ccs/bin/cc} file present.)  It's very much like the
3028 @samp{i?86-*-unixware7*} target
3029 but is meant to be used when hosting on a system where UDK isn't the
3030 default compiler such as OpenServer 5 or Unixware 2.  This target will
3031 generate binaries that will run on OpenServer, Unixware 2, or Unixware 7,
3032 with the same warnings and caveats as the SCO UDK@.
3034 This target is a little tricky to build because we have to distinguish
3035 it from the native tools (so it gets headers, startups, and libraries
3036 from the right place) while making the tools not think we're actually
3037 building a cross compiler.   The easiest way to do this is with a configure
3038 command like this:
3040 @smallexample
3041     CC=/udk/usr/ccs/bin/cc @var{/your/path/to}/gcc/configure \
3042       --host=i686-pc-udk --target=i686-pc-udk --program-prefix=udk-
3043 @end smallexample
3045 @emph{You should substitute @samp{i686} in the above command with the appropriate
3046 processor for your host.}
3048 After the usual @samp{make bootstrap} and
3049 @samp{make install}, you can then access the UDK-targeted GCC
3050 tools by adding @command{udk-} before the commonly known name.  For
3051 example, to invoke the C compiler, you would use @command{udk-gcc}.
3052 They will coexist peacefully with any native-target GCC tools you may
3053 have installed.
3056 @html
3057 <hr />
3058 @end html
3059 @heading @anchor{ia64-x-linux}ia64-*-linux
3060 IA-64 processor (also known as IPF, or Itanium Processor Family)
3061 running GNU/Linux.
3063 If you are using the installed system libunwind library with
3064 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3065 later.
3067 None of the following versions of GCC has an ABI that is compatible
3068 with any of the other versions in this list, with the exception that
3069 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3070 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3071 This primarily affects C++ programs and programs that create shared libraries.
3072 GCC 3.1 or later is recommended for compiling linux, the kernel.
3073 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3074 more major ABI changes are expected.
3076 @html
3077 <hr />
3078 @end html
3079 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3080 Building GCC on this target requires the GNU Assembler.  The bundled HP
3081 assembler will not work.  To prevent GCC from using the wrong assembler,
3082 the option @option{--with-gnu-as} may be necessary.
3084 The GCC libunwind library has not been ported to HPUX@.  This means that for
3085 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3086 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3087 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3088 removed and the system libunwind library will always be used.
3090 @html
3091 <hr />
3092 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3093 @end html
3094 @heading @anchor{x-ibm-aix}*-ibm-aix*
3095 Support for AIX version 3 and older was discontinued in GCC 3.4.
3097 AIX Make frequently has problems with GCC makefiles.  GNU Make 3.79.1 or
3098 newer is recommended to build on this platform.
3100 ``out of memory'' bootstrap failures may indicate a problem with
3101 process resource limits (ulimit).  Hard limits are configured in the
3102 @file{/etc/security/limits} system configuration file.
3104 To speed up the configuration phases of bootstrapping and installing GCC,
3105 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3107 @smallexample
3108    % CONFIG_SHELL=/opt/freeware/bin/bash
3109    % export CONFIG_SHELL
3110 @end smallexample
3112 and then proceed as described in @uref{build.html,,the build instructions},
3113 where we strongly recommend using GNU make and specifying an absolute path
3114 to invoke @var{srcdir}/configure.
3116 Errors involving @code{alloca} when building GCC generally are due
3117 to an incorrect definition of @code{CC} in the Makefile or mixing files
3118 compiled with the native C compiler and GCC@.  During the stage1 phase of
3119 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3120 (not @command{xlc}).  Once @command{configure} has been informed of
3121 @command{xlc}, one needs to use @samp{make distclean} to remove the
3122 configure cache files and ensure that @env{CC} environment variable
3123 does not provide a definition that will confuse @command{configure}.
3124 If this error occurs during stage2 or later, then the problem most likely
3125 is the version of Make (see above).
3127 The native @command{as} and @command{ld} are recommended for bootstrapping
3128 on AIX 4 and required for bootstrapping on AIX 5L@.  The GNU Assembler
3129 reports that it supports WEAK symbols on AIX 4, which causes GCC to try to
3130 utilize weak symbol functionality although it is not supported.  The GNU
3131 Assembler and Linker do not support AIX 5L sufficiently to bootstrap GCC@.
3132 The native AIX tools do interoperate with GCC@.
3134 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3135 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3136 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3137 referenced as APAR IY53606 (AIX 5.2) or a APAR IY54774 (AIX 5.1)
3139 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3140 shared object and GCC installation places the @file{libstdc++.a}
3141 shared library in a common location which will overwrite the and GCC
3142 3.3 version of the shared library.  Applications either need to be
3143 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3144 versions of the @samp{libstdc++} shared object needs to be available
3145 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3146 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3147 installed for runtime dynamic loading using the following steps to set
3148 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3149 multilib @file{libstdc++.a} installed:
3151 Extract the shared objects from the currently installed
3152 @file{libstdc++.a} archive:
3153 @smallexample
3154    % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3155 @end smallexample
3157 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3158 available for runtime dynamic loading, but not linking:
3159 @smallexample
3160    % strip -e libstdc++.so.4 libstdc++.so.5
3161 @end smallexample
3163 Archive the runtime-only shared object in the GCC 3.4
3164 @file{libstdc++.a} archive:
3165 @smallexample
3166    % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3167 @end smallexample
3169 Linking executables and shared libraries may produce warnings of
3170 duplicate symbols.  The assembly files generated by GCC for AIX always
3171 have included multiple symbol definitions for certain global variable
3172 and function declarations in the original program.  The warnings should
3173 not prevent the linker from producing a correct library or runnable
3174 executable.
3176 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3177 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3178 to parse archive libraries did not handle the new format correctly.
3179 These routines are used by GCC and result in error messages during
3180 linking such as ``not a COFF file''.  The version of the routines shipped
3181 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3182 option of the archive command may be used to create archives of 32-bit
3183 objects using the original ``small format''.  A correct version of the
3184 routines is shipped with AIX 4.3.2 and above.
3186 Some versions of the AIX binder (linker) can fail with a relocation
3187 overflow severe error when the @option{-bbigtoc} option is used to link
3188 GCC-produced object files into an executable that overflows the TOC@.  A fix
3189 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3190 available from IBM Customer Support and from its
3191 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3192 website as PTF U455193.
3194 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3195 with a segmentation fault when invoked by any version of GCC@.  A fix for
3196 APAR IX87327 is available from IBM Customer Support and from its
3197 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3198 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3200 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3201 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3202 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3203 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3204 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3206 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3207 use NLS to support locale-specific representations of various data
3208 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3209 separating decimal fractions).  There have been problems reported where
3210 GCC does not produce the same floating-point formats that the assembler
3211 expects.  If one encounters this problem, set the @env{LANG}
3212 environment variable to @samp{C} or @samp{En_US}.
3214 By default, GCC for AIX 4.1 and above produces code that can be used on
3215 both Power or PowerPC processors.
3217 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3218 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3220 @html
3221 <hr />
3222 @end html
3223 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3224 Vitesse IQ2000 processors.  These are used in embedded
3225 applications.  There are no standard Unix configurations.
3227 @html
3228 <hr />
3229 @end html
3230 @heading @anchor{m32c-x-elf}m32c-*-elf
3231 Renesas M32C processor.
3232 This configuration is intended for embedded systems.
3234 @html
3235 <hr />
3236 @end html
3237 @heading @anchor{m32r-x-elf}m32r-*-elf
3238 Renesas M32R processor.
3239 This configuration is intended for embedded systems.
3241 @html
3242 <hr />
3243 @end html
3244 @heading @anchor{m6811-elf}m6811-elf
3245 Motorola 68HC11 family micro controllers.  These are used in embedded
3246 applications.  There are no standard Unix configurations.
3248 @html
3249 <hr />
3250 @end html
3251 @heading @anchor{m6812-elf}m6812-elf
3252 Motorola 68HC12 family micro controllers.  These are used in embedded
3253 applications.  There are no standard Unix configurations.
3255 @html
3256 <hr />
3257 @end html
3258 @heading @anchor{m68k-hp-hpux}m68k-hp-hpux
3259 HP 9000 series 300 or 400 running HP-UX@.  HP-UX version 8.0 has a bug in
3260 the assembler that prevents compilation of GCC@.  This
3261 bug manifests itself during the first stage of compilation, while
3262 building @file{libgcc2.a}:
3264 @smallexample
3265 _floatdisf
3266 cc1: warning: `-g' option not supported on this version of GCC
3267 cc1: warning: `-g1' option not supported on this version of GCC
3268 ./xgcc: Internal compiler error: program as got fatal signal 11
3269 @end smallexample
3271 A patched version of the assembler is available as the file
3272 @uref{ftp://altdorf.ai.mit.edu/archive/cph/hpux-8.0-assembler}.  If you
3273 have HP software support, the patch can also be obtained directly from
3274 HP, as described in the following note:
3276 @quotation
3277 This is the patched assembler, to patch SR#1653-010439, where the
3278 assembler aborts on floating point constants.
3280 The bug is not really in the assembler, but in the shared library
3281 version of the function ``cvtnum(3c)''.  The bug on ``cvtnum(3c)'' is
3282 SR#4701-078451.  Anyway, the attached assembler uses the archive
3283 library version of ``cvtnum(3c)'' and thus does not exhibit the bug.
3284 @end quotation
3286 This patch is also known as PHCO_4484.
3288 In addition gdb does not understand that native HP-UX format, so
3289 you must use gas if you wish to use gdb.
3291 On HP-UX version 8.05, but not on 8.07 or more recent versions, the
3292 @command{fixproto} shell script triggers a bug in the system shell.  If you
3293 encounter this problem, upgrade your operating system or use BASH (the
3294 GNU shell) to run @command{fixproto}.  This bug will cause the fixproto
3295 program to report an error of the form:
3297 @smallexample
3298 ./fixproto: sh internal 1K buffer overflow
3299 @end smallexample
3301 To fix this, you can also change the first line of the fixproto script
3302 to look like:
3304 @smallexample
3305 #!/bin/ksh
3306 @end smallexample
3308 @html
3309 <hr />
3310 @end html
3311 @heading @anchor{mips-x-x}mips-*-*
3312 If on a MIPS system you get an error message saying ``does not have gp
3313 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3314 happens whenever you use GAS with the MIPS linker, but there is not
3315 really anything wrong, and it is okay to use the output file.  You can
3316 stop such warnings by installing the GNU linker.
3318 It would be nice to extend GAS to produce the gp tables, but they are
3319 optional, and there should not be a warning about their absence.
3321 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3322 and later.  A patch went in just after the GCC 3.3 release to
3323 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3324 configure for @samp{mipsel-elf} as a workaround.  The
3325 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3326 work on this is expected in future releases.
3328 MIPS systems check for division by zero (unless
3329 @option{-mno-check-zero-division} is passed to the compiler) by
3330 generating either a conditional trap or a break instruction.  Using
3331 trap results in smaller code, but is only supported on MIPS II and
3332 later.  Also, some versions of the Linux kernel have a bug that
3333 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3334 the use of break, use the @option{--with-divide=breaks}
3335 @command{configure} option when configuring GCC@.  The default is to
3336 use traps on systems that support them.
3338 Cross-compilers for the MIPS as target using the MIPS assembler
3339 currently do not work, because the auxiliary programs
3340 @file{mips-tdump.c} and @file{mips-tfile.c} can't be compiled on
3341 anything but a MIPS.  It does work to cross compile for a MIPS
3342 if you use the GNU assembler and linker.
3344 @html
3345 <hr />
3346 @end html
3347 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3349 In order to compile GCC on an SGI running IRIX 5, the @samp{compiler_dev.hdr}
3350 subsystem must be installed from the IDO CD-ROM supplied by SGI@.
3351 It is also available for download from
3352 @uref{ftp://ftp.sgi.com/sgi/IRIX5.3/iris-development-option-5.3.tardist}.
3354 If you use the MIPS C compiler to bootstrap, it may be necessary
3355 to increase its table size for switch statements with the
3356 @option{-Wf,-XNg1500} option.  If you use the @option{-O2}
3357 optimization option, you also need to use @option{-Olimit 3000}.
3359 To enable debugging under IRIX 5, you must use GNU binutils 2.15 or
3360 later, and use the @option{--with-gnu-ld} @command{configure} option
3361 when configuring GCC@.  You need to use GNU @command{ar} and @command{nm},
3362 also distributed with GNU binutils.
3364 Some users have reported that @command{/bin/sh} will hang during bootstrap.
3365 This problem can be avoided by running the commands:
3367 @smallexample
3368    % CONFIG_SHELL=/bin/ksh
3369    % export CONFIG_SHELL
3370 @end smallexample
3372 before starting the build.
3374 @html
3375 <hr />
3376 @end html
3377 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3379 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3380 ensure that the N32 ABI is in use.  To test this, compile a simple C
3381 file with @command{cc} and then run @command{file} on the
3382 resulting object file.  The output should look like:
3384 @smallexample
3385 test.o: ELF N32 MSB @dots{}
3386 @end smallexample
3388 If you see:
3390 @smallexample
3391 test.o: ELF 32-bit MSB @dots{}
3392 @end smallexample
3396 @smallexample
3397 test.o: ELF 64-bit MSB @dots{}
3398 @end smallexample
3400 then your version of @command{cc} uses the O32 or N64 ABI by default.  You
3401 should set the environment variable @env{CC} to @samp{cc -n32}
3402 before configuring GCC@.
3404 If you want the resulting @command{gcc} to run on old 32-bit systems
3405 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3406 instruction set architecture (ISA) is generated.  While GCC 3.x does
3407 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3408 the ISA depending on the machine where GCC is built.  Using one of them
3409 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3410 all on @samp{mips3}-only systems.  For the test program above, you should see:
3412 @smallexample
3413 test.o: ELF N32 MSB mips-3 @dots{}
3414 @end smallexample
3416 If you get:
3418 @smallexample
3419 test.o: ELF N32 MSB mips-4 @dots{}
3420 @end smallexample
3422 instead, you should set the environment variable @env{CC} to @samp{cc
3423 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3425 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3426 @code{memcmp}.  Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3427 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3429 GCC on IRIX 6 is usually built to support the N32, O32 and N64 ABIs.  If
3430 you build GCC on a system that doesn't have the N64 libraries installed
3431 or cannot run 64-bit binaries,
3432 you need to configure with @option{--disable-multilib} so GCC doesn't
3433 try to use them.  This will disable building the O32 libraries, too.
3434 Look for @file{/usr/lib64/libc.so.1} to see if you
3435 have the 64-bit libraries installed.
3437 To enable debugging for the O32 ABI, you must use GNU @command{as} from
3438 GNU binutils 2.15 or later.  You may also use GNU @command{ld}, but
3439 this is not required and currently causes some problems with Ada.
3441 The @option{--enable-threads} option doesn't currently work, a patch is
3442 in preparation for a future release.  The @option{--enable-libgcj}
3443 option is disabled by default: IRIX 6 uses a very low default limit
3444 (20480) for the command line length.  Although @command{libtool} contains a
3445 workaround for this problem, at least the N64 @samp{libgcj} is known not
3446 to build despite this, running into an internal error of the native
3447 @command{ld}.  A sure fix is to increase this limit (@samp{ncargs}) to
3448 its maximum of 262144 bytes.  If you have root access, you can use the
3449 @command{systune} command to do this.
3451 See @uref{http://freeware.sgi.com/} for more
3452 information about using GCC on IRIX platforms.
3454 @html
3455 <hr />
3456 @end html
3457 @heading @anchor{powerpc-x-x}powerpc-*-*
3459 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3460 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3462 @html
3463 <hr />
3464 @end html
3465 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3466 PowerPC running Darwin (Mac OS X kernel).
3468 Pre-installed versions of Mac OS X may not include any developer tools,
3469 meaning that you will not be able to build GCC from source.  Tool
3470 binaries are available at
3471 @uref{http://developer.apple.com/darwin/projects/compiler/} (free
3472 registration required).
3474 This version of GCC requires at least cctools-590.7.
3476 The version of GCC shipped by Apple typically includes a number of
3477 extensions not available in a standard GCC release.  These extensions
3478 are generally for backwards compatibility and best avoided.
3480 @html
3481 <hr />
3482 @end html
3483 @heading @anchor{powerpc-x-elf}powerpc-*-elf, powerpc-*-sysv4
3484 PowerPC system in big endian mode, running System V.4.
3486 @html
3487 <hr />
3488 @end html
3489 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
3491 You will need
3492 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3493 or newer for a working GCC@.
3495 @html
3496 <hr />
3497 @end html
3498 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
3499 PowerPC system in big endian mode running NetBSD@.  To build the
3500 documentation you will need Texinfo version 4.4 (NetBSD 1.5.1 included
3501 Texinfo version 3.12).
3503 @html
3504 <hr />
3505 @end html
3506 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
3507 Embedded PowerPC system in big endian mode for use in running under the
3508 PSIM simulator.
3510 @html
3511 <hr />
3512 @end html
3513 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
3514 Embedded PowerPC system in big endian mode.
3516 @html
3517 <hr />
3518 @end html
3519 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf, powerpcle-*-sysv4
3520 PowerPC system in little endian mode, running System V.4.
3522 @html
3523 <hr />
3524 @end html
3525 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
3526 Embedded PowerPC system in little endian mode for use in running under
3527 the PSIM simulator.
3529 @html
3530 <hr />
3531 @end html
3532 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
3533 Embedded PowerPC system in little endian mode.
3535 @html
3536 <hr />
3537 @end html
3538 @heading @anchor{s390-x-linux}s390-*-linux*
3539 S/390 system running GNU/Linux for S/390@.
3541 @html
3542 <hr />
3543 @end html
3544 @heading @anchor{s390x-x-linux}s390x-*-linux*
3545 zSeries system (64-bit) running GNU/Linux for zSeries@.
3547 @html
3548 <hr />
3549 @end html
3550 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
3551 zSeries system (64-bit) running TPF@.  This platform is
3552 supported as cross-compilation target only.
3554 @html
3555 <hr />
3556 @end html
3557 @c Please use Solaris 2 to refer to all release of Solaris, starting
3558 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
3559 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
3560 @c alone is too unspecific and must be avoided.
3561 @heading @anchor{x-x-solaris2}*-*-solaris2*
3563 Sun does not ship a C compiler with Solaris 2.  To bootstrap and install
3564 GCC you first have to install a pre-built compiler, see the
3565 @uref{binaries.html,,binaries page} for details.
3567 The Solaris 2 @command{/bin/sh} will often fail to configure
3568 @file{libstdc++-v3}, @file{boehm-gc} or @file{libjava}.  We therefore
3569 recommend to use the following sequence of commands to bootstrap and
3570 install GCC:
3572 @smallexample
3573    % CONFIG_SHELL=/bin/ksh
3574    % export CONFIG_SHELL
3575 @end smallexample
3577 and then proceed as described in @uref{build.html,,the build instructions}.
3578 In addition we strongly recommend specifying an absolute path to invoke
3579 @var{srcdir}/configure.
3581 Solaris 2 comes with a number of optional OS packages.  Some of these
3582 are needed to use GCC fully, namely @code{SUNWarc},
3583 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
3584 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
3585 optional packages when installing Solaris 2, you will need to verify that
3586 the packages that GCC needs are installed.
3588 To check whether an optional package is installed, use
3589 the @command{pkginfo} command.  To add an optional package, use the
3590 @command{pkgadd} command.  For further details, see the Solaris 2
3591 documentation.
3593 Trying to use the linker and other tools in
3594 @file{/usr/ucb} to install GCC has been observed to cause trouble.
3595 For example, the linker may hang indefinitely.  The fix is to remove
3596 @file{/usr/ucb} from your @env{PATH}.
3598 The build process works more smoothly with the legacy Sun tools so, if you
3599 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
3600 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
3602 All releases of GNU binutils prior to 2.11.2 have known bugs on this
3603 platform.  We recommend the use of GNU binutils 2.11.2 or later, or the
3604 vendor tools (Sun @command{as}, Sun @command{ld}).  Note that your mileage
3605 may vary if you use a combination of the GNU tools and the Sun tools: while
3606 the combination GNU @command{as} + Sun @command{ld} should reasonably work,
3607 the reverse combination Sun @command{as} + GNU @command{ld} is known to
3608 cause memory corruption at runtime in some cases for C++ programs.
3610 The stock GNU binutils 2.15 release is broken on this platform because of a
3611 single bug.  It has been fixed on the 2.15 branch in the CVS repository.
3612 You can obtain a working version by checking out the binutils-2_15-branch
3613 from the CVS repository or applying the patch
3614 @uref{http://sources.redhat.com/ml/binutils-cvs/2004-09/msg00036.html} to the
3615 release.
3617 We recommend using GNU binutils 2.16 or later in conjunction with GCC 4.x,
3618 or the vendor tools (Sun @command{as}, Sun @command{ld}).  However, for
3619 Solaris 10 and above, an additional patch is required in order for the GNU
3620 linker to be able to cope with a new flavor of shared libraries.  You
3621 can obtain a working version by checking out the binutils-2_16-branch from
3622 the CVS repository or applying the patch
3623 @uref{http://sourceware.org/ml/binutils-cvs/2005-07/msg00122.html} to the
3624 release.
3626 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
3627 newer: @command{g++} will complain that types are missing.  These headers assume
3628 that omitting the type means @code{int}; this assumption worked for C89 but
3629 is wrong for C++, and is now wrong for C99 also.
3631 @command{g++} accepts such (invalid) constructs with the option
3632 @option{-fpermissive}; it
3633 will assume that any missing type is @code{int} (as defined by C89).
3635 There are patches for Solaris 2.6 (105633-56 or newer for SPARC,
3636 106248-42 or newer for Intel), Solaris 7 (108376-21 or newer for SPARC,
3637 108377-20 for Intel), and Solaris 8 (108652-24 or newer for SPARC,
3638 108653-22 for Intel) that fix this bug.
3640 Sun bug 4927647 sometimes causes random spurious testsuite failures
3641 related to missing diagnostic output.  This bug doesn't affect GCC
3642 itself, rather it is a kernel bug triggered by the @command{expect}
3643 program which is used only by the GCC testsuite driver.  When the bug
3644 causes the @command{expect} program to miss anticipated output, extra
3645 testsuite failures appear.
3647 There are patches for Solaris 8 (117350-12 or newer for SPARC,
3648 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
3649 SPARC, 117172-11 or newer for Intel) that address this problem.
3651 @html
3652 <hr />
3653 @end html
3654 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
3656 When GCC is configured to use binutils 2.11.2 or later the binaries
3657 produced are smaller than the ones produced using Sun's native tools;
3658 this difference is quite significant for binaries containing debugging
3659 information.
3661 Sun @command{as} 4.x is broken in that it cannot cope with long symbol names.
3662 A typical error message might look similar to the following:
3664 @smallexample
3665 /usr/ccs/bin/as: "/var/tmp/ccMsw135.s", line 11041: error:
3666   can't compute value of an expression involving an external symbol.
3667 @end smallexample
3669 This is Sun bug 4237974.  This is fixed with patch 108908-02 for Solaris
3670 2.6 and has been fixed in later (5.x) versions of the assembler,
3671 starting with Solaris 7.
3673 Starting with Solaris 7, the operating system is capable of executing
3674 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
3675 this; the @option{-m64} option enables 64-bit code generation.
3676 However, if all you want is code tuned for the UltraSPARC CPU, you
3677 should try the @option{-mtune=ultrasparc} option instead, which produces
3678 code that, unlike full 64-bit code, can still run on non-UltraSPARC
3679 machines.
3681 When configuring on a Solaris 7 or later system that is running a kernel
3682 that supports only 32-bit binaries, one must configure with
3683 @option{--disable-multilib}, since we will not be able to build the
3684 64-bit target libraries.
3686 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
3687 the GNU compiler (especially GCC 3.0.x versions), which lead to the
3688 miscompilation of the stage1 compiler and the subsequent failure of the
3689 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
3690 stage, i.e.@: to bootstrap that compiler with the base compiler and then
3691 use it to bootstrap the final compiler.
3693 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
3694 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
3695 failure in form of a miscompilation of the stage1 compiler by the Sun
3696 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
3698 GCC 3.4 changed the default debugging format from STABS to DWARF-2 for
3699 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
3700 change apparently runs afoul of Sun bug 4910101 (which is referenced as
3701 a x86-only problem by Sun, probably because they do not use DWARF-2).
3702 A symptom of the problem is that you cannot compile C++ programs like
3703 @command{groff} 1.19.1 without getting messages similar to the following:
3705 @smallexample
3706 ld: warning: relocation error: R_SPARC_UA32: @dots{}
3707   external symbolic relocation against non-allocatable section
3708   .debug_info cannot be processed at runtime: relocation ignored.
3709 @end smallexample
3711 To work around this problem, compile with @option{-gstabs+} instead of
3712 plain @option{-g}.
3714 When configuring the GNU Multiple Precision Library (GMP) on a Solaris 7
3715 or later system, the canonical target triplet must be specified as the
3716 @command{build} parameter on the configure line:
3718 @smallexample
3719 ./configure --build=sparc-sun-solaris2.7 --prefix=xxx --enable-mpfr
3720 @end smallexample
3722 @html
3723 <hr />
3724 @end html
3725 @heading @anchor{sparc-sun-solaris27}sparc-sun-solaris2.7
3727 Sun patch 107058-01 (1999-01-13) for Solaris 7/SPARC triggers a bug in
3728 the dynamic linker.  This problem (Sun bug 4210064) affects GCC 2.8
3729 and later, including all EGCS releases.  Sun formerly recommended
3730 107058-01 for all Solaris 7 users, but around 1999-09-01 it started to
3731 recommend it only for people who use Sun's compilers.
3733 Here are some workarounds to this problem:
3734 @itemize @bullet
3735 @item
3736 Do not install Sun patch 107058-01 until after Sun releases a
3737 complete patch for bug 4210064.  This is the simplest course to take,
3738 unless you must also use Sun's C compiler.  Unfortunately 107058-01
3739 is preinstalled on some new Solaris 7-based hosts, so you may have to
3740 back it out.
3742 @item
3743 Copy the original, unpatched Solaris 7
3744 @command{/usr/ccs/bin/as} into
3745 @command{/usr/local/libexec/gcc/sparc-sun-solaris2.7/3.4/as},
3746 adjusting the latter name to fit your local conventions and software
3747 version numbers.
3749 @item
3750 Install Sun patch 106950-03 (1999-05-25) or later.  Nobody with
3751 both 107058-01 and 106950-03 installed has reported the bug with GCC
3752 and Sun's dynamic linker.  This last course of action is riskiest,
3753 for two reasons.  First, you must install 106950 on all hosts that
3754 run code generated by GCC; it doesn't suffice to install it only on
3755 the hosts that run GCC itself.  Second, Sun says that 106950-03 is
3756 only a partial fix for bug 4210064, but Sun doesn't know whether the
3757 partial fix is adequate for GCC@.  Revision -08 or later should fix
3758 the bug.  The current (as of 2004-05-23) revision is -24, and is included in
3759 the Solaris 7 Recommended Patch Cluster.
3760 @end itemize
3762 GCC 3.3 triggers a bug in version 5.0 Alpha 03/27/98 of the Sun assembler,
3763 which causes a bootstrap failure when linking the 64-bit shared version of
3764 libgcc.  A typical error message is:
3766 @smallexample
3767 ld: fatal: relocation error: R_SPARC_32: file libgcc/sparcv9/_muldi3.o:
3768   symbol <unknown>:  offset 0xffffffff7ec133e7 is non-aligned.
3769 @end smallexample
3771 This bug has been fixed in the final 5.0 version of the assembler.
3773 A similar problem was reported for version Sun WorkShop 6 99/08/18 of the
3774 Sun assembler, which causes a bootstrap failure with GCC 4.0.0:
3776 @smallexample
3777 ld: fatal: relocation error: R_SPARC_DISP32:
3778   file .libs/libstdc++.lax/libsupc++convenience.a/vterminate.o:
3779     symbol <unknown>: offset 0xfccd33ad is non-aligned
3780 @end smallexample
3782 This bug has been fixed in more recent revisions of the assembler.
3784 @html
3785 <hr />
3786 @end html
3787 @heading @anchor{sparc-x-linux}sparc-*-linux*
3789 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
3790 or newer on this platform.  All earlier binutils and glibc
3791 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
3794 @html
3795 <hr />
3796 @end html
3797 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
3799 The following compiler flags must be specified in the configure
3800 step in order to bootstrap this target with the Sun compiler:
3802 @smallexample
3803    % CC="cc -xildoff -xarch=v9" @var{srcdir}/configure [@var{options}] [@var{target}]
3804 @end smallexample
3806 @option{-xildoff} turns off the incremental linker, and @option{-xarch=v9}
3807 specifies the SPARC-V9 architecture to the Sun linker and assembler.
3809 @html
3810 <hr />
3811 @end html
3812 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
3814 This is a synonym for sparc64-*-solaris2*.
3816 @html
3817 <hr />
3818 @end html
3819 @heading @anchor{x-x-sysv}*-*-sysv*
3820 On System V release 3, you may get this error message
3821 while linking:
3823 @smallexample
3824 ld fatal: failed to write symbol name @var{something}
3825  in strings table for file @var{whatever}
3826 @end smallexample
3828 This probably indicates that the disk is full or your ulimit won't allow
3829 the file to be as large as it needs to be.
3831 This problem can also result because the kernel parameter @code{MAXUMEM}
3832 is too small.  If so, you must regenerate the kernel and make the value
3833 much larger.  The default value is reported to be 1024; a value of 32768
3834 is said to work.  Smaller values may also work.
3836 On System V, if you get an error like this,
3838 @smallexample
3839 /usr/local/lib/bison.simple: In function `yyparse':
3840 /usr/local/lib/bison.simple:625: virtual memory exhausted
3841 @end smallexample
3843 @noindent
3844 that too indicates a problem with disk space, ulimit, or @code{MAXUMEM}.
3846 On a System V release 4 system, make sure @file{/usr/bin} precedes
3847 @file{/usr/ucb} in @code{PATH}.  The @command{cc} command in
3848 @file{/usr/ucb} uses libraries which have bugs.
3850 @html
3851 <hr />
3852 @end html
3853 @heading @anchor{vax-dec-ultrix}vax-dec-ultrix
3854 Don't try compiling with VAX C (@command{vcc}).  It produces incorrect code
3855 in some cases (for example, when @code{alloca} is used).
3857 @html
3858 <hr />
3859 @end html
3860 @heading @anchor{x-x-vxworks}*-*-vxworks*
3861 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
3862 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
3863 We welcome patches for other architectures supported by VxWorks 5.5.
3864 Support for VxWorks AE would also be welcome; we believe this is merely
3865 a matter of writing an appropriate ``configlette'' (see below).  We are
3866 not interested in supporting older, a.out or COFF-based, versions of
3867 VxWorks in GCC 3.
3869 VxWorks comes with an older version of GCC installed in
3870 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
3871 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
3872 Before running @command{configure}, create the directories @file{@var{prefix}}
3873 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
3874 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
3875 include that directory while running both @command{configure} and
3876 @command{make}.
3878 You must give @command{configure} the
3879 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
3880 find the VxWorks system headers.  Since VxWorks is a cross compilation
3881 target only, you must also specify @option{--target=@var{target}}.
3882 @command{configure} will attempt to create the directory
3883 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
3884 make sure the user running @command{configure} has sufficient privilege
3885 to do so.
3887 GCC's exception handling runtime requires a special ``configlette''
3888 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
3889 that file to add the module to your kernel build.  (Future versions of
3890 VxWorks will incorporate this module.)
3892 @html
3893 <hr />
3894 @end html
3895 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
3897 GCC supports the x86-64 architecture implemented by the AMD64 processor
3898 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
3899 On GNU/Linux the default is a bi-arch compiler which is able to generate
3900 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
3902 @html
3903 <hr />
3904 @end html
3905 @heading @anchor{xtensa-x-elf}xtensa-*-elf
3907 This target is intended for embedded Xtensa systems using the
3908 @samp{newlib} C library.  It uses ELF but does not support shared
3909 objects.  Designed-defined instructions specified via the
3910 Tensilica Instruction Extension (TIE) language are only supported
3911 through inline assembly.
3913 The Xtensa configuration information must be specified prior to
3914 building GCC@.  The @file{include/xtensa-config.h} header
3915 file contains the configuration information.  If you created your
3916 own Xtensa configuration with the Xtensa Processor Generator, the
3917 downloaded files include a customized copy of this header file,
3918 which you can use to replace the default header file.
3920 @html
3921 <hr />
3922 @end html
3923 @heading @anchor{xtensa-x-linux}xtensa-*-linux*
3925 This target is for Xtensa systems running GNU/Linux.  It supports ELF
3926 shared objects and the GNU C library (glibc).  It also generates
3927 position-independent code (PIC) regardless of whether the
3928 @option{-fpic} or @option{-fPIC} options are used.  In other
3929 respects, this target is the same as the
3930 @uref{#xtensa-*-elf,,@samp{xtensa-*-elf}} target.
3932 @html
3933 <hr />
3934 @end html
3935 @heading @anchor{windows}Microsoft Windows (32-bit)
3937 Ports of GCC are included with the
3938 @uref{http://www.cygwin.com/,,Cygwin environment}.
3940 GCC will build under Cygwin without modification; it does not build
3941 with Microsoft's C++ compiler and there are no plans to make it do so.
3943 @html
3944 <hr />
3945 @end html
3946 @heading @anchor{os2}OS/2
3948 GCC does not currently support OS/2.  However, Andrew Zabolotny has been
3949 working on a generic OS/2 port with pgcc.  The current code can be found
3950 at @uref{http://www.goof.com/pcg/os2/,,http://www.goof.com/pcg/os2/}.
3952 @html
3953 <hr />
3954 @end html
3955 @heading @anchor{older}Older systems
3957 GCC contains support files for many older (1980s and early
3958 1990s) Unix variants.  For the most part, support for these systems
3959 has not been deliberately removed, but it has not been maintained for
3960 several years and may suffer from bitrot.
3962 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
3963 Support for these systems is still present in that release, but
3964 @command{configure} will fail unless the @option{--enable-obsolete}
3965 option is given.  Unless a maintainer steps forward, support for these
3966 systems will be removed from the next release of GCC@.
3968 Support for old systems as hosts for GCC can cause problems if the
3969 workarounds for compiler, library and operating system bugs affect the
3970 cleanliness or maintainability of the rest of GCC@.  In some cases, to
3971 bring GCC up on such a system, if still possible with current GCC, may
3972 require first installing an old version of GCC which did work on that
3973 system, and using it to compile a more recent GCC, to avoid bugs in the
3974 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
3975 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
3976 sites}.  Header bugs may generally be avoided using
3977 @command{fixincludes}, but bugs or deficiencies in libraries and the
3978 operating system may still cause problems.
3980 Support for older systems as targets for cross-compilation is less
3981 problematic than support for them as hosts for GCC; if an enthusiast
3982 wishes to make such a target work again (including resurrecting any of
3983 the targets that never worked with GCC 2, starting from the last CVS
3984 version before they were removed), patches
3985 @uref{../contribute.html,,following the usual requirements} would be
3986 likely to be accepted, since they should not affect the support for more
3987 modern targets.
3989 For some systems, old versions of GNU binutils may also be useful,
3990 and are available from @file{pub/binutils/old-releases} on
3991 @uref{http://sources.redhat.com/mirrors.html,,sources.redhat.com mirror sites}.
3993 Some of the information on specific systems above relates to
3994 such older systems, but much of the information
3995 about GCC on such systems (which may no longer be applicable to
3996 current GCC) is to be found in the GCC texinfo manual.
3998 @html
3999 <hr />
4000 @end html
4001 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
4003 C++ support is significantly better on ELF targets if you use the
4004 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4005 inlines, vtables and template instantiations will be discarded
4006 automatically.
4009 @html
4010 <hr />
4012 @end html
4013 @ifhtml
4014 @uref{./index.html,,Return to the GCC Installation page}
4015 @end ifhtml
4016 @end ifset
4018 @c ***Old documentation******************************************************
4019 @ifset oldhtml
4020 @include install-old.texi
4021 @html
4022 <hr />
4024 @end html
4025 @ifhtml
4026 @uref{./index.html,,Return to the GCC Installation page}
4027 @end ifhtml
4028 @end ifset
4030 @c ***GFDL********************************************************************
4031 @ifset gfdlhtml
4032 @include fdl.texi
4033 @html
4034 <hr />
4036 @end html
4037 @ifhtml
4038 @uref{./index.html,,Return to the GCC Installation page}
4039 @end ifhtml
4040 @end ifset
4042 @c ***************************************************************************
4043 @c Part 6 The End of the Document
4044 @ifinfo
4045 @comment node-name,     next,          previous, up
4046 @node    Concept Index, , GNU Free Documentation License, Top
4047 @end ifinfo
4049 @ifinfo
4050 @unnumbered Concept Index
4052 @printindex cp
4054 @contents
4055 @end ifinfo
4056 @bye