* doc/install.texi (*-*-solaris2*): Document recommended version
[official-gcc.git] / gcc / doc / install.texi
blobe0362635da098943b5aebd085f87993a30b2db8d
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.2 (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 Used by various scripts to generate some files included in CVS (mainly
402 Unicode-related and rarely changing) from source tables.
404 @item GNU diffutils version 2.7 (or later)
406 Necessary when creating changes to GCC source code to submit for review.
408 @item patch version 2.5.4 (or later)
410 Necessary when applying patches, created with @command{diff}, to one's
411 own sources.
413 @end table
415 @html
416 <hr />
418 @end html
419 @ifhtml
420 @uref{./index.html,,Return to the GCC Installation page}
421 @end ifhtml
422 @end ifset
424 @c ***Downloading the source**************************************************
425 @ifnothtml
426 @comment node-name,     next,          previous, up
427 @node    Downloading the source, Configuration, Prerequisites, Installing GCC
428 @end ifnothtml
429 @ifset downloadhtml
430 @ifnothtml
431 @chapter Downloading GCC
432 @end ifnothtml
433 @cindex Downloading GCC
434 @cindex Downloading the Source
436 GCC is distributed via @uref{http://gcc.gnu.org/cvs.html,,CVS} and FTP
437 tarballs compressed with @command{gzip} or
438 @command{bzip2}.  It is possible to download a full distribution or specific
439 components.
441 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
442 for information on how to obtain GCC@.
444 The full distribution includes the C, C++, Objective-C, Fortran 77, Fortran
445 (in case of GCC 4.0 and later), Java, and Ada (in case of GCC 3.1 and later)
446 compilers.  The full distribution also includes runtime libraries for C++,
447 Objective-C, Fortran 77, Fortran, and Java.  In GCC 3.0 and later versions,
448 GNU compiler testsuites are also included in the full distribution.
450 If you choose to download specific components, you must download the core
451 GCC distribution plus any language specific distributions you wish to
452 use.  The core distribution includes the C language front end as well as the
453 shared components.  Each language has a tarball which includes the language
454 front end as well as the language runtime (when appropriate).
456 Unpack the core distribution as well as any language specific
457 distributions in the same directory.
459 If you also intend to build binutils (either to upgrade an existing
460 installation or for use in place of the corresponding tools of your
461 OS), unpack the binutils distribution either in the same directory or
462 a separate one.  In the latter case, add symbolic links to any
463 components of the binutils you intend to build alongside the compiler
464 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
465 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
467 @html
468 <hr />
470 @end html
471 @ifhtml
472 @uref{./index.html,,Return to the GCC Installation page}
473 @end ifhtml
474 @end ifset
476 @c ***Configuration***********************************************************
477 @ifnothtml
478 @comment node-name,     next,          previous, up
479 @node    Configuration, Building, Downloading the source, Installing GCC
480 @end ifnothtml
481 @ifset configurehtml
482 @ifnothtml
483 @chapter Installing GCC: Configuration
484 @end ifnothtml
485 @cindex Configuration
486 @cindex Installing GCC: Configuration
488 Like most GNU software, GCC must be configured before it can be built.
489 This document describes the recommended configuration procedure
490 for both native and cross targets.
492 We use @var{srcdir} to refer to the toplevel source directory for
493 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
495 If you obtained the sources via CVS, @var{srcdir} must refer to the top
496 @file{gcc} directory, the one where the @file{MAINTAINERS} can be found,
497 and not its @file{gcc} subdirectory, otherwise the build will fail.
499 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
500 file system, the shell's built-in @command{pwd} command will return
501 temporary pathnames.  Using these can lead to various sorts of build
502 problems.  To avoid this issue, set the @env{PWDCMD} environment
503 variable to an automounter-aware @command{pwd} command, e.g.,
504 @command{pawd} or @samp{amq -w}, during the configuration and build
505 phases.
507 First, we @strong{highly} recommend that GCC be built into a
508 separate directory than the sources which does @strong{not} reside
509 within the source tree.  This is how we generally build GCC; building
510 where @var{srcdir} == @var{objdir} should still work, but doesn't
511 get extensive testing; building where @var{objdir} is a subdirectory
512 of @var{srcdir} is unsupported.
514 If you have previously built GCC in the same directory for a
515 different target machine, do @samp{make distclean} to delete all files
516 that might be invalid.  One of the files this deletes is @file{Makefile};
517 if @samp{make distclean} complains that @file{Makefile} does not exist
518 or issues a message like ``don't know how to make distclean'' it probably
519 means that the directory is already suitably clean.  However, with the
520 recommended method of building in a separate @var{objdir}, you should
521 simply use a different @var{objdir} for each target.
523 Second, when configuring a native system, either @command{cc} or
524 @command{gcc} must be in your path or you must set @env{CC} in
525 your environment before running configure.  Otherwise the configuration
526 scripts may fail.
528 Note that the bootstrap compiler and the resulting GCC must be link
529 compatible, else the bootstrap will fail with linker errors about
530 incompatible object file formats.  Several multilibed targets are
531 affected by this requirement, see
532 @ifnothtml
533 @ref{Specific, host/target specific installation notes}.
534 @end ifnothtml
535 @ifhtml
536 @uref{specific.html,,host/target specific installation notes}.
537 @end ifhtml
539 To configure GCC:
541 @smallexample
542    % mkdir @var{objdir}
543    % cd @var{objdir}
544    % @var{srcdir}/configure [@var{options}] [@var{target}]
545 @end smallexample
548 @heading Target specification
549 @itemize @bullet
550 @item
551 GCC has code to correctly determine the correct value for @var{target}
552 for nearly all native systems.  Therefore, we highly recommend you not
553 provide a configure target when configuring a native compiler.
555 @item
556 @var{target} must be specified as @option{--target=@var{target}}
557 when configuring a cross compiler; examples of valid targets would be
558 m68k-coff, sh-elf, etc.
560 @item
561 Specifying just @var{target} instead of @option{--target=@var{target}}
562 implies that the host defaults to @var{target}.
563 @end itemize
566 @heading Options specification
568 Use @var{options} to override several configure time options for
569 GCC@.  A list of supported @var{options} follows; @samp{configure
570 --help} may list other options, but those not listed below may not
571 work and should not normally be used.
573 Note that each @option{--enable} option has a corresponding
574 @option{--disable} option and that each @option{--with} option has a
575 corresponding @option{--without} option.
577 @table @code
578 @item --prefix=@var{dirname}
579 Specify the toplevel installation
580 directory.  This is the recommended way to install the tools into a directory
581 other than the default.  The toplevel installation directory defaults to
582 @file{/usr/local}.
584 We @strong{highly} recommend against @var{dirname} being the same or a
585 subdirectory of @var{objdir} or vice versa.  If specifying a directory
586 beneath a user's home directory tree, some shells will not expand
587 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
588 @env{$HOME} instead.
590 The following standard @command{autoconf} options are supported.  Normally you
591 should not need to use these options.
592 @table @code
593 @item --exec-prefix=@var{dirname}
594 Specify the toplevel installation directory for architecture-dependent
595 files.  The default is @file{@var{prefix}}.
597 @item --bindir=@var{dirname}
598 Specify the installation directory for the executables called by users
599 (such as @command{gcc} and @command{g++}).  The default is
600 @file{@var{exec-prefix}/bin}.
602 @item --libdir=@var{dirname}
603 Specify the installation directory for object code libraries and
604 internal data files of GCC@.  The default is @file{@var{exec-prefix}/lib}.
606 @item --libexecdir=@var{dirname}
607 Specify the installation directory for internal executables of GCC@.
608   The default is @file{@var{exec-prefix}/libexec}.
610 @item --with-slibdir=@var{dirname}
611 Specify the installation directory for the shared libgcc library.  The
612 default is @file{@var{libdir}}.
614 @item --infodir=@var{dirname}
615 Specify the installation directory for documentation in info format.
616 The default is @file{@var{prefix}/info}.
618 @item --datadir=@var{dirname}
619 Specify the installation directory for some architecture-independent
620 data files referenced by GCC@.  The default is @file{@var{prefix}/share}.
622 @item --mandir=@var{dirname}
623 Specify the installation directory for manual pages.  The default is
624 @file{@var{prefix}/man}.  (Note that the manual pages are only extracts from
625 the full GCC manuals, which are provided in Texinfo format.  The manpages
626 are derived by an automatic conversion process from parts of the full
627 manual.)
629 @item --with-gxx-include-dir=@var{dirname}
630 Specify
631 the installation directory for G++ header files.  The default is
632 @file{@var{prefix}/include/c++/@var{version}}.
634 @end table
636 @item --program-prefix=@var{prefix}
637 GCC supports some transformations of the names of its programs when
638 installing them.  This option prepends @var{prefix} to the names of
639 programs to install in @var{bindir} (see above).  For example, specifying
640 @option{--program-prefix=foo-} would result in @samp{gcc}
641 being installed as @file{/usr/local/bin/foo-gcc}.
643 @item --program-suffix=@var{suffix}
644 Appends @var{suffix} to the names of programs to install in @var{bindir}
645 (see above).  For example, specifying @option{--program-suffix=-3.1}
646 would result in @samp{gcc} being installed as
647 @file{/usr/local/bin/gcc-3.1}.
649 @item --program-transform-name=@var{pattern}
650 Applies the @samp{sed} script @var{pattern} to be applied to the names
651 of programs to install in @var{bindir} (see above).  @var{pattern} has to
652 consist of one or more basic @samp{sed} editing commands, separated by
653 semicolons.  For example, if you want the @samp{gcc} program name to be
654 transformed to the installed program @file{/usr/local/bin/myowngcc} and
655 the @samp{g++} program name to be transformed to
656 @file{/usr/local/bin/gspecial++} without changing other program names,
657 you could use the pattern
658 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
659 to achieve this effect.
661 All three options can be combined and used together, resulting in more
662 complex conversion patterns.  As a basic rule, @var{prefix} (and
663 @var{suffix}) are prepended (appended) before further transformations
664 can happen with a special transformation script @var{pattern}.
666 As currently implemented, this option only takes effect for native
667 builds; cross compiler binaries' names are not transformed even when a
668 transformation is explicitly asked for by one of these options.
670 For native builds, some of the installed programs are also installed
671 with the target alias in front of their name, as in
672 @samp{i686-pc-linux-gnu-gcc}.  All of the above transformations happen
673 before the target alias is prepended to the name---so, specifying
674 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
675 resulting binary would be installed as
676 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
678 As a last shortcoming, none of the installed Ada programs are
679 transformed yet, which will be fixed in some time.
681 @item --with-local-prefix=@var{dirname}
682 Specify the
683 installation directory for local include files.  The default is
684 @file{/usr/local}.  Specify this option if you want the compiler to
685 search directory @file{@var{dirname}/include} for locally installed
686 header files @emph{instead} of @file{/usr/local/include}.
688 You should specify @option{--with-local-prefix} @strong{only} if your
689 site has a different convention (not @file{/usr/local}) for where to put
690 site-specific files.
692 The default value for @option{--with-local-prefix} is @file{/usr/local}
693 regardless of the value of @option{--prefix}.  Specifying
694 @option{--prefix} has no effect on which directory GCC searches for
695 local header files.  This may seem counterintuitive, but actually it is
696 logical.
698 The purpose of @option{--prefix} is to specify where to @emph{install
699 GCC}.  The local header files in @file{/usr/local/include}---if you put
700 any in that directory---are not part of GCC@.  They are part of other
701 programs---perhaps many others.  (GCC installs its own header files in
702 another directory which is based on the @option{--prefix} value.)
704 Both the local-prefix include directory and the GCC-prefix include
705 directory are part of GCC's ``system include'' directories.  Although these
706 two directories are not fixed, they need to be searched in the proper
707 order for the correct processing of the include_next directive.  The
708 local-prefix include directory is searched before the GCC-prefix
709 include directory.  Another characteristic of system include directories
710 is that pedantic warnings are turned off for headers in these directories.
712 Some autoconf macros add @option{-I @var{directory}} options to the
713 compiler command line, to ensure that directories containing installed
714 packages' headers are searched.  When @var{directory} is one of GCC's
715 system include directories, GCC will ignore the option so that system
716 directories continue to be processed in the correct order.  This
717 may result in a search order different from what was specified but the
718 directory will still be searched.
720 GCC automatically searches for ordinary libraries using
721 @env{GCC_EXEC_PREFIX}.  Thus, when the same installation prefix is
722 used for both GCC and packages, GCC will automatically search for
723 both headers and libraries.  This provides a configuration that is
724 easy to use.  GCC behaves in a manner similar to that when it is
725 installed as a system compiler in @file{/usr}.
727 Sites that need to install multiple versions of GCC may not want to
728 use the above simple configuration.  It is possible to use the
729 @option{--program-prefix}, @option{--program-suffix} and
730 @option{--program-transform-name} options to install multiple versions
731 into a single directory, but it may be simpler to use different prefixes
732 and the @option{--with-local-prefix} option to specify the location of the
733 site-specific files for each version.  It will then be necessary for
734 users to specify explicitly the location of local site libraries
735 (e.g., with @env{LIBRARY_PATH}).
737 The same value can be used for both @option{--with-local-prefix} and
738 @option{--prefix} provided it is not @file{/usr}.  This can be used
739 to avoid the default search of @file{/usr/local/include}.
741 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
742 The directory you use for @option{--with-local-prefix} @strong{must not}
743 contain any of the system's standard header files.  If it did contain
744 them, certain programs would be miscompiled (including GNU Emacs, on
745 certain targets), because this would override and nullify the header
746 file corrections made by the @command{fixincludes} script.
748 Indications are that people who use this option use it based on mistaken
749 ideas of what it is for.  People use it as if it specified where to
750 install part of GCC@.  Perhaps they make this assumption because
751 installing GCC creates the directory.
753 @item --enable-shared[=@var{package}[,@dots{}]]
754 Build shared versions of libraries, if shared libraries are supported on
755 the target platform.  Unlike GCC 2.95.x and earlier, shared libraries
756 are enabled by default on all platforms that support shared libraries.
758 If a list of packages is given as an argument, build shared libraries
759 only for the listed packages.  For other packages, only static libraries
760 will be built.  Package names currently recognized in the GCC tree are
761 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
762 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
763 @samp{ada}, @samp{libada}, @samp{libjava} and @samp{libobjc}.
764 Note @samp{libiberty} does not support shared libraries at all.
766 Use @option{--disable-shared} to build only static libraries.  Note that
767 @option{--disable-shared} does not accept a list of package names as
768 argument, only @option{--enable-shared} does.
770 @item @anchor{with-gnu-as}--with-gnu-as
771 Specify that the compiler should assume that the
772 assembler it finds is the GNU assembler.  However, this does not modify
773 the rules to find an assembler and will result in confusion if the
774 assembler found is not actually the GNU assembler.  (Confusion may also
775 result if the compiler finds the GNU assembler but has not been
776 configured with @option{--with-gnu-as}.)  If you have more than one
777 assembler installed on your system, you may want to use this option in
778 connection with @option{--with-as=@var{pathname}}.
780 The following systems are the only ones where it makes a difference
781 whether you use the GNU assembler.  On any other system,
782 @option{--with-gnu-as} has no effect.
784 @itemize @bullet
785 @item @samp{hppa1.0-@var{any}-@var{any}}
786 @item @samp{hppa1.1-@var{any}-@var{any}}
787 @item @samp{i386-@var{any}-sysv}
788 @item @samp{m68k-bull-sysv}
789 @item @samp{m68k-hp-hpux}
790 @item @samp{m68000-hp-hpux}
791 @item @samp{m68000-att-sysv}
792 @item @samp{sparc-sun-solaris2.@var{any}}
793 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
794 @end itemize
796 On the systems listed above (except for the HP-PA, the SPARC, for ISC on
797 the 386, if you use the GNU assembler, you should also use the GNU linker
798 (and specify @option{--with-gnu-ld}).
800 @item @anchor{with-as}--with-as=@var{pathname}
801 Specify that the
802 compiler should use the assembler pointed to by @var{pathname}, rather
803 than the one found by the standard rules to find an assembler, which
804 are:
805 @itemize @bullet
806 @item
807 Check the @file{@var{libexec}/gcc/@var{target}/@var{version}}
808 directory, where @var{libexec} defaults to
809 @file{@var{exec-prefix}/libexec} and @var{exec-prefix} defaults to
810 @var{prefix} which defaults to @file{/usr/local} unless overridden by
811 the @option{--prefix=@var{pathname}} switch described
812 above.  @var{target} is the target system triple, such as
813 @samp{sparc-sun-solaris2.7}, and @var{version} denotes the GCC
814 version, such as 3.0.
815 @item
816 Check operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
817 Sun Solaris 2).
818 @end itemize
819 Note that these rules do not check for the value of @env{PATH}.  You may
820 want to use @option{--with-as} if no assembler is installed in the
821 directories listed above, or if you have multiple assemblers installed
822 and want to choose one that is not found by the above rules.
824 @item @anchor{with-gnu-ld}--with-gnu-ld
825 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
826 but for the linker.
828 @item --with-ld=@var{pathname}
829 Same as @uref{#with-as,,@option{--with-as}}
830 but for the linker.
832 @item --with-stabs
833 Specify that stabs debugging
834 information should be used instead of whatever format the host normally
835 uses.  Normally GCC uses the same debug format as the host system.
837 On MIPS based systems and on Alphas, you must specify whether you want
838 GCC to create the normal ECOFF debugging format, or to use BSD-style
839 stabs passed through the ECOFF symbol table.  The normal ECOFF debug
840 format cannot fully handle languages other than C@.  BSD stabs format can
841 handle other languages, but it only works with the GNU debugger GDB@.
843 Normally, GCC uses the ECOFF debugging format by default; if you
844 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
846 No matter which default you choose when you configure GCC, the user
847 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
848 the debug format for a particular compilation.
850 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
851 @option{--with-gas} is used.  It selects use of stabs debugging
852 information embedded in COFF output.  This kind of debugging information
853 supports C++ well; ordinary COFF debugging information does not.
855 @option{--with-stabs} is also meaningful on 386 systems running SVR4.  It
856 selects use of stabs debugging information embedded in ELF output.  The
857 C++ compiler currently (2.6.0) does not support the DWARF debugging
858 information normally used on 386 SVR4 platforms; stabs provide a
859 workable alternative.  This requires gas and gdb, as the normal SVR4
860 tools can not generate or interpret stabs.
862 @item --disable-multilib
863 Specify that multiple target
864 libraries to support different target variants, calling
865 conventions, etc should not be built.  The default is to build a
866 predefined set of them.
868 Some targets provide finer-grained control over which multilibs are built
869 (e.g., @option{--disable-softfloat}):
870 @table @code
871 @item arc-*-elf*
872 biendian.
874 @item arm-*-*
875 fpu, 26bit, underscore, interwork, biendian, nofmult.
877 @item m68*-*-*
878 softfloat, m68881, m68000, m68020.
880 @item mips*-*-*
881 single-float, biendian, softfloat.
883 @item powerpc*-*-*, rs6000*-*-*
884 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
885 sysv, aix.
887 @end table
889 @item --enable-threads
890 Specify that the target
891 supports threads.  This affects the Objective-C compiler and runtime
892 library, and exception handling for other languages like C++ and Java.
893 On some systems, this is the default.
895 In general, the best (and, in many cases, the only known) threading
896 model available will be configured for use.  Beware that on some
897 systems, GCC has not been taught what threading models are generally
898 available for the system.  In this case, @option{--enable-threads} is an
899 alias for @option{--enable-threads=single}.
901 @item --disable-threads
902 Specify that threading support should be disabled for the system.
903 This is an alias for @option{--enable-threads=single}.
905 @item --enable-threads=@var{lib}
906 Specify that
907 @var{lib} is the thread support library.  This affects the Objective-C
908 compiler and runtime library, and exception handling for other languages
909 like C++ and Java.  The possibilities for @var{lib} are:
911 @table @code
912 @item aix
913 AIX thread support.
914 @item dce
915 DCE thread support.
916 @item gnat
917 Ada tasking support.  For non-Ada programs, this setting is equivalent
918 to @samp{single}.  When used in conjunction with the Ada run time, it
919 causes GCC to use the same thread primitives as Ada uses.  This option
920 is necessary when using both Ada and the back end exception handling,
921 which is the default for most Ada targets.
922 @item mach
923 Generic MACH thread support, known to work on NeXTSTEP@.  (Please note
924 that the file needed to support this configuration, @file{gthr-mach.h}, is
925 missing and thus this setting will cause a known bootstrap failure.)
926 @item no
927 This is an alias for @samp{single}.
928 @item posix
929 Generic POSIX/Unix98 thread support.
930 @item posix95
931 Generic POSIX/Unix95 thread support.
932 @item rtems
933 RTEMS thread support.
934 @item single
935 Disable thread support, should work for all platforms.
936 @item solaris
937 Sun Solaris 2 thread support.
938 @item vxworks
939 VxWorks thread support.
940 @item win32
941 Microsoft Win32 API thread support.
942 @item nks
943 Novell Kernel Services thread support.
944 @end table
946 @item --with-cpu=@var{cpu}
947 Specify which cpu variant the compiler should generate code for by default.
948 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
949 This option is only supported on some targets, including ARM, i386, PowerPC,
950 and SPARC@.
952 @item --with-schedule=@var{cpu}
953 @itemx --with-arch=@var{cpu}
954 @itemx --with-tune=@var{cpu}
955 @itemx --with-abi=@var{abi}
956 @itemx --with-fpu=@var{type}
957 @itemx --with-float=@var{type}
958 These configure options provide default values for the @option{-mschedule=},
959 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
960 options and for @option{-mhard-float} or @option{-msoft-float}.  As with
961 @option{--with-cpu}, which switches will be accepted and acceptable values
962 of the arguments depend on the target.
964 @item --with-divide=@var{type}
965 Specify how the compiler should generate code for checking for
966 division by zero.  This option is only supported on the MIPS target.
967 The possibilities for @var{type} are:
968 @table @code
969 @item traps
970 Division by zero checks use conditional traps (this is the default on
971 systems that support conditional traps).
972 @item breaks
973 Division by zero checks use the break instruction.
974 @end table
976 @item --enable-__cxa_atexit
977 Define if you want to use __cxa_atexit, rather than atexit, to
978 register C++ destructors for local statics and global objects.
979 This is essential for fully standards-compliant handling of
980 destructors, but requires __cxa_atexit in libc.  This option is currently
981 only available on systems with GNU libc.  When enabled, this will cause
982 @option{-fuse-cxa-exit} to be passed by default.
984 @item --enable-target-optspace
985 Specify that target
986 libraries should be optimized for code space instead of code speed.
987 This is the default for the m32r platform.
989 @item --disable-cpp
990 Specify that a user visible @command{cpp} program should not be installed.
992 @item --with-cpp-install-dir=@var{dirname}
993 Specify that the user visible @command{cpp} program should be installed
994 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
996 @item --enable-initfini-array
997 Force the use of sections @code{.init_array} and @code{.fini_array}
998 (instead of @code{.init} and @code{.fini}) for constructors and
999 destructors.  Option @option{--disable-initfini-array} has the
1000 opposite effect.  If neither option is specified, the configure script
1001 will try to guess whether the @code{.init_array} and
1002 @code{.fini_array} sections are supported and, if they are, use them.
1004 @item --enable-maintainer-mode
1005 The build rules that
1006 regenerate the GCC master message catalog @file{gcc.pot} are normally
1007 disabled.  This is because it can only be rebuilt if the complete source
1008 tree is present.  If you have changed the sources and want to rebuild the
1009 catalog, configuring with @option{--enable-maintainer-mode} will enable
1010 this.  Note that you need a recent version of the @code{gettext} tools
1011 to do so.
1013 @item --enable-generated-files-in-srcdir
1014 Neither the .c and .h files that are generated from bison and flex nor the
1015 info manuals and man pages that are built from the .texi files are present
1016 in the CVS development tree.  When building GCC from that development tree,
1017 or from a snapshot which are created from CVS, then those generated files
1018 are placed in your build directory, which allows for the source to be in a
1019 readonly directory.
1021 If you configure with @option{--enable-generated-files-in-srcdir} then those
1022 generated files will go into the source directory.  This is mainly intended
1023 for generating release or prerelease tarballs of the GCC sources, since it
1024 is not a requirement that the users of source releases to have flex, bison, or
1025 makeinfo.
1027 @item --enable-version-specific-runtime-libs
1028 Specify
1029 that runtime libraries should be installed in the compiler specific
1030 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places.  In
1031 addition, @samp{libstdc++}'s include files will be installed into
1032 @file{@var{libdir}} unless you overruled it by using
1033 @option{--with-gxx-include-dir=@var{dirname}}.  Using this option is
1034 particularly useful if you intend to use several versions of GCC in
1035 parallel.  This is currently supported by @samp{libgfortran},
1036 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1038 @item --with-java-home=@var{dirname}
1039 This @samp{libjava} option overrides the default value of the
1040 @samp{java.home} system property.  It is also used to set
1041 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}.  By
1042 default @samp{java.home} is set to @file{@var{prefix}} and
1043 @samp{sun.boot.class.path} to
1044 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1046 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1047 Specify that only a particular subset of compilers and
1048 their runtime libraries should be built.  For a list of valid values for
1049 @var{langN} you can issue the following command in the
1050 @file{gcc} directory of your GCC source tree:@*
1051 @smallexample
1052 grep language= */config-lang.in
1053 @end smallexample
1054 Currently, you can use any of the following:
1055 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{f95}, @code{java},
1056 @code{objc}, @code{obj-c++}, @code{treelang}.
1057 Building the Ada compiler has special requirements, see below.
1058 If you do not pass this flag, or specify the option @code{all}, then all
1059 default languages available in the @file{gcc} sub-tree will be configured.
1060 Ada, Objective-C++, and treelang are not default languages; the rest are.
1061 Re-defining @code{LANGUAGES} when calling @samp{make bootstrap}
1062 @strong{does not} work anymore, as those language sub-directories might
1063 not have been configured!
1065 @item --disable-libada
1066 Specify that the run-time libraries and tools used by GNAT should not
1067 be built.  This can be useful for debugging, or for compatibility with
1068 previous Ada build procedures, when it was required to explicitly
1069 do a @samp{make -C gcc gnatlib_and_tools}.
1071 @item --disable-libssp
1072 Specify that the run-time libraries for stack smashing protection
1073 should not be built.
1075 @item --with-dwarf2
1076 Specify that the compiler should
1077 use DWARF 2 debugging information as the default.
1079 @item --enable-targets=all
1080 @itemx --enable-targets=@var{target_list}
1081 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1082 These are compilers that are able to generate either 64-bit or 32-bit
1083 code.  Typically, the corresponding 32-bit target, e.g.@:
1084 powerpc-linux for powerpc64-linux, only generates 32-bit code.  This
1085 option enables the 32-bit target to be a bi-arch compiler, which is
1086 useful when you want a bi-arch compiler that defaults to 32-bit, and
1087 you are building a bi-arch or multi-arch binutils in a combined tree.
1088 Currently, this option only affects powerpc-linux.
1090 @item --enable-secureplt
1091 This option enables @option{-msecure-plt} by default for powerpc-linux.
1092 @ifnothtml
1093 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1094 Using the GNU Compiler Collection (GCC)},
1095 @end ifnothtml
1096 @ifhtml
1097 See ``RS/6000 and PowerPC Options'' in the main manual
1098 @end ifhtml
1100 @item --enable-win32-registry
1101 @itemx --enable-win32-registry=@var{key}
1102 @itemx --disable-win32-registry
1103 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1104 to look up installations paths in the registry using the following key:
1106 @smallexample
1107 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1108 @end smallexample
1110 @var{key} defaults to GCC version number, and can be overridden by the
1111 @option{--enable-win32-registry=@var{key}} option.  Vendors and distributors
1112 who use custom installers are encouraged to provide a different key,
1113 perhaps one comprised of vendor name and GCC version number, to
1114 avoid conflict with existing installations.  This feature is enabled
1115 by default, and can be disabled by @option{--disable-win32-registry}
1116 option.  This option has no effect on the other hosts.
1118 @item --nfp
1119 Specify that the machine does not have a floating point unit.  This
1120 option only applies to @samp{m68k-sun-sunos@var{n}}.  On any other
1121 system, @option{--nfp} has no effect.
1123 @item --enable-werror
1124 @itemx --disable-werror
1125 @itemx --enable-werror=yes
1126 @itemx --enable-werror=no
1127 When you specify this option, it controls whether certain files in the
1128 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1129 If you don't specify it, @option{-Werror} is turned on for the main
1130 development trunk.  However it defaults to off for release branches and
1131 final releases.  The specific files which get @option{-Werror} are
1132 controlled by the Makefiles.
1134 @item --enable-checking
1135 @itemx --enable-checking=@var{list}
1136 When you specify this option, the compiler is built to perform internal
1137 consistency checks of the requested complexity.  This does not change the
1138 generated code, but adds error checking within the compiler.  This will
1139 slow down the compiler and may only work properly if you are building
1140 the compiler with GCC@.  This is @samp{yes} by default when building
1141 from CVS or snapshots, but @samp{release} for releases.  More control
1142 over the checks may be had by specifying @var{list}.  The categories of
1143 checks available are @samp{yes} (most common checks
1144 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1145 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1146 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1147 Individual checks can be enabled with these flags @samp{assert},
1148 @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1149 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1151 The @samp{valgrind} check requires the external @command{valgrind}
1152 simulator, available from @uref{http://valgrind.kde.org/}.  The
1153 @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1154 To disable all checking, @samp{--disable-checking} or
1155 @samp{--enable-checking=none} must be explicitly requested.  Disabling
1156 assertions will make the compiler and runtime slightly faster but
1157 increase the risk of undetected internal errors causing wrong code to be
1158 generated.
1160 @item --enable-coverage
1161 @itemx --enable-coverage=@var{level}
1162 With this option, the compiler is built to collect self coverage
1163 information, every time it is run.  This is for internal development
1164 purposes, and only works when the compiler is being built with gcc.  The
1165 @var{level} argument controls whether the compiler is built optimized or
1166 not, values are @samp{opt} and @samp{noopt}.  For coverage analysis you
1167 want to disable optimization, for performance analysis you want to
1168 enable optimization.  When coverage is enabled, the default level is
1169 without optimization.
1171 @item --enable-gather-detailed-mem-stats
1172 When this option is specified more detailed information on memory
1173 allocation is gathered.  This information is printed when using
1174 @option{-fmem-report}.
1176 @item --with-gc
1177 @itemx --with-gc=@var{choice}
1178 With this option you can specify the garbage collector implementation
1179 used during the compilation process.  @var{choice} can be one of
1180 @samp{page} and @samp{zone}, where @samp{page} is the default.
1182 @item --enable-nls
1183 @itemx --disable-nls
1184 The @option{--enable-nls} option enables Native Language Support (NLS),
1185 which lets GCC output diagnostics in languages other than American
1186 English.  Native Language Support is enabled by default if not doing a
1187 canadian cross build.  The @option{--disable-nls} option disables NLS@.
1189 @item --with-included-gettext
1190 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1191 procedure to prefer its copy of GNU @command{gettext}.
1193 @item --with-catgets
1194 If NLS is enabled, and if the host lacks @code{gettext} but has the
1195 inferior @code{catgets} interface, the GCC build procedure normally
1196 ignores @code{catgets} and instead uses GCC's copy of the GNU
1197 @code{gettext} library.  The @option{--with-catgets} option causes the
1198 build procedure to use the host's @code{catgets} in this situation.
1200 @item --with-libiconv-prefix=@var{dir}
1201 Search for libiconv header files in @file{@var{dir}/include} and
1202 libiconv library files in @file{@var{dir}/lib}.
1204 @item --enable-obsolete
1205 Enable configuration for an obsoleted system.  If you attempt to
1206 configure GCC for a system (build, host, or target) which has been
1207 obsoleted, and you do not specify this flag, configure will halt with an
1208 error message.
1210 All support for systems which have been obsoleted in one release of GCC
1211 is removed entirely in the next major release, unless someone steps
1212 forward to maintain the port.
1213 @end table
1215 @subheading Cross-Compiler-Specific Options
1216 The following options only apply to building cross compilers.
1217 @table @code
1218 @item --with-sysroot
1219 @itemx --with-sysroot=@var{dir}
1220 Tells GCC to consider @var{dir} as the root of a tree that contains a
1221 (subset of) the root filesystem of the target operating system.
1222 Target system headers, libraries and run-time object files will be
1223 searched in there.  The specified directory is not copied into the
1224 install tree, unlike the options @option{--with-headers} and
1225 @option{--with-libs} that this option obsoletes.  The default value,
1226 in case @option{--with-sysroot} is not given an argument, is
1227 @option{$@{gcc_tooldir@}/sys-root}.  If the specified directory is a
1228 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1229 the GCC binaries if the installation tree is moved.
1231 @item --with-headers
1232 @itemx --with-headers=@var{dir}
1233 Deprecated in favor of @option{--with-sysroot}.
1234 Specifies that target headers are available when building a cross compiler.
1235 The @var{dir} argument specifies a directory which has the target include
1236 files.  These include files will be copied into the @file{gcc} install
1237 directory.  @emph{This option with the @var{dir} argument is required} when
1238 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1239 doesn't pre-exist.  If @file{@var{prefix}/@var{target}/sys-include} does
1240 pre-exist, the @var{dir} argument may be omitted.  @command{fixincludes}
1241 will be run on these files to make them compatible with GCC@.
1243 @item --without-headers
1244 Tells GCC not use any target headers from a libc when building a cross
1245 compiler.  When crossing to GNU/Linux, you need the headers so GCC
1246 can build the exception handling for libgcc.
1247 See @uref{http://www.objsw.com/CrossGCC/,,CrossGCC} for more information
1248 on this option.
1250 @item --with-libs
1251 @itemx --with-libs=``@var{dir1} @var{dir2} @dots{} @var{dirN}''
1252 Deprecated in favor of @option{--with-sysroot}.
1253 Specifies a list of directories which contain the target runtime
1254 libraries.  These libraries will be copied into the @file{gcc} install
1255 directory.  If the directory list is omitted, this option has no
1256 effect.
1257 @item --with-newlib
1258 Specifies that @samp{newlib} is
1259 being used as the target C library.  This causes @code{__eprintf} to be
1260 omitted from @file{libgcc.a} on the assumption that it will be provided by
1261 @samp{newlib}.
1262 @end table
1264 @subheading Fortran-specific Option
1266 The following options apply to the build of the Fortran front end.
1268 @table @code
1270 @item --with-gmp=@var{pathname}
1271 @itemx --with-mpfr=@var{pathname}
1272 @itemx --with-gmp-dir=@var{pathname}
1273 @itemx --with-mpfr-dir=@var{pathname}
1274 If you don't have GMP (the GNU Multiple Precision library) and the MPFR
1275 Libraries installed in a standard location and you want to build the Fortran
1276 front-end, you can explicitly specify the directory where they are installed
1277 (@samp{--with-gmp=gmpinstalldir}, @samp{--with-mpfr=mpfrinstalldir}) or where
1278 you built them without installing (@samp{--with-gmp-dir=gmpbuilddir},
1279 @samp{--with-mpfr-dir=gmpbuilddir}).
1281 @end table
1283 @subheading Java-Specific Options
1285 The following option applies to the build of the Java front end.
1287 @table @code
1288 @item --disable-libgcj
1289 Specify that the run-time libraries
1290 used by GCJ should not be built.  This is useful in case you intend
1291 to use GCJ with some other run-time, or you're going to install it
1292 separately, or it just happens not to build on your particular
1293 machine.  In general, if the Java front end is enabled, the GCJ
1294 libraries will be enabled too, unless they're known to not work on
1295 the target platform.  If GCJ is enabled but @samp{libgcj} isn't built, you
1296 may need to port it; in this case, before modifying the top-level
1297 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1298 you may use @option{--enable-libgcj} to override the default.
1300 @end table
1302 The following options apply to building @samp{libgcj}.
1304 @subsubheading General Options
1306 @table @code
1307 @item --disable-getenv-properties
1308 Don't set system properties from @env{GCJ_PROPERTIES}.
1310 @item --enable-hash-synchronization
1311 Use a global hash table for monitor locks.  Ordinarily,
1312 @samp{libgcj}'s @samp{configure} script automatically makes
1313 the correct choice for this option for your platform.  Only use
1314 this if you know you need the library to be configured differently.
1316 @item --enable-interpreter
1317 Enable the Java interpreter.  The interpreter is automatically
1318 enabled by default on all platforms that support it.  This option
1319 is really only useful if you want to disable the interpreter
1320 (using @option{--disable-interpreter}).
1322 @item --disable-java-net
1323 Disable java.net.  This disables the native part of java.net only,
1324 using non-functional stubs for native method implementations.
1326 @item --disable-jvmpi
1327 Disable JVMPI support.
1329 @item --with-ecos
1330 Enable runtime eCos target support.
1332 @item --without-libffi
1333 Don't use @samp{libffi}.  This will disable the interpreter and JNI
1334 support as well, as these require @samp{libffi} to work.
1336 @item --enable-libgcj-debug
1337 Enable runtime debugging code.
1339 @item --enable-libgcj-multifile
1340 If specified, causes all @file{.java} source files to be
1341 compiled into @file{.class} files in one invocation of
1342 @samp{gcj}.  This can speed up build time, but is more
1343 resource-intensive.  If this option is unspecified or
1344 disabled, @samp{gcj} is invoked once for each @file{.java}
1345 file to compile into a @file{.class} file.
1347 @item --with-libiconv-prefix=DIR
1348 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1350 @item --enable-sjlj-exceptions
1351 Force use of @code{builtin_setjmp} for exceptions.  @samp{configure}
1352 ordinarily picks the correct value based on the platform.  Only use
1353 this option if you are sure you need a different setting.
1355 @item --with-system-zlib
1356 Use installed @samp{zlib} rather than that included with GCC@.
1358 @item --with-win32-nlsapi=ansi, unicows or unicode
1359 Indicates how MinGW @samp{libgcj} translates between UNICODE
1360 characters and the Win32 API@.
1361 @table @code
1362 @item ansi
1363 Use the single-byte @code{char} and the Win32 A functions natively,
1364 translating to and from UNICODE when using these functions.  If
1365 unspecified, this is the default.
1367 @item unicows
1368 Use the @code{WCHAR} and Win32 W functions natively.  Adds
1369 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1370 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1371 running built executables.  @file{libunicows.a}, an open-source
1372 import library around Microsoft's @code{unicows.dll}, is obtained from
1373 @uref{http://libunicows.sourceforge.net/}, which also gives details
1374 on getting @file{unicows.dll} from Microsoft.
1376 @item unicode
1377 Use the @code{WCHAR} and Win32 W functions natively.  Does @emph{not}
1378 add @code{-lunicows} to @file{libgcj.spec}.  The built executables will
1379 only run on Microsoft Windows NT and above.
1380 @end table
1381 @end table
1383 @subsubheading AWT-Specific Options
1385 @table @code
1386 @item --with-x
1387 Use the X Window System.
1389 @item --enable-java-awt=PEER(S)
1390 Specifies the AWT peer library or libraries to build alongside
1391 @samp{libgcj}.  If this option is unspecified or disabled, AWT
1392 will be non-functional.  Current valid values are @option{gtk} and
1393 @option{xlib}.  Multiple libraries should be separated by a
1394 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1396 @item --enable-gtk-cairo
1397 Build the cairo Graphics2D implementation on GTK@.
1399 @item --enable-java-gc=TYPE
1400 Choose garbage collector.  Defaults to @option{boehm} if unspecified.
1402 @item --disable-gtktest
1403 Do not try to compile and run a test GTK+ program.
1405 @item --disable-glibtest
1406 Do not try to compile and run a test GLIB program.
1408 @item --with-libart-prefix=PFX
1409 Prefix where libart is installed (optional).
1411 @item --with-libart-exec-prefix=PFX
1412 Exec prefix where libart is installed (optional).
1414 @item --disable-libarttest
1415 Do not try to compile and run a test libart program.
1417 @end table
1419 @html
1420 <hr />
1422 @end html
1423 @ifhtml
1424 @uref{./index.html,,Return to the GCC Installation page}
1425 @end ifhtml
1426 @end ifset
1428 @c ***Building****************************************************************
1429 @ifnothtml
1430 @comment node-name,     next,          previous, up
1431 @node    Building, Testing, Configuration, Installing GCC
1432 @end ifnothtml
1433 @ifset buildhtml
1434 @ifnothtml
1435 @chapter Building
1436 @end ifnothtml
1437 @cindex Installing GCC: Building
1439 Now that GCC is configured, you are ready to build the compiler and
1440 runtime libraries.
1442 Some commands executed when making the compiler may fail (return a
1443 nonzero status) and be ignored by @command{make}.  These failures, which
1444 are often due to files that were not found, are expected, and can safely
1445 be ignored.
1447 It is normal to have compiler warnings when compiling certain files.
1448 Unless you are a GCC developer, you can generally ignore these warnings
1449 unless they cause compilation to fail.  Developers should attempt to fix
1450 any warnings encountered, however they can temporarily continue past
1451 warnings-as-errors by specifying the configure flag
1452 @option{--disable-werror}.
1454 On certain old systems, defining certain environment variables such as
1455 @env{CC} can interfere with the functioning of @command{make}.
1457 If you encounter seemingly strange errors when trying to build the
1458 compiler in a directory other than the source directory, it could be
1459 because you have previously configured the compiler in the source
1460 directory.  Make sure you have done all the necessary preparations.
1462 If you build GCC on a BSD system using a directory stored in an old System
1463 V file system, problems may occur in running @command{fixincludes} if the
1464 System V file system doesn't support symbolic links.  These problems
1465 result in a failure to fix the declaration of @code{size_t} in
1466 @file{sys/types.h}.  If you find that @code{size_t} is a signed type and
1467 that type mismatches occur, this could be the cause.
1469 The solution is not to use such a directory for building GCC@.
1471 When building from CVS or snapshots, or if you modify parser sources,
1472 you need the Bison parser generator installed.  Any version 1.25 or
1473 later should work; older versions may also work.  If you do not modify
1474 parser sources, releases contain the Bison-generated files and you do
1475 not need Bison installed to build them.
1477 When building from CVS or snapshots, or if you modify Texinfo
1478 documentation, you need version 4.2 or later of Texinfo installed if you
1479 want Info documentation to be regenerated.  Releases contain Info
1480 documentation pre-built for the unmodified documentation in the release.
1482 @section Building a native compiler
1484 For a native build issue the command @samp{make bootstrap}.  This
1485 will build the entire GCC system, which includes the following steps:
1487 @itemize @bullet
1488 @item
1489 Build host tools necessary to build the compiler such as texinfo, bison,
1490 gperf.
1492 @item
1493 Build target tools for use by the compiler such as binutils (bfd,
1494 binutils, gas, gprof, ld, and opcodes)
1495 if they have been individually linked
1496 or moved into the top level GCC source tree before configuring.
1498 @item
1499 Perform a 3-stage bootstrap of the compiler.
1501 @item
1502 Perform a comparison test of the stage2 and stage3 compilers.
1504 @item
1505 Build runtime libraries using the stage3 compiler from the previous step.
1507 @end itemize
1509 If you are short on disk space you might consider @samp{make
1510 bootstrap-lean} instead.  This is identical to @samp{make
1511 bootstrap} except that object files from the stage1 and
1512 stage2 of the 3-stage bootstrap of the compiler are deleted as
1513 soon as they are no longer needed.
1515 If you want to save additional space during the bootstrap and in
1516 the final installation as well, you can build the compiler binaries
1517 without debugging information as in the following example.  This will save
1518 roughly 40% of disk space both for the bootstrap and the final installation.
1519 (Libraries will still contain debugging information.)
1521 @smallexample
1522      make CFLAGS='-O' LIBCFLAGS='-g -O2' \
1523        LIBCXXFLAGS='-g -O2 -fno-implicit-templates' bootstrap
1524 @end smallexample
1526 If you wish to use non-default GCC flags when compiling the stage2 and
1527 stage3 compilers, set @code{BOOT_CFLAGS} on the command line when doing
1528 @samp{make bootstrap}.  Non-default optimization flags are less well
1529 tested here than the default of @samp{-g -O2}, but should still work.
1530 In a few cases, you may find that you need to specify special flags such
1531 as @option{-msoft-float} here to complete the bootstrap; or, if the
1532 native compiler miscompiles the stage1 compiler, you may need to work
1533 around this, by choosing @code{BOOT_CFLAGS} to avoid the parts of the
1534 stage1 compiler that were miscompiled, or by using @samp{make
1535 bootstrap4} to increase the number of stages of bootstrap.
1537 Note that using non-standard @code{CFLAGS} can cause bootstrap to fail in
1538 @file{libiberty}, if these trigger a warning with the new compiler.  For
1539 example using @samp{-O2 -g -mcpu=i686} on @code{i686-pc-linux-gnu} will
1540 cause bootstrap failure as @option{-mcpu=} is deprecated in 3.4.0 and above.
1543 If you used the flag @option{--enable-languages=@dots{}} to restrict
1544 the compilers to be built, only those you've actually enabled will be
1545 built.  This will of course only build those runtime libraries, for
1546 which the particular compiler has been built.  Please note,
1547 that re-defining @env{LANGUAGES} when calling @samp{make bootstrap}
1548 @strong{does not} work anymore!
1550 If the comparison of stage2 and stage3 fails, this normally indicates
1551 that the stage2 compiler has compiled GCC incorrectly, and is therefore
1552 a potentially serious bug which you should investigate and report.  (On
1553 a few systems, meaningful comparison of object files is impossible; they
1554 always appear ``different''.  If you encounter this problem, you will
1555 need to disable comparison in the @file{Makefile}.)
1557 @section Building a cross compiler
1559 We recommend reading the
1560 @uref{http://www.objsw.com/CrossGCC/,,crossgcc FAQ}
1561 for information about building cross compilers.
1563 When building a cross compiler, it is not generally possible to do a
1564 3-stage bootstrap of the compiler.  This makes for an interesting problem
1565 as parts of GCC can only be built with GCC@.
1567 To build a cross compiler, we first recommend building and installing a
1568 native compiler.  You can then use the native GCC compiler to build the
1569 cross compiler.  The installed native compiler needs to be GCC version
1570 2.95 or later.
1572 Assuming you have already installed a native copy of GCC and configured
1573 your cross compiler, issue the command @command{make}, which performs the
1574 following steps:
1576 @itemize @bullet
1577 @item
1578 Build host tools necessary to build the compiler such as texinfo, bison,
1579 gperf.
1581 @item
1582 Build target tools for use by the compiler such as binutils (bfd,
1583 binutils, gas, gprof, ld, and opcodes)
1584 if they have been individually linked or moved into the top level GCC source
1585 tree before configuring.
1587 @item
1588 Build the compiler (single stage only).
1590 @item
1591 Build runtime libraries using the compiler from the previous step.
1592 @end itemize
1594 Note that if an error occurs in any step the make process will exit.
1596 If you are not building GNU binutils in the same source tree as GCC,
1597 you will need a cross-assembler and cross-linker installed before
1598 configuring GCC@.  Put them in the directory
1599 @file{@var{prefix}/@var{target}/bin}.  Here is a table of the tools
1600 you should put in this directory:
1602 @table @file
1603 @item as
1604 This should be the cross-assembler.
1606 @item ld
1607 This should be the cross-linker.
1609 @item ar
1610 This should be the cross-archiver: a program which can manipulate
1611 archive files (linker libraries) in the target machine's format.
1613 @item ranlib
1614 This should be a program to construct a symbol table in an archive file.
1615 @end table
1617 The installation of GCC will find these programs in that directory,
1618 and copy or link them to the proper place to for the cross-compiler to
1619 find them when run later.
1621 The easiest way to provide these files is to build the Binutils package.
1622 Configure it with the same @option{--host} and @option{--target}
1623 options that you use for configuring GCC, then build and install
1624 them.  They install their executables automatically into the proper
1625 directory.  Alas, they do not support all the targets that GCC
1626 supports.
1628 If you are not building a C library in the same source tree as GCC,
1629 you should also provide the target libraries and headers before
1630 configuring GCC, specifying the directories with
1631 @option{--with-sysroot} or @option{--with-headers} and
1632 @option{--with-libs}.  Many targets also require ``start files'' such
1633 as @file{crt0.o} and
1634 @file{crtn.o} which are linked into each executable.  There may be several
1635 alternatives for @file{crt0.o}, for use with profiling or other
1636 compilation options.  Check your target's definition of
1637 @code{STARTFILE_SPEC} to find out what start files it uses.
1639 @section Building in parallel
1641 You can use @samp{make bootstrap MAKE="make -j 2" -j 2}, or just
1642 @samp{make -j 2 bootstrap} for GNU Make 3.79 and above, instead of
1643 @samp{make bootstrap} to build GCC in parallel.
1644 You can also specify a bigger number, and in most cases using a value
1645 greater than the number of processors in your machine will result in
1646 fewer and shorter I/O latency hits, thus improving overall throughput;
1647 this is especially true for slow drives and network filesystems.
1649 @section Building the Ada compiler
1651 In order to build GNAT, the Ada compiler, you need a working GNAT
1652 compiler (GNAT version 3.14 or later, or GCC version 3.1 or later),
1653 including GNAT tools such as @command{gnatmake} and @command{gnatlink},
1654 since the Ada front end is written in Ada (with some
1655 GNAT-specific extensions), and GNU make.
1657 @command{configure} does not test whether the GNAT installation works
1658 and has a sufficiently recent version; if too old a GNAT version is
1659 installed, the build will fail unless @option{--enable-languages} is
1660 used to disable building the Ada front end.
1662 @section Building with profile feedback
1664 It is possible to use profile feedback to optimize the compiler itself.  This
1665 should result in a faster compiler binary.  Experiments done on x86 using gcc
1666 3.3 showed approximately 7 percent speedup on compiling C programs.  To
1667 bootstrap compiler with profile feedback, use @code{make profiledbootstrap}.
1669 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
1670 compiler.  This compiler is used to build a @code{stageprofile} compiler
1671 instrumented to collect execution counts of instruction and branch
1672 probabilities.  Then runtime libraries are compiled with profile collected.
1673 Finally a @code{stagefeedback} compiler is built using the information collected.
1675 Unlike @samp{make bootstrap} several additional restrictions apply.  The
1676 compiler used to build @code{stage1} needs to support a 64-bit integral type.
1677 It is recommended to only use GCC for this.  Also parallel make is currently
1678 not supported since collisions in profile collecting may occur.
1680 @html
1681 <hr />
1683 @end html
1684 @ifhtml
1685 @uref{./index.html,,Return to the GCC Installation page}
1686 @end ifhtml
1687 @end ifset
1689 @c ***Testing*****************************************************************
1690 @ifnothtml
1691 @comment node-name,     next,          previous, up
1692 @node    Testing, Final install, Building, Installing GCC
1693 @end ifnothtml
1694 @ifset testhtml
1695 @ifnothtml
1696 @chapter Installing GCC: Testing
1697 @end ifnothtml
1698 @cindex Testing
1699 @cindex Installing GCC: Testing
1700 @cindex Testsuite
1702 Before you install GCC, we encourage you to run the testsuites and to
1703 compare your results with results from a similar configuration that have
1704 been submitted to the
1705 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
1706 Some of these archived results are linked from the build status lists
1707 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
1708 reports a successful build runs the testsuites and submits the results.
1709 This step is optional and may require you to download additional software,
1710 but it can give you confidence in your new GCC installation or point out
1711 problems before you install and start using your new GCC@.
1713 First, you must have @uref{download.html,,downloaded the testsuites}.
1714 These are part of the full distribution, but if you downloaded the
1715 ``core'' compiler plus any front ends, you must download the testsuites
1716 separately.
1718 Second, you must have the testing tools installed.  This includes
1719 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu} 1.4.4 and later,
1720 Tcl, and Expect; the DejaGnu site has links to these.
1722 If the directories where @command{runtest} and @command{expect} were
1723 installed are not in the @env{PATH}, you may need to set the following
1724 environment variables appropriately, as in the following example (which
1725 assumes that DejaGnu has been installed under @file{/usr/local}):
1727 @smallexample
1728      TCL_LIBRARY = /usr/local/share/tcl8.0
1729      DEJAGNULIBS = /usr/local/share/dejagnu
1730 @end smallexample
1732 (On systems such as Cygwin, these paths are required to be actual
1733 paths, not mounts or links; presumably this is due to some lack of
1734 portability in the DejaGnu code.)
1737 Finally, you can run the testsuite (which may take a long time):
1738 @smallexample
1739      cd @var{objdir}; make -k check
1740 @end smallexample
1742 This will test various components of GCC, such as compiler
1743 front ends and runtime libraries.  While running the testsuite, DejaGnu
1744 might emit some harmless messages resembling
1745 @samp{WARNING: Couldn't find the global config file.} or
1746 @samp{WARNING: Couldn't find tool init file} that can be ignored.
1748 @section How can you run the testsuite on selected tests?
1750 In order to run sets of tests selectively, there are targets
1751 @samp{make check-gcc} and @samp{make check-g++}
1752 in the @file{gcc} subdirectory of the object directory.  You can also
1753 just run @samp{make check} in a subdirectory of the object directory.
1756 A more selective way to just run all @command{gcc} execute tests in the
1757 testsuite is to use
1759 @smallexample
1760     make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
1761 @end smallexample
1763 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
1764 the testsuite with filenames matching @samp{9805*}, you would use
1766 @smallexample
1767     make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
1768 @end smallexample
1770 The @file{*.exp} files are located in the testsuite directories of the GCC
1771 source, the most important ones being @file{compile.exp},
1772 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
1773 To get a list of the possible @file{*.exp} files, pipe the
1774 output of @samp{make check} into a file and look at the
1775 @samp{Running @dots{}  .exp} lines.
1777 @section Passing options and running multiple testsuites
1779 You can pass multiple options to the testsuite using the
1780 @samp{--target_board} option of DejaGNU, either passed as part of
1781 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
1782 work outside the makefiles.  For example,
1784 @smallexample
1785     make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fno-strength-reduce"
1786 @end smallexample
1788 will run the standard @command{g++} testsuites (``unix'' is the target name
1789 for a standard native testsuite situation), passing
1790 @samp{-O3 -fno-strength-reduce} to the compiler on every test, i.e.,
1791 slashes separate options.
1793 You can run the testsuites multiple times using combinations of options
1794 with a syntax similar to the brace expansion of popular shells:
1796 @smallexample
1797     @dots{}"--target_board=arm-sim/@{-mhard-float,-msoft-float@}@{-O1,-O2,-O3,@}"
1798 @end smallexample
1800 (Note the empty option caused by the trailing comma in the final group.)
1801 The following will run each testsuite eight times using the @samp{arm-sim}
1802 target, as if you had specified all possible combinations yourself:
1804 @smallexample
1805     --target_board=arm-sim/-mhard-float/-O1
1806     --target_board=arm-sim/-mhard-float/-O2
1807     --target_board=arm-sim/-mhard-float/-O3
1808     --target_board=arm-sim/-mhard-float
1809     --target_board=arm-sim/-msoft-float/-O1
1810     --target_board=arm-sim/-msoft-float/-O2
1811     --target_board=arm-sim/-msoft-float/-O3
1812     --target_board=arm-sim/-msoft-float
1813 @end smallexample
1815 They can be combined as many times as you wish, in arbitrary ways.  This
1816 list:
1818 @smallexample
1819     @dots{}"--target_board=unix/-Wextra@{-O3,-fno-strength-reduce@}@{-fomit-frame-pointer,@}"
1820 @end smallexample
1822 will generate four combinations, all involving @samp{-Wextra}.
1824 The disadvantage to this method is that the testsuites are run in serial,
1825 which is a waste on multiprocessor systems.  For users with GNU Make and
1826 a shell which performs brace expansion, you can run the testsuites in
1827 parallel by having the shell perform the combinations and @command{make}
1828 do the parallel runs.  Instead of using @samp{--target_board}, use a
1829 special makefile target:
1831 @smallexample
1832     make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
1833 @end smallexample
1835 For example,
1837 @smallexample
1838     make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
1839 @end smallexample
1841 will run three concurrent ``make-gcc'' testsuites, eventually testing all
1842 ten combinations as described above.  Note that this is currently only
1843 supported in the @file{gcc} subdirectory.  (To see how this works, try
1844 typing @command{echo} before the example given here.)
1847 @section Additional testing for Java Class Libraries
1849 The Java runtime tests can be executed via @samp{make check}
1850 in the @file{@var{target}/libjava/testsuite} directory in
1851 the build tree.
1853 The @uref{http://sources.redhat.com/mauve/,,Mauve Project} provides
1854 a suite of tests for the Java Class Libraries.  This suite can be run
1855 as part of libgcj testing by placing the Mauve tree within the libjava
1856 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
1857 specifying the location of that tree when invoking @samp{make}, as in
1858 @samp{make MAUVEDIR=~/mauve check}.
1860 @uref{http://sources.redhat.com/mauve/,,Jacks}
1861 is a free testsuite that tests Java compiler front ends.  This suite
1862 can be run as part of libgcj testing by placing the Jacks tree within
1863 the libjava testsuite at @file{libjava/testsuite/libjava.jacks/jacks}.
1865 @section How to interpret test results
1867 The result of running the testsuite are various @file{*.sum} and @file{*.log}
1868 files in the testsuite subdirectories.  The @file{*.log} files contain a
1869 detailed log of the compiler invocations and the corresponding
1870 results, the @file{*.sum} files summarize the results.  These summaries
1871 contain status codes for all tests:
1873 @itemize @bullet
1874 @item
1875 PASS: the test passed as expected
1876 @item
1877 XPASS: the test unexpectedly passed
1878 @item
1879 FAIL: the test unexpectedly failed
1880 @item
1881 XFAIL: the test failed as expected
1882 @item
1883 UNSUPPORTED: the test is not supported on this platform
1884 @item
1885 ERROR: the testsuite detected an error
1886 @item
1887 WARNING: the testsuite detected a possible problem
1888 @end itemize
1890 It is normal for some tests to report unexpected failures.  At the
1891 current time the testing harness does not allow fine grained control
1892 over whether or not a test is expected to fail.  This problem should
1893 be fixed in future releases.
1896 @section Submitting test results
1898 If you want to report the results to the GCC project, use the
1899 @file{contrib/test_summary} shell script.  Start it in the @var{objdir} with
1901 @smallexample
1902     @var{srcdir}/contrib/test_summary -p your_commentary.txt \
1903         -m gcc-testresults@@gcc.gnu.org |sh
1904 @end smallexample
1906 This script uses the @command{Mail} program to send the results, so
1907 make sure it is in your @env{PATH}.  The file @file{your_commentary.txt} is
1908 prepended to the testsuite summary and should contain any special
1909 remarks you have on your results or your build environment.  Please
1910 do not edit the testsuite result block or the subject line, as these
1911 messages may be automatically processed.
1913 @html
1914 <hr />
1916 @end html
1917 @ifhtml
1918 @uref{./index.html,,Return to the GCC Installation page}
1919 @end ifhtml
1920 @end ifset
1922 @c ***Final install***********************************************************
1923 @ifnothtml
1924 @comment node-name,     next,          previous, up
1925 @node    Final install, , Testing, Installing GCC
1926 @end ifnothtml
1927 @ifset finalinstallhtml
1928 @ifnothtml
1929 @chapter Installing GCC: Final installation
1930 @end ifnothtml
1932 Now that GCC has been built (and optionally tested), you can install it with
1933 @smallexample
1934 cd @var{objdir}; make install
1935 @end smallexample
1937 We strongly recommend to install into a target directory where there is
1938 no previous version of GCC present.
1940 That step completes the installation of GCC; user level binaries can
1941 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
1942 you specified with the @option{--prefix} to configure (or
1943 @file{/usr/local} by default).  (If you specified @option{--bindir},
1944 that directory will be used instead; otherwise, if you specified
1945 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
1946 Headers for the C++ and Java libraries are installed in
1947 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
1948 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
1949 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
1950 in info format in @file{@var{infodir}} (normally
1951 @file{@var{prefix}/info}).
1953 When installing cross-compilers, GCC's executables
1954 are not only installed into @file{@var{bindir}}, that
1955 is, @file{@var{exec-prefix}/bin}, but additionally into
1956 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
1957 exists.  Typically, such @dfn{tooldirs} hold target-specific
1958 binutils, including assembler and linker.
1960 Installation into a temporary staging area or into a @command{chroot}
1961 jail can be achieved with the command
1963 @smallexample
1964 make DESTDIR=@var{path-to-rootdir} install
1965 @end smallexample
1967 @noindent where @var{path-to-rootdir} is the absolute path of
1968 a directory relative to which all installation paths will be
1969 interpreted.  Note that the directory specified by @code{DESTDIR}
1970 need not exist yet; it will be created if necessary.
1972 There is a subtle point with tooldirs and @code{DESTDIR}:
1973 If you relocate a cross-compiler installation with
1974 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
1975 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
1976 be filled with duplicated GCC executables only if it already exists,
1977 it will not be created otherwise.  This is regarded as a feature,
1978 not as a bug, because it gives slightly more control to the packagers
1979 using the @code{DESTDIR} feature.
1981 If you built a released version of GCC using @samp{make bootstrap} then please
1982 quickly review the build status page for your release, available from
1983 @uref{http://gcc.gnu.org/buildstat.html}.
1984 If your system is not listed for the version of GCC that you built,
1985 send a note to
1986 @email{gcc@@gcc.gnu.org} indicating
1987 that you successfully built and installed GCC@.
1988 Include the following information:
1990 @itemize @bullet
1991 @item
1992 Output from running @file{@var{srcdir}/config.guess}.  Do not send
1993 that file itself, just the one-line output from running it.
1995 @item
1996 The output of @samp{gcc -v} for your newly installed @command{gcc}.
1997 This tells us which version of GCC you built and the options you passed to
1998 configure.
2000 @item
2001 Whether you enabled all languages or a subset of them.  If you used a
2002 full distribution then this information is part of the configure
2003 options in the output of @samp{gcc -v}, but if you downloaded the
2004 ``core'' compiler plus additional front ends then it isn't apparent
2005 which ones you built unless you tell us about it.
2007 @item
2008 If the build was for GNU/Linux, also include:
2009 @itemize @bullet
2010 @item
2011 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2012 this information should be available from @file{/etc/issue}.
2014 @item
2015 The version of the Linux kernel, available from @samp{uname --version}
2016 or @samp{uname -a}.
2018 @item
2019 The version of glibc you used; for RPM-based systems like Red Hat,
2020 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2021 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2022 @end itemize
2023 For other systems, you can include similar information if you think it is
2024 relevant.
2026 @item
2027 Any other information that you think would be useful to people building
2028 GCC on the same configuration.  The new entry in the build status list
2029 will include a link to the archived copy of your message.
2030 @end itemize
2032 We'd also like to know if the
2033 @ifnothtml
2034 @ref{Specific, host/target specific installation notes}
2035 @end ifnothtml
2036 @ifhtml
2037 @uref{specific.html,,host/target specific installation notes}
2038 @end ifhtml
2039 didn't include your host/target information or if that information is
2040 incomplete or out of date.  Send a note to
2041 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2043 If you find a bug, please report it following the
2044 @uref{../bugs.html,,bug reporting guidelines}.
2046 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2047 dvi}.  You will need to have @command{texi2dvi} (version at least 4.2)
2048 and @TeX{} installed.  This creates a number of @file{.dvi} files in
2049 subdirectories of @file{@var{objdir}}; these may be converted for
2050 printing with programs such as @command{dvips}.  You can also
2051 @uref{http://www.gnu.org/order/order.html,,buy printed manuals from the
2052 Free Software Foundation}, though such manuals may not be for the most
2053 recent version of GCC@.
2055 If you would like to generate online HTML documentation, do @samp{cd
2056 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2057 @file{@var{objdir}/gcc/HTML}.
2059 @html
2060 <hr />
2062 @end html
2063 @ifhtml
2064 @uref{./index.html,,Return to the GCC Installation page}
2065 @end ifhtml
2066 @end ifset
2068 @c ***Binaries****************************************************************
2069 @ifnothtml
2070 @comment node-name,     next,          previous, up
2071 @node    Binaries, Specific, Installing GCC, Top
2072 @end ifnothtml
2073 @ifset binarieshtml
2074 @ifnothtml
2075 @chapter Installing GCC: Binaries
2076 @end ifnothtml
2077 @cindex Binaries
2078 @cindex Installing GCC: Binaries
2080 We are often asked about pre-compiled versions of GCC@.  While we cannot
2081 provide these for all platforms, below you'll find links to binaries for
2082 various platforms where creating them by yourself is not easy due to various
2083 reasons.
2085 Please note that we did not create these binaries, nor do we
2086 support them.  If you have any problems installing them, please
2087 contact their makers.
2089 @itemize
2090 @item
2091 AIX:
2092 @itemize
2093 @item
2094 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2096 @item
2097 @uref{http://aixpdslib.seas.ucla.edu,,UCLA Software Library for AIX}.
2098 @end itemize
2100 @item
2101 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2103 @item
2104 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2105 Development Tools for the Renesas H8/300[HS] Series}.
2107 @item
2108 HP-UX:
2109 @itemize
2110 @item
2111 @uref{http://hpux.cae.wisc.edu/,,HP-UX Porting Center};
2113 @item
2114 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2115 @end itemize
2117 @item
2118 Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU
2119 Development Tools for the Motorola 68HC11/68HC12}.
2121 @item
2122 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2123 OpenServer/Unixware}.
2125 @item
2126 Sinix/Reliant Unix---@uref{ftp://ftp.fujitsu-siemens.com/pub/pd/gnu/gcc/,,Siemens}.
2128 @item
2129 Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}.
2131 @item
2132 SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}.
2134 @item
2135 Microsoft Windows:
2136 @itemize
2137 @item
2138 The @uref{http://sources.redhat.com/cygwin/,,Cygwin} project;
2139 @item
2140 The @uref{http://www.mingw.org/,,MinGW} project.
2141 @end itemize
2143 @item
2144 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2145 Written Word} offers binaries for
2146 AIX 4.3.2.
2147 IRIX 6.5,
2148 Digital UNIX 4.0D and 5.1,
2149 GNU/Linux (i386),
2150 HP-UX 10.20, 11.00, and 11.11, and
2151 Solaris/SPARC 2.5.1, 2.6, 7, 8, and 9.
2153 @item
2154 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2155 number of platforms.
2156 @end itemize
2158 In addition to those specific offerings, you can get a binary
2159 distribution CD-ROM from the
2160 @uref{http://www.fsf.org/order/order.html,,Free Software Foundation}.
2161 It contains binaries for a number of platforms, and
2162 includes not only GCC, but other stuff as well.  The current CD does
2163 not contain the latest version of GCC, but it should allow
2164 bootstrapping the compiler.  An updated version of that disk is in the
2165 works.
2167 @html
2168 <hr />
2170 @end html
2171 @ifhtml
2172 @uref{./index.html,,Return to the GCC Installation page}
2173 @end ifhtml
2174 @end ifset
2176 @c ***Specific****************************************************************
2177 @ifnothtml
2178 @comment node-name,     next,          previous, up
2179 @node    Specific, Old, Binaries, Top
2180 @end ifnothtml
2181 @ifset specifichtml
2182 @ifnothtml
2183 @chapter Host/target specific installation notes for GCC
2184 @end ifnothtml
2185 @cindex Specific
2186 @cindex Specific installation notes
2187 @cindex Target specific installation
2188 @cindex Host specific installation
2189 @cindex Target specific installation notes
2191 Please read this document carefully @emph{before} installing the
2192 GNU Compiler Collection on your machine.
2194 @ifhtml
2195 @itemize
2196 @item
2197 @uref{#alpha-x-x,,alpha*-*-*}
2198 @item
2199 @uref{#alpha-dec-osf,,alpha*-dec-osf*}
2200 @item
2201 @uref{#alphaev5-cray-unicosmk,,alphaev5-cray-unicosmk*}
2202 @item
2203 @uref{#arc-x-elf,,arc-*-elf}
2204 @item
2205 @uref{#arm-x-elf,,arm-*-elf}
2206 @uref{#arm-x-coff,,arm-*-coff}
2207 @uref{#arm-x-aout,,arm-*-aout}
2208 @item
2209 @uref{#xscale-x-x,,xscale-*-*}
2210 @item
2211 @uref{#avr,,avr}
2212 @item
2213 @uref{#bfin,,Blackfin}
2214 @item
2215 @uref{#c4x,,c4x}
2216 @item
2217 @uref{#dos,,DOS}
2218 @item
2219 @uref{#x-x-freebsd,,*-*-freebsd*}
2220 @item
2221 @uref{#h8300-hms,,h8300-hms}
2222 @item
2223 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2224 @item
2225 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2226 @item
2227 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2228 @item
2229 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2230 @item
2231 @uref{#ix86-x-linuxaout,,i?86-*-linux*aout}
2232 @item
2233 @uref{#ix86-x-linux,,i?86-*-linux*}
2234 @item
2235 @uref{#ix86-x-sco32v5,,i?86-*-sco3.2v5*}
2236 @item
2237 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2238 @item
2239 @uref{#ix86-x-udk,,i?86-*-udk}
2240 @item
2241 @uref{#ia64-x-linux,,ia64-*-linux}
2242 @item
2243 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2244 @item
2245 @uref{#x-ibm-aix,,*-ibm-aix*}
2246 @item
2247 @uref{#ip2k-x-elf,,ip2k-*-elf}
2248 @item
2249 @uref{#iq2000-x-elf,,iq2000-*-elf}
2250 @item
2251 @uref{#m32r-x-elf,,m32r-*-elf}
2252 @item
2253 @uref{#m6811-elf,,m6811-elf}
2254 @item
2255 @uref{#m6812-elf,,m6812-elf}
2256 @item
2257 @uref{#m68k-hp-hpux,,m68k-hp-hpux}
2258 @item
2259 @uref{#mips-x-x,,mips-*-*}
2260 @item
2261 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
2262 @item
2263 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
2264 @item
2265 @uref{#powerpc-x-x,,powerpc*-*-*, powerpc-*-sysv4}
2266 @item
2267 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
2268 @item
2269 @uref{#powerpc-x-elf,,powerpc-*-elf, powerpc-*-sysv4}
2270 @item
2271 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
2272 @item
2273 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
2274 @item
2275 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
2276 @item
2277 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
2278 @item
2279 @uref{#powerpcle-x-elf,,powerpcle-*-elf, powerpcle-*-sysv4}
2280 @item
2281 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
2282 @item
2283 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
2284 @item
2285 @uref{#s390-x-linux,,s390-*-linux*}
2286 @item
2287 @uref{#s390x-x-linux,,s390x-*-linux*}
2288 @item
2289 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
2290 @item
2291 @uref{#x-x-solaris2,,*-*-solaris2*}
2292 @item
2293 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
2294 @item
2295 @uref{#sparc-sun-solaris27,,sparc-sun-solaris2.7}
2296 @item
2297 @uref{#sparc-x-linux,,sparc-*-linux*}
2298 @item
2299 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
2300 @item
2301 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
2302 @item
2303 @uref{#x-x-sysv,,*-*-sysv*}
2304 @item
2305 @uref{#vax-dec-ultrix,,vax-dec-ultrix}
2306 @item
2307 @uref{#x-x-vxworks,,*-*-vxworks*}
2308 @item
2309 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
2310 @item
2311 @uref{#xtensa-x-elf,,xtensa-*-elf}
2312 @item
2313 @uref{#xtensa-x-linux,,xtensa-*-linux*}
2314 @item
2315 @uref{#windows,,Microsoft Windows}
2316 @item
2317 @uref{#os2,,OS/2}
2318 @item
2319 @uref{#older,,Older systems}
2320 @end itemize
2322 @itemize
2323 @item
2324 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
2325 @end itemize
2326 @end ifhtml
2329 @html
2330 <!-- -------- host/target specific issues start here ---------------- -->
2331 <hr />
2332 @end html
2333 @heading @anchor{alpha-x-x}alpha*-*-*
2335 This section contains general configuration information for all
2336 alpha-based platforms using ELF (in particular, ignore this section for
2337 DEC OSF/1, Digital UNIX and Tru64 UNIX)@.  In addition to reading this
2338 section, please read all other sections that match your target.
2340 We require binutils 2.11.2 or newer.
2341 Previous binutils releases had a number of problems with DWARF 2
2342 debugging information, not the least of which is incorrect linking of
2343 shared libraries.
2345 @html
2346 <hr />
2347 @end html
2348 @heading @anchor{alpha-dec-osf}alpha*-dec-osf*
2349 Systems using processors that implement the DEC Alpha architecture and
2350 are running the DEC/Compaq Unix (DEC OSF/1, Digital UNIX, or Compaq
2351 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
2353 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
2354 supported.  (These are the versions which identify themselves as DEC
2355 OSF/1.)
2357 In Digital Unix V4.0, virtual memory exhausted bootstrap failures
2358 may be fixed by configuring with @option{--with-gc=simple},
2359 reconfiguring Kernel Virtual Memory and Swap parameters
2360 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
2361 or applying the patch in
2362 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.
2364 In Tru64 UNIX V5.1, Compaq introduced a new assembler that does not
2365 currently (2001-06-13) work with @command{mips-tfile}.  As a workaround,
2366 we need to use the old assembler, invoked via the barely documented
2367 @option{-oldas} option.  To bootstrap GCC, you either need to use the
2368 Compaq C Compiler:
2370 @smallexample
2371    % CC=cc @var{srcdir}/configure [@var{options}] [@var{target}]
2372 @end smallexample
2374 or you can use a copy of GCC 2.95.3 or higher built on Tru64 UNIX V4.0:
2376 @smallexample
2377    % CC=gcc -Wa,-oldas @var{srcdir}/configure [@var{options}] [@var{target}]
2378 @end smallexample
2380 As of GNU binutils 2.11.2, neither GNU @command{as} nor GNU @command{ld}
2381 are supported on Tru64 UNIX, so you must not configure GCC with
2382 @option{--with-gnu-as} or @option{--with-gnu-ld}.
2384 GCC writes a @samp{.verstamp} directive to the assembler output file
2385 unless it is built as a cross-compiler.  It gets the version to use from
2386 the system header file @file{/usr/include/stamp.h}.  If you install a
2387 new version of DEC Unix, you should rebuild GCC to pick up the new version
2388 stamp.
2390 Note that since the Alpha is a 64-bit architecture, cross-compilers from
2391 32-bit machines will not generate code as efficient as that generated
2392 when the compiler is running on a 64-bit machine because many
2393 optimizations that depend on being able to represent a word on the
2394 target in an integral value on the host cannot be performed.  Building
2395 cross-compilers on the Alpha for 32-bit machines has only been tested in
2396 a few cases and may not work properly.
2398 @samp{make compare} may fail on old versions of DEC Unix unless you add
2399 @option{-save-temps} to @code{CFLAGS}.  On these systems, the name of the
2400 assembler input file is stored in the object file, and that makes
2401 comparison fail if it differs between the @code{stage1} and
2402 @code{stage2} compilations.  The option @option{-save-temps} forces a
2403 fixed name to be used for the assembler input file, instead of a
2404 randomly chosen name in @file{/tmp}.  Do not add @option{-save-temps}
2405 unless the comparisons fail without that option.  If you add
2406 @option{-save-temps}, you will have to manually delete the @samp{.i} and
2407 @samp{.s} files after each series of compilations.
2409 GCC now supports both the native (ECOFF) debugging format used by DBX
2410 and GDB and an encapsulated STABS format for use only with GDB@.  See the
2411 discussion of the @option{--with-stabs} option of @file{configure} above
2412 for more information on these formats and how to select them.
2414 There is a bug in DEC's assembler that produces incorrect line numbers
2415 for ECOFF format when the @samp{.align} directive is used.  To work
2416 around this problem, GCC will not emit such alignment directives
2417 while writing ECOFF format debugging information even if optimization is
2418 being performed.  Unfortunately, this has the very undesirable
2419 side-effect that code addresses when @option{-O} is specified are
2420 different depending on whether or not @option{-g} is also specified.
2422 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
2423 DBX@.  DEC is now aware of this problem with the assembler and hopes to
2424 provide a fix shortly.
2426 @html
2427 <hr />
2428 @end html
2429 @heading @anchor{alphaev5-cray-unicosmk}alphaev5-cray-unicosmk*
2430 Cray T3E systems running Unicos/Mk.
2432 This port is incomplete and has many known bugs.  We hope to improve the
2433 support for this target soon.  Currently, only the C front end is supported,
2434 and it is not possible to build parallel applications.  Cray modules are not
2435 supported; in particular, Craylibs are assumed to be in
2436 @file{/opt/ctl/craylibs/craylibs}.
2438 You absolutely @strong{must} use GNU make on this platform.  Also, you
2439 need to tell GCC where to find the assembler and the linker.  The
2440 simplest way to do so is by providing @option{--with-as} and
2441 @option{--with-ld} to @file{configure}, e.g.@:
2443 @smallexample
2444     configure --with-as=/opt/ctl/bin/cam --with-ld=/opt/ctl/bin/cld \
2445       --enable-languages=c
2446 @end smallexample
2448 The comparison test during @samp{make bootstrap} fails on Unicos/Mk
2449 because the assembler inserts timestamps into object files.  You should
2450 be able to work around this by doing @samp{make all} after getting this
2451 failure.
2453 @html
2454 <hr />
2455 @end html
2456 @heading @anchor{arc-x-elf}arc-*-elf
2457 Argonaut ARC processor.
2458 This configuration is intended for embedded systems.
2460 @html
2461 <hr />
2462 @end html
2463 @heading @anchor{arm-x-elf}arm-*-elf
2464 @heading @anchor{xscale-x-x}xscale-*-*
2465 ARM-family processors.  Subtargets that use the ELF object format
2466 require GNU binutils 2.13 or newer.  Such subtargets include:
2467 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux},
2468 @code{arm-*-rtems} and @code{arm-*-kaos}.
2470 @html
2471 <hr />
2472 @end html
2473 @heading @anchor{arm-x-coff}arm-*-coff
2474 ARM-family processors.  Note that there are two different varieties
2475 of PE format subtarget supported: @code{arm-wince-pe} and
2476 @code{arm-pe} as well as a standard COFF target @code{arm-*-coff}.
2478 @html
2479 <hr />
2480 @end html
2481 @heading @anchor{arm-x-aout}arm-*-aout
2482 ARM-family processors.  These targets support the AOUT file format:
2483 @code{arm-*-aout}, @code{arm-*-netbsd}.
2485 @html
2486 <hr />
2487 @end html
2488 @heading @anchor{avr}avr
2490 ATMEL AVR-family micro controllers.  These are used in embedded
2491 applications.  There are no standard Unix configurations.
2492 @ifnothtml
2493 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
2494 Collection (GCC)},
2495 @end ifnothtml
2496 @ifhtml
2497 See ``AVR Options'' in the main manual
2498 @end ifhtml
2499 for the list of supported MCU types.
2501 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
2503 Further installation notes and other useful information about AVR tools
2504 can also be obtained from:
2506 @itemize @bullet
2507 @item
2508 @uref{http://www.openavr.org,,http://www.openavr.org}
2509 @item
2510 @uref{http://home.overta.ru/users/denisc/,,http://home.overta.ru/users/denisc/}
2511 @item
2512 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
2513 @end itemize
2515 We @emph{strongly} recommend using binutils 2.13 or newer.
2517 The following error:
2518 @smallexample
2519   Error: register required
2520 @end smallexample
2522 indicates that you should upgrade to a newer version of the binutils.
2524 @html
2525 <hr />
2526 @end html
2527 @heading @anchor{bfin}Blackfin
2529 The Blackfin processor, an Analog Devices DSP.
2530 @ifnothtml
2531 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
2532 Collection (GCC)},
2533 @end ifnothtml
2534 @ifhtml
2535 See ``Blackfin Options'' in the main manual
2536 @end ifhtml
2538 More information, and a version of binutils with support for this processor,
2539 is available at @uref{http://blackfin.uclinux.org}
2541 @html
2542 <hr />
2543 @end html
2544 @heading @anchor{c4x}c4x
2546 Texas Instruments TMS320C3x and TMS320C4x Floating Point Digital Signal
2547 Processors.  These are used in embedded applications.  There are no
2548 standard Unix configurations.
2549 @ifnothtml
2550 @xref{TMS320C3x/C4x Options,, TMS320C3x/C4x Options, gcc, Using the
2551 GNU Compiler Collection (GCC)},
2552 @end ifnothtml
2553 @ifhtml
2554 See ``TMS320C3x/C4x Options'' in the main manual
2555 @end ifhtml
2556 for the list of supported MCU types.
2558 GCC can be configured as a cross compiler for both the C3x and C4x
2559 architectures on the same system.  Use @samp{configure --target=c4x
2560 --enable-languages="c,c++"} to configure.
2563 Further installation notes and other useful information about C4x tools
2564 can also be obtained from:
2566 @itemize @bullet
2567 @item
2568 @uref{http://www.elec.canterbury.ac.nz/c4x/,,http://www.elec.canterbury.ac.nz/c4x/}
2569 @end itemize
2571 @html
2572 <hr />
2573 @end html
2574 @heading @anchor{cris}CRIS
2576 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
2577 series.  These are used in embedded applications.
2579 @ifnothtml
2580 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
2581 Collection (GCC)},
2582 @end ifnothtml
2583 @ifhtml
2584 See ``CRIS Options'' in the main manual
2585 @end ifhtml
2586 for a list of CRIS-specific options.
2588 There are a few different CRIS targets:
2589 @table @code
2590 @item cris-axis-aout
2591 Old target.  Includes a multilib for the @samp{elinux} a.out-based
2592 target.  No multilibs for newer architecture variants.
2593 @item cris-axis-elf
2594 Mainly for monolithic embedded systems.  Includes a multilib for the
2595 @samp{v10} core used in @samp{ETRAX 100 LX}.
2596 @item cris-axis-linux-gnu
2597 A GNU/Linux port for the CRIS architecture, currently targeting
2598 @samp{ETRAX 100 LX} by default.
2599 @end table
2601 For @code{cris-axis-aout} and @code{cris-axis-elf} you need binutils 2.11
2602 or newer.  For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
2604 Pre-packaged tools can be obtained from
2605 @uref{ftp://ftp.axis.com/pub/axis/tools/cris/compiler-kit/}.  More
2606 information about this platform is available at
2607 @uref{http://developer.axis.com/}.
2609 @html
2610 <hr />
2611 @end html
2612 @heading @anchor{dos}DOS
2614 Please have a look at the @uref{binaries.html,,binaries page}.
2616 You cannot install GCC by itself on MSDOS; it will not compile under
2617 any MSDOS compiler except itself.  You need to get the complete
2618 compilation package DJGPP, which includes binaries as well as sources,
2619 and includes all the necessary compilation tools and libraries.
2621 @html
2622 <hr />
2623 @end html
2624 @heading @anchor{x-x-freebsd}*-*-freebsd*
2626 The version of binutils installed in @file{/usr/bin} probably works with
2627 this release of GCC@.  However, on FreeBSD 4, bootstrapping against the
2628 latest FSF binutils is known to improve overall testsuite results; and,
2629 on FreeBSD/alpha, using binutils 2.14 or later is required to build libjava.
2631 Support for FreeBSD 1 was discontinued in GCC 3.2.
2633 Support for FreeBSD 2 will be discontinued after GCC 3.4.  The
2634 following was true for GCC 3.1 but the current status is unknown.
2635 For FreeBSD 2 or any mutant a.out versions of FreeBSD 3: All
2636 configuration support and files as shipped with GCC 2.95 are still in
2637 place.  FreeBSD 2.2.7 has been known to bootstrap completely; however,
2638 it is unknown which version of binutils was used (it is assumed that it
2639 was the system copy in @file{/usr/bin}) and C++ EH failures were noted.
2641 For FreeBSD using the ELF file format: DWARF 2 debugging is now the
2642 default for all CPU architectures.  It had been the default on
2643 FreeBSD/alpha since its inception.  You may use @option{-gstabs} instead
2644 of @option{-g}, if you really want the old debugging format.  There are
2645 no known issues with mixing object files and libraries with different
2646 debugging formats.  Otherwise, this release of GCC should now match more
2647 of the configuration used in the stock FreeBSD configuration of GCC@.  In
2648 particular, @option{--enable-threads} is now configured by default.
2649 However, as a general user, do not attempt to replace the system
2650 compiler with this release.  Known to bootstrap and check with good
2651 results on FreeBSD 4.9-STABLE and 5-CURRENT@.  In the past, known to
2652 bootstrap and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2,
2653 4.3, 4.4, 4.5, 4.8-STABLE@.
2655 In principle, @option{--enable-threads} is now compatible with
2656 @option{--enable-libgcj} on FreeBSD@.  However, it has only been built
2657 and tested on @samp{i386-*-freebsd[45]} and @samp{alpha-*-freebsd[45]}.
2658 The static
2659 library may be incorrectly built (symbols are missing at link time).
2660 There is a rare timing-based startup hang (probably involves an
2661 assumption about the thread library).  Multi-threaded boehm-gc (required for
2662 libjava) exposes severe threaded signal-handling bugs on FreeBSD before
2663 4.5-RELEASE@.  Other CPU architectures
2664 supported by FreeBSD will require additional configuration tuning in, at
2665 the very least, both boehm-gc and libffi.
2667 Shared @file{libgcc_s.so} is now built and installed by default.
2669 @html
2670 <hr />
2671 @end html
2672 @heading @anchor{h8300-hms}h8300-hms
2673 Renesas H8/300 series of processors.
2675 Please have a look at the @uref{binaries.html,,binaries page}.
2677 The calling convention and structure layout has changed in release 2.6.
2678 All code must be recompiled.  The calling convention now passes the
2679 first three arguments in function calls in registers.  Structures are no
2680 longer a multiple of 2 bytes.
2682 @html
2683 <hr />
2684 @end html
2685 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
2686 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
2688 We @emph{highly} recommend using gas/binutils on all hppa platforms;
2689 you may encounter a variety of problems when using the HP assembler.
2691 Specifically, @option{-g} does not work on HP-UX (since that system
2692 uses a peculiar debugging format which GCC does not know about), unless
2693 you use GAS and GDB@.  It may be helpful to configure GCC with the
2694 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
2695 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
2697 If you wish to use the pa-risc 2.0 architecture support with a 32-bit
2698 runtime, you must use either the HP assembler, or gas/binutils 2.11
2699 or newer.
2701 There are two default scheduling models for instructions.  These are
2702 PROCESSOR_7100LC and PROCESSOR_8000.  They are selected from the pa-risc
2703 architecture specified for the target machine when configuring.
2704 PROCESSOR_8000 is the default.  PROCESSOR_7100LC is selected when
2705 the target is a @samp{hppa1*} machine.
2707 The PROCESSOR_8000 model is not well suited to older processors.  Thus,
2708 it is important to completely specify the machine architecture when
2709 configuring if you want a model other than PROCESSOR_8000.  The macro
2710 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
2711 default scheduling model is desired.
2713 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
2714 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
2715 This namespace change might cause problems when bootstrapping with
2716 an earlier version of GCC or the HP compiler as essentially the same
2717 namespace is required for an entire build.  This problem can be avoided
2718 in a number of ways.  With HP cc, @env{UNIX_STD} can be set to @samp{95}
2719 or @samp{98}.  Another way is to add an appropriate set of predefines
2720 to @env{CC}.  The description for the @option{munix=} option contains
2721 a list of the predefines used with each standard.
2723 More specific information to @samp{hppa*-hp-hpux*} targets follows.
2725 @html
2726 <hr />
2727 @end html
2728 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
2730 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
2731 @code{PHCO_19798} from HP@.  HP has two sites which provide patches free of
2732 charge:
2734 @itemize @bullet
2735 @item
2736 @html
2737 <a href="http://us.itrc.hp.com/service/home/home.do">US, Canada, Asia-Pacific, and
2738 Latin-America</a>
2739 @end html
2740 @ifnothtml
2741 @uref{http://us.itrc.hp.com/service/home/home.do,,} US, Canada, Asia-Pacific,
2742 and Latin-America.
2743 @end ifnothtml
2744 @item
2745 @uref{http://europe.itrc.hp.com/service/home/home.do,,} Europe.
2746 @end itemize
2748 The HP assembler on these systems has some problems.  Most notably the
2749 assembler inserts timestamps into each object file it creates, causing
2750 the 3-stage comparison test to fail during a @samp{make bootstrap}.
2751 You should be able to continue by saying @samp{make all} after getting
2752 the failure from @samp{make bootstrap}.
2754 GCC 4.0 requires CVS binutils as of April 28, 2004 or later.  Earlier
2755 versions require binutils 2.8 or later.
2757 The C++ ABI has changed incompatibly in GCC 4.0.  COMDAT subspaces are
2758 used for one-only code and data.  This resolves many of the previous
2759 problems in using C++ on this target.  However, the ABI is not compatible
2760 with the one implemented under HP-UX 11 using secondary definitions.
2762 @html
2763 <hr />
2764 @end html
2765 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
2767 GCC 3.0 and up support HP-UX 11.  GCC 2.95.x is not supported and cannot
2768 be used to compile GCC 3.0 and up.
2770 Refer to @uref{binaries.html,,binaries} for information about obtaining
2771 precompiled GCC binaries for HP-UX@.  Precompiled binaries must be obtained
2772 to build the Ada language as it can't be bootstrapped using C@.  Ada is
2773 only available for the 32-bit PA-RISC runtime.  The libffi and libjava
2774 haven't been ported to HP-UX and don't build.
2776 It is possible to build GCC 3.3 starting with the bundled HP compiler,
2777 but the process requires several steps.  GCC 3.3 can then be used to
2778 build later versions.  The fastjar program contains ISO C code and
2779 can't be built with the HP bundled compiler.  This problem can be
2780 avoided by not building the Java language.  For example, use the
2781 @option{--enable-languages="c,c++,f77,objc"} option in your configure
2782 command.
2784 Starting with GCC 3.4 an ISO C compiler is required to bootstrap.  The
2785 bundled compiler supports only traditional C; you will need either HP's
2786 unbundled compiler, or a binary distribution of GCC@.
2788 There are several possible approaches to building the distribution.
2789 Binutils can be built first using the HP tools.  Then, the GCC
2790 distribution can be built.  The second approach is to build GCC
2791 first using the HP tools, then build binutils, then rebuild GCC@.
2792 There have been problems with various binary distributions, so it
2793 is best not to start from a binary distribution.
2795 On 64-bit capable systems, there are two distinct targets.  Different
2796 installation prefixes must be used if both are to be installed on
2797 the same system.  The @samp{hppa[1-2]*-hp-hpux11*} target generates code
2798 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
2799 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
2800 PA-RISC 2.0 architecture.  The HP and GNU linkers are both supported
2801 for this target.
2803 The script config.guess now selects the target type based on the compiler
2804 detected during configuration.  You must define @env{PATH} or @env{CC} so
2805 that configure finds an appropriate compiler for the initial bootstrap.
2806 When @env{CC} is used, the definition should contain the options that are
2807 needed whenever @env{CC} is used.
2809 Specifically, options that determine the runtime architecture must be
2810 in @env{CC} to correctly select the target for the build.  It is also
2811 convenient to place many other compiler options in @env{CC}.  For example,
2812 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
2813 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
2814 64-bit K&R/bundled mode.  The @option{+DA2.0W} option will result in
2815 the automatic selection of the @samp{hppa64-hp-hpux11*} target.  The
2816 macro definition table of cpp needs to be increased for a successful
2817 build with the HP compiler.  _CLASSIC_TYPES and _HPUX_SOURCE need to
2818 be defined when building with the bundled compiler, or when using the
2819 @option{-Ac} option.  These defines aren't necessary with @option{-Ae}.
2821 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
2822 with the @option{--with-ld=@dots{}} option.  This overrides the standard
2823 search for ld.  The two linkers supported on this target require different
2824 commands.  The default linker is determined during configuration.  As a
2825 result, it's not possible to switch linkers in the middle of a GCC build.
2826 This has been been reported to sometimes occur in unified builds of
2827 binutils and GCC@.
2829 GCC 3.0 through 3.2 require binutils 2.11 or above.  GCC 3.3 through
2830 GCC 4.0 require binutils 2.14 or later.
2832 Although the HP assembler can be used for an initial build, it shouldn't
2833 be used with any languages other than C and perhaps Fortran due to its
2834 many limitations.  For example, it does not support weak symbols or alias
2835 definitions.  As a result, explicit template instantiations are required
2836 when using C++.  This makes it difficult if not impossible to build many
2837 C++ applications.  You can't generate debugging information when using
2838 the HP assembler.  Finally, @samp{make bootstrap} fails in the final
2839 comparison of object modules due to the time stamps that it inserts into
2840 the modules.  The bootstrap can be continued from this point with
2841 @samp{make all}.
2843 A recent linker patch must be installed for the correct operation of
2844 GCC 3.3 and later.  @code{PHSS_26559} and @code{PHSS_24304} are the
2845 oldest linker patches that are known to work.  They are for HP-UX
2846 11.00 and 11.11, respectively.  @code{PHSS_24303}, the companion to
2847 @code{PHSS_24304}, might be usable but it hasn't been tested.  These
2848 patches have been superseded.  Consult the HP patch database to obtain
2849 the currently recommended linker patch for your system.
2851 The patches are necessary for the support of weak symbols on the
2852 32-bit port, and for the running of initializers and finalizers.  Weak
2853 symbols are implemented using SOM secondary definition symbols.  Prior
2854 to HP-UX 11, there are bugs in the linker support for secondary symbols.
2855 The patches correct a problem of linker core dumps creating shared
2856 libraries containing secondary symbols, as well as various other
2857 linking issues involving secondary symbols.
2859 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
2860 run initializers and finalizers on the 64-bit port.  The 32-bit port
2861 uses the linker @option{+init} and @option{+fini} options for the same
2862 purpose.  The patches correct various problems with the +init/+fini
2863 options, including program core dumps.  Binutils 2.14 corrects a
2864 problem on the 64-bit port resulting from HP's non-standard use of
2865 the .init and .fini sections for array initializers and finalizers.
2867 There are a number of issues to consider in selecting which linker to
2868 use with the 64-bit port.  The GNU 64-bit linker can only create dynamic
2869 binaries.  The @option{-static} option causes linking with archive
2870 libraries but doesn't produce a truly static binary.  Dynamic binaries
2871 still require final binding by the dynamic loader to resolve a set of
2872 dynamic-loader-defined symbols.  The default behavior of the HP linker
2873 is the same as the GNU linker.  However, it can generate true 64-bit
2874 static binaries using the @option{+compat} option.
2876 The HP 64-bit linker doesn't support linkonce semantics.  As a
2877 result, C++ programs have many more sections than they should.
2879 The GNU 64-bit linker has some issues with shared library support
2880 and exceptions.  As a result, we only support libgcc in archive
2881 format.  For similar reasons, dwarf2 unwind and exception support
2882 are disabled.  The GNU linker also has problems creating binaries
2883 with @option{-static}.  It doesn't provide stubs for internal
2884 calls to global functions in shared libraries, so these calls
2885 can't be overloaded.
2887 Thread support is not implemented in GCC 3.0 through 3.2, so the
2888 @option{--enable-threads} configure option does not work.  In 3.3
2889 and later, POSIX threads are supported.  The optional DCE thread
2890 library is not supported.
2892 This port still is undergoing significant development.
2894 @html
2895 <hr />
2896 @end html
2897 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
2899 Versions of libstdc++-v3 starting with 3.2.1 require bugfixes present
2900 in glibc 2.2.5 and later.  More information is available in the
2901 libstdc++-v3 documentation.
2903 @html
2904 <hr />
2905 @end html
2906 @heading @anchor{ix86-x-linuxaout}i?86-*-linux*aout
2907 Use this configuration to generate @file{a.out} binaries on Linux-based
2908 GNU systems.  This configuration is being superseded.
2910 @html
2911 <hr />
2912 @end html
2913 @heading @anchor{ix86-x-linux}i?86-*-linux*
2915 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
2916 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
2918 If you receive Signal 11 errors when building on GNU/Linux, then it is
2919 possible you have a hardware problem.  Further information on this can be
2920 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
2922 @html
2923 <hr />
2924 @end html
2925 @heading @anchor{ix86-x-sco32v5}i?86-*-sco3.2v5*
2926 Use this for the SCO OpenServer Release 5 family of operating systems.
2928 Unlike earlier versions of GCC, the ability to generate COFF with this
2929 target is no longer provided.
2931 Earlier versions of GCC emitted DWARF 1 when generating ELF to allow
2932 the system debugger to be used.  That support was too burdensome to
2933 maintain.  GCC now emits only DWARF 2 for this target.  This means you
2934 may use either the UDK debugger or GDB to debug programs built by this
2935 version of GCC@.
2937 GCC is now only supported on releases 5.0.4 and later, and requires that
2938 you install Support Level Supplement OSS646B or later, and Support Level
2939 Supplement OSS631C or later.  If you are using release 5.0.7 of
2940 OpenServer, you must have at least the first maintenance pack installed
2941 (this includes the relevant portions of OSS646).  OSS646, also known as
2942 the ``Execution Environment Update'', provides updated link editors and
2943 assemblers, as well as updated standard C and math libraries.  The C
2944 startup modules are also updated to support the System V gABI draft, and
2945 GCC relies on that behavior.  OSS631 provides a collection of commonly
2946 used open source libraries, some of which GCC depends on (such as GNU
2947 gettext and zlib).  SCO OpenServer Release 5.0.7 has all of this built
2948 in by default, but OSS631C and later also apply to that release.  Please
2949 visit
2950 @uref{ftp://ftp.sco.com/pub/openserver5,,ftp://ftp.sco.com/pub/openserver5}
2951 for the latest versions of these (and other potentially useful)
2952 supplements.
2954 Although there is support for using the native assembler, it is
2955 recommended that you configure GCC to use the GNU assembler.  You do
2956 this by using the flags
2957 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}}.  You should
2958 use a modern version of GNU binutils.  Version 2.13.2.1 was used for all
2959 testing.  In general, only the @option{--with-gnu-as} option is tested.
2960 A modern bintuils (as well as a plethora of other development related
2961 GNU utilities) can be found in Support Level Supplement OSS658A, the
2962 ``GNU Development Tools'' package.  See the SCO web and ftp sites for details.
2963 That package also contains the currently ``officially supported'' version of
2964 GCC, version 2.95.3.  It is useful for bootstrapping this version.
2966 @html
2967 <hr />
2968 @end html
2969 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
2970 Use this for Solaris 10 or later on x86 and x86-64 systems.  This
2971 configuration is supported by GCC 4.0 and later versions only.
2973 It is recommended that you configure GCC to use the GNU assembler in
2974 @file{/usr/sfw/bin/gas} but the Sun linker, using the options
2975 @option{--with-gnu-as --with-as=/usr/sfw/bin/gas --without-gnu-ld
2976 --with-ld=/usr/ccs/bin/ld}.
2978 @html
2979 <hr />
2980 @end html
2981 @heading @anchor{ix86-x-udk}i?86-*-udk
2983 This target emulates the SCO Universal Development Kit and requires that
2984 package be installed.  (If it is installed, you will have a
2985 @file{/udk/usr/ccs/bin/cc} file present.)  It's very much like the
2986 @samp{i?86-*-unixware7*} target
2987 but is meant to be used when hosting on a system where UDK isn't the
2988 default compiler such as OpenServer 5 or Unixware 2.  This target will
2989 generate binaries that will run on OpenServer, Unixware 2, or Unixware 7,
2990 with the same warnings and caveats as the SCO UDK@.
2992 This target is a little tricky to build because we have to distinguish
2993 it from the native tools (so it gets headers, startups, and libraries
2994 from the right place) while making the tools not think we're actually
2995 building a cross compiler.   The easiest way to do this is with a configure
2996 command like this:
2998 @smallexample
2999     CC=/udk/usr/ccs/bin/cc @var{/your/path/to}/gcc/configure \
3000       --host=i686-pc-udk --target=i686-pc-udk --program-prefix=udk-
3001 @end smallexample
3003 @emph{You should substitute @samp{i686} in the above command with the appropriate
3004 processor for your host.}
3006 After the usual @samp{make bootstrap} and
3007 @samp{make install}, you can then access the UDK-targeted GCC
3008 tools by adding @command{udk-} before the commonly known name.  For
3009 example, to invoke the C compiler, you would use @command{udk-gcc}.
3010 They will coexist peacefully with any native-target GCC tools you may
3011 have installed.
3014 @html
3015 <hr />
3016 @end html
3017 @heading @anchor{ia64-x-linux}ia64-*-linux
3018 IA-64 processor (also known as IPF, or Itanium Processor Family)
3019 running GNU/Linux.
3021 If you are using the installed system libunwind library with
3022 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3023 later.
3025 None of the following versions of GCC has an ABI that is compatible
3026 with any of the other versions in this list, with the exception that
3027 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3028 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3029 This primarily affects C++ programs and programs that create shared libraries.
3030 GCC 3.1 or later is recommended for compiling linux, the kernel.
3031 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3032 more major ABI changes are expected.
3034 @html
3035 <hr />
3036 @end html
3037 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3038 Building GCC on this target requires the GNU Assembler.  The bundled HP
3039 assembler will not work.  To prevent GCC from using the wrong assembler,
3040 the option @option{--with-gnu-as} may be necessary.
3042 The GCC libunwind library has not been ported to HPUX@.  This means that for
3043 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3044 is required to build GCC@.  For GCC 3.3 and later, this is the default.
3045 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3046 removed and the system libunwind library will always be used.
3048 @html
3049 <hr />
3050 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3051 @end html
3052 @heading @anchor{x-ibm-aix}*-ibm-aix*
3053 Support for AIX version 3 and older was discontinued in GCC 3.4.
3055 AIX Make frequently has problems with GCC makefiles.  GNU Make 3.79.1 or
3056 newer is recommended to build on this platform.
3058 ``out of memory'' bootstrap failures may indicate a problem with
3059 process resource limits (ulimit).  Hard limits are configured in the
3060 @file{/etc/security/limits} system configuration file.
3062 To speed up the configuration phases of bootstrapping and installing GCC,
3063 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3065 @smallexample
3066    % CONFIG_SHELL=/opt/freeware/bin/bash
3067    % export CONFIG_SHELL
3068 @end smallexample
3070 and then proceed as described in @uref{build.html,,the build instructions},
3071 where we strongly recommend using GNU make and specifying an absolute path
3072 to invoke @var{srcdir}/configure.
3074 Errors involving @code{alloca} when building GCC generally are due
3075 to an incorrect definition of @code{CC} in the Makefile or mixing files
3076 compiled with the native C compiler and GCC@.  During the stage1 phase of
3077 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3078 (not @command{xlc}).  Once @command{configure} has been informed of
3079 @command{xlc}, one needs to use @samp{make distclean} to remove the
3080 configure cache files and ensure that @env{CC} environment variable
3081 does not provide a definition that will confuse @command{configure}.
3082 If this error occurs during stage2 or later, then the problem most likely
3083 is the version of Make (see above).
3085 The native @command{as} and @command{ld} are recommended for bootstrapping
3086 on AIX 4 and required for bootstrapping on AIX 5L@.  The GNU Assembler
3087 reports that it supports WEAK symbols on AIX 4, which causes GCC to try to
3088 utilize weak symbol functionality although it is not supported.  The GNU
3089 Assembler and Linker do not support AIX 5L sufficiently to bootstrap GCC@.
3090 The native AIX tools do interoperate with GCC@.
3092 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3093 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1).  It also requires a
3094 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3095 referenced as APAR IY53606 (AIX 5.2) or a APAR IY54774 (AIX 5.1)
3097 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3098 shared object and GCC installation places the @file{libstdc++.a}
3099 shared library in a common location which will overwrite the and GCC
3100 3.3 version of the shared library.  Applications either need to be
3101 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3102 versions of the @samp{libstdc++} shared object needs to be available
3103 to the AIX runtime loader.  The GCC 3.1 @samp{libstdc++.so.4}, if
3104 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3105 installed for runtime dynamic loading using the following steps to set
3106 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3107 multilib @file{libstdc++.a} installed:
3109 Extract the shared objects from the currently installed
3110 @file{libstdc++.a} archive:
3111 @smallexample
3112    % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3113 @end smallexample
3115 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3116 available for runtime dynamic loading, but not linking:
3117 @smallexample
3118    % strip -e libstdc++.so.4 libstdc++.so.5
3119 @end smallexample
3121 Archive the runtime-only shared object in the GCC 3.4
3122 @file{libstdc++.a} archive:
3123 @smallexample
3124    % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3125 @end smallexample
3127 Linking executables and shared libraries may produce warnings of
3128 duplicate symbols.  The assembly files generated by GCC for AIX always
3129 have included multiple symbol definitions for certain global variable
3130 and function declarations in the original program.  The warnings should
3131 not prevent the linker from producing a correct library or runnable
3132 executable.
3134 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3135 64-bit object modules.  The routines provided in AIX 4.3.0 and AIX 4.3.1
3136 to parse archive libraries did not handle the new format correctly.
3137 These routines are used by GCC and result in error messages during
3138 linking such as ``not a COFF file''.  The version of the routines shipped
3139 with AIX 4.3.1 should work for a 32-bit environment.  The @option{-g}
3140 option of the archive command may be used to create archives of 32-bit
3141 objects using the original ``small format''.  A correct version of the
3142 routines is shipped with AIX 4.3.2 and above.
3144 Some versions of the AIX binder (linker) can fail with a relocation
3145 overflow severe error when the @option{-bbigtoc} option is used to link
3146 GCC-produced object files into an executable that overflows the TOC@.  A fix
3147 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3148 available from IBM Customer Support and from its
3149 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3150 website as PTF U455193.
3152 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3153 with a segmentation fault when invoked by any version of GCC@.  A fix for
3154 APAR IX87327 is available from IBM Customer Support and from its
3155 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3156 website as PTF U461879.  This fix is incorporated in AIX 4.3.3 and above.
3158 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3159 files.  A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3160 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3161 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3162 website as PTF U453956.  This fix is incorporated in AIX 4.3.1 and above.
3164 AIX provides National Language Support (NLS)@.  Compilers and assemblers
3165 use NLS to support locale-specific representations of various data
3166 formats including floating-point numbers (e.g., @samp{.}  vs @samp{,} for
3167 separating decimal fractions).  There have been problems reported where
3168 GCC does not produce the same floating-point formats that the assembler
3169 expects.  If one encounters this problem, set the @env{LANG}
3170 environment variable to @samp{C} or @samp{En_US}.
3172 By default, GCC for AIX 4.1 and above produces code that can be used on
3173 both Power or PowerPC processors.
3175 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3176 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3178 @html
3179 <hr />
3180 @end html
3181 @heading @anchor{ip2k-x-elf}ip2k-*-elf
3182 Ubicom IP2022 micro controller.
3183 This configuration is intended for embedded systems.
3184 There are no standard Unix configurations.
3186 Use @samp{configure --target=ip2k-elf --enable-languages=c} to configure GCC@.
3188 @html
3189 <hr />
3190 @end html
3191 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3192 Vitesse IQ2000 processors.  These are used in embedded
3193 applications.  There are no standard Unix configurations.
3195 @html
3196 <hr />
3197 @end html
3198 @heading @anchor{m32r-x-elf}m32r-*-elf
3199 Renesas M32R processor.
3200 This configuration is intended for embedded systems.
3202 @html
3203 <hr />
3204 @end html
3205 @heading @anchor{m6811-elf}m6811-elf
3206 Motorola 68HC11 family micro controllers.  These are used in embedded
3207 applications.  There are no standard Unix configurations.
3209 @html
3210 <hr />
3211 @end html
3212 @heading @anchor{m6812-elf}m6812-elf
3213 Motorola 68HC12 family micro controllers.  These are used in embedded
3214 applications.  There are no standard Unix configurations.
3216 @html
3217 <hr />
3218 @end html
3219 @heading @anchor{m68k-hp-hpux}m68k-hp-hpux
3220 HP 9000 series 300 or 400 running HP-UX@.  HP-UX version 8.0 has a bug in
3221 the assembler that prevents compilation of GCC@.  This
3222 bug manifests itself during the first stage of compilation, while
3223 building @file{libgcc2.a}:
3225 @smallexample
3226 _floatdisf
3227 cc1: warning: `-g' option not supported on this version of GCC
3228 cc1: warning: `-g1' option not supported on this version of GCC
3229 ./xgcc: Internal compiler error: program as got fatal signal 11
3230 @end smallexample
3232 A patched version of the assembler is available as the file
3233 @uref{ftp://altdorf.ai.mit.edu/archive/cph/hpux-8.0-assembler}.  If you
3234 have HP software support, the patch can also be obtained directly from
3235 HP, as described in the following note:
3237 @quotation
3238 This is the patched assembler, to patch SR#1653-010439, where the
3239 assembler aborts on floating point constants.
3241 The bug is not really in the assembler, but in the shared library
3242 version of the function ``cvtnum(3c)''.  The bug on ``cvtnum(3c)'' is
3243 SR#4701-078451.  Anyway, the attached assembler uses the archive
3244 library version of ``cvtnum(3c)'' and thus does not exhibit the bug.
3245 @end quotation
3247 This patch is also known as PHCO_4484.
3249 In addition gdb does not understand that native HP-UX format, so
3250 you must use gas if you wish to use gdb.
3252 On HP-UX version 8.05, but not on 8.07 or more recent versions, the
3253 @command{fixproto} shell script triggers a bug in the system shell.  If you
3254 encounter this problem, upgrade your operating system or use BASH (the
3255 GNU shell) to run @command{fixproto}.  This bug will cause the fixproto
3256 program to report an error of the form:
3258 @smallexample
3259 ./fixproto: sh internal 1K buffer overflow
3260 @end smallexample
3262 To fix this, you can also change the first line of the fixproto script
3263 to look like:
3265 @smallexample
3266 #!/bin/ksh
3267 @end smallexample
3269 @html
3270 <hr />
3271 @end html
3272 @heading @anchor{mips-x-x}mips-*-*
3273 If on a MIPS system you get an error message saying ``does not have gp
3274 sections for all it's [sic] sectons [sic]'', don't worry about it.  This
3275 happens whenever you use GAS with the MIPS linker, but there is not
3276 really anything wrong, and it is okay to use the output file.  You can
3277 stop such warnings by installing the GNU linker.
3279 It would be nice to extend GAS to produce the gp tables, but they are
3280 optional, and there should not be a warning about their absence.
3282 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3283 and later.  A patch went in just after the GCC 3.3 release to
3284 make @samp{mips*-*-*} use the generic implementation instead.  You can also
3285 configure for @samp{mipsel-elf} as a workaround.  The
3286 @samp{mips*-*-linux*} target continues to use the MIPS II routines.  More
3287 work on this is expected in future releases.
3289 MIPS systems check for division by zero (unless
3290 @option{-mno-check-zero-division} is passed to the compiler) by
3291 generating either a conditional trap or a break instruction.  Using
3292 trap results in smaller code, but is only supported on MIPS II and
3293 later.  Also, some versions of the Linux kernel have a bug that
3294 prevents trap from generating the proper signal (@code{SIGFPE}).  To enable
3295 the use of break, use the @option{--with-divide=breaks}
3296 @command{configure} option when configuring GCC@.  The default is to
3297 use traps on systems that support them.
3299 Cross-compilers for the Mips as target using the Mips assembler
3300 currently do not work, because the auxiliary programs
3301 @file{mips-tdump.c} and @file{mips-tfile.c} can't be compiled on
3302 anything but a Mips.  It does work to cross compile for a Mips
3303 if you use the GNU assembler and linker.
3305 @html
3306 <hr />
3307 @end html
3308 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3310 In order to compile GCC on an SGI running IRIX 5, the @samp{compiler_dev.hdr}
3311 subsystem must be installed from the IDO CD-ROM supplied by SGI@.
3312 It is also available for download from
3313 @uref{ftp://ftp.sgi.com/sgi/IRIX5.3/iris-development-option-5.3.tardist}.
3315 If you use the MIPS C compiler to bootstrap, it may be necessary
3316 to increase its table size for switch statements with the
3317 @option{-Wf,-XNg1500} option.  If you use the @option{-O2}
3318 optimization option, you also need to use @option{-Olimit 3000}.
3320 To enable debugging under IRIX 5, you must use GNU binutils 2.15 or
3321 later, and use the @option{--with-gnu-ld} @command{configure} option
3322 when configuring GCC@.  You need to use GNU @command{ar} and @command{nm},
3323 also distributed with GNU binutils.
3325 Some users have reported that @command{/bin/sh} will hang during bootstrap.
3326 This problem can be avoided by running the commands:
3328 @smallexample
3329    % CONFIG_SHELL=/bin/ksh
3330    % export CONFIG_SHELL
3331 @end smallexample
3333 before starting the build.
3335 @html
3336 <hr />
3337 @end html
3338 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3340 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3341 ensure that the N32 ABI is in use.  To test this, compile a simple C
3342 file with @command{cc} and then run @command{file} on the
3343 resulting object file.  The output should look like:
3345 @smallexample
3346 test.o: ELF N32 MSB @dots{}
3347 @end smallexample
3349 If you see:
3351 @smallexample
3352 test.o: ELF 32-bit MSB @dots{}
3353 @end smallexample
3357 @smallexample
3358 test.o: ELF 64-bit MSB @dots{}
3359 @end smallexample
3361 then your version of @command{cc} uses the O32 or N64 ABI by default.  You
3362 should set the environment variable @env{CC} to @samp{cc -n32}
3363 before configuring GCC@.
3365 If you want the resulting @command{gcc} to run on old 32-bit systems
3366 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3367 instruction set architecture (ISA) is generated.  While GCC 3.x does
3368 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3369 the ISA depending on the machine where GCC is built.  Using one of them
3370 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3371 all on @samp{mips3}-only systems.  For the test program above, you should see:
3373 @smallexample
3374 test.o: ELF N32 MSB mips-3 @dots{}
3375 @end smallexample
3377 If you get:
3379 @smallexample
3380 test.o: ELF N32 MSB mips-4 @dots{}
3381 @end smallexample
3383 instead, you should set the environment variable @env{CC} to @samp{cc
3384 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3386 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3387 @code{memcmp}.  Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3388 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3390 GCC on IRIX 6 is usually built to support the N32, O32 and N64 ABIs.  If
3391 you build GCC on a system that doesn't have the N64 libraries installed
3392 or cannot run 64-bit binaries,
3393 you need to configure with @option{--disable-multilib} so GCC doesn't
3394 try to use them.  This will disable building the O32 libraries, too.
3395 Look for @file{/usr/lib64/libc.so.1} to see if you
3396 have the 64-bit libraries installed.
3398 To enable debugging for the O32 ABI, you must use GNU @command{as} from
3399 GNU binutils 2.15 or later.  You may also use GNU @command{ld}, but
3400 this is not required and currently causes some problems with Ada.
3402 The @option{--enable-threads} option doesn't currently work, a patch is
3403 in preparation for a future release.  The @option{--enable-libgcj}
3404 option is disabled by default: IRIX 6 uses a very low default limit
3405 (20480) for the command line length.  Although @command{libtool} contains a
3406 workaround for this problem, at least the N64 @samp{libgcj} is known not
3407 to build despite this, running into an internal error of the native
3408 @command{ld}.  A sure fix is to increase this limit (@samp{ncargs}) to
3409 its maximum of 262144 bytes.  If you have root access, you can use the
3410 @command{systune} command to do this.
3412 See @uref{http://freeware.sgi.com/} for more
3413 information about using GCC on IRIX platforms.
3415 @html
3416 <hr />
3417 @end html
3418 @heading @anchor{powerpc-x-x}powerpc-*-*
3420 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3421 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3423 @html
3424 <hr />
3425 @end html
3426 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3427 PowerPC running Darwin (Mac OS X kernel).
3429 Pre-installed versions of Mac OS X may not include any developer tools,
3430 meaning that you will not be able to build GCC from source.  Tool
3431 binaries are available at
3432 @uref{http://developer.apple.com/darwin/projects/compiler/} (free
3433 registration required).
3435 This version of GCC requires at least cctools-528.
3437 The version of GCC shipped by Apple typically includes a number of
3438 extensions not available in a standard GCC release.  These extensions
3439 are generally for backwards compatibility and best avoided.
3441 @html
3442 <hr />
3443 @end html
3444 @heading @anchor{powerpc-x-elf}powerpc-*-elf, powerpc-*-sysv4
3445 PowerPC system in big endian mode, running System V.4.
3447 @html
3448 <hr />
3449 @end html
3450 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
3452 You will need
3453 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3454 or newer for a working GCC@.
3456 @html
3457 <hr />
3458 @end html
3459 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
3460 PowerPC system in big endian mode running NetBSD@.  To build the
3461 documentation you will need Texinfo version 4.2 (NetBSD 1.5.1 included
3462 Texinfo version 3.12).
3464 @html
3465 <hr />
3466 @end html
3467 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
3468 Embedded PowerPC system in big endian mode for use in running under the
3469 PSIM simulator.
3471 @html
3472 <hr />
3473 @end html
3474 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
3475 Embedded PowerPC system in big endian mode.
3477 @html
3478 <hr />
3479 @end html
3480 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf, powerpcle-*-sysv4
3481 PowerPC system in little endian mode, running System V.4.
3483 @html
3484 <hr />
3485 @end html
3486 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
3487 Embedded PowerPC system in little endian mode for use in running under
3488 the PSIM simulator.
3490 @html
3491 <hr />
3492 @end html
3493 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
3494 Embedded PowerPC system in little endian mode.
3496 @html
3497 <hr />
3498 @end html
3499 @heading @anchor{s390-x-linux}s390-*-linux*
3500 S/390 system running GNU/Linux for S/390@.
3502 @html
3503 <hr />
3504 @end html
3505 @heading @anchor{s390x-x-linux}s390x-*-linux*
3506 zSeries system (64-bit) running GNU/Linux for zSeries@.
3508 @html
3509 <hr />
3510 @end html
3511 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
3512 zSeries system (64-bit) running TPF@.  This platform is
3513 supported as cross-compilation target only.
3515 @html
3516 <hr />
3517 @end html
3518 @c Please use Solaris 2 to refer to all release of Solaris, starting
3519 @c with 2.0 until 2.6, 7, 8, etc.  Solaris 1 was a marketing name for
3520 @c SunOS 4 releases which we don't use to avoid confusion.  Solaris
3521 @c alone is too unspecific and must be avoided.
3522 @heading @anchor{x-x-solaris2}*-*-solaris2*
3524 Sun does not ship a C compiler with Solaris 2.  To bootstrap and install
3525 GCC you first have to install a pre-built compiler, see the
3526 @uref{binaries.html,,binaries page} for details.
3528 The Solaris 2 @command{/bin/sh} will often fail to configure
3529 @file{libstdc++-v3}, @file{boehm-gc} or @file{libjava}.  We therefore
3530 recommend to use the following sequence of commands to bootstrap and
3531 install GCC:
3533 @smallexample
3534    % CONFIG_SHELL=/bin/ksh
3535    % export CONFIG_SHELL
3536 @end smallexample
3538 and then proceed as described in @uref{build.html,,the build instructions}.
3539 In addition we strongly recommend specifying an absolute path to invoke
3540 @var{srcdir}/configure.
3542 Solaris 2 comes with a number of optional OS packages.  Some of these
3543 are needed to use GCC fully, namely @code{SUNWarc},
3544 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
3545 @code{SUNWsprot}, and @code{SUNWtoo}.  If you did not install all
3546 optional packages when installing Solaris 2, you will need to verify that
3547 the packages that GCC needs are installed.
3549 To check whether an optional package is installed, use
3550 the @command{pkginfo} command.  To add an optional package, use the
3551 @command{pkgadd} command.  For further details, see the Solaris 2
3552 documentation.
3554 Trying to use the linker and other tools in
3555 @file{/usr/ucb} to install GCC has been observed to cause trouble.
3556 For example, the linker may hang indefinitely.  The fix is to remove
3557 @file{/usr/ucb} from your @env{PATH}.
3559 The build process works more smoothly with the legacy Sun tools so, if you
3560 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
3561 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
3563 All releases of GNU binutils prior to 2.11.2 have known bugs on this
3564 platform.  We recommend the use of GNU binutils 2.11.2 or later, or the
3565 vendor tools (Sun @command{as}, Sun @command{ld}).  Note that your mileage
3566 may vary if you use a combination of the GNU tools and the Sun tools: while
3567 the combination GNU @command{as} + Sun @command{ld} should reasonably work,
3568 the reverse combination Sun @command{as} + GNU @command{ld} is known to
3569 cause memory corruption at runtime in some cases for C++ programs.
3571 The stock GNU binutils 2.15 release is broken on this platform because of a
3572 single bug.  It has been fixed on the 2.15 branch in the CVS repository.
3573 You can obtain a working version by checking out the binutils-2_15-branch
3574 from the CVS repository or applying the patch
3575 @uref{http://sources.redhat.com/ml/binutils-cvs/2004-09/msg00036.html} to the
3576 release.
3578 We recommend using GNU binutils 2.16 or later in conjunction with GCC 4.x.
3579 However, for Solaris 10 and above, an additional patch is required in order
3580 for the GNU linker to be able to cope with a new flavor of shared libraries.
3581 You can obtain a working version by checking out the binutils-2_16-branch
3582 from the CVS repository or applying the patch
3583 @uref{http://sourceware.org/ml/binutils-cvs/2005-07/msg00122.html} to the
3584 release.
3586 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
3587 newer: @command{g++} will complain that types are missing.  These headers assume
3588 that omitting the type means @code{int}; this assumption worked for C89 but
3589 is wrong for C++, and is now wrong for C99 also.
3591 @command{g++} accepts such (invalid) constructs with the option
3592 @option{-fpermissive}; it
3593 will assume that any missing type is @code{int} (as defined by C89).
3595 There are patches for Solaris 2.6 (105633-56 or newer for SPARC,
3596 106248-42 or newer for Intel), Solaris 7 (108376-21 or newer for SPARC,
3597 108377-20 for Intel), and Solaris 8 (108652-24 or newer for SPARC,
3598 108653-22 for Intel) that fix this bug.
3600 Sun bug 4927647 sometimes causes random spurious testsuite failures
3601 related to missing diagnostic output.  This bug doesn't affect GCC
3602 itself, rather it is a kernel bug triggered by the @command{expect}
3603 program which is used only by the GCC testsuite driver.  When the bug
3604 causes the @command{expect} program to miss anticipated output, extra
3605 testsuite failures appear.
3607 There are patches for Solaris 8 (117350-12 or newer for SPARC,
3608 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
3609 SPARC, 117172-11 or newer for Intel) that address this problem.
3611 @html
3612 <hr />
3613 @end html
3614 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
3616 When GCC is configured to use binutils 2.11.2 or later the binaries
3617 produced are smaller than the ones produced using Sun's native tools;
3618 this difference is quite significant for binaries containing debugging
3619 information.
3621 Sun @command{as} 4.x is broken in that it cannot cope with long symbol names.
3622 A typical error message might look similar to the following:
3624 @smallexample
3625 /usr/ccs/bin/as: "/var/tmp/ccMsw135.s", line 11041: error:
3626   can't compute value of an expression involving an external symbol.
3627 @end smallexample
3629 This is Sun bug 4237974.  This is fixed with patch 108908-02 for Solaris
3630 2.6 and has been fixed in later (5.x) versions of the assembler,
3631 starting with Solaris 7.
3633 Starting with Solaris 7, the operating system is capable of executing
3634 64-bit SPARC V9 binaries.  GCC 3.1 and later properly supports
3635 this; the @option{-m64} option enables 64-bit code generation.
3636 However, if all you want is code tuned for the UltraSPARC CPU, you
3637 should try the @option{-mtune=ultrasparc} option instead, which produces
3638 code that, unlike full 64-bit code, can still run on non-UltraSPARC
3639 machines.
3641 When configuring on a Solaris 7 or later system that is running a kernel
3642 that supports only 32-bit binaries, one must configure with
3643 @option{--disable-multilib}, since we will not be able to build the
3644 64-bit target libraries.
3646 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
3647 the GNU compiler (especially GCC 3.0.x versions), which lead to the
3648 miscompilation of the stage1 compiler and the subsequent failure of the
3649 bootstrap process.  A workaround is to use GCC 3.2.3 as an intermediary
3650 stage, i.e.@: to bootstrap that compiler with the base compiler and then
3651 use it to bootstrap the final compiler.
3653 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
3654 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
3655 failure in form of a miscompilation of the stage1 compiler by the Sun
3656 compiler.  This is Sun bug 4974440.  This is fixed with patch 112760-07.
3658 GCC 3.4 changed the default debugging format from STABS to DWARF-2 for
3659 32-bit code on Solaris 7 and later.  If you use the Sun assembler, this
3660 change apparently runs afoul of Sun bug 4910101 (which is referenced as
3661 a x86-only problem by Sun, probably because they do not use DWARF-2).
3662 A symptom of the problem is that you cannot compile C++ programs like
3663 @command{groff} 1.19.1 without getting messages similar to the following:
3665 @smallexample
3666 ld: warning: relocation error: R_SPARC_UA32: @dots{}
3667   external symbolic relocation against non-allocatable section
3668   .debug_info cannot be processed at runtime: relocation ignored.
3669 @end smallexample
3671 To work around this problem, compile with @option{-gstabs+} instead of
3672 plain @option{-g}.
3674 When configuring the GNU Multiple Precision Library (GMP) on a Solaris 7
3675 or later system, the canonical target triplet must be specified as the
3676 @command{build} parameter on the configure line:
3678 @smallexample
3679 ./configure --build=sparc-sun-solaris2.7 --prefix=xxx --enable-mpfr
3680 @end smallexample
3682 @html
3683 <hr />
3684 @end html
3685 @heading @anchor{sparc-sun-solaris27}sparc-sun-solaris2.7
3687 Sun patch 107058-01 (1999-01-13) for Solaris 7/SPARC triggers a bug in
3688 the dynamic linker.  This problem (Sun bug 4210064) affects GCC 2.8
3689 and later, including all EGCS releases.  Sun formerly recommended
3690 107058-01 for all Solaris 7 users, but around 1999-09-01 it started to
3691 recommend it only for people who use Sun's compilers.
3693 Here are some workarounds to this problem:
3694 @itemize @bullet
3695 @item
3696 Do not install Sun patch 107058-01 until after Sun releases a
3697 complete patch for bug 4210064.  This is the simplest course to take,
3698 unless you must also use Sun's C compiler.  Unfortunately 107058-01
3699 is preinstalled on some new Solaris 7-based hosts, so you may have to
3700 back it out.
3702 @item
3703 Copy the original, unpatched Solaris 7
3704 @command{/usr/ccs/bin/as} into
3705 @command{/usr/local/libexec/gcc/sparc-sun-solaris2.7/3.4/as},
3706 adjusting the latter name to fit your local conventions and software
3707 version numbers.
3709 @item
3710 Install Sun patch 106950-03 (1999-05-25) or later.  Nobody with
3711 both 107058-01 and 106950-03 installed has reported the bug with GCC
3712 and Sun's dynamic linker.  This last course of action is riskiest,
3713 for two reasons.  First, you must install 106950 on all hosts that
3714 run code generated by GCC; it doesn't suffice to install it only on
3715 the hosts that run GCC itself.  Second, Sun says that 106950-03 is
3716 only a partial fix for bug 4210064, but Sun doesn't know whether the
3717 partial fix is adequate for GCC@.  Revision -08 or later should fix
3718 the bug.  The current (as of 2004-05-23) revision is -24, and is included in
3719 the Solaris 7 Recommended Patch Cluster.
3720 @end itemize
3722 GCC 3.3 triggers a bug in version 5.0 Alpha 03/27/98 of the Sun assembler,
3723 which causes a bootstrap failure when linking the 64-bit shared version of
3724 libgcc.  A typical error message is:
3726 @smallexample
3727 ld: fatal: relocation error: R_SPARC_32: file libgcc/sparcv9/_muldi3.o:
3728   symbol <unknown>:  offset 0xffffffff7ec133e7 is non-aligned.
3729 @end smallexample
3731 This bug has been fixed in the final 5.0 version of the assembler.
3733 A similar problem was reported for version Sun WorkShop 6 99/08/18 of the
3734 Sun assembler, which causes a bootstrap failure with GCC 4.0.0:
3736 @smallexample
3737 ld: fatal: relocation error: R_SPARC_DISP32:
3738   file .libs/libstdc++.lax/libsupc++convenience.a/vterminate.o:
3739     symbol <unknown>: offset 0xfccd33ad is non-aligned
3740 @end smallexample
3742 This bug has been fixed in more recent revisions of the assembler.
3744 @html
3745 <hr />
3746 @end html
3747 @heading @anchor{sparc-x-linux}sparc-*-linux*
3749 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
3750 or newer on this platform.  All earlier binutils and glibc
3751 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
3754 @html
3755 <hr />
3756 @end html
3757 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
3759 The following compiler flags must be specified in the configure
3760 step in order to bootstrap this target with the Sun compiler:
3762 @smallexample
3763    % CC="cc -xildoff -xarch=v9" @var{srcdir}/configure [@var{options}] [@var{target}]
3764 @end smallexample
3766 @option{-xildoff} turns off the incremental linker, and @option{-xarch=v9}
3767 specifies the SPARC-V9 architecture to the Sun linker and assembler.
3769 @html
3770 <hr />
3771 @end html
3772 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
3774 This is a synonym for sparc64-*-solaris2*.
3776 @html
3777 <hr />
3778 @end html
3779 @heading @anchor{x-x-sysv}*-*-sysv*
3780 On System V release 3, you may get this error message
3781 while linking:
3783 @smallexample
3784 ld fatal: failed to write symbol name @var{something}
3785  in strings table for file @var{whatever}
3786 @end smallexample
3788 This probably indicates that the disk is full or your ulimit won't allow
3789 the file to be as large as it needs to be.
3791 This problem can also result because the kernel parameter @code{MAXUMEM}
3792 is too small.  If so, you must regenerate the kernel and make the value
3793 much larger.  The default value is reported to be 1024; a value of 32768
3794 is said to work.  Smaller values may also work.
3796 On System V, if you get an error like this,
3798 @smallexample
3799 /usr/local/lib/bison.simple: In function `yyparse':
3800 /usr/local/lib/bison.simple:625: virtual memory exhausted
3801 @end smallexample
3803 @noindent
3804 that too indicates a problem with disk space, ulimit, or @code{MAXUMEM}.
3806 On a System V release 4 system, make sure @file{/usr/bin} precedes
3807 @file{/usr/ucb} in @code{PATH}.  The @command{cc} command in
3808 @file{/usr/ucb} uses libraries which have bugs.
3810 @html
3811 <hr />
3812 @end html
3813 @heading @anchor{vax-dec-ultrix}vax-dec-ultrix
3814 Don't try compiling with VAX C (@command{vcc}).  It produces incorrect code
3815 in some cases (for example, when @code{alloca} is used).
3817 @html
3818 <hr />
3819 @end html
3820 @heading @anchor{x-x-vxworks}*-*-vxworks*
3821 Support for VxWorks is in flux.  At present GCC supports @emph{only} the
3822 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
3823 We welcome patches for other architectures supported by VxWorks 5.5.
3824 Support for VxWorks AE would also be welcome; we believe this is merely
3825 a matter of writing an appropriate ``configlette'' (see below).  We are
3826 not interested in supporting older, a.out or COFF-based, versions of
3827 VxWorks in GCC 3.
3829 VxWorks comes with an older version of GCC installed in
3830 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
3831 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
3832 Before running @command{configure}, create the directories @file{@var{prefix}}
3833 and @file{@var{prefix}/bin}.  Link or copy the appropriate assembler,
3834 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
3835 include that directory while running both @command{configure} and
3836 @command{make}.
3838 You must give @command{configure} the
3839 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
3840 find the VxWorks system headers.  Since VxWorks is a cross compilation
3841 target only, you must also specify @option{--target=@var{target}}.
3842 @command{configure} will attempt to create the directory
3843 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
3844 make sure the user running @command{configure} has sufficient privilege
3845 to do so.
3847 GCC's exception handling runtime requires a special ``configlette''
3848 module, @file{contrib/gthr_supp_vxw_5x.c}.  Follow the instructions in
3849 that file to add the module to your kernel build.  (Future versions of
3850 VxWorks will incorporate this module.)
3852 @html
3853 <hr />
3854 @end html
3855 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
3857 GCC supports the x86-64 architecture implemented by the AMD64 processor
3858 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
3859 On GNU/Linux the default is a bi-arch compiler which is able to generate
3860 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
3862 @html
3863 <hr />
3864 @end html
3865 @heading @anchor{xtensa-x-elf}xtensa-*-elf
3867 This target is intended for embedded Xtensa systems using the
3868 @samp{newlib} C library.  It uses ELF but does not support shared
3869 objects.  Designed-defined instructions specified via the
3870 Tensilica Instruction Extension (TIE) language are only supported
3871 through inline assembly.
3873 The Xtensa configuration information must be specified prior to
3874 building GCC@.  The @file{include/xtensa-config.h} header
3875 file contains the configuration information.  If you created your
3876 own Xtensa configuration with the Xtensa Processor Generator, the
3877 downloaded files include a customized copy of this header file,
3878 which you can use to replace the default header file.
3880 @html
3881 <hr />
3882 @end html
3883 @heading @anchor{xtensa-x-linux}xtensa-*-linux*
3885 This target is for Xtensa systems running GNU/Linux.  It supports ELF
3886 shared objects and the GNU C library (glibc).  It also generates
3887 position-independent code (PIC) regardless of whether the
3888 @option{-fpic} or @option{-fPIC} options are used.  In other
3889 respects, this target is the same as the
3890 @uref{#xtensa-*-elf,,@samp{xtensa-*-elf}} target.
3892 @html
3893 <hr />
3894 @end html
3895 @heading @anchor{windows}Microsoft Windows (32-bit)
3897 Ports of GCC are included with the
3898 @uref{http://www.cygwin.com/,,Cygwin environment}.
3900 GCC will build under Cygwin without modification; it does not build
3901 with Microsoft's C++ compiler and there are no plans to make it do so.
3903 @html
3904 <hr />
3905 @end html
3906 @heading @anchor{os2}OS/2
3908 GCC does not currently support OS/2.  However, Andrew Zabolotny has been
3909 working on a generic OS/2 port with pgcc.  The current code can be found
3910 at @uref{http://www.goof.com/pcg/os2/,,http://www.goof.com/pcg/os2/}.
3912 An older copy of GCC 2.8.1 is included with the EMX tools available at
3913 @uref{ftp://ftp.leo.org/pub/comp/os/os2/leo/devtools/emx+gcc/,,
3914 ftp://ftp.leo.org/pub/comp/os/os2/leo/devtools/emx+gcc/}.
3916 @html
3917 <hr />
3918 @end html
3919 @heading @anchor{older}Older systems
3921 GCC contains support files for many older (1980s and early
3922 1990s) Unix variants.  For the most part, support for these systems
3923 has not been deliberately removed, but it has not been maintained for
3924 several years and may suffer from bitrot.
3926 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
3927 Support for these systems is still present in that release, but
3928 @command{configure} will fail unless the @option{--enable-obsolete}
3929 option is given.  Unless a maintainer steps forward, support for these
3930 systems will be removed from the next release of GCC@.
3932 Support for old systems as hosts for GCC can cause problems if the
3933 workarounds for compiler, library and operating system bugs affect the
3934 cleanliness or maintainability of the rest of GCC@.  In some cases, to
3935 bring GCC up on such a system, if still possible with current GCC, may
3936 require first installing an old version of GCC which did work on that
3937 system, and using it to compile a more recent GCC, to avoid bugs in the
3938 vendor compiler.  Old releases of GCC 1 and GCC 2 are available in the
3939 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
3940 sites}.  Header bugs may generally be avoided using
3941 @command{fixincludes}, but bugs or deficiencies in libraries and the
3942 operating system may still cause problems.
3944 Support for older systems as targets for cross-compilation is less
3945 problematic than support for them as hosts for GCC; if an enthusiast
3946 wishes to make such a target work again (including resurrecting any of
3947 the targets that never worked with GCC 2, starting from the last CVS
3948 version before they were removed), patches
3949 @uref{../contribute.html,,following the usual requirements} would be
3950 likely to be accepted, since they should not affect the support for more
3951 modern targets.
3953 For some systems, old versions of GNU binutils may also be useful,
3954 and are available from @file{pub/binutils/old-releases} on
3955 @uref{http://sources.redhat.com/mirrors.html,,sources.redhat.com mirror sites}.
3957 Some of the information on specific systems above relates to
3958 such older systems, but much of the information
3959 about GCC on such systems (which may no longer be applicable to
3960 current GCC) is to be found in the GCC texinfo manual.
3962 @html
3963 <hr />
3964 @end html
3965 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
3967 C++ support is significantly better on ELF targets if you use the
3968 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
3969 inlines, vtables and template instantiations will be discarded
3970 automatically.
3973 @html
3974 <hr />
3976 @end html
3977 @ifhtml
3978 @uref{./index.html,,Return to the GCC Installation page}
3979 @end ifhtml
3980 @end ifset
3982 @c ***Old documentation******************************************************
3983 @ifset oldhtml
3984 @include install-old.texi
3985 @html
3986 <hr />
3988 @end html
3989 @ifhtml
3990 @uref{./index.html,,Return to the GCC Installation page}
3991 @end ifhtml
3992 @end ifset
3994 @c ***GFDL********************************************************************
3995 @ifset gfdlhtml
3996 @include fdl.texi
3997 @html
3998 <hr />
4000 @end html
4001 @ifhtml
4002 @uref{./index.html,,Return to the GCC Installation page}
4003 @end ifhtml
4004 @end ifset
4006 @c ***************************************************************************
4007 @c Part 6 The End of the Document
4008 @ifinfo
4009 @comment node-name,     next,          previous, up
4010 @node    Concept Index, , GNU Free Documentation License, Top
4011 @end ifinfo
4013 @ifinfo
4014 @unnumbered Concept Index
4016 @printindex cp
4018 @contents
4019 @end ifinfo
4020 @bye