OSDN Git Service

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