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