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