OSDN Git Service

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