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