* doc/install.texi (os2): Remove section.
[gcc.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 @include gcc-common.texi
11
12 @c Specify title for specific html page
13 @ifset indexhtml
14 @settitle Installing GCC
15 @end ifset
16 @ifset specifichtml
17 @settitle Host/Target specific installation notes for GCC
18 @end ifset
19 @ifset prerequisiteshtml
20 @settitle Prerequisites for GCC
21 @end ifset
22 @ifset downloadhtml
23 @settitle Downloading GCC
24 @end ifset
25 @ifset configurehtml
26 @settitle Installing GCC: Configuration
27 @end ifset
28 @ifset buildhtml
29 @settitle Installing GCC: Building
30 @end ifset
31 @ifset testhtml
32 @settitle Installing GCC: Testing
33 @end ifset
34 @ifset finalinstallhtml
35 @settitle Installing GCC: Final installation
36 @end ifset
37 @ifset binarieshtml
38 @settitle Installing GCC: Binaries
39 @end ifset
40 @ifset oldhtml
41 @settitle Installing GCC: Old documentation
42 @end ifset
43 @ifset gfdlhtml
44 @settitle Installing GCC: GNU Free Documentation License
45 @end ifset
46
47 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
48 @c 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
49 @c *** Converted to texinfo by Dean Wakerley, dean@wakerley.com
50
51 @c IMPORTANT: whenever you modify this file, run `install.texi2html' to
52 @c test the generation of HTML documents for the gcc.gnu.org web pages.
53 @c
54 @c Do not use @footnote{} in this file as it breaks install.texi2html!
55
56 @c Include everything if we're not making html
57 @ifnothtml
58 @set indexhtml
59 @set specifichtml
60 @set prerequisiteshtml
61 @set downloadhtml
62 @set configurehtml
63 @set buildhtml
64 @set testhtml
65 @set finalinstallhtml
66 @set binarieshtml
67 @set oldhtml
68 @set gfdlhtml
69 @end ifnothtml
70
71 @c Part 2 Summary Description and Copyright
72 @copying
73 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
74 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
75 2008 Free Software Foundation, Inc.
76 @sp 1
77 Permission is granted to copy, distribute and/or modify this document
78 under the terms of the GNU Free Documentation License, Version 1.2 or
79 any later version published by the Free Software Foundation; with no
80 Invariant Sections, the Front-Cover texts being (a) (see below), and
81 with the Back-Cover Texts being (b) (see below). A copy of the
82 license is included in the section entitled ``@uref{./gfdl.html,,GNU
83 Free Documentation License}''.
84
85 (a) The FSF's Front-Cover Text is:
86
87 A GNU Manual
88
89 (b) The FSF's Back-Cover Text is:
90
91 You have freedom to copy and modify this GNU Manual, like GNU
92 software. Copies published by the Free Software Foundation raise
93 funds for GNU development.
94 @end copying
95 @ifinfo
96 @insertcopying
97 @end ifinfo
98 @dircategory Software development
99 @direntry
100 * gccinstall: (gccinstall). Installing the GNU Compiler Collection.
101 @end direntry
102
103 @c Part 3 Titlepage and Copyright
104 @titlepage
105 @title Installing GCC
106 @versionsubtitle
107
108 @c The following two commands start the copyright page.
109 @page
110 @vskip 0pt plus 1filll
111 @insertcopying
112 @end titlepage
113
114 @c Part 4 Top node, Master Menu, and/or Table of Contents
115 @ifinfo
116 @node Top, , , (dir)
117 @comment node-name, next, Previous, up
118
119 @menu
120 * Installing GCC:: This document describes the generic installation
121 procedure for GCC as well as detailing some target
122 specific installation instructions.
123
124 * Specific:: Host/target specific installation notes for GCC.
125 * Binaries:: Where to get pre-compiled binaries.
126
127 * Old:: Old installation documentation.
128
129 * GNU Free Documentation License:: How you can copy and share this manual.
130 * Concept Index:: This index has two entries.
131 @end menu
132 @end ifinfo
133
134 @iftex
135 @contents
136 @end iftex
137
138 @c Part 5 The Body of the Document
139 @c ***Installing GCC**********************************************************
140 @ifnothtml
141 @comment node-name, next, previous, up
142 @node Installing GCC, Binaries, , Top
143 @end ifnothtml
144 @ifset indexhtml
145 @ifnothtml
146 @chapter Installing GCC
147 @end ifnothtml
148
149 The latest version of this document is always available at
150 @uref{http://gcc.gnu.org/install/,,http://gcc.gnu.org/install/}.
151
152 This document describes the generic installation procedure for GCC as well
153 as detailing some target specific installation instructions.
154
155 GCC includes several components that previously were separate distributions
156 with their own installation instructions. This document supersedes all
157 package specific installation instructions.
158
159 @emph{Before} starting the build/install procedure please check the
160 @ifnothtml
161 @ref{Specific, host/target specific installation notes}.
162 @end ifnothtml
163 @ifhtml
164 @uref{specific.html,,host/target specific installation notes}.
165 @end ifhtml
166 We recommend you browse the entire generic installation instructions before
167 you proceed.
168
169 Lists of successful builds for released versions of GCC are
170 available at @uref{http://gcc.gnu.org/buildstat.html}.
171 These lists are updated as new information becomes available.
172
173 The installation procedure itself is broken into five steps.
174
175 @ifinfo
176 @menu
177 * Prerequisites::
178 * Downloading the source::
179 * Configuration::
180 * Building::
181 * Testing:: (optional)
182 * Final install::
183 @end menu
184 @end ifinfo
185 @ifhtml
186 @enumerate
187 @item
188 @uref{prerequisites.html,,Prerequisites}
189 @item
190 @uref{download.html,,Downloading the source}
191 @item
192 @uref{configure.html,,Configuration}
193 @item
194 @uref{build.html,,Building}
195 @item
196 @uref{test.html,,Testing} (optional)
197 @item
198 @uref{finalinstall.html,,Final install}
199 @end enumerate
200 @end ifhtml
201
202 Please note that GCC does not support @samp{make uninstall} and probably
203 won't do so in the near future as this would open a can of worms. Instead,
204 we suggest that you install GCC into a directory of its own and simply
205 remove that directory when you do not need that specific version of GCC
206 any longer, and, if shared libraries are installed there as well, no
207 more binaries exist that use them.
208
209 @ifhtml
210 There are also some @uref{old.html,,old installation instructions},
211 which are mostly obsolete but still contain some information which has
212 not yet been merged into the main part of this manual.
213 @end ifhtml
214
215 @html
216 <hr />
217 <p>
218 @end html
219 @ifhtml
220 @uref{./index.html,,Return to the GCC Installation page}
221
222 @insertcopying
223 @end ifhtml
224 @end ifset
225
226 @c ***Prerequisites**************************************************
227 @ifnothtml
228 @comment node-name, next, previous, up
229 @node Prerequisites, Downloading the source, , Installing GCC
230 @end ifnothtml
231 @ifset prerequisiteshtml
232 @ifnothtml
233 @chapter Prerequisites
234 @end ifnothtml
235 @cindex Prerequisites
236
237 GCC requires that various tools and packages be available for use in the
238 build procedure. Modifying GCC sources requires additional tools
239 described below.
240
241 @heading Tools/packages necessary for building GCC
242 @table @asis
243 @item ISO C90 compiler
244 Necessary to bootstrap GCC, although versions of GCC prior
245 to 3.4 also allow bootstrapping with a traditional (K&R) C compiler.
246
247 To build all languages in a cross-compiler or other configuration where
248 3-stage bootstrap is not performed, you need to start with an existing
249 GCC binary (version 2.95 or later) because source code for language
250 frontends other than C might use GCC extensions.
251
252 @item GNAT
253
254 In order to build the Ada compiler (GNAT) you must already have GNAT
255 installed because portions of the Ada frontend are written in Ada (with
256 GNAT extensions.) Refer to the Ada installation instructions for more
257 specific information.
258
259 @item A ``working'' POSIX compatible shell, or GNU bash
260
261 Necessary when running @command{configure} because some
262 @command{/bin/sh} shells have bugs and may crash when configuring the
263 target libraries. In other cases, @command{/bin/sh} or @command{ksh}
264 have disastrous corner-case performance problems. This
265 can cause target @command{configure} runs to literally take days to
266 complete in some cases.
267
268 So on some platforms @command{/bin/ksh} is sufficient, on others it
269 isn't. See the host/target specific instructions for your platform, or
270 use @command{bash} to be sure. Then set @env{CONFIG_SHELL} in your
271 environment to your ``good'' shell prior to running
272 @command{configure}/@command{make}.
273
274 @command{zsh} is not a fully compliant POSIX shell and will not
275 work when configuring GCC@.
276
277 @item A POSIX or SVR4 awk
278
279 Necessary for creating some of the generated source files for GCC@.
280 If in doubt, use a recent GNU awk version, as some of the older ones
281 are broken. GNU awk version 3.1.5 is known to work.
282
283 @item GNU binutils
284
285 Necessary in some circumstances, optional in others. See the
286 host/target specific instructions for your platform for the exact
287 requirements.
288
289 @item gzip version 1.2.4 (or later) or
290 @itemx bzip2 version 1.0.2 (or later)
291
292 Necessary to uncompress GCC @command{tar} files when source code is
293 obtained via FTP mirror sites.
294
295 @item GNU make version 3.80 (or later)
296
297 You must have GNU make installed to build GCC@.
298
299 @item GNU tar version 1.14 (or later)
300
301 Necessary (only on some platforms) to untar the source code. Many
302 systems' @command{tar} programs will also work, only try GNU
303 @command{tar} if you have problems.
304
305 @item GNU Multiple Precision Library (GMP) version 4.2 (or later)
306
307 Necessary to build GCC@. If you do not have it installed in your
308 library search path, you will have to configure with the
309 @option{--with-gmp} configure option. See also @option{--with-gmp-lib}
310 and @option{--with-gmp-include}. Alternatively, if a GMP source
311 distribution is found in a subdirectory of your GCC sources named
312 @file{gmp}, it will be built together with GCC@.
313
314 @item MPFR Library version 2.3.2 (or later)
315
316 Necessary to build GCC@. It can be downloaded from
317 @uref{http://www.mpfr.org/}. The @option{--with-mpfr} configure
318 option should be used if your MPFR Library is not installed in your
319 default library search path. See also @option{--with-mpfr-lib} and
320 @option{--with-mpfr-include}. Alternatively, if a MPFR source
321 distribution is found in a subdirectory of your GCC sources named
322 @file{mpfr}, it will be built together with GCC@.
323
324 @item Parma Polyhedra Library (PPL) version 0.10
325
326 Necessary to build GCC with the Graphite loop optimizations.
327 It can be downloaded from @uref{http://www.cs.unipr.it/ppl/Download/}.
328
329 The @option{--with-ppl} configure option should be used if PPL is not
330 installed in your default library search path.
331
332 @item CLooG-PPL version 0.15
333
334 Necessary to build GCC with the Graphite loop optimizations. It can
335 be downloaded from @uref{ftp://gcc.gnu.org/pub/gcc/infrastructure/}.
336 The code in @file{cloog-ppl-0.15.tar.gz} comes from a branch of CLooG
337 available from @uref{http://repo.or.cz/w/cloog-ppl.git}. CLooG-PPL
338 should be configured with @option{--with-ppl}.
339
340 The @option{--with-cloog} configure option should be used if CLooG is
341 not installed in your default library search path.
342
343 @item @command{jar}, or InfoZIP (@command{zip} and @command{unzip})
344
345 Necessary to build libgcj, the GCJ runtime.
346
347 @item MPC Library version 0.6.0 (or later)
348
349 Optional when building GCC@. Having this library will enable
350 additional optimizations on complex numbers. It can be downloaded
351 from @uref{http://www.multiprecision.org/mpc/}. The
352 @option{--with-mpc} configure option should be used if your MPC
353 Library is not installed in your default library search path. See
354 also @option{--with-mpc-lib} and @option{--with-mpc-include}.
355 Alternatively, if an MPC source distribution is found in a
356 subdirectory of your GCC sources named @file{mpc}, it will be built
357 together with GCC@.
358
359 @end table
360
361 @heading Tools/packages necessary for modifying GCC
362 @table @asis
363 @item autoconf version 2.64
364 @itemx GNU m4 version 1.4.6 (or later)
365
366 Necessary when modifying @file{configure.ac}, @file{aclocal.m4}, etc.@:
367 to regenerate @file{configure} and @file{config.in} files.
368
369 @item automake version 1.11
370
371 Necessary when modifying a @file{Makefile.am} file to regenerate its
372 associated @file{Makefile.in}.
373
374 Much of GCC does not use automake, so directly edit the @file{Makefile.in}
375 file. Specifically this applies to the @file{gcc}, @file{intl},
376 @file{libcpp}, @file{libiberty}, @file{libobjc} directories as well
377 as any of their subdirectories.
378
379 For directories that use automake, GCC requires the latest release in
380 the 1.11 series, which is currently 1.11. When regenerating a directory
381 to a newer version, please update all the directories using an older 1.11
382 to the latest released version.
383
384 @item gettext version 0.14.5 (or later)
385
386 Needed to regenerate @file{gcc.pot}.
387
388 @item gperf version 2.7.2 (or later)
389
390 Necessary when modifying @command{gperf} input files, e.g.@:
391 @file{gcc/cp/cfns.gperf} to regenerate its associated header file, e.g.@:
392 @file{gcc/cp/cfns.h}.
393
394 @item DejaGnu 1.4.4
395 @itemx Expect
396 @itemx Tcl
397
398 Necessary to run the GCC testsuite; see the section on testing for details.
399
400 @item autogen version 5.5.4 (or later) and
401 @itemx guile version 1.4.1 (or later)
402
403 Necessary to regenerate @file{fixinc/fixincl.x} from
404 @file{fixinc/inclhack.def} and @file{fixinc/*.tpl}.
405
406 Necessary to run @samp{make check} for @file{fixinc}.
407
408 Necessary to regenerate the top level @file{Makefile.in} file from
409 @file{Makefile.tpl} and @file{Makefile.def}.
410
411 @item Flex version 2.5.4 (or later)
412
413 Necessary when modifying @file{*.l} files.
414
415 Necessary to build GCC during development because the generated output
416 files are not included in the SVN repository. They are included in
417 releases.
418
419 @item Texinfo version 4.7 (or later)
420
421 Necessary for running @command{makeinfo} when modifying @file{*.texi}
422 files to test your changes.
423
424 Necessary for running @command{make dvi} or @command{make pdf} to
425 create printable documentation in DVI or PDF format. Texinfo version
426 4.8 or later is required for @command{make pdf}.
427
428 Necessary to build GCC documentation during development because the
429 generated output files are not included in the SVN repository. They are
430 included in releases.
431
432 @item @TeX{} (any working version)
433
434 Necessary for running @command{texi2dvi} and @command{texi2pdf}, which
435 are used when running @command{make dvi} or @command{make pdf} to create
436 DVI or PDF files, respectively.
437
438 @item SVN (any version)
439 @itemx SSH (any version)
440
441 Necessary to access the SVN repository. Public releases and weekly
442 snapshots of the development sources are also available via FTP@.
443
444 @item Perl version 5.6.1 (or later)
445
446 Necessary when regenerating @file{Makefile} dependencies in libiberty.
447 Necessary when regenerating @file{libiberty/functions.texi}.
448 Necessary when generating manpages from Texinfo manuals.
449 Necessary when targetting Darwin, building libstdc++,
450 and not using @option{--disable-symvers}.
451 Used by various scripts to generate some files included in SVN (mainly
452 Unicode-related and rarely changing) from source tables.
453
454 @item GNU diffutils version 2.7 (or later)
455
456 Useful when submitting patches for the GCC source code.
457
458 @item patch version 2.5.4 (or later)
459
460 Necessary when applying patches, created with @command{diff}, to one's
461 own sources.
462
463 @item ecj1
464 @itemx gjavah
465
466 If you wish to modify @file{.java} files in libjava, you will need to
467 configure with @option{--enable-java-maintainer-mode}, and you will need
468 to have executables named @command{ecj1} and @command{gjavah} in your path.
469 The @command{ecj1} executable should run the Eclipse Java compiler via
470 the GCC-specific entry point. You can download a suitable jar from
471 @uref{ftp://sourceware.org/pub/java/}, or by running the script
472 @command{contrib/download_ecj}.
473
474 @item antlr.jar version 2.7.1 (or later)
475 @itemx antlr binary
476
477 If you wish to build the @command{gjdoc} binary in libjava, you will
478 need to have an @file{antlr.jar} library available. The library is
479 searched in system locations but can be configured with
480 @option{--with-antlr-jar=} instead. When configuring with
481 @option{--enable-java-maintainer-mode}, you will need to have one of
482 the executables named @command{cantlr}, @command{runantlr} or
483 @command{antlr} in your path.
484
485 @end table
486
487 @html
488 <hr />
489 <p>
490 @end html
491 @ifhtml
492 @uref{./index.html,,Return to the GCC Installation page}
493 @end ifhtml
494 @end ifset
495
496 @c ***Downloading the source**************************************************
497 @ifnothtml
498 @comment node-name, next, previous, up
499 @node Downloading the source, Configuration, Prerequisites, Installing GCC
500 @end ifnothtml
501 @ifset downloadhtml
502 @ifnothtml
503 @chapter Downloading GCC
504 @end ifnothtml
505 @cindex Downloading GCC
506 @cindex Downloading the Source
507
508 GCC is distributed via @uref{http://gcc.gnu.org/svn.html,,SVN} and FTP
509 tarballs compressed with @command{gzip} or
510 @command{bzip2}. It is possible to download a full distribution or specific
511 components.
512
513 Please refer to the @uref{http://gcc.gnu.org/releases.html,,releases web page}
514 for information on how to obtain GCC@.
515
516 The full distribution includes the C, C++, Objective-C, Fortran, Java,
517 and Ada (in the case of GCC 3.1 and later) compilers. The full
518 distribution also includes runtime libraries for C++, Objective-C,
519 Fortran, and Java. In GCC 3.0 and later versions, the GNU compiler
520 testsuites are also included in the full distribution.
521
522 If you choose to download specific components, you must download the core
523 GCC distribution plus any language specific distributions you wish to
524 use. The core distribution includes the C language front end as well as the
525 shared components. Each language has a tarball which includes the language
526 front end as well as the language runtime (when appropriate).
527
528 Unpack the core distribution as well as any language specific
529 distributions in the same directory.
530
531 If you also intend to build binutils (either to upgrade an existing
532 installation or for use in place of the corresponding tools of your
533 OS), unpack the binutils distribution either in the same directory or
534 a separate one. In the latter case, add symbolic links to any
535 components of the binutils you intend to build alongside the compiler
536 (@file{bfd}, @file{binutils}, @file{gas}, @file{gprof}, @file{ld},
537 @file{opcodes}, @dots{}) to the directory containing the GCC sources.
538
539 Likewise the GMP, MPFR and MPC libraries can be automatically built
540 together with GCC. Unpack the GMP, MPFR and/or MPC source
541 distributions in the directory containing the GCC sources and rename
542 their directories to @file{gmp}, @file{mpfr} and @file{mpc},
543 respectively (or use symbolic links with the same name).
544
545 @html
546 <hr />
547 <p>
548 @end html
549 @ifhtml
550 @uref{./index.html,,Return to the GCC Installation page}
551 @end ifhtml
552 @end ifset
553
554 @c ***Configuration***********************************************************
555 @ifnothtml
556 @comment node-name, next, previous, up
557 @node Configuration, Building, Downloading the source, Installing GCC
558 @end ifnothtml
559 @ifset configurehtml
560 @ifnothtml
561 @chapter Installing GCC: Configuration
562 @end ifnothtml
563 @cindex Configuration
564 @cindex Installing GCC: Configuration
565
566 Like most GNU software, GCC must be configured before it can be built.
567 This document describes the recommended configuration procedure
568 for both native and cross targets.
569
570 We use @var{srcdir} to refer to the toplevel source directory for
571 GCC; we use @var{objdir} to refer to the toplevel build/object directory.
572
573 If you obtained the sources via SVN, @var{srcdir} must refer to the top
574 @file{gcc} directory, the one where the @file{MAINTAINERS} can be found,
575 and not its @file{gcc} subdirectory, otherwise the build will fail.
576
577 If either @var{srcdir} or @var{objdir} is located on an automounted NFS
578 file system, the shell's built-in @command{pwd} command will return
579 temporary pathnames. Using these can lead to various sorts of build
580 problems. To avoid this issue, set the @env{PWDCMD} environment
581 variable to an automounter-aware @command{pwd} command, e.g.,
582 @command{pawd} or @samp{amq -w}, during the configuration and build
583 phases.
584
585 First, we @strong{highly} recommend that GCC be built into a
586 separate directory than the sources which does @strong{not} reside
587 within the source tree. This is how we generally build GCC; building
588 where @var{srcdir} == @var{objdir} should still work, but doesn't
589 get extensive testing; building where @var{objdir} is a subdirectory
590 of @var{srcdir} is unsupported.
591
592 If you have previously built GCC in the same directory for a
593 different target machine, do @samp{make distclean} to delete all files
594 that might be invalid. One of the files this deletes is @file{Makefile};
595 if @samp{make distclean} complains that @file{Makefile} does not exist
596 or issues a message like ``don't know how to make distclean'' it probably
597 means that the directory is already suitably clean. However, with the
598 recommended method of building in a separate @var{objdir}, you should
599 simply use a different @var{objdir} for each target.
600
601 Second, when configuring a native system, either @command{cc} or
602 @command{gcc} must be in your path or you must set @env{CC} in
603 your environment before running configure. Otherwise the configuration
604 scripts may fail.
605
606 @ignore
607 Note that the bootstrap compiler and the resulting GCC must be link
608 compatible, else the bootstrap will fail with linker errors about
609 incompatible object file formats. Several multilibed targets are
610 affected by this requirement, see
611 @ifnothtml
612 @ref{Specific, host/target specific installation notes}.
613 @end ifnothtml
614 @ifhtml
615 @uref{specific.html,,host/target specific installation notes}.
616 @end ifhtml
617 @end ignore
618
619 To configure GCC:
620
621 @smallexample
622 % mkdir @var{objdir}
623 % cd @var{objdir}
624 % @var{srcdir}/configure [@var{options}] [@var{target}]
625 @end smallexample
626
627 @heading Distributor options
628
629 If you will be distributing binary versions of GCC, with modifications
630 to the source code, you should use the options described in this
631 section to make clear that your version contains modifications.
632
633 @table @code
634 @item --with-pkgversion=@var{version}
635 Specify a string that identifies your package. You may wish
636 to include a build number or build date. This version string will be
637 included in the output of @command{gcc --version}. This suffix does
638 not replace the default version string, only the @samp{GCC} part.
639
640 The default value is @samp{GCC}.
641
642 @item --with-bugurl=@var{url}
643 Specify the URL that users should visit if they wish to report a bug.
644 You are of course welcome to forward bugs reported to you to the FSF,
645 if you determine that they are not bugs in your modifications.
646
647 The default value refers to the FSF's GCC bug tracker.
648
649 @end table
650
651 @heading Target specification
652 @itemize @bullet
653 @item
654 GCC has code to correctly determine the correct value for @var{target}
655 for nearly all native systems. Therefore, we highly recommend you not
656 provide a configure target when configuring a native compiler.
657
658 @item
659 @var{target} must be specified as @option{--target=@var{target}}
660 when configuring a cross compiler; examples of valid targets would be
661 m68k-elf, sh-elf, etc.
662
663 @item
664 Specifying just @var{target} instead of @option{--target=@var{target}}
665 implies that the host defaults to @var{target}.
666 @end itemize
667
668
669 @heading Options specification
670
671 Use @var{options} to override several configure time options for
672 GCC@. A list of supported @var{options} follows; @samp{configure
673 --help} may list other options, but those not listed below may not
674 work and should not normally be used.
675
676 Note that each @option{--enable} option has a corresponding
677 @option{--disable} option and that each @option{--with} option has a
678 corresponding @option{--without} option.
679
680 @table @code
681 @item --prefix=@var{dirname}
682 Specify the toplevel installation
683 directory. This is the recommended way to install the tools into a directory
684 other than the default. The toplevel installation directory defaults to
685 @file{/usr/local}.
686
687 We @strong{highly} recommend against @var{dirname} being the same or a
688 subdirectory of @var{objdir} or vice versa. If specifying a directory
689 beneath a user's home directory tree, some shells will not expand
690 @var{dirname} correctly if it contains the @samp{~} metacharacter; use
691 @env{$HOME} instead.
692
693 The following standard @command{autoconf} options are supported. Normally you
694 should not need to use these options.
695 @table @code
696 @item --exec-prefix=@var{dirname}
697 Specify the toplevel installation directory for architecture-dependent
698 files. The default is @file{@var{prefix}}.
699
700 @item --bindir=@var{dirname}
701 Specify the installation directory for the executables called by users
702 (such as @command{gcc} and @command{g++}). The default is
703 @file{@var{exec-prefix}/bin}.
704
705 @item --libdir=@var{dirname}
706 Specify the installation directory for object code libraries and
707 internal data files of GCC@. The default is @file{@var{exec-prefix}/lib}.
708
709 @item --libexecdir=@var{dirname}
710 Specify the installation directory for internal executables of GCC@.
711 The default is @file{@var{exec-prefix}/libexec}.
712
713 @item --with-slibdir=@var{dirname}
714 Specify the installation directory for the shared libgcc library. The
715 default is @file{@var{libdir}}.
716
717 @item --datarootdir=@var{dirname}
718 Specify the root of the directory tree for read-only architecture-independent
719 data files referenced by GCC@. The default is @file{@var{prefix}/share}.
720
721 @item --infodir=@var{dirname}
722 Specify the installation directory for documentation in info format.
723 The default is @file{@var{datarootdir}/info}.
724
725 @item --datadir=@var{dirname}
726 Specify the installation directory for some architecture-independent
727 data files referenced by GCC@. The default is @file{@var{datarootdir}}.
728
729 @item --docdir=@var{dirname}
730 Specify the installation directory for documentation files (other
731 than Info) for GCC@. The default is @file{@var{datarootdir}/doc}.
732
733 @item --htmldir=@var{dirname}
734 Specify the installation directory for HTML documentation files.
735 The default is @file{@var{docdir}}.
736
737 @item --pdfdir=@var{dirname}
738 Specify the installation directory for PDF documentation files.
739 The default is @file{@var{docdir}}.
740
741 @item --mandir=@var{dirname}
742 Specify the installation directory for manual pages. The default is
743 @file{@var{datarootdir}/man}. (Note that the manual pages are only extracts
744 from the full GCC manuals, which are provided in Texinfo format. The manpages
745 are derived by an automatic conversion process from parts of the full
746 manual.)
747
748 @item --with-gxx-include-dir=@var{dirname}
749 Specify
750 the installation directory for G++ header files. The default depends
751 on other configuration options, and differs between cross and native
752 configurations.
753
754 @end table
755
756 @item --program-prefix=@var{prefix}
757 GCC supports some transformations of the names of its programs when
758 installing them. This option prepends @var{prefix} to the names of
759 programs to install in @var{bindir} (see above). For example, specifying
760 @option{--program-prefix=foo-} would result in @samp{gcc}
761 being installed as @file{/usr/local/bin/foo-gcc}.
762
763 @item --program-suffix=@var{suffix}
764 Appends @var{suffix} to the names of programs to install in @var{bindir}
765 (see above). For example, specifying @option{--program-suffix=-3.1}
766 would result in @samp{gcc} being installed as
767 @file{/usr/local/bin/gcc-3.1}.
768
769 @item --program-transform-name=@var{pattern}
770 Applies the @samp{sed} script @var{pattern} to be applied to the names
771 of programs to install in @var{bindir} (see above). @var{pattern} has to
772 consist of one or more basic @samp{sed} editing commands, separated by
773 semicolons. For example, if you want the @samp{gcc} program name to be
774 transformed to the installed program @file{/usr/local/bin/myowngcc} and
775 the @samp{g++} program name to be transformed to
776 @file{/usr/local/bin/gspecial++} without changing other program names,
777 you could use the pattern
778 @option{--program-transform-name='s/^gcc$/myowngcc/; s/^g++$/gspecial++/'}
779 to achieve this effect.
780
781 All three options can be combined and used together, resulting in more
782 complex conversion patterns. As a basic rule, @var{prefix} (and
783 @var{suffix}) are prepended (appended) before further transformations
784 can happen with a special transformation script @var{pattern}.
785
786 As currently implemented, this option only takes effect for native
787 builds; cross compiler binaries' names are not transformed even when a
788 transformation is explicitly asked for by one of these options.
789
790 For native builds, some of the installed programs are also installed
791 with the target alias in front of their name, as in
792 @samp{i686-pc-linux-gnu-gcc}. All of the above transformations happen
793 before the target alias is prepended to the name---so, specifying
794 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
795 resulting binary would be installed as
796 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
797
798 As a last shortcoming, none of the installed Ada programs are
799 transformed yet, which will be fixed in some time.
800
801 @item --with-local-prefix=@var{dirname}
802 Specify the
803 installation directory for local include files. The default is
804 @file{/usr/local}. Specify this option if you want the compiler to
805 search directory @file{@var{dirname}/include} for locally installed
806 header files @emph{instead} of @file{/usr/local/include}.
807
808 You should specify @option{--with-local-prefix} @strong{only} if your
809 site has a different convention (not @file{/usr/local}) for where to put
810 site-specific files.
811
812 The default value for @option{--with-local-prefix} is @file{/usr/local}
813 regardless of the value of @option{--prefix}. Specifying
814 @option{--prefix} has no effect on which directory GCC searches for
815 local header files. This may seem counterintuitive, but actually it is
816 logical.
817
818 The purpose of @option{--prefix} is to specify where to @emph{install
819 GCC}. The local header files in @file{/usr/local/include}---if you put
820 any in that directory---are not part of GCC@. They are part of other
821 programs---perhaps many others. (GCC installs its own header files in
822 another directory which is based on the @option{--prefix} value.)
823
824 Both the local-prefix include directory and the GCC-prefix include
825 directory are part of GCC's ``system include'' directories. Although these
826 two directories are not fixed, they need to be searched in the proper
827 order for the correct processing of the include_next directive. The
828 local-prefix include directory is searched before the GCC-prefix
829 include directory. Another characteristic of system include directories
830 is that pedantic warnings are turned off for headers in these directories.
831
832 Some autoconf macros add @option{-I @var{directory}} options to the
833 compiler command line, to ensure that directories containing installed
834 packages' headers are searched. When @var{directory} is one of GCC's
835 system include directories, GCC will ignore the option so that system
836 directories continue to be processed in the correct order. This
837 may result in a search order different from what was specified but the
838 directory will still be searched.
839
840 GCC automatically searches for ordinary libraries using
841 @env{GCC_EXEC_PREFIX}. Thus, when the same installation prefix is
842 used for both GCC and packages, GCC will automatically search for
843 both headers and libraries. This provides a configuration that is
844 easy to use. GCC behaves in a manner similar to that when it is
845 installed as a system compiler in @file{/usr}.
846
847 Sites that need to install multiple versions of GCC may not want to
848 use the above simple configuration. It is possible to use the
849 @option{--program-prefix}, @option{--program-suffix} and
850 @option{--program-transform-name} options to install multiple versions
851 into a single directory, but it may be simpler to use different prefixes
852 and the @option{--with-local-prefix} option to specify the location of the
853 site-specific files for each version. It will then be necessary for
854 users to specify explicitly the location of local site libraries
855 (e.g., with @env{LIBRARY_PATH}).
856
857 The same value can be used for both @option{--with-local-prefix} and
858 @option{--prefix} provided it is not @file{/usr}. This can be used
859 to avoid the default search of @file{/usr/local/include}.
860
861 @strong{Do not} specify @file{/usr} as the @option{--with-local-prefix}!
862 The directory you use for @option{--with-local-prefix} @strong{must not}
863 contain any of the system's standard header files. If it did contain
864 them, certain programs would be miscompiled (including GNU Emacs, on
865 certain targets), because this would override and nullify the header
866 file corrections made by the @command{fixincludes} script.
867
868 Indications are that people who use this option use it based on mistaken
869 ideas of what it is for. People use it as if it specified where to
870 install part of GCC@. Perhaps they make this assumption because
871 installing GCC creates the directory.
872
873 @item --enable-shared[=@var{package}[,@dots{}]]
874 Build shared versions of libraries, if shared libraries are supported on
875 the target platform. Unlike GCC 2.95.x and earlier, shared libraries
876 are enabled by default on all platforms that support shared libraries.
877
878 If a list of packages is given as an argument, build shared libraries
879 only for the listed packages. For other packages, only static libraries
880 will be built. Package names currently recognized in the GCC tree are
881 @samp{libgcc} (also known as @samp{gcc}), @samp{libstdc++} (not
882 @samp{libstdc++-v3}), @samp{libffi}, @samp{zlib}, @samp{boehm-gc},
883 @samp{ada}, @samp{libada}, @samp{libjava} and @samp{libobjc}.
884 Note @samp{libiberty} does not support shared libraries at all.
885
886 Use @option{--disable-shared} to build only static libraries. Note that
887 @option{--disable-shared} does not accept a list of package names as
888 argument, only @option{--enable-shared} does.
889
890 @item @anchor{with-gnu-as}--with-gnu-as
891 Specify that the compiler should assume that the
892 assembler it finds is the GNU assembler. However, this does not modify
893 the rules to find an assembler and will result in confusion if the
894 assembler found is not actually the GNU assembler. (Confusion may also
895 result if the compiler finds the GNU assembler but has not been
896 configured with @option{--with-gnu-as}.) If you have more than one
897 assembler installed on your system, you may want to use this option in
898 connection with @option{--with-as=@var{pathname}} or
899 @option{--with-build-time-tools=@var{pathname}}.
900
901 The following systems are the only ones where it makes a difference
902 whether you use the GNU assembler. On any other system,
903 @option{--with-gnu-as} has no effect.
904
905 @itemize @bullet
906 @item @samp{hppa1.0-@var{any}-@var{any}}
907 @item @samp{hppa1.1-@var{any}-@var{any}}
908 @item @samp{sparc-sun-solaris2.@var{any}}
909 @item @samp{sparc64-@var{any}-solaris2.@var{any}}
910 @end itemize
911
912 @item @anchor{with-as}--with-as=@var{pathname}
913 Specify that the compiler should use the assembler pointed to by
914 @var{pathname}, rather than the one found by the standard rules to find
915 an assembler, which are:
916 @itemize @bullet
917 @item
918 Unless GCC is being built with a cross compiler, check the
919 @file{@var{libexec}/gcc/@var{target}/@var{version}} directory.
920 @var{libexec} defaults to @file{@var{exec-prefix}/libexec};
921 @var{exec-prefix} defaults to @var{prefix}, which
922 defaults to @file{/usr/local} unless overridden by the
923 @option{--prefix=@var{pathname}} switch described above. @var{target}
924 is the target system triple, such as @samp{sparc-sun-solaris2.7}, and
925 @var{version} denotes the GCC version, such as 3.0.
926
927 @item
928 If the target system is the same that you are building on, check
929 operating system specific directories (e.g.@: @file{/usr/ccs/bin} on
930 Sun Solaris 2).
931
932 @item
933 Check in the @env{PATH} for a tool whose name is prefixed by the
934 target system triple.
935
936 @item
937 Check in the @env{PATH} for a tool whose name is not prefixed by the
938 target system triple, if the host and target system triple are
939 the same (in other words, we use a host tool if it can be used for
940 the target as well).
941 @end itemize
942
943 You may want to use @option{--with-as} if no assembler
944 is installed in the directories listed above, or if you have multiple
945 assemblers installed and want to choose one that is not found by the
946 above rules.
947
948 @item @anchor{with-gnu-ld}--with-gnu-ld
949 Same as @uref{#with-gnu-as,,@option{--with-gnu-as}}
950 but for the linker.
951
952 @item --with-ld=@var{pathname}
953 Same as @uref{#with-as,,@option{--with-as}}
954 but for the linker.
955
956 @item --with-stabs
957 Specify that stabs debugging
958 information should be used instead of whatever format the host normally
959 uses. Normally GCC uses the same debug format as the host system.
960
961 On MIPS based systems and on Alphas, you must specify whether you want
962 GCC to create the normal ECOFF debugging format, or to use BSD-style
963 stabs passed through the ECOFF symbol table. The normal ECOFF debug
964 format cannot fully handle languages other than C@. BSD stabs format can
965 handle other languages, but it only works with the GNU debugger GDB@.
966
967 Normally, GCC uses the ECOFF debugging format by default; if you
968 prefer BSD stabs, specify @option{--with-stabs} when you configure GCC@.
969
970 No matter which default you choose when you configure GCC, the user
971 can use the @option{-gcoff} and @option{-gstabs+} options to specify explicitly
972 the debug format for a particular compilation.
973
974 @option{--with-stabs} is meaningful on the ISC system on the 386, also, if
975 @option{--with-gas} is used. It selects use of stabs debugging
976 information embedded in COFF output. This kind of debugging information
977 supports C++ well; ordinary COFF debugging information does not.
978
979 @option{--with-stabs} is also meaningful on 386 systems running SVR4. It
980 selects use of stabs debugging information embedded in ELF output. The
981 C++ compiler currently (2.6.0) does not support the DWARF debugging
982 information normally used on 386 SVR4 platforms; stabs provide a
983 workable alternative. This requires gas and gdb, as the normal SVR4
984 tools can not generate or interpret stabs.
985
986 @item --disable-multilib
987 Specify that multiple target
988 libraries to support different target variants, calling
989 conventions, etc.@: should not be built. The default is to build a
990 predefined set of them.
991
992 Some targets provide finer-grained control over which multilibs are built
993 (e.g., @option{--disable-softfloat}):
994 @table @code
995 @item arc-*-elf*
996 biendian.
997
998 @item arm-*-*
999 fpu, 26bit, underscore, interwork, biendian, nofmult.
1000
1001 @item m68*-*-*
1002 softfloat, m68881, m68000, m68020.
1003
1004 @item mips*-*-*
1005 single-float, biendian, softfloat.
1006
1007 @item powerpc*-*-*, rs6000*-*-*
1008 aix64, pthread, softfloat, powercpu, powerpccpu, powerpcos, biendian,
1009 sysv, aix.
1010
1011 @end table
1012
1013 @item --with-multilib-list=@var{list}
1014 @itemx --without-multilib-list
1015 Specify what multilibs to build.
1016 Currently only implemented for sh*-*-*.
1017
1018 @var{list} is a comma separated list of CPU names. These must be of the
1019 form @code{sh*} or @code{m*} (in which case they match the compiler option
1020 for that processor). The list should not contain any endian options -
1021 these are handled by @option{--with-endian}.
1022
1023 If @var{list} is empty, then there will be no multilibs for extra
1024 processors. The multilib for the secondary endian remains enabled.
1025
1026 As a special case, if an entry in the list starts with a @code{!}
1027 (exclamation point), then it is added to the list of excluded multilibs.
1028 Entries of this sort should be compatible with @samp{MULTILIB_EXCLUDES}
1029 (once the leading @code{!} has been stripped).
1030
1031 If @option{--with-multilib-list} is not given, then a default set of
1032 multilibs is selected based on the value of @option{--target}. This is
1033 usually the complete set of libraries, but some targets imply a more
1034 specialized subset.
1035
1036 Example 1: to configure a compiler for SH4A only, but supporting both
1037 endians, with little endian being the default:
1038 @smallexample
1039 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=
1040 @end smallexample
1041
1042 Example 2: to configure a compiler for both SH4A and SH4AL-DSP, but with
1043 only little endian SH4AL:
1044 @smallexample
1045 --with-cpu=sh4a --with-endian=little,big --with-multilib-list=sh4al,!mb/m4al
1046 @end smallexample
1047
1048 @item --with-endian=@var{endians}
1049 Specify what endians to use.
1050 Currently only implemented for sh*-*-*.
1051
1052 @var{endians} may be one of the following:
1053 @table @code
1054 @item big
1055 Use big endian exclusively.
1056 @item little
1057 Use little endian exclusively.
1058 @item big,little
1059 Use big endian by default. Provide a multilib for little endian.
1060 @item little,big
1061 Use little endian by default. Provide a multilib for big endian.
1062 @end table
1063
1064 @item --enable-threads
1065 Specify that the target
1066 supports threads. This affects the Objective-C compiler and runtime
1067 library, and exception handling for other languages like C++ and Java.
1068 On some systems, this is the default.
1069
1070 In general, the best (and, in many cases, the only known) threading
1071 model available will be configured for use. Beware that on some
1072 systems, GCC has not been taught what threading models are generally
1073 available for the system. In this case, @option{--enable-threads} is an
1074 alias for @option{--enable-threads=single}.
1075
1076 @item --disable-threads
1077 Specify that threading support should be disabled for the system.
1078 This is an alias for @option{--enable-threads=single}.
1079
1080 @item --enable-threads=@var{lib}
1081 Specify that
1082 @var{lib} is the thread support library. This affects the Objective-C
1083 compiler and runtime library, and exception handling for other languages
1084 like C++ and Java. The possibilities for @var{lib} are:
1085
1086 @table @code
1087 @item aix
1088 AIX thread support.
1089 @item dce
1090 DCE thread support.
1091 @item gnat
1092 Ada tasking support. For non-Ada programs, this setting is equivalent
1093 to @samp{single}. When used in conjunction with the Ada run time, it
1094 causes GCC to use the same thread primitives as Ada uses. This option
1095 is necessary when using both Ada and the back end exception handling,
1096 which is the default for most Ada targets.
1097 @item mach
1098 Generic MACH thread support, known to work on NeXTSTEP@. (Please note
1099 that the file needed to support this configuration, @file{gthr-mach.h}, is
1100 missing and thus this setting will cause a known bootstrap failure.)
1101 @item no
1102 This is an alias for @samp{single}.
1103 @item posix
1104 Generic POSIX/Unix98 thread support.
1105 @item posix95
1106 Generic POSIX/Unix95 thread support.
1107 @item rtems
1108 RTEMS thread support.
1109 @item single
1110 Disable thread support, should work for all platforms.
1111 @item solaris
1112 Sun Solaris 2 thread support.
1113 @item vxworks
1114 VxWorks thread support.
1115 @item win32
1116 Microsoft Win32 API thread support.
1117 @item nks
1118 Novell Kernel Services thread support.
1119 @end table
1120
1121 @item --enable-tls
1122 Specify that the target supports TLS (Thread Local Storage). Usually
1123 configure can correctly determine if TLS is supported. In cases where
1124 it guesses incorrectly, TLS can be explicitly enabled or disabled with
1125 @option{--enable-tls} or @option{--disable-tls}. This can happen if
1126 the assembler supports TLS but the C library does not, or if the
1127 assumptions made by the configure test are incorrect.
1128
1129 @item --disable-tls
1130 Specify that the target does not support TLS.
1131 This is an alias for @option{--enable-tls=no}.
1132
1133 @item --with-cpu=@var{cpu}
1134 @itemx --with-cpu-32=@var{cpu}
1135 @itemx --with-cpu-64=@var{cpu}
1136 Specify which cpu variant the compiler should generate code for by default.
1137 @var{cpu} will be used as the default value of the @option{-mcpu=} switch.
1138 This option is only supported on some targets, including ARM, i386, M68k,
1139 PowerPC, and SPARC@. The @option{--with-cpu-32} and
1140 @option{--with-cpu-64} options specify separate default CPUs for
1141 32-bit and 64-bit modes; these options are only supported for i386,
1142 x86-64 and PowerPC.
1143
1144 @item --with-schedule=@var{cpu}
1145 @itemx --with-arch=@var{cpu}
1146 @itemx --with-arch-32=@var{cpu}
1147 @itemx --with-arch-64=@var{cpu}
1148 @itemx --with-tune=@var{cpu}
1149 @itemx --with-tune-32=@var{cpu}
1150 @itemx --with-tune-64=@var{cpu}
1151 @itemx --with-abi=@var{abi}
1152 @itemx --with-fpu=@var{type}
1153 @itemx --with-float=@var{type}
1154 These configure options provide default values for the @option{-mschedule=},
1155 @option{-march=}, @option{-mtune=}, @option{-mabi=}, and @option{-mfpu=}
1156 options and for @option{-mhard-float} or @option{-msoft-float}. As with
1157 @option{--with-cpu}, which switches will be accepted and acceptable values
1158 of the arguments depend on the target.
1159
1160 @item --with-mode=@var{mode}
1161 Specify if the compiler should default to @option{-marm} or @option{-mthumb}.
1162 This option is only supported on ARM targets.
1163
1164 @item --with-divide=@var{type}
1165 Specify how the compiler should generate code for checking for
1166 division by zero. This option is only supported on the MIPS target.
1167 The possibilities for @var{type} are:
1168 @table @code
1169 @item traps
1170 Division by zero checks use conditional traps (this is the default on
1171 systems that support conditional traps).
1172 @item breaks
1173 Division by zero checks use the break instruction.
1174 @end table
1175
1176 @c If you make --with-llsc the default for additional targets,
1177 @c update the --with-llsc description in the MIPS section below.
1178
1179 @item --with-llsc
1180 On MIPS targets, make @option{-mllsc} the default when no
1181 @option{-mno-lsc} option is passed. This is the default for
1182 Linux-based targets, as the kernel will emulate them if the ISA does
1183 not provide them.
1184
1185 @item --without-llsc
1186 On MIPS targets, make @option{-mno-llsc} the default when no
1187 @option{-mllsc} option is passed.
1188
1189 @item --with-synci
1190 On MIPS targets, make @option{-msynci} the default when no
1191 @option{-mno-synci} option is passed.
1192
1193 @item --without-synci
1194 On MIPS targets, make @option{-mno-synci} the default when no
1195 @option{-msynci} option is passed. This is the default.
1196
1197 @item --with-mips-plt
1198 On MIPS targets, make use of copy relocations and PLTs.
1199 These features are extensions to the traditional
1200 SVR4-based MIPS ABIs and require support from GNU binutils
1201 and the runtime C library.
1202
1203 @item --enable-__cxa_atexit
1204 Define if you want to use __cxa_atexit, rather than atexit, to
1205 register C++ destructors for local statics and global objects.
1206 This is essential for fully standards-compliant handling of
1207 destructors, but requires __cxa_atexit in libc. This option is currently
1208 only available on systems with GNU libc. When enabled, this will cause
1209 @option{-fuse-cxa-atexit} to be passed by default.
1210
1211 @item --enable-target-optspace
1212 Specify that target
1213 libraries should be optimized for code space instead of code speed.
1214 This is the default for the m32r platform.
1215
1216 @item --disable-cpp
1217 Specify that a user visible @command{cpp} program should not be installed.
1218
1219 @item --with-cpp-install-dir=@var{dirname}
1220 Specify that the user visible @command{cpp} program should be installed
1221 in @file{@var{prefix}/@var{dirname}/cpp}, in addition to @var{bindir}.
1222
1223 @item --enable-initfini-array
1224 Force the use of sections @code{.init_array} and @code{.fini_array}
1225 (instead of @code{.init} and @code{.fini}) for constructors and
1226 destructors. Option @option{--disable-initfini-array} has the
1227 opposite effect. If neither option is specified, the configure script
1228 will try to guess whether the @code{.init_array} and
1229 @code{.fini_array} sections are supported and, if they are, use them.
1230
1231 @item --enable-build-with-cxx
1232 Build GCC using a C++ compiler rather than a C compiler. This is an
1233 experimental option which may become the default in a later release.
1234
1235 @item --enable-maintainer-mode
1236 The build rules that
1237 regenerate the GCC master message catalog @file{gcc.pot} are normally
1238 disabled. This is because it can only be rebuilt if the complete source
1239 tree is present. If you have changed the sources and want to rebuild the
1240 catalog, configuring with @option{--enable-maintainer-mode} will enable
1241 this. Note that you need a recent version of the @code{gettext} tools
1242 to do so.
1243
1244 @item --disable-bootstrap
1245 For a native build, the default configuration is to perform
1246 a 3-stage bootstrap of the compiler when @samp{make} is invoked,
1247 testing that GCC can compile itself correctly. If you want to disable
1248 this process, you can configure with @option{--disable-bootstrap}.
1249
1250 @item --enable-bootstrap
1251 In special cases, you may want to perform a 3-stage build
1252 even if the target and host triplets are different.
1253 This could happen when the host can run code compiled for
1254 the target (e.g.@: host is i686-linux, target is i486-linux).
1255 Starting from GCC 4.2, to do this you have to configure explicitly
1256 with @option{--enable-bootstrap}.
1257
1258 @item --enable-generated-files-in-srcdir
1259 Neither the .c and .h files that are generated from Bison and flex nor the
1260 info manuals and man pages that are built from the .texi files are present
1261 in the SVN development tree. When building GCC from that development tree,
1262 or from one of our snapshots, those generated files are placed in your
1263 build directory, which allows for the source to be in a readonly
1264 directory.
1265
1266 If you configure with @option{--enable-generated-files-in-srcdir} then those
1267 generated files will go into the source directory. This is mainly intended
1268 for generating release or prerelease tarballs of the GCC sources, since it
1269 is not a requirement that the users of source releases to have flex, Bison,
1270 or makeinfo.
1271
1272 @item --enable-version-specific-runtime-libs
1273 Specify
1274 that runtime libraries should be installed in the compiler specific
1275 subdirectory (@file{@var{libdir}/gcc}) rather than the usual places. In
1276 addition, @samp{libstdc++}'s include files will be installed into
1277 @file{@var{libdir}} unless you overruled it by using
1278 @option{--with-gxx-include-dir=@var{dirname}}. Using this option is
1279 particularly useful if you intend to use several versions of GCC in
1280 parallel. This is currently supported by @samp{libgfortran},
1281 @samp{libjava}, @samp{libmudflap}, @samp{libstdc++}, and @samp{libobjc}.
1282
1283 @item --enable-languages=@var{lang1},@var{lang2},@dots{}
1284 Specify that only a particular subset of compilers and
1285 their runtime libraries should be built. For a list of valid values for
1286 @var{langN} you can issue the following command in the
1287 @file{gcc} directory of your GCC source tree:@*
1288 @smallexample
1289 grep language= */config-lang.in
1290 @end smallexample
1291 Currently, you can use any of the following:
1292 @code{all}, @code{ada}, @code{c}, @code{c++}, @code{fortran}, @code{java},
1293 @code{objc}, @code{obj-c++}.
1294 Building the Ada compiler has special requirements, see below.
1295 If you do not pass this flag, or specify the option @code{all}, then all
1296 default languages available in the @file{gcc} sub-tree will be configured.
1297 Ada and Objective-C++ are not default languages; the rest are.
1298 Re-defining @code{LANGUAGES} when calling @samp{make} @strong{does not}
1299 work anymore, as those language sub-directories might not have been
1300 configured!
1301
1302 @item --enable-stage1-languages=@var{lang1},@var{lang2},@dots{}
1303 Specify that a particular subset of compilers and their runtime
1304 libraries should be built with the system C compiler during stage 1 of
1305 the bootstrap process, rather than only in later stages with the
1306 bootstrapped C compiler. The list of valid values is the same as for
1307 @option{--enable-languages}, and the option @code{all} will select all
1308 of the languages enabled by @option{--enable-languages}. This option is
1309 primarily useful for GCC development; for instance, when a development
1310 version of the compiler cannot bootstrap due to compiler bugs, or when
1311 one is debugging front ends other than the C front end. When this
1312 option is used, one can then build the target libraries for the
1313 specified languages with the stage-1 compiler by using @command{make
1314 stage1-bubble all-target}, or run the testsuite on the stage-1 compiler
1315 for the specified languages using @command{make stage1-start check-gcc}.
1316
1317 @item --disable-libada
1318 Specify that the run-time libraries and tools used by GNAT should not
1319 be built. This can be useful for debugging, or for compatibility with
1320 previous Ada build procedures, when it was required to explicitly
1321 do a @samp{make -C gcc gnatlib_and_tools}.
1322
1323 @item --disable-libssp
1324 Specify that the run-time libraries for stack smashing protection
1325 should not be built.
1326
1327 @item --disable-libgomp
1328 Specify that the run-time libraries used by GOMP should not be built.
1329
1330 @item --with-dwarf2
1331 Specify that the compiler should
1332 use DWARF 2 debugging information as the default.
1333
1334 @item --enable-targets=all
1335 @itemx --enable-targets=@var{target_list}
1336 Some GCC targets, e.g.@: powerpc64-linux, build bi-arch compilers.
1337 These are compilers that are able to generate either 64-bit or 32-bit
1338 code. Typically, the corresponding 32-bit target, e.g.@:
1339 powerpc-linux for powerpc64-linux, only generates 32-bit code. This
1340 option enables the 32-bit target to be a bi-arch compiler, which is
1341 useful when you want a bi-arch compiler that defaults to 32-bit, and
1342 you are building a bi-arch or multi-arch binutils in a combined tree.
1343 Currently, this option only affects sparc-linux, powerpc-linux and
1344 x86-linux.
1345
1346 @item --enable-secureplt
1347 This option enables @option{-msecure-plt} by default for powerpc-linux.
1348 @ifnothtml
1349 @xref{RS/6000 and PowerPC Options,, RS/6000 and PowerPC Options, gcc,
1350 Using the GNU Compiler Collection (GCC)},
1351 @end ifnothtml
1352 @ifhtml
1353 See ``RS/6000 and PowerPC Options'' in the main manual
1354 @end ifhtml
1355
1356 @item --enable-cld
1357 This option enables @option{-mcld} by default for 32-bit x86 targets.
1358 @ifnothtml
1359 @xref{i386 and x86-64 Options,, i386 and x86-64 Options, gcc,
1360 Using the GNU Compiler Collection (GCC)},
1361 @end ifnothtml
1362 @ifhtml
1363 See ``i386 and x86-64 Options'' in the main manual
1364 @end ifhtml
1365
1366 @item --enable-win32-registry
1367 @itemx --enable-win32-registry=@var{key}
1368 @itemx --disable-win32-registry
1369 The @option{--enable-win32-registry} option enables Microsoft Windows-hosted GCC
1370 to look up installations paths in the registry using the following key:
1371
1372 @smallexample
1373 @code{HKEY_LOCAL_MACHINE\SOFTWARE\Free Software Foundation\@var{key}}
1374 @end smallexample
1375
1376 @var{key} defaults to GCC version number, and can be overridden by the
1377 @option{--enable-win32-registry=@var{key}} option. Vendors and distributors
1378 who use custom installers are encouraged to provide a different key,
1379 perhaps one comprised of vendor name and GCC version number, to
1380 avoid conflict with existing installations. This feature is enabled
1381 by default, and can be disabled by @option{--disable-win32-registry}
1382 option. This option has no effect on the other hosts.
1383
1384 @item --nfp
1385 Specify that the machine does not have a floating point unit. This
1386 option only applies to @samp{m68k-sun-sunos@var{n}}. On any other
1387 system, @option{--nfp} has no effect.
1388
1389 @item --enable-werror
1390 @itemx --disable-werror
1391 @itemx --enable-werror=yes
1392 @itemx --enable-werror=no
1393 When you specify this option, it controls whether certain files in the
1394 compiler are built with @option{-Werror} in bootstrap stage2 and later.
1395 If you don't specify it, @option{-Werror} is turned on for the main
1396 development trunk. However it defaults to off for release branches and
1397 final releases. The specific files which get @option{-Werror} are
1398 controlled by the Makefiles.
1399
1400 @item --enable-checking
1401 @itemx --enable-checking=@var{list}
1402 When you specify this option, the compiler is built to perform internal
1403 consistency checks of the requested complexity. This does not change the
1404 generated code, but adds error checking within the compiler. This will
1405 slow down the compiler and may only work properly if you are building
1406 the compiler with GCC@. This is @samp{yes} by default when building
1407 from SVN or snapshots, but @samp{release} for releases. The default
1408 for building the stage1 compiler is @samp{yes}. More control
1409 over the checks may be had by specifying @var{list}. The categories of
1410 checks available are @samp{yes} (most common checks
1411 @samp{assert,misc,tree,gc,rtlflag,runtime}), @samp{no} (no checks at
1412 all), @samp{all} (all but @samp{valgrind}), @samp{release} (cheapest
1413 checks @samp{assert,runtime}) or @samp{none} (same as @samp{no}).
1414 Individual checks can be enabled with these flags @samp{assert},
1415 @samp{df}, @samp{fold}, @samp{gc}, @samp{gcac} @samp{misc}, @samp{rtl},
1416 @samp{rtlflag}, @samp{runtime}, @samp{tree}, and @samp{valgrind}.
1417
1418 The @samp{valgrind} check requires the external @command{valgrind}
1419 simulator, available from @uref{http://valgrind.org/}. The
1420 @samp{df}, @samp{rtl}, @samp{gcac} and @samp{valgrind} checks are very expensive.
1421 To disable all checking, @samp{--disable-checking} or
1422 @samp{--enable-checking=none} must be explicitly requested. Disabling
1423 assertions will make the compiler and runtime slightly faster but
1424 increase the risk of undetected internal errors causing wrong code to be
1425 generated.
1426
1427 @item --disable-stage1-checking
1428 @item --enable-stage1-checking
1429 @itemx --enable-stage1-checking=@var{list}
1430 If no @option{--enable-checking} option is specified the stage1
1431 compiler will be built with @samp{yes} checking enabled, otherwise
1432 the stage1 checking flags are the same as specified by
1433 @option{--enable-checking}. To build the stage1 compiler with
1434 different checking options use @option{--enable-stage1-checking}.
1435 The list of checking options is the same as for @option{--enable-checking}.
1436 If your system is too slow or too small to bootstrap a released compiler
1437 with checking for stage1 enabled, you can use @samp{--disable-stage1-checking}
1438 to disable checking for the stage1 compiler.
1439
1440 @item --enable-coverage
1441 @itemx --enable-coverage=@var{level}
1442 With this option, the compiler is built to collect self coverage
1443 information, every time it is run. This is for internal development
1444 purposes, and only works when the compiler is being built with gcc. The
1445 @var{level} argument controls whether the compiler is built optimized or
1446 not, values are @samp{opt} and @samp{noopt}. For coverage analysis you
1447 want to disable optimization, for performance analysis you want to
1448 enable optimization. When coverage is enabled, the default level is
1449 without optimization.
1450
1451 @item --enable-gather-detailed-mem-stats
1452 When this option is specified more detailed information on memory
1453 allocation is gathered. This information is printed when using
1454 @option{-fmem-report}.
1455
1456 @item --with-gc
1457 @itemx --with-gc=@var{choice}
1458 With this option you can specify the garbage collector implementation
1459 used during the compilation process. @var{choice} can be one of
1460 @samp{page} and @samp{zone}, where @samp{page} is the default.
1461
1462 @item --enable-nls
1463 @itemx --disable-nls
1464 The @option{--enable-nls} option enables Native Language Support (NLS),
1465 which lets GCC output diagnostics in languages other than American
1466 English. Native Language Support is enabled by default if not doing a
1467 canadian cross build. The @option{--disable-nls} option disables NLS@.
1468
1469 @item --with-included-gettext
1470 If NLS is enabled, the @option{--with-included-gettext} option causes the build
1471 procedure to prefer its copy of GNU @command{gettext}.
1472
1473 @item --with-catgets
1474 If NLS is enabled, and if the host lacks @code{gettext} but has the
1475 inferior @code{catgets} interface, the GCC build procedure normally
1476 ignores @code{catgets} and instead uses GCC's copy of the GNU
1477 @code{gettext} library. The @option{--with-catgets} option causes the
1478 build procedure to use the host's @code{catgets} in this situation.
1479
1480 @item --with-libiconv-prefix=@var{dir}
1481 Search for libiconv header files in @file{@var{dir}/include} and
1482 libiconv library files in @file{@var{dir}/lib}.
1483
1484 @item --enable-obsolete
1485 Enable configuration for an obsoleted system. If you attempt to
1486 configure GCC for a system (build, host, or target) which has been
1487 obsoleted, and you do not specify this flag, configure will halt with an
1488 error message.
1489
1490 All support for systems which have been obsoleted in one release of GCC
1491 is removed entirely in the next major release, unless someone steps
1492 forward to maintain the port.
1493
1494 @item --enable-decimal-float
1495 @itemx --enable-decimal-float=yes
1496 @itemx --enable-decimal-float=no
1497 @itemx --enable-decimal-float=bid
1498 @itemx --enable-decimal-float=dpd
1499 @itemx --disable-decimal-float
1500 Enable (or disable) support for the C decimal floating point extension
1501 that is in the IEEE 754-2008 standard. This is enabled by default only
1502 on PowerPC, i386, and x86_64 GNU/Linux systems. Other systems may also
1503 support it, but require the user to specifically enable it. You can
1504 optionally control which decimal floating point format is used (either
1505 @samp{bid} or @samp{dpd}). The @samp{bid} (binary integer decimal)
1506 format is default on i386 and x86_64 systems, and the @samp{dpd}
1507 (densely packed decimal) format is default on PowerPC systems.
1508
1509 @item --enable-fixed-point
1510 @itemx --disable-fixed-point
1511 Enable (or disable) support for C fixed-point arithmetic.
1512 This option is enabled by default for some targets (such as MIPS) which
1513 have hardware-support for fixed-point operations. On other targets, you
1514 may enable this option manually.
1515
1516 @item --with-long-double-128
1517 Specify if @code{long double} type should be 128-bit by default on selected
1518 GNU/Linux architectures. If using @code{--without-long-double-128},
1519 @code{long double} will be by default 64-bit, the same as @code{double} type.
1520 When neither of these configure options are used, the default will be
1521 128-bit @code{long double} when built against GNU C Library 2.4 and later,
1522 64-bit @code{long double} otherwise.
1523
1524 @item --with-gmp=@var{pathname}
1525 @itemx --with-gmp-include=@var{pathname}
1526 @itemx --with-gmp-lib=@var{pathname}
1527 @itemx --with-mpfr=@var{pathname}
1528 @itemx --with-mpfr-include=@var{pathname}
1529 @itemx --with-mpfr-lib=@var{pathname}
1530 @itemx --with-mpc=@var{pathname}
1531 @itemx --with-mpc-include=@var{pathname}
1532 @itemx --with-mpc-lib=@var{pathname}
1533 If you do not have GMP (the GNU Multiple Precision library), the MPFR
1534 library and/or the MPC library installed in a standard location and
1535 you want to build GCC, you can explicitly specify the directory where
1536 they are installed (@samp{--with-gmp=@var{gmpinstalldir}},
1537 @samp{--with-mpfr=@var{mpfrinstalldir}},
1538 @samp{--with-mpc=@var{mpcinstalldir}}). The
1539 @option{--with-gmp=@var{gmpinstalldir}} option is shorthand for
1540 @option{--with-gmp-lib=@var{gmpinstalldir}/lib} and
1541 @option{--with-gmp-include=@var{gmpinstalldir}/include}. Likewise the
1542 @option{--with-mpfr=@var{mpfrinstalldir}} option is shorthand for
1543 @option{--with-mpfr-lib=@var{mpfrinstalldir}/lib} and
1544 @option{--with-mpfr-include=@var{mpfrinstalldir}/include}, also the
1545 @option{--with-mpc=@var{mpcinstalldir}} option is shorthand for
1546 @option{--with-mpc-lib=@var{mpcinstalldir}/lib} and
1547 @option{--with-mpc-include=@var{mpcinstalldir}/include}. If these
1548 shorthand assumptions are not correct, you can use the explicit
1549 include and lib options directly.
1550
1551 @item --with-ppl=@var{pathname}
1552 @itemx --with-ppl-include=@var{pathname}
1553 @itemx --with-ppl-lib=@var{pathname}
1554 @itemx --with-cloog=@var{pathname}
1555 @itemx --with-cloog-include=@var{pathname}
1556 @itemx --with-cloog-lib=@var{pathname}
1557 If you do not have PPL (the Parma Polyhedra Library) and the CLooG
1558 libraries installed in a standard location and you want to build GCC,
1559 you can explicitly specify the directory where they are installed
1560 (@samp{--with-ppl=@var{pplinstalldir}},
1561 @samp{--with-cloog=@var{clooginstalldir}}). The
1562 @option{--with-ppl=@var{pplinstalldir}} option is shorthand for
1563 @option{--with-ppl-lib=@var{pplinstalldir}/lib} and
1564 @option{--with-ppl-include=@var{pplinstalldir}/include}. Likewise the
1565 @option{--with-cloog=@var{clooginstalldir}} option is shorthand for
1566 @option{--with-cloog-lib=@var{clooginstalldir}/lib} and
1567 @option{--with-cloog-include=@var{clooginstalldir}/include}. If these
1568 shorthand assumptions are not correct, you can use the explicit
1569 include and lib options directly.
1570
1571 @item --with-host-libstdcxx=@var{linker-args}
1572 If you are linking with a static copy of PPL, you can use this option
1573 to specify how the linker should find the standard C++ library used
1574 internally by PPL. Typical values of @var{linker-args} might be
1575 @samp{-lstdc++} or @samp{-Wl,-Bstatic,-lstdc++,-Bdynamic -lm}. If you are
1576 linking with a shared copy of PPL, you probably do not need this
1577 option; shared library dependencies will cause the linker to search
1578 for the standard C++ library automatically.
1579
1580 @item --with-stage1-ldflags=@var{flags}
1581 This option may be used to set linker flags to be used when linking
1582 stage 1 of GCC. These are also used when linking GCC if configured with
1583 @option{--disable-bootstrap}. By default no special flags are used.
1584
1585 @item --with-stage1-libs=@var{libs}
1586 This option may be used to set libraries to be used when linking stage 1
1587 of GCC. These are also used when linking GCC if configured with
1588 @option{--disable-bootstrap}. The default is the argument to
1589 @option{--with-host-libstdcxx}, if specified.
1590
1591 @item --with-boot-ldflags=@var{flags}
1592 This option may be used to set linker flags to be used when linking
1593 stage 2 and later when bootstrapping GCC. By default no special flags
1594 are used.
1595
1596 @item --with-boot-libs=@var{libs}
1597 This option may be used to set libraries to be used when linking stage 2
1598 and later when bootstrapping GCC. The default is the argument to
1599 @option{--with-host-libstdcxx}, if specified.
1600
1601 @item --with-debug-prefix-map=@var{map}
1602 Convert source directory names using @option{-fdebug-prefix-map} when
1603 building runtime libraries. @samp{@var{map}} is a space-separated
1604 list of maps of the form @samp{@var{old}=@var{new}}.
1605
1606 @item --enable-linker-build-id
1607 Tells GCC to pass @option{--build-id} option to the linker for all final
1608 links (links performed without the @option{-r} or @option{--relocatable}
1609 option), if the linker supports it. If you specify
1610 @option{--enable-linker-build-id}, but your linker does not
1611 support @option{--build-id} option, a warning is issued and the
1612 @option{--enable-linker-build-id} option is ignored. The default is off.
1613
1614 @item --enable-gnu-unique-object
1615 @itemx --disable-gnu-unique-object
1616 Tells GCC to use the gnu_unique_object relocation for C++ template
1617 static data members and inline function local statics. Enabled by
1618 default for a native toolchain with an assembler that accepts it and
1619 GLIBC 2.11 or above, otherwise disabled.
1620
1621 @end table
1622
1623 @subheading Cross-Compiler-Specific Options
1624 The following options only apply to building cross compilers.
1625 @table @code
1626 @item --with-sysroot
1627 @itemx --with-sysroot=@var{dir}
1628 Tells GCC to consider @var{dir} as the root of a tree that contains a
1629 (subset of) the root filesystem of the target operating system.
1630 Target system headers, libraries and run-time object files will be
1631 searched in there. The specified directory is not copied into the
1632 install tree, unlike the options @option{--with-headers} and
1633 @option{--with-libs} that this option obsoletes. The default value,
1634 in case @option{--with-sysroot} is not given an argument, is
1635 @option{$@{gcc_tooldir@}/sys-root}. If the specified directory is a
1636 subdirectory of @option{$@{exec_prefix@}}, then it will be found relative to
1637 the GCC binaries if the installation tree is moved.
1638
1639 @item --with-build-sysroot
1640 @itemx --with-build-sysroot=@var{dir}
1641 Tells GCC to consider @var{dir} as the system root (see
1642 @option{--with-sysroot}) while building target libraries, instead of
1643 the directory specified with @option{--with-sysroot}. This option is
1644 only useful when you are already using @option{--with-sysroot}. You
1645 can use @option{--with-build-sysroot} when you are configuring with
1646 @option{--prefix} set to a directory that is different from the one in
1647 which you are installing GCC and your target libraries.
1648
1649 This option affects the system root for the compiler used to build
1650 target libraries (which runs on the build system); it does not affect
1651 the compiler which is used to build GCC itself.
1652
1653 @item --with-headers
1654 @itemx --with-headers=@var{dir}
1655 Deprecated in favor of @option{--with-sysroot}.
1656 Specifies that target headers are available when building a cross compiler.
1657 The @var{dir} argument specifies a directory which has the target include
1658 files. These include files will be copied into the @file{gcc} install
1659 directory. @emph{This option with the @var{dir} argument is required} when
1660 building a cross compiler, if @file{@var{prefix}/@var{target}/sys-include}
1661 doesn't pre-exist. If @file{@var{prefix}/@var{target}/sys-include} does
1662 pre-exist, the @var{dir} argument may be omitted. @command{fixincludes}
1663 will be run on these files to make them compatible with GCC@.
1664
1665 @item --without-headers
1666 Tells GCC not use any target headers from a libc when building a cross
1667 compiler. When crossing to GNU/Linux, you need the headers so GCC
1668 can build the exception handling for libgcc.
1669
1670 @item --with-libs
1671 @itemx --with-libs=``@var{dir1} @var{dir2} @dots{} @var{dirN}''
1672 Deprecated in favor of @option{--with-sysroot}.
1673 Specifies a list of directories which contain the target runtime
1674 libraries. These libraries will be copied into the @file{gcc} install
1675 directory. If the directory list is omitted, this option has no
1676 effect.
1677
1678 @item --with-newlib
1679 Specifies that @samp{newlib} is
1680 being used as the target C library. This causes @code{__eprintf} to be
1681 omitted from @file{libgcc.a} on the assumption that it will be provided by
1682 @samp{newlib}.
1683
1684 @item --with-build-time-tools=@var{dir}
1685 Specifies where to find the set of target tools (assembler, linker, etc.)
1686 that will be used while building GCC itself. This option can be useful
1687 if the directory layouts are different between the system you are building
1688 GCC on, and the system where you will deploy it.
1689
1690 For example, on an @samp{ia64-hp-hpux} system, you may have the GNU
1691 assembler and linker in @file{/usr/bin}, and the native tools in a
1692 different path, and build a toolchain that expects to find the
1693 native tools in @file{/usr/bin}.
1694
1695 When you use this option, you should ensure that @var{dir} includes
1696 @command{ar}, @command{as}, @command{ld}, @command{nm},
1697 @command{ranlib} and @command{strip} if necessary, and possibly
1698 @command{objdump}. Otherwise, GCC may use an inconsistent set of
1699 tools.
1700 @end table
1701
1702 @subheading Java-Specific Options
1703
1704 The following option applies to the build of the Java front end.
1705
1706 @table @code
1707 @item --disable-libgcj
1708 Specify that the run-time libraries
1709 used by GCJ should not be built. This is useful in case you intend
1710 to use GCJ with some other run-time, or you're going to install it
1711 separately, or it just happens not to build on your particular
1712 machine. In general, if the Java front end is enabled, the GCJ
1713 libraries will be enabled too, unless they're known to not work on
1714 the target platform. If GCJ is enabled but @samp{libgcj} isn't built, you
1715 may need to port it; in this case, before modifying the top-level
1716 @file{configure.in} so that @samp{libgcj} is enabled by default on this platform,
1717 you may use @option{--enable-libgcj} to override the default.
1718
1719 @end table
1720
1721 The following options apply to building @samp{libgcj}.
1722
1723 @subsubheading General Options
1724
1725 @table @code
1726 @item --enable-java-maintainer-mode
1727 By default the @samp{libjava} build will not attempt to compile the
1728 @file{.java} source files to @file{.class}. Instead, it will use the
1729 @file{.class} files from the source tree. If you use this option you
1730 must have executables named @command{ecj1} and @command{gjavah} in your path
1731 for use by the build. You must use this option if you intend to
1732 modify any @file{.java} files in @file{libjava}.
1733
1734 @item --with-java-home=@var{dirname}
1735 This @samp{libjava} option overrides the default value of the
1736 @samp{java.home} system property. It is also used to set
1737 @samp{sun.boot.class.path} to @file{@var{dirname}/lib/rt.jar}. By
1738 default @samp{java.home} is set to @file{@var{prefix}} and
1739 @samp{sun.boot.class.path} to
1740 @file{@var{datadir}/java/libgcj-@var{version}.jar}.
1741
1742 @item --with-ecj-jar=@var{filename}
1743 This option can be used to specify the location of an external jar
1744 file containing the Eclipse Java compiler. A specially modified
1745 version of this compiler is used by @command{gcj} to parse
1746 @file{.java} source files. If this option is given, the
1747 @samp{libjava} build will create and install an @file{ecj1} executable
1748 which uses this jar file at runtime.
1749
1750 If this option is not given, but an @file{ecj.jar} file is found in
1751 the topmost source tree at configure time, then the @samp{libgcj}
1752 build will create and install @file{ecj1}, and will also install the
1753 discovered @file{ecj.jar} into a suitable place in the install tree.
1754
1755 If @file{ecj1} is not installed, then the user will have to supply one
1756 on his path in order for @command{gcj} to properly parse @file{.java}
1757 source files. A suitable jar is available from
1758 @uref{ftp://sourceware.org/pub/java/}.
1759
1760 @item --disable-getenv-properties
1761 Don't set system properties from @env{GCJ_PROPERTIES}.
1762
1763 @item --enable-hash-synchronization
1764 Use a global hash table for monitor locks. Ordinarily,
1765 @samp{libgcj}'s @samp{configure} script automatically makes
1766 the correct choice for this option for your platform. Only use
1767 this if you know you need the library to be configured differently.
1768
1769 @item --enable-interpreter
1770 Enable the Java interpreter. The interpreter is automatically
1771 enabled by default on all platforms that support it. This option
1772 is really only useful if you want to disable the interpreter
1773 (using @option{--disable-interpreter}).
1774
1775 @item --disable-java-net
1776 Disable java.net. This disables the native part of java.net only,
1777 using non-functional stubs for native method implementations.
1778
1779 @item --disable-jvmpi
1780 Disable JVMPI support.
1781
1782 @item --disable-libgcj-bc
1783 Disable BC ABI compilation of certain parts of libgcj. By default,
1784 some portions of libgcj are compiled with @option{-findirect-dispatch}
1785 and @option{-fno-indirect-classes}, allowing them to be overridden at
1786 run-time.
1787
1788 If @option{--disable-libgcj-bc} is specified, libgcj is built without
1789 these options. This allows the compile-time linker to resolve
1790 dependencies when statically linking to libgcj. However it makes it
1791 impossible to override the affected portions of libgcj at run-time.
1792
1793 @item --enable-reduced-reflection
1794 Build most of libgcj with @option{-freduced-reflection}. This reduces
1795 the size of libgcj at the expense of not being able to do accurate
1796 reflection on the classes it contains. This option is safe if you
1797 know that code using libgcj will never use reflection on the standard
1798 runtime classes in libgcj (including using serialization, RMI or CORBA).
1799
1800 @item --with-ecos
1801 Enable runtime eCos target support.
1802
1803 @item --without-libffi
1804 Don't use @samp{libffi}. This will disable the interpreter and JNI
1805 support as well, as these require @samp{libffi} to work.
1806
1807 @item --enable-libgcj-debug
1808 Enable runtime debugging code.
1809
1810 @item --enable-libgcj-multifile
1811 If specified, causes all @file{.java} source files to be
1812 compiled into @file{.class} files in one invocation of
1813 @samp{gcj}. This can speed up build time, but is more
1814 resource-intensive. If this option is unspecified or
1815 disabled, @samp{gcj} is invoked once for each @file{.java}
1816 file to compile into a @file{.class} file.
1817
1818 @item --with-libiconv-prefix=DIR
1819 Search for libiconv in @file{DIR/include} and @file{DIR/lib}.
1820
1821 @item --enable-sjlj-exceptions
1822 Force use of the @code{setjmp}/@code{longjmp}-based scheme for exceptions.
1823 @samp{configure} ordinarily picks the correct value based on the platform.
1824 Only use this option if you are sure you need a different setting.
1825
1826 @item --with-system-zlib
1827 Use installed @samp{zlib} rather than that included with GCC@.
1828
1829 @item --with-win32-nlsapi=ansi, unicows or unicode
1830 Indicates how MinGW @samp{libgcj} translates between UNICODE
1831 characters and the Win32 API@.
1832
1833 @item --enable-java-home
1834 If enabled, this creates a JPackage compatible SDK environment during install.
1835 Note that if --enable-java-home is used, --with-arch-directory=ARCH must also
1836 be specified.
1837
1838 @item --with-arch-directory=ARCH
1839 Specifies the name to use for the @file{jre/lib/ARCH} directory in the SDK
1840 environment created when --enable-java-home is passed. Typical names for this
1841 directory include i386, amd64, ia64, etc.
1842
1843 @item --with-os-directory=DIR
1844 Specifies the OS directory for the SDK include directory. This is set to auto
1845 detect, and is typically 'linux'.
1846
1847 @item --with-origin-name=NAME
1848 Specifies the JPackage origin name. This defaults to the 'gcj' in
1849 java-1.5.0-gcj.
1850
1851 @item --with-arch-suffix=SUFFIX
1852 Specifies the suffix for the sdk directory. Defaults to the empty string.
1853 Examples include '.x86_64' in 'java-1.5.0-gcj-1.5.0.0.x86_64'.
1854
1855 @item --with-jvm-root-dir=DIR
1856 Specifies where to install the SDK. Default is $(prefix)/lib/jvm.
1857
1858 @item --with-jvm-jar-dir=DIR
1859 Specifies where to install jars. Default is $(prefix)/lib/jvm-exports.
1860
1861 @item --with-python-dir=DIR
1862 Specifies where to install the Python modules used for aot-compile. DIR should
1863 not include the prefix used in installation. For example, if the Python modules
1864 are to be installed in /usr/lib/python2.5/site-packages, then
1865 --with-python-dir=/lib/python2.5/site-packages should be passed. If this is
1866 not specified, then the Python modules are installed in $(prefix)/share/python.
1867
1868 @item --enable-aot-compile-rpm
1869 Adds aot-compile-rpm to the list of installed scripts.
1870
1871 @table @code
1872 @item ansi
1873 Use the single-byte @code{char} and the Win32 A functions natively,
1874 translating to and from UNICODE when using these functions. If
1875 unspecified, this is the default.
1876
1877 @item unicows
1878 Use the @code{WCHAR} and Win32 W functions natively. Adds
1879 @code{-lunicows} to @file{libgcj.spec} to link with @samp{libunicows}.
1880 @file{unicows.dll} needs to be deployed on Microsoft Windows 9X machines
1881 running built executables. @file{libunicows.a}, an open-source
1882 import library around Microsoft's @code{unicows.dll}, is obtained from
1883 @uref{http://libunicows.sourceforge.net/}, which also gives details
1884 on getting @file{unicows.dll} from Microsoft.
1885
1886 @item unicode
1887 Use the @code{WCHAR} and Win32 W functions natively. Does @emph{not}
1888 add @code{-lunicows} to @file{libgcj.spec}. The built executables will
1889 only run on Microsoft Windows NT and above.
1890 @end table
1891 @end table
1892
1893 @subsubheading AWT-Specific Options
1894
1895 @table @code
1896 @item --with-x
1897 Use the X Window System.
1898
1899 @item --enable-java-awt=PEER(S)
1900 Specifies the AWT peer library or libraries to build alongside
1901 @samp{libgcj}. If this option is unspecified or disabled, AWT
1902 will be non-functional. Current valid values are @option{gtk} and
1903 @option{xlib}. Multiple libraries should be separated by a
1904 comma (i.e.@: @option{--enable-java-awt=gtk,xlib}).
1905
1906 @item --enable-gtk-cairo
1907 Build the cairo Graphics2D implementation on GTK@.
1908
1909 @item --enable-java-gc=TYPE
1910 Choose garbage collector. Defaults to @option{boehm} if unspecified.
1911
1912 @item --disable-gtktest
1913 Do not try to compile and run a test GTK+ program.
1914
1915 @item --disable-glibtest
1916 Do not try to compile and run a test GLIB program.
1917
1918 @item --with-libart-prefix=PFX
1919 Prefix where libart is installed (optional).
1920
1921 @item --with-libart-exec-prefix=PFX
1922 Exec prefix where libart is installed (optional).
1923
1924 @item --disable-libarttest
1925 Do not try to compile and run a test libart program.
1926
1927 @end table
1928
1929 @html
1930 <hr />
1931 <p>
1932 @end html
1933 @ifhtml
1934 @uref{./index.html,,Return to the GCC Installation page}
1935 @end ifhtml
1936 @end ifset
1937
1938 @c ***Building****************************************************************
1939 @ifnothtml
1940 @comment node-name, next, previous, up
1941 @node Building, Testing, Configuration, Installing GCC
1942 @end ifnothtml
1943 @ifset buildhtml
1944 @ifnothtml
1945 @chapter Building
1946 @end ifnothtml
1947 @cindex Installing GCC: Building
1948
1949 Now that GCC is configured, you are ready to build the compiler and
1950 runtime libraries.
1951
1952 Some commands executed when making the compiler may fail (return a
1953 nonzero status) and be ignored by @command{make}. These failures, which
1954 are often due to files that were not found, are expected, and can safely
1955 be ignored.
1956
1957 It is normal to have compiler warnings when compiling certain files.
1958 Unless you are a GCC developer, you can generally ignore these warnings
1959 unless they cause compilation to fail. Developers should attempt to fix
1960 any warnings encountered, however they can temporarily continue past
1961 warnings-as-errors by specifying the configure flag
1962 @option{--disable-werror}.
1963
1964 On certain old systems, defining certain environment variables such as
1965 @env{CC} can interfere with the functioning of @command{make}.
1966
1967 If you encounter seemingly strange errors when trying to build the
1968 compiler in a directory other than the source directory, it could be
1969 because you have previously configured the compiler in the source
1970 directory. Make sure you have done all the necessary preparations.
1971
1972 If you build GCC on a BSD system using a directory stored in an old System
1973 V file system, problems may occur in running @command{fixincludes} if the
1974 System V file system doesn't support symbolic links. These problems
1975 result in a failure to fix the declaration of @code{size_t} in
1976 @file{sys/types.h}. If you find that @code{size_t} is a signed type and
1977 that type mismatches occur, this could be the cause.
1978
1979 The solution is not to use such a directory for building GCC@.
1980
1981 Similarly, when building from SVN or snapshots, or if you modify
1982 @file{*.l} files, you need the Flex lexical analyzer generator
1983 installed. If you do not modify @file{*.l} files, releases contain
1984 the Flex-generated files and you do not need Flex installed to build
1985 them. There is still one Flex-based lexical analyzer (part of the
1986 build machinery, not of GCC itself) that is used even if you only
1987 build the C front end.
1988
1989 When building from SVN or snapshots, or if you modify Texinfo
1990 documentation, you need version 4.7 or later of Texinfo installed if you
1991 want Info documentation to be regenerated. Releases contain Info
1992 documentation pre-built for the unmodified documentation in the release.
1993
1994 @section Building a native compiler
1995
1996 For a native build, the default configuration is to perform
1997 a 3-stage bootstrap of the compiler when @samp{make} is invoked.
1998 This will build the entire GCC system and ensure that it compiles
1999 itself correctly. It can be disabled with the @option{--disable-bootstrap}
2000 parameter to @samp{configure}, but bootstrapping is suggested because
2001 the compiler will be tested more completely and could also have
2002 better performance.
2003
2004 The bootstrapping process will complete the following steps:
2005
2006 @itemize @bullet
2007 @item
2008 Build tools necessary to build the compiler.
2009
2010 @item
2011 Perform a 3-stage bootstrap of the compiler. This includes building
2012 three times the target tools for use by the compiler such as binutils
2013 (bfd, binutils, gas, gprof, ld, and opcodes) if they have been
2014 individually linked or moved into the top level GCC source tree before
2015 configuring.
2016
2017 @item
2018 Perform a comparison test of the stage2 and stage3 compilers.
2019
2020 @item
2021 Build runtime libraries using the stage3 compiler from the previous step.
2022
2023 @end itemize
2024
2025 If you are short on disk space you might consider @samp{make
2026 bootstrap-lean} instead. The sequence of compilation is the
2027 same described above, but object files from the stage1 and
2028 stage2 of the 3-stage bootstrap of the compiler are deleted as
2029 soon as they are no longer needed.
2030
2031 If you wish to use non-default GCC flags when compiling the stage2
2032 and stage3 compilers, set @code{BOOT_CFLAGS} on the command line when
2033 doing @samp{make}. For example, if you want to save additional space
2034 during the bootstrap and in the final installation as well, you can
2035 build the compiler binaries without debugging information as in the
2036 following example. This will save roughly 40% of disk space both for
2037 the bootstrap and the final installation. (Libraries will still contain
2038 debugging information.)
2039
2040 @smallexample
2041 make BOOT_CFLAGS='-O' bootstrap
2042 @end smallexample
2043
2044 You can place non-default optimization flags into @code{BOOT_CFLAGS}; they
2045 are less well tested here than the default of @samp{-g -O2}, but should
2046 still work. In a few cases, you may find that you need to specify special
2047 flags such as @option{-msoft-float} here to complete the bootstrap; or,
2048 if the native compiler miscompiles the stage1 compiler, you may need
2049 to work around this, by choosing @code{BOOT_CFLAGS} to avoid the parts
2050 of the stage1 compiler that were miscompiled, or by using @samp{make
2051 bootstrap4} to increase the number of stages of bootstrap.
2052
2053 @code{BOOT_CFLAGS} does not apply to bootstrapped target libraries.
2054 Since these are always compiled with the compiler currently being
2055 bootstrapped, you can use @code{CFLAGS_FOR_TARGET} to modify their
2056 compilation flags, as for non-bootstrapped target libraries.
2057 Again, if the native compiler miscompiles the stage1 compiler, you may
2058 need to work around this by avoiding non-working parts of the stage1
2059 compiler. Use @code{STAGE1_TFLAGS} to this end.
2060
2061 If you used the flag @option{--enable-languages=@dots{}} to restrict
2062 the compilers to be built, only those you've actually enabled will be
2063 built. This will of course only build those runtime libraries, for
2064 which the particular compiler has been built. Please note,
2065 that re-defining @env{LANGUAGES} when calling @samp{make}
2066 @strong{does not} work anymore!
2067
2068 If the comparison of stage2 and stage3 fails, this normally indicates
2069 that the stage2 compiler has compiled GCC incorrectly, and is therefore
2070 a potentially serious bug which you should investigate and report. (On
2071 a few systems, meaningful comparison of object files is impossible; they
2072 always appear ``different''. If you encounter this problem, you will
2073 need to disable comparison in the @file{Makefile}.)
2074
2075 If you do not want to bootstrap your compiler, you can configure with
2076 @option{--disable-bootstrap}. In particular cases, you may want to
2077 bootstrap your compiler even if the target system is not the same as
2078 the one you are building on: for example, you could build a
2079 @code{powerpc-unknown-linux-gnu} toolchain on a
2080 @code{powerpc64-unknown-linux-gnu} host. In this case, pass
2081 @option{--enable-bootstrap} to the configure script.
2082
2083 @code{BUILD_CONFIG} can be used to bring in additional customization
2084 to the build. It can be set to a whitespace-separated list of names.
2085 For each such @code{NAME}, top-level @file{config/@code{NAME}.mk} will
2086 be included by the top-level @file{Makefile}, bringing in any settings
2087 it contains. The default @code{BUILD_CONFIG} can be set using the
2088 configure option @option{--with-build-config=@code{NAME}...}. Some
2089 examples of supported build configurations are:
2090
2091 @table @asis
2092 @item @samp{bootstrap-O1}
2093 Removes any @option{-O}-started option from @code{BOOT_CFLAGS}, and adds
2094 @option{-O1} to it. @samp{BUILD_CONFIG=bootstrap-O1} is equivalent to
2095 @samp{BOOT_CFLAGS='-g -O1'}.
2096
2097 @item @samp{bootstrap-O3}
2098 Analogous to @code{bootstrap-O1}.
2099
2100 @item @samp{bootstrap-debug}
2101 Verifies that the compiler generates the same executable code, whether
2102 or not it is asked to emit debug information. To this end, this
2103 option builds stage2 host programs without debug information, and uses
2104 @file{contrib/compare-debug} to compare them with the stripped stage3
2105 object files. If @code{BOOT_CFLAGS} is overridden so as to not enable
2106 debug information, stage2 will have it, and stage3 won't. This option
2107 is enabled by default when GCC bootstrapping is enabled, if
2108 @code{strip} can turn object files compiled with and without debug
2109 info into identical object files. In addition to better test
2110 coverage, this option makes default bootstraps faster and leaner.
2111
2112 @item @samp{bootstrap-debug-big}
2113 Rather than comparing stripped object files, as in
2114 @code{bootstrap-debug}, this option saves internal compiler dumps
2115 during stage2 and stage3 and compares them as well, which helps catch
2116 additional potential problems, but at a great cost in terms of disk
2117 space. It can be specified in addition to @samp{bootstrap-debug}.
2118
2119 @item @samp{bootstrap-debug-lean}
2120 This option saves disk space compared with @code{bootstrap-debug-big},
2121 but at the expense of some recompilation. Instead of saving the dumps
2122 of stage2 and stage3 until the final compare, it uses
2123 @option{-fcompare-debug} to generate, compare and remove the dumps
2124 during stage3, repeating the compilation that already took place in
2125 stage2, whose dumps were not saved.
2126
2127 @item @samp{bootstrap-debug-lib}
2128 This option tests executable code invariance over debug information
2129 generation on target libraries, just like @code{bootstrap-debug-lean}
2130 tests it on host programs. It builds stage3 libraries with
2131 @option{-fcompare-debug}, and it can be used along with any of the
2132 @code{bootstrap-debug} options above.
2133
2134 There aren't @code{-lean} or @code{-big} counterparts to this option
2135 because most libraries are only build in stage3, so bootstrap compares
2136 would not get significant coverage. Moreover, the few libraries built
2137 in stage2 are used in stage3 host programs, so we wouldn't want to
2138 compile stage2 libraries with different options for comparison purposes.
2139
2140 @item @samp{bootstrap-debug-ckovw}
2141 Arranges for error messages to be issued if the compiler built on any
2142 stage is run without the option @option{-fcompare-debug}. This is
2143 useful to verify the full @option{-fcompare-debug} testing coverage. It
2144 must be used along with @code{bootstrap-debug-lean} and
2145 @code{bootstrap-debug-lib}.
2146
2147 @item @samp{bootstrap-time}
2148 Arranges for the run time of each program started by the GCC driver,
2149 built in any stage, to be logged to @file{time.log}, in the top level of
2150 the build tree.
2151
2152 @end table
2153
2154 @section Building a cross compiler
2155
2156 When building a cross compiler, it is not generally possible to do a
2157 3-stage bootstrap of the compiler. This makes for an interesting problem
2158 as parts of GCC can only be built with GCC@.
2159
2160 To build a cross compiler, we first recommend building and installing a
2161 native compiler. You can then use the native GCC compiler to build the
2162 cross compiler. The installed native compiler needs to be GCC version
2163 2.95 or later.
2164
2165 If the cross compiler is to be built with support for the Java
2166 programming language and the ability to compile .java source files is
2167 desired, the installed native compiler used to build the cross
2168 compiler needs to be the same GCC version as the cross compiler. In
2169 addition the cross compiler needs to be configured with
2170 @option{--with-ecj-jar=@dots{}}.
2171
2172 Assuming you have already installed a native copy of GCC and configured
2173 your cross compiler, issue the command @command{make}, which performs the
2174 following steps:
2175
2176 @itemize @bullet
2177 @item
2178 Build host tools necessary to build the compiler.
2179
2180 @item
2181 Build target tools for use by the compiler such as binutils (bfd,
2182 binutils, gas, gprof, ld, and opcodes)
2183 if they have been individually linked or moved into the top level GCC source
2184 tree before configuring.
2185
2186 @item
2187 Build the compiler (single stage only).
2188
2189 @item
2190 Build runtime libraries using the compiler from the previous step.
2191 @end itemize
2192
2193 Note that if an error occurs in any step the make process will exit.
2194
2195 If you are not building GNU binutils in the same source tree as GCC,
2196 you will need a cross-assembler and cross-linker installed before
2197 configuring GCC@. Put them in the directory
2198 @file{@var{prefix}/@var{target}/bin}. Here is a table of the tools
2199 you should put in this directory:
2200
2201 @table @file
2202 @item as
2203 This should be the cross-assembler.
2204
2205 @item ld
2206 This should be the cross-linker.
2207
2208 @item ar
2209 This should be the cross-archiver: a program which can manipulate
2210 archive files (linker libraries) in the target machine's format.
2211
2212 @item ranlib
2213 This should be a program to construct a symbol table in an archive file.
2214 @end table
2215
2216 The installation of GCC will find these programs in that directory,
2217 and copy or link them to the proper place to for the cross-compiler to
2218 find them when run later.
2219
2220 The easiest way to provide these files is to build the Binutils package.
2221 Configure it with the same @option{--host} and @option{--target}
2222 options that you use for configuring GCC, then build and install
2223 them. They install their executables automatically into the proper
2224 directory. Alas, they do not support all the targets that GCC
2225 supports.
2226
2227 If you are not building a C library in the same source tree as GCC,
2228 you should also provide the target libraries and headers before
2229 configuring GCC, specifying the directories with
2230 @option{--with-sysroot} or @option{--with-headers} and
2231 @option{--with-libs}. Many targets also require ``start files'' such
2232 as @file{crt0.o} and
2233 @file{crtn.o} which are linked into each executable. There may be several
2234 alternatives for @file{crt0.o}, for use with profiling or other
2235 compilation options. Check your target's definition of
2236 @code{STARTFILE_SPEC} to find out what start files it uses.
2237
2238 @section Building in parallel
2239
2240 GNU Make 3.79 and above, which is necessary to build GCC, support
2241 building in parallel. To activate this, you can use @samp{make -j 2}
2242 instead of @samp{make}. You can also specify a bigger number, and
2243 in most cases using a value greater than the number of processors in
2244 your machine will result in fewer and shorter I/O latency hits, thus
2245 improving overall throughput; this is especially true for slow drives
2246 and network filesystems.
2247
2248 @section Building the Ada compiler
2249
2250 In order to build GNAT, the Ada compiler, you need a working GNAT
2251 compiler (GCC version 3.4 or later).
2252 This includes GNAT tools such as @command{gnatmake} and
2253 @command{gnatlink}, since the Ada front end is written in Ada and
2254 uses some GNAT-specific extensions.
2255
2256 In order to build a cross compiler, it is suggested to install
2257 the new compiler as native first, and then use it to build the cross
2258 compiler.
2259
2260 @command{configure} does not test whether the GNAT installation works
2261 and has a sufficiently recent version; if too old a GNAT version is
2262 installed, the build will fail unless @option{--enable-languages} is
2263 used to disable building the Ada front end.
2264
2265 @env{ADA_INCLUDE_PATH} and @env{ADA_OBJECT_PATH} environment variables
2266 must not be set when building the Ada compiler, the Ada tools, or the
2267 Ada runtime libraries. You can check that your build environment is clean
2268 by verifying that @samp{gnatls -v} lists only one explicit path in each
2269 section.
2270
2271 @section Building with profile feedback
2272
2273 It is possible to use profile feedback to optimize the compiler itself. This
2274 should result in a faster compiler binary. Experiments done on x86 using gcc
2275 3.3 showed approximately 7 percent speedup on compiling C programs. To
2276 bootstrap the compiler with profile feedback, use @code{make profiledbootstrap}.
2277
2278 When @samp{make profiledbootstrap} is run, it will first build a @code{stage1}
2279 compiler. This compiler is used to build a @code{stageprofile} compiler
2280 instrumented to collect execution counts of instruction and branch
2281 probabilities. Then runtime libraries are compiled with profile collected.
2282 Finally a @code{stagefeedback} compiler is built using the information collected.
2283
2284 Unlike standard bootstrap, several additional restrictions apply. The
2285 compiler used to build @code{stage1} needs to support a 64-bit integral type.
2286 It is recommended to only use GCC for this. Also parallel make is currently
2287 not supported since collisions in profile collecting may occur.
2288
2289 @html
2290 <hr />
2291 <p>
2292 @end html
2293 @ifhtml
2294 @uref{./index.html,,Return to the GCC Installation page}
2295 @end ifhtml
2296 @end ifset
2297
2298 @c ***Testing*****************************************************************
2299 @ifnothtml
2300 @comment node-name, next, previous, up
2301 @node Testing, Final install, Building, Installing GCC
2302 @end ifnothtml
2303 @ifset testhtml
2304 @ifnothtml
2305 @chapter Installing GCC: Testing
2306 @end ifnothtml
2307 @cindex Testing
2308 @cindex Installing GCC: Testing
2309 @cindex Testsuite
2310
2311 Before you install GCC, we encourage you to run the testsuites and to
2312 compare your results with results from a similar configuration that have
2313 been submitted to the
2314 @uref{http://gcc.gnu.org/ml/gcc-testresults/,,gcc-testresults mailing list}.
2315 Some of these archived results are linked from the build status lists
2316 at @uref{http://gcc.gnu.org/buildstat.html}, although not everyone who
2317 reports a successful build runs the testsuites and submits the results.
2318 This step is optional and may require you to download additional software,
2319 but it can give you confidence in your new GCC installation or point out
2320 problems before you install and start using your new GCC@.
2321
2322 First, you must have @uref{download.html,,downloaded the testsuites}.
2323 These are part of the full distribution, but if you downloaded the
2324 ``core'' compiler plus any front ends, you must download the testsuites
2325 separately.
2326
2327 Second, you must have the testing tools installed. This includes
2328 @uref{http://www.gnu.org/software/dejagnu/,,DejaGnu}, Tcl, and Expect;
2329 the DejaGnu site has links to these.
2330
2331 If the directories where @command{runtest} and @command{expect} were
2332 installed are not in the @env{PATH}, you may need to set the following
2333 environment variables appropriately, as in the following example (which
2334 assumes that DejaGnu has been installed under @file{/usr/local}):
2335
2336 @smallexample
2337 TCL_LIBRARY = /usr/local/share/tcl8.0
2338 DEJAGNULIBS = /usr/local/share/dejagnu
2339 @end smallexample
2340
2341 (On systems such as Cygwin, these paths are required to be actual
2342 paths, not mounts or links; presumably this is due to some lack of
2343 portability in the DejaGnu code.)
2344
2345
2346 Finally, you can run the testsuite (which may take a long time):
2347 @smallexample
2348 cd @var{objdir}; make -k check
2349 @end smallexample
2350
2351 This will test various components of GCC, such as compiler
2352 front ends and runtime libraries. While running the testsuite, DejaGnu
2353 might emit some harmless messages resembling
2354 @samp{WARNING: Couldn't find the global config file.} or
2355 @samp{WARNING: Couldn't find tool init file} that can be ignored.
2356
2357 If you are testing a cross-compiler, you may want to run the testsuite
2358 on a simulator as described at @uref{http://gcc.gnu.org/simtest-howto.html}.
2359
2360 @section How can you run the testsuite on selected tests?
2361
2362 In order to run sets of tests selectively, there are targets
2363 @samp{make check-gcc} and @samp{make check-g++}
2364 in the @file{gcc} subdirectory of the object directory. You can also
2365 just run @samp{make check} in a subdirectory of the object directory.
2366
2367
2368 A more selective way to just run all @command{gcc} execute tests in the
2369 testsuite is to use
2370
2371 @smallexample
2372 make check-gcc RUNTESTFLAGS="execute.exp @var{other-options}"
2373 @end smallexample
2374
2375 Likewise, in order to run only the @command{g++} ``old-deja'' tests in
2376 the testsuite with filenames matching @samp{9805*}, you would use
2377
2378 @smallexample
2379 make check-g++ RUNTESTFLAGS="old-deja.exp=9805* @var{other-options}"
2380 @end smallexample
2381
2382 The @file{*.exp} files are located in the testsuite directories of the GCC
2383 source, the most important ones being @file{compile.exp},
2384 @file{execute.exp}, @file{dg.exp} and @file{old-deja.exp}.
2385 To get a list of the possible @file{*.exp} files, pipe the
2386 output of @samp{make check} into a file and look at the
2387 @samp{Running @dots{} .exp} lines.
2388
2389 @section Passing options and running multiple testsuites
2390
2391 You can pass multiple options to the testsuite using the
2392 @samp{--target_board} option of DejaGNU, either passed as part of
2393 @samp{RUNTESTFLAGS}, or directly to @command{runtest} if you prefer to
2394 work outside the makefiles. For example,
2395
2396 @smallexample
2397 make check-g++ RUNTESTFLAGS="--target_board=unix/-O3/-fmerge-constants"
2398 @end smallexample
2399
2400 will run the standard @command{g++} testsuites (``unix'' is the target name
2401 for a standard native testsuite situation), passing
2402 @samp{-O3 -fmerge-constants} to the compiler on every test, i.e.,
2403 slashes separate options.
2404
2405 You can run the testsuites multiple times using combinations of options
2406 with a syntax similar to the brace expansion of popular shells:
2407
2408 @smallexample
2409 @dots{}"--target_board=arm-sim\@{-mhard-float,-msoft-float\@}\@{-O1,-O2,-O3,\@}"
2410 @end smallexample
2411
2412 (Note the empty option caused by the trailing comma in the final group.)
2413 The following will run each testsuite eight times using the @samp{arm-sim}
2414 target, as if you had specified all possible combinations yourself:
2415
2416 @smallexample
2417 --target_board=arm-sim/-mhard-float/-O1
2418 --target_board=arm-sim/-mhard-float/-O2
2419 --target_board=arm-sim/-mhard-float/-O3
2420 --target_board=arm-sim/-mhard-float
2421 --target_board=arm-sim/-msoft-float/-O1
2422 --target_board=arm-sim/-msoft-float/-O2
2423 --target_board=arm-sim/-msoft-float/-O3
2424 --target_board=arm-sim/-msoft-float
2425 @end smallexample
2426
2427 They can be combined as many times as you wish, in arbitrary ways. This
2428 list:
2429
2430 @smallexample
2431 @dots{}"--target_board=unix/-Wextra\@{-O3,-fno-strength\@}\@{-fomit-frame,\@}"
2432 @end smallexample
2433
2434 will generate four combinations, all involving @samp{-Wextra}.
2435
2436 The disadvantage to this method is that the testsuites are run in serial,
2437 which is a waste on multiprocessor systems. For users with GNU Make and
2438 a shell which performs brace expansion, you can run the testsuites in
2439 parallel by having the shell perform the combinations and @command{make}
2440 do the parallel runs. Instead of using @samp{--target_board}, use a
2441 special makefile target:
2442
2443 @smallexample
2444 make -j@var{N} check-@var{testsuite}//@var{test-target}/@var{option1}/@var{option2}/@dots{}
2445 @end smallexample
2446
2447 For example,
2448
2449 @smallexample
2450 make -j3 check-gcc//sh-hms-sim/@{-m1,-m2,-m3,-m3e,-m4@}/@{,-nofpu@}
2451 @end smallexample
2452
2453 will run three concurrent ``make-gcc'' testsuites, eventually testing all
2454 ten combinations as described above. Note that this is currently only
2455 supported in the @file{gcc} subdirectory. (To see how this works, try
2456 typing @command{echo} before the example given here.)
2457
2458
2459 @section Additional testing for Java Class Libraries
2460
2461 The Java runtime tests can be executed via @samp{make check}
2462 in the @file{@var{target}/libjava/testsuite} directory in
2463 the build tree.
2464
2465 The @uref{http://sourceware.org/mauve/,,Mauve Project} provides
2466 a suite of tests for the Java Class Libraries. This suite can be run
2467 as part of libgcj testing by placing the Mauve tree within the libjava
2468 testsuite at @file{libjava/testsuite/libjava.mauve/mauve}, or by
2469 specifying the location of that tree when invoking @samp{make}, as in
2470 @samp{make MAUVEDIR=~/mauve check}.
2471
2472 @section How to interpret test results
2473
2474 The result of running the testsuite are various @file{*.sum} and @file{*.log}
2475 files in the testsuite subdirectories. The @file{*.log} files contain a
2476 detailed log of the compiler invocations and the corresponding
2477 results, the @file{*.sum} files summarize the results. These summaries
2478 contain status codes for all tests:
2479
2480 @itemize @bullet
2481 @item
2482 PASS: the test passed as expected
2483 @item
2484 XPASS: the test unexpectedly passed
2485 @item
2486 FAIL: the test unexpectedly failed
2487 @item
2488 XFAIL: the test failed as expected
2489 @item
2490 UNSUPPORTED: the test is not supported on this platform
2491 @item
2492 ERROR: the testsuite detected an error
2493 @item
2494 WARNING: the testsuite detected a possible problem
2495 @end itemize
2496
2497 It is normal for some tests to report unexpected failures. At the
2498 current time the testing harness does not allow fine grained control
2499 over whether or not a test is expected to fail. This problem should
2500 be fixed in future releases.
2501
2502
2503 @section Submitting test results
2504
2505 If you want to report the results to the GCC project, use the
2506 @file{contrib/test_summary} shell script. Start it in the @var{objdir} with
2507
2508 @smallexample
2509 @var{srcdir}/contrib/test_summary -p your_commentary.txt \
2510 -m gcc-testresults@@gcc.gnu.org |sh
2511 @end smallexample
2512
2513 This script uses the @command{Mail} program to send the results, so
2514 make sure it is in your @env{PATH}. The file @file{your_commentary.txt} is
2515 prepended to the testsuite summary and should contain any special
2516 remarks you have on your results or your build environment. Please
2517 do not edit the testsuite result block or the subject line, as these
2518 messages may be automatically processed.
2519
2520 @html
2521 <hr />
2522 <p>
2523 @end html
2524 @ifhtml
2525 @uref{./index.html,,Return to the GCC Installation page}
2526 @end ifhtml
2527 @end ifset
2528
2529 @c ***Final install***********************************************************
2530 @ifnothtml
2531 @comment node-name, next, previous, up
2532 @node Final install, , Testing, Installing GCC
2533 @end ifnothtml
2534 @ifset finalinstallhtml
2535 @ifnothtml
2536 @chapter Installing GCC: Final installation
2537 @end ifnothtml
2538
2539 Now that GCC has been built (and optionally tested), you can install it with
2540 @smallexample
2541 cd @var{objdir}; make install
2542 @end smallexample
2543
2544 We strongly recommend to install into a target directory where there is
2545 no previous version of GCC present. Also, the GNAT runtime should not
2546 be stripped, as this would break certain features of the debugger that
2547 depend on this debugging information (catching Ada exceptions for
2548 instance).
2549
2550 That step completes the installation of GCC; user level binaries can
2551 be found in @file{@var{prefix}/bin} where @var{prefix} is the value
2552 you specified with the @option{--prefix} to configure (or
2553 @file{/usr/local} by default). (If you specified @option{--bindir},
2554 that directory will be used instead; otherwise, if you specified
2555 @option{--exec-prefix}, @file{@var{exec-prefix}/bin} will be used.)
2556 Headers for the C++ and Java libraries are installed in
2557 @file{@var{prefix}/include}; libraries in @file{@var{libdir}}
2558 (normally @file{@var{prefix}/lib}); internal parts of the compiler in
2559 @file{@var{libdir}/gcc} and @file{@var{libexecdir}/gcc}; documentation
2560 in info format in @file{@var{infodir}} (normally
2561 @file{@var{prefix}/info}).
2562
2563 When installing cross-compilers, GCC's executables
2564 are not only installed into @file{@var{bindir}}, that
2565 is, @file{@var{exec-prefix}/bin}, but additionally into
2566 @file{@var{exec-prefix}/@var{target-alias}/bin}, if that directory
2567 exists. Typically, such @dfn{tooldirs} hold target-specific
2568 binutils, including assembler and linker.
2569
2570 Installation into a temporary staging area or into a @command{chroot}
2571 jail can be achieved with the command
2572
2573 @smallexample
2574 make DESTDIR=@var{path-to-rootdir} install
2575 @end smallexample
2576
2577 @noindent where @var{path-to-rootdir} is the absolute path of
2578 a directory relative to which all installation paths will be
2579 interpreted. Note that the directory specified by @code{DESTDIR}
2580 need not exist yet; it will be created if necessary.
2581
2582 There is a subtle point with tooldirs and @code{DESTDIR}:
2583 If you relocate a cross-compiler installation with
2584 e.g.@: @samp{DESTDIR=@var{rootdir}}, then the directory
2585 @file{@var{rootdir}/@var{exec-prefix}/@var{target-alias}/bin} will
2586 be filled with duplicated GCC executables only if it already exists,
2587 it will not be created otherwise. This is regarded as a feature,
2588 not as a bug, because it gives slightly more control to the packagers
2589 using the @code{DESTDIR} feature.
2590
2591 If you are bootstrapping a released version of GCC then please
2592 quickly review the build status page for your release, available from
2593 @uref{http://gcc.gnu.org/buildstat.html}.
2594 If your system is not listed for the version of GCC that you built,
2595 send a note to
2596 @email{gcc@@gcc.gnu.org} indicating
2597 that you successfully built and installed GCC@.
2598 Include the following information:
2599
2600 @itemize @bullet
2601 @item
2602 Output from running @file{@var{srcdir}/config.guess}. Do not send
2603 that file itself, just the one-line output from running it.
2604
2605 @item
2606 The output of @samp{gcc -v} for your newly installed @command{gcc}.
2607 This tells us which version of GCC you built and the options you passed to
2608 configure.
2609
2610 @item
2611 Whether you enabled all languages or a subset of them. If you used a
2612 full distribution then this information is part of the configure
2613 options in the output of @samp{gcc -v}, but if you downloaded the
2614 ``core'' compiler plus additional front ends then it isn't apparent
2615 which ones you built unless you tell us about it.
2616
2617 @item
2618 If the build was for GNU/Linux, also include:
2619 @itemize @bullet
2620 @item
2621 The distribution name and version (e.g., Red Hat 7.1 or Debian 2.2.3);
2622 this information should be available from @file{/etc/issue}.
2623
2624 @item
2625 The version of the Linux kernel, available from @samp{uname --version}
2626 or @samp{uname -a}.
2627
2628 @item
2629 The version of glibc you used; for RPM-based systems like Red Hat,
2630 Mandrake, and SuSE type @samp{rpm -q glibc} to get the glibc version,
2631 and on systems like Debian and Progeny use @samp{dpkg -l libc6}.
2632 @end itemize
2633 For other systems, you can include similar information if you think it is
2634 relevant.
2635
2636 @item
2637 Any other information that you think would be useful to people building
2638 GCC on the same configuration. The new entry in the build status list
2639 will include a link to the archived copy of your message.
2640 @end itemize
2641
2642 We'd also like to know if the
2643 @ifnothtml
2644 @ref{Specific, host/target specific installation notes}
2645 @end ifnothtml
2646 @ifhtml
2647 @uref{specific.html,,host/target specific installation notes}
2648 @end ifhtml
2649 didn't include your host/target information or if that information is
2650 incomplete or out of date. Send a note to
2651 @email{gcc@@gcc.gnu.org} detailing how the information should be changed.
2652
2653 If you find a bug, please report it following the
2654 @uref{../bugs.html,,bug reporting guidelines}.
2655
2656 If you want to print the GCC manuals, do @samp{cd @var{objdir}; make
2657 dvi}. You will need to have @command{texi2dvi} (version at least 4.7)
2658 and @TeX{} installed. This creates a number of @file{.dvi} files in
2659 subdirectories of @file{@var{objdir}}; these may be converted for
2660 printing with programs such as @command{dvips}. Alternately, by using
2661 @samp{make pdf} in place of @samp{make dvi}, you can create documentation
2662 in the form of @file{.pdf} files; this requires @command{texi2pdf}, which
2663 is included with Texinfo version 4.8 and later. You can also
2664 @uref{http://shop.fsf.org/,,buy printed manuals from the
2665 Free Software Foundation}, though such manuals may not be for the most
2666 recent version of GCC@.
2667
2668 If you would like to generate online HTML documentation, do @samp{cd
2669 @var{objdir}; make html} and HTML will be generated for the gcc manuals in
2670 @file{@var{objdir}/gcc/HTML}.
2671
2672 @html
2673 <hr />
2674 <p>
2675 @end html
2676 @ifhtml
2677 @uref{./index.html,,Return to the GCC Installation page}
2678 @end ifhtml
2679 @end ifset
2680
2681 @c ***Binaries****************************************************************
2682 @ifnothtml
2683 @comment node-name, next, previous, up
2684 @node Binaries, Specific, Installing GCC, Top
2685 @end ifnothtml
2686 @ifset binarieshtml
2687 @ifnothtml
2688 @chapter Installing GCC: Binaries
2689 @end ifnothtml
2690 @cindex Binaries
2691 @cindex Installing GCC: Binaries
2692
2693 We are often asked about pre-compiled versions of GCC@. While we cannot
2694 provide these for all platforms, below you'll find links to binaries for
2695 various platforms where creating them by yourself is not easy due to various
2696 reasons.
2697
2698 Please note that we did not create these binaries, nor do we
2699 support them. If you have any problems installing them, please
2700 contact their makers.
2701
2702 @itemize
2703 @item
2704 AIX:
2705 @itemize
2706 @item
2707 @uref{http://www.bullfreeware.com,,Bull's Freeware and Shareware Archive for AIX};
2708
2709 @item
2710 @uref{http://pware.hvcc.edu,,Hudson Valley Community College Open Source Software for IBM System p};
2711
2712 @item
2713 @uref{http://www.perzl.org/aix/,,AIX 5L and 6 Open Source Packages}.
2714 @end itemize
2715
2716 @item
2717 DOS---@uref{http://www.delorie.com/djgpp/,,DJGPP}.
2718
2719 @item
2720 Renesas H8/300[HS]---@uref{http://h8300-hms.sourceforge.net/,,GNU
2721 Development Tools for the Renesas H8/300[HS] Series}.
2722
2723 @item
2724 HP-UX:
2725 @itemize
2726 @item
2727 @uref{http://hpux.cs.utah.edu/,,HP-UX Porting Center};
2728
2729 @item
2730 @uref{ftp://sunsite.informatik.rwth-aachen.de/pub/packages/gcc_hpux/,,Binaries for HP-UX 11.00 at Aachen University of Technology}.
2731 @end itemize
2732
2733 @item
2734 Motorola 68HC11/68HC12---@uref{http://www.gnu-m68hc11.org,,GNU
2735 Development Tools for the Motorola 68HC11/68HC12}.
2736
2737 @item
2738 @uref{http://www.sco.com/skunkware/devtools/index.html#gcc,,SCO
2739 OpenServer/Unixware}.
2740
2741 @item
2742 Solaris 2 (SPARC, Intel)---@uref{http://www.sunfreeware.com/,,Sunfreeware}.
2743
2744 @item
2745 SGI---@uref{http://freeware.sgi.com/,,SGI Freeware}.
2746
2747 @item
2748 Microsoft Windows:
2749 @itemize
2750 @item
2751 The @uref{http://sourceware.org/cygwin/,,Cygwin} project;
2752 @item
2753 The @uref{http://www.mingw.org/,,MinGW} project.
2754 @end itemize
2755
2756 @item
2757 @uref{ftp://ftp.thewrittenword.com/packages/by-name/,,The
2758 Written Word} offers binaries for
2759 AIX 4.3.3, 5.1 and 5.2,
2760 IRIX 6.5,
2761 Tru64 UNIX 4.0D and 5.1,
2762 GNU/Linux (i386),
2763 HP-UX 10.20, 11.00, and 11.11, and
2764 Solaris/SPARC 2.5.1, 2.6, 7, 8, 9 and 10.
2765
2766 @item
2767 @uref{http://www.openpkg.org/,,OpenPKG} offers binaries for quite a
2768 number of platforms.
2769
2770 @item
2771 The @uref{http://gcc.gnu.org/wiki/GFortranBinaries,,GFortran Wiki} has
2772 links to GNU Fortran binaries for several platforms.
2773 @end itemize
2774
2775 In addition to those specific offerings, you can get a binary
2776 distribution CD-ROM from the
2777 @uref{http://www.gnu.org/order/order.html,,Free Software Foundation}.
2778 It contains binaries for a number of platforms, and
2779 includes not only GCC, but other stuff as well. The current CD does
2780 not contain the latest version of GCC, but it should allow
2781 bootstrapping the compiler. An updated version of that disk is in the
2782 works.
2783
2784 @html
2785 <hr />
2786 <p>
2787 @end html
2788 @ifhtml
2789 @uref{./index.html,,Return to the GCC Installation page}
2790 @end ifhtml
2791 @end ifset
2792
2793 @c ***Specific****************************************************************
2794 @ifnothtml
2795 @comment node-name, next, previous, up
2796 @node Specific, Old, Binaries, Top
2797 @end ifnothtml
2798 @ifset specifichtml
2799 @ifnothtml
2800 @chapter Host/target specific installation notes for GCC
2801 @end ifnothtml
2802 @cindex Specific
2803 @cindex Specific installation notes
2804 @cindex Target specific installation
2805 @cindex Host specific installation
2806 @cindex Target specific installation notes
2807
2808 Please read this document carefully @emph{before} installing the
2809 GNU Compiler Collection on your machine.
2810
2811 Note that this list of install notes is @emph{not} a list of supported
2812 hosts or targets. Not all supported hosts and targets are listed
2813 here, only the ones that require host-specific or target-specific
2814 information are.
2815
2816 @ifhtml
2817 @itemize
2818 @item
2819 @uref{#alpha-x-x,,alpha*-*-*}
2820 @item
2821 @uref{#alpha-dec-osf,,alpha*-dec-osf*}
2822 @item
2823 @uref{#arc-x-elf,,arc-*-elf}
2824 @item
2825 @uref{#arm-x-elf,,arm-*-elf}
2826 @item
2827 @uref{#avr,,avr}
2828 @item
2829 @uref{#bfin,,Blackfin}
2830 @item
2831 @uref{#dos,,DOS}
2832 @item
2833 @uref{#x-x-freebsd,,*-*-freebsd*}
2834 @item
2835 @uref{#h8300-hms,,h8300-hms}
2836 @item
2837 @uref{#hppa-hp-hpux,,hppa*-hp-hpux*}
2838 @item
2839 @uref{#hppa-hp-hpux10,,hppa*-hp-hpux10}
2840 @item
2841 @uref{#hppa-hp-hpux11,,hppa*-hp-hpux11}
2842 @item
2843 @uref{#x-x-linux-gnu,,*-*-linux-gnu}
2844 @item
2845 @uref{#ix86-x-linux,,i?86-*-linux*}
2846 @item
2847 @uref{#ix86-x-solaris210,,i?86-*-solaris2.10}
2848 @item
2849 @uref{#ia64-x-linux,,ia64-*-linux}
2850 @item
2851 @uref{#ia64-x-hpux,,ia64-*-hpux*}
2852 @item
2853 @uref{#x-ibm-aix,,*-ibm-aix*}
2854 @item
2855 @uref{#iq2000-x-elf,,iq2000-*-elf}
2856 @item
2857 @uref{#m32c-x-elf,,m32c-*-elf}
2858 @item
2859 @uref{#m32r-x-elf,,m32r-*-elf}
2860 @item
2861 @uref{#m6811-elf,,m6811-elf}
2862 @item
2863 @uref{#m6812-elf,,m6812-elf}
2864 @item
2865 @uref{#m68k-x-x,,m68k-*-*}
2866 @item
2867 @uref{#m68k-uclinux,,m68k-uclinux}
2868 @item
2869 @uref{#mep-x-elf,,mep-*-elf}
2870 @item
2871 @uref{#mips-x-x,,mips-*-*}
2872 @item
2873 @uref{#mips-sgi-irix5,,mips-sgi-irix5}
2874 @item
2875 @uref{#mips-sgi-irix6,,mips-sgi-irix6}
2876 @item
2877 @uref{#powerpc-x-x,,powerpc*-*-*}
2878 @item
2879 @uref{#powerpc-x-darwin,,powerpc-*-darwin*}
2880 @item
2881 @uref{#powerpc-x-elf,,powerpc-*-elf}
2882 @item
2883 @uref{#powerpc-x-linux-gnu,,powerpc*-*-linux-gnu*}
2884 @item
2885 @uref{#powerpc-x-netbsd,,powerpc-*-netbsd*}
2886 @item
2887 @uref{#powerpc-x-eabisim,,powerpc-*-eabisim}
2888 @item
2889 @uref{#powerpc-x-eabi,,powerpc-*-eabi}
2890 @item
2891 @uref{#powerpcle-x-elf,,powerpcle-*-elf}
2892 @item
2893 @uref{#powerpcle-x-eabisim,,powerpcle-*-eabisim}
2894 @item
2895 @uref{#powerpcle-x-eabi,,powerpcle-*-eabi}
2896 @item
2897 @uref{#s390-x-linux,,s390-*-linux*}
2898 @item
2899 @uref{#s390x-x-linux,,s390x-*-linux*}
2900 @item
2901 @uref{#s390x-ibm-tpf,,s390x-ibm-tpf*}
2902 @item
2903 @uref{#x-x-solaris2,,*-*-solaris2*}
2904 @item
2905 @uref{#sparc-sun-solaris2,,sparc-sun-solaris2*}
2906 @item
2907 @uref{#sparc-sun-solaris27,,sparc-sun-solaris2.7}
2908 @item
2909 @uref{#sparc-x-linux,,sparc-*-linux*}
2910 @item
2911 @uref{#sparc64-x-solaris2,,sparc64-*-solaris2*}
2912 @item
2913 @uref{#sparcv9-x-solaris2,,sparcv9-*-solaris2*}
2914 @item
2915 @uref{#x-x-vxworks,,*-*-vxworks*}
2916 @item
2917 @uref{#x86-64-x-x,,x86_64-*-*, amd64-*-*}
2918 @item
2919 @uref{#xtensa-x-elf,,xtensa*-*-elf}
2920 @item
2921 @uref{#xtensa-x-linux,,xtensa*-*-linux*}
2922 @item
2923 @uref{#windows,,Microsoft Windows}
2924 @item
2925 @uref{#x-x-cygwin,,*-*-cygwin}
2926 @item
2927 @uref{#x-x-interix,,*-*-interix}
2928 @item
2929 @uref{#x-x-mingw32,,*-*-mingw32}
2930 @item
2931 @uref{#os2,,OS/2}
2932 @item
2933 @uref{#older,,Older systems}
2934 @end itemize
2935
2936 @itemize
2937 @item
2938 @uref{#elf,,all ELF targets} (SVR4, Solaris 2, etc.)
2939 @end itemize
2940 @end ifhtml
2941
2942
2943 @html
2944 <!-- -------- host/target specific issues start here ---------------- -->
2945 <hr />
2946 @end html
2947 @heading @anchor{alpha-x-x}alpha*-*-*
2948
2949 This section contains general configuration information for all
2950 alpha-based platforms using ELF (in particular, ignore this section for
2951 DEC OSF/1, Digital UNIX and Tru64 UNIX)@. In addition to reading this
2952 section, please read all other sections that match your target.
2953
2954 We require binutils 2.11.2 or newer.
2955 Previous binutils releases had a number of problems with DWARF 2
2956 debugging information, not the least of which is incorrect linking of
2957 shared libraries.
2958
2959 @html
2960 <hr />
2961 @end html
2962 @heading @anchor{alpha-dec-osf}alpha*-dec-osf*
2963 Systems using processors that implement the DEC Alpha architecture and
2964 are running the DEC/Compaq Unix (DEC OSF/1, Digital UNIX, or Compaq
2965 Tru64 UNIX) operating system, for example the DEC Alpha AXP systems.
2966
2967 As of GCC 3.2, versions before @code{alpha*-dec-osf4} are no longer
2968 supported. (These are the versions which identify themselves as DEC
2969 OSF/1.)
2970
2971 In Digital Unix V4.0, virtual memory exhausted bootstrap failures
2972 may be fixed by configuring with @option{--with-gc=simple},
2973 reconfiguring Kernel Virtual Memory and Swap parameters
2974 per the @command{/usr/sbin/sys_check} Tuning Suggestions,
2975 or applying the patch in
2976 @uref{http://gcc.gnu.org/ml/gcc/2002-08/msg00822.html}.
2977
2978 In Tru64 UNIX V5.1, Compaq introduced a new assembler that does not
2979 currently (2001-06-13) work with @command{mips-tfile}. As a workaround,
2980 we need to use the old assembler, invoked via the barely documented
2981 @option{-oldas} option. To bootstrap GCC, you either need to use the
2982 Compaq C Compiler:
2983
2984 @smallexample
2985 % CC=cc @var{srcdir}/configure [@var{options}] [@var{target}]
2986 @end smallexample
2987
2988 or you can use a copy of GCC 2.95.3 or higher built on Tru64 UNIX V4.0:
2989
2990 @smallexample
2991 % CC=gcc -Wa,-oldas @var{srcdir}/configure [@var{options}] [@var{target}]
2992 @end smallexample
2993
2994 As of GNU binutils 2.11.2, neither GNU @command{as} nor GNU @command{ld}
2995 are supported on Tru64 UNIX, so you must not configure GCC with
2996 @option{--with-gnu-as} or @option{--with-gnu-ld}.
2997
2998 GCC writes a @samp{.verstamp} directive to the assembler output file
2999 unless it is built as a cross-compiler. It gets the version to use from
3000 the system header file @file{/usr/include/stamp.h}. If you install a
3001 new version of DEC Unix, you should rebuild GCC to pick up the new version
3002 stamp.
3003
3004 @samp{make compare} may fail on old versions of DEC Unix unless you add
3005 @option{-save-temps} to @code{BOOT_CFLAGS}. On these systems, the name
3006 of the assembler input file is stored in the object file, and that makes
3007 comparison fail if it differs between the @code{stage1} and
3008 @code{stage2} compilations. The option @option{-save-temps} forces a
3009 fixed name to be used for the assembler input file, instead of a
3010 randomly chosen name in @file{/tmp}. Do not add @option{-save-temps}
3011 unless the comparisons fail without that option. If you add
3012 @option{-save-temps}, you will have to manually delete the @samp{.i} and
3013 @samp{.s} files after each series of compilations.
3014
3015 GCC now supports both the native (ECOFF) debugging format used by DBX
3016 and GDB and an encapsulated STABS format for use only with GDB@. See the
3017 discussion of the @option{--with-stabs} option of @file{configure} above
3018 for more information on these formats and how to select them.
3019
3020 There is a bug in DEC's assembler that produces incorrect line numbers
3021 for ECOFF format when the @samp{.align} directive is used. To work
3022 around this problem, GCC will not emit such alignment directives
3023 while writing ECOFF format debugging information even if optimization is
3024 being performed. Unfortunately, this has the very undesirable
3025 side-effect that code addresses when @option{-O} is specified are
3026 different depending on whether or not @option{-g} is also specified.
3027
3028 To avoid this behavior, specify @option{-gstabs+} and use GDB instead of
3029 DBX@. DEC is now aware of this problem with the assembler and hopes to
3030 provide a fix shortly.
3031
3032 @html
3033 <hr />
3034 @end html
3035 @heading @anchor{arc-x-elf}arc-*-elf
3036 Argonaut ARC processor.
3037 This configuration is intended for embedded systems.
3038
3039 @html
3040 <hr />
3041 @end html
3042 @heading @anchor{arm-x-elf}arm-*-elf
3043 ARM-family processors. Subtargets that use the ELF object format
3044 require GNU binutils 2.13 or newer. Such subtargets include:
3045 @code{arm-*-freebsd}, @code{arm-*-netbsdelf}, @code{arm-*-*linux}
3046 and @code{arm-*-rtems}.
3047
3048 @html
3049 <hr />
3050 @end html
3051 @heading @anchor{avr}avr
3052
3053 ATMEL AVR-family micro controllers. These are used in embedded
3054 applications. There are no standard Unix configurations.
3055 @ifnothtml
3056 @xref{AVR Options,, AVR Options, gcc, Using the GNU Compiler
3057 Collection (GCC)},
3058 @end ifnothtml
3059 @ifhtml
3060 See ``AVR Options'' in the main manual
3061 @end ifhtml
3062 for the list of supported MCU types.
3063
3064 Use @samp{configure --target=avr --enable-languages="c"} to configure GCC@.
3065
3066 Further installation notes and other useful information about AVR tools
3067 can also be obtained from:
3068
3069 @itemize @bullet
3070 @item
3071 @uref{http://www.nongnu.org/avr/,,http://www.nongnu.org/avr/}
3072 @item
3073 @uref{http://www.amelek.gda.pl/avr/,,http://www.amelek.gda.pl/avr/}
3074 @end itemize
3075
3076 We @emph{strongly} recommend using binutils 2.13 or newer.
3077
3078 The following error:
3079 @smallexample
3080 Error: register required
3081 @end smallexample
3082
3083 indicates that you should upgrade to a newer version of the binutils.
3084
3085 @html
3086 <hr />
3087 @end html
3088 @heading @anchor{bfin}Blackfin
3089
3090 The Blackfin processor, an Analog Devices DSP.
3091 @ifnothtml
3092 @xref{Blackfin Options,, Blackfin Options, gcc, Using the GNU Compiler
3093 Collection (GCC)},
3094 @end ifnothtml
3095 @ifhtml
3096 See ``Blackfin Options'' in the main manual
3097 @end ifhtml
3098
3099 More information, and a version of binutils with support for this processor,
3100 is available at @uref{http://blackfin.uclinux.org}
3101
3102 @html
3103 <hr />
3104 @end html
3105 @heading @anchor{cris}CRIS
3106
3107 CRIS is the CPU architecture in Axis Communications ETRAX system-on-a-chip
3108 series. These are used in embedded applications.
3109
3110 @ifnothtml
3111 @xref{CRIS Options,, CRIS Options, gcc, Using the GNU Compiler
3112 Collection (GCC)},
3113 @end ifnothtml
3114 @ifhtml
3115 See ``CRIS Options'' in the main manual
3116 @end ifhtml
3117 for a list of CRIS-specific options.
3118
3119 There are a few different CRIS targets:
3120 @table @code
3121 @item cris-axis-elf
3122 Mainly for monolithic embedded systems. Includes a multilib for the
3123 @samp{v10} core used in @samp{ETRAX 100 LX}.
3124 @item cris-axis-linux-gnu
3125 A GNU/Linux port for the CRIS architecture, currently targeting
3126 @samp{ETRAX 100 LX} by default.
3127 @end table
3128
3129 For @code{cris-axis-elf} you need binutils 2.11
3130 or newer. For @code{cris-axis-linux-gnu} you need binutils 2.12 or newer.
3131
3132 Pre-packaged tools can be obtained from
3133 @uref{ftp://ftp.axis.com/pub/axis/tools/cris/compiler-kit/}. More
3134 information about this platform is available at
3135 @uref{http://developer.axis.com/}.
3136
3137 @html
3138 <hr />
3139 @end html
3140 @heading @anchor{crx}CRX
3141
3142 The CRX CompactRISC architecture is a low-power 32-bit architecture with
3143 fast context switching and architectural extensibility features.
3144
3145 @ifnothtml
3146 @xref{CRX Options,, CRX Options, gcc, Using and Porting the GNU Compiler
3147 Collection (GCC)},
3148 @end ifnothtml
3149
3150 @ifhtml
3151 See ``CRX Options'' in the main manual for a list of CRX-specific options.
3152 @end ifhtml
3153
3154 Use @samp{configure --target=crx-elf --enable-languages=c,c++} to configure
3155 GCC@ for building a CRX cross-compiler. The option @samp{--target=crx-elf}
3156 is also used to build the @samp{newlib} C library for CRX.
3157
3158 It is also possible to build libstdc++-v3 for the CRX architecture. This
3159 needs to be done in a separate step with the following configure settings:
3160 @samp{gcc/libstdc++-v3/configure --host=crx-elf --with-newlib
3161 --enable-sjlj-exceptions --enable-cxx-flags='-fexceptions -frtti'}
3162
3163 @html
3164 <hr />
3165 @end html
3166 @heading @anchor{dos}DOS
3167
3168 Please have a look at the @uref{binaries.html,,binaries page}.
3169
3170 You cannot install GCC by itself on MSDOS; it will not compile under
3171 any MSDOS compiler except itself. You need to get the complete
3172 compilation package DJGPP, which includes binaries as well as sources,
3173 and includes all the necessary compilation tools and libraries.
3174
3175 @html
3176 <hr />
3177 @end html
3178 @heading @anchor{x-x-freebsd}*-*-freebsd*
3179
3180 Support for FreeBSD 1 was discontinued in GCC 3.2. Support for
3181 FreeBSD 2 (and any mutant a.out variants of FreeBSD 3) was
3182 discontinued in GCC 4.0.
3183
3184 We support FreeBSD using the ELF file format with DWARF 2 debugging
3185 for all CPU architectures. You may use @option{-gstabs} instead of
3186 @option{-g}, if you really want the old debugging format. There are
3187 no known issues with mixing object files and libraries with different
3188 debugging formats. Otherwise, this release of GCC should now match
3189 more of the configuration used in the stock FreeBSD configuration of
3190 GCC@. In particular, @option{--enable-threads} is now configured by
3191 default. However, as a general user, do not attempt to replace the
3192 system compiler with this release. Known to bootstrap and check with
3193 good results on FreeBSD 7.2-STABLE@. In the past, known to bootstrap
3194 and check with good results on FreeBSD 3.0, 3.4, 4.0, 4.2, 4.3, 4.4,
3195 4.5, 4.8, 4.9 and 5-CURRENT@.
3196
3197 The version of binutils installed in @file{/usr/bin} probably works
3198 with this release of GCC@. Bootstrapping against the latest GNU
3199 binutils and/or the version found in /usr/ports/devel/binutils has
3200 been known to enable additional features and improve overall testsuite
3201 results. However, it is currently known that boehm-gc (which itself
3202 is required for java) may not configure properly on FreeBSD prior to
3203 the FreeBSD 7.0 release with GNU binutils after 2.16.1.
3204
3205 @html
3206 <hr />
3207 @end html
3208 @heading @anchor{h8300-hms}h8300-hms
3209 Renesas H8/300 series of processors.
3210
3211 Please have a look at the @uref{binaries.html,,binaries page}.
3212
3213 The calling convention and structure layout has changed in release 2.6.
3214 All code must be recompiled. The calling convention now passes the
3215 first three arguments in function calls in registers. Structures are no
3216 longer a multiple of 2 bytes.
3217
3218 @html
3219 <hr />
3220 @end html
3221 @heading @anchor{hppa-hp-hpux}hppa*-hp-hpux*
3222 Support for HP-UX version 9 and older was discontinued in GCC 3.4.
3223
3224 We require using gas/binutils on all hppa platforms. Version 2.19 or
3225 later is recommended.
3226
3227 It may be helpful to configure GCC with the
3228 @uref{./configure.html#with-gnu-as,,@option{--with-gnu-as}} and
3229 @option{--with-as=@dots{}} options to ensure that GCC can find GAS@.
3230
3231 The HP assembler should not be used with GCC. It is rarely tested and may
3232 not work. It shouldn't be used with any languages other than C due to its
3233 many limitations.
3234
3235 Specifically, @option{-g} does not work (HP-UX uses a peculiar debugging
3236 format which GCC does not know about). It also inserts timestamps
3237 into each object file it creates, causing the 3-stage comparison test to
3238 fail during a bootstrap. You should be able to continue by saying
3239 @samp{make all-host all-target} after getting the failure from @samp{make}.
3240
3241 Various GCC features are not supported. For example, it does not support weak
3242 symbols or alias definitions. As a result, explicit template instantiations
3243 are required when using C++. This makes it difficult if not impossible to
3244 build many C++ applications.
3245
3246 There are two default scheduling models for instructions. These are
3247 PROCESSOR_7100LC and PROCESSOR_8000. They are selected from the pa-risc
3248 architecture specified for the target machine when configuring.
3249 PROCESSOR_8000 is the default. PROCESSOR_7100LC is selected when
3250 the target is a @samp{hppa1*} machine.
3251
3252 The PROCESSOR_8000 model is not well suited to older processors. Thus,
3253 it is important to completely specify the machine architecture when
3254 configuring if you want a model other than PROCESSOR_8000. The macro
3255 TARGET_SCHED_DEFAULT can be defined in BOOT_CFLAGS if a different
3256 default scheduling model is desired.
3257
3258 As of GCC 4.0, GCC uses the UNIX 95 namespace for HP-UX 10.10
3259 through 11.00, and the UNIX 98 namespace for HP-UX 11.11 and later.
3260 This namespace change might cause problems when bootstrapping with
3261 an earlier version of GCC or the HP compiler as essentially the same
3262 namespace is required for an entire build. This problem can be avoided
3263 in a number of ways. With HP cc, @env{UNIX_STD} can be set to @samp{95}
3264 or @samp{98}. Another way is to add an appropriate set of predefines
3265 to @env{CC}. The description for the @option{munix=} option contains
3266 a list of the predefines used with each standard.
3267
3268 More specific information to @samp{hppa*-hp-hpux*} targets follows.
3269
3270 @html
3271 <hr />
3272 @end html
3273 @heading @anchor{hppa-hp-hpux10}hppa*-hp-hpux10
3274
3275 For hpux10.20, we @emph{highly} recommend you pick up the latest sed patch
3276 @code{PHCO_19798} from HP@. HP has two sites which provide patches free of
3277 charge:
3278
3279 @itemize @bullet
3280 @item
3281 @html
3282 <a href="http://us.itrc.hp.com/service/home/home.do">US, Canada, Asia-Pacific, and
3283 Latin-America</a>
3284 @end html
3285 @ifnothtml
3286 @uref{http://us.itrc.hp.com/service/home/home.do,,} US, Canada, Asia-Pacific,
3287 and Latin-America.
3288 @end ifnothtml
3289 @item
3290 @uref{http://europe.itrc.hp.com/service/home/home.do,,} Europe.
3291 @end itemize
3292
3293 The C++ ABI has changed incompatibly in GCC 4.0. COMDAT subspaces are
3294 used for one-only code and data. This resolves many of the previous
3295 problems in using C++ on this target. However, the ABI is not compatible
3296 with the one implemented under HP-UX 11 using secondary definitions.
3297
3298 @html
3299 <hr />
3300 @end html
3301 @heading @anchor{hppa-hp-hpux11}hppa*-hp-hpux11
3302
3303 GCC 3.0 and up support HP-UX 11. GCC 2.95.x is not supported and cannot
3304 be used to compile GCC 3.0 and up.
3305
3306 The libffi and libjava libraries haven't been ported to 64-bit HP-UX@
3307 and don't build.
3308
3309 Refer to @uref{binaries.html,,binaries} for information about obtaining
3310 precompiled GCC binaries for HP-UX@. Precompiled binaries must be obtained
3311 to build the Ada language as it can't be bootstrapped using C@. Ada is
3312 only available for the 32-bit PA-RISC runtime.
3313
3314 Starting with GCC 3.4 an ISO C compiler is required to bootstrap. The
3315 bundled compiler supports only traditional C; you will need either HP's
3316 unbundled compiler, or a binary distribution of GCC@.
3317
3318 It is possible to build GCC 3.3 starting with the bundled HP compiler,
3319 but the process requires several steps. GCC 3.3 can then be used to
3320 build later versions. The fastjar program contains ISO C code and
3321 can't be built with the HP bundled compiler. This problem can be
3322 avoided by not building the Java language. For example, use the
3323 @option{--enable-languages="c,c++,f77,objc"} option in your configure
3324 command.
3325
3326 There are several possible approaches to building the distribution.
3327 Binutils can be built first using the HP tools. Then, the GCC
3328 distribution can be built. The second approach is to build GCC
3329 first using the HP tools, then build binutils, then rebuild GCC@.
3330 There have been problems with various binary distributions, so it
3331 is best not to start from a binary distribution.
3332
3333 On 64-bit capable systems, there are two distinct targets. Different
3334 installation prefixes must be used if both are to be installed on
3335 the same system. The @samp{hppa[1-2]*-hp-hpux11*} target generates code
3336 for the 32-bit PA-RISC runtime architecture and uses the HP linker.
3337 The @samp{hppa64-hp-hpux11*} target generates 64-bit code for the
3338 PA-RISC 2.0 architecture.
3339
3340 The script config.guess now selects the target type based on the compiler
3341 detected during configuration. You must define @env{PATH} or @env{CC} so
3342 that configure finds an appropriate compiler for the initial bootstrap.
3343 When @env{CC} is used, the definition should contain the options that are
3344 needed whenever @env{CC} is used.
3345
3346 Specifically, options that determine the runtime architecture must be
3347 in @env{CC} to correctly select the target for the build. It is also
3348 convenient to place many other compiler options in @env{CC}. For example,
3349 @env{CC="cc -Ac +DA2.0W -Wp,-H16376 -D_CLASSIC_TYPES -D_HPUX_SOURCE"}
3350 can be used to bootstrap the GCC 3.3 branch with the HP compiler in
3351 64-bit K&R/bundled mode. The @option{+DA2.0W} option will result in
3352 the automatic selection of the @samp{hppa64-hp-hpux11*} target. The
3353 macro definition table of cpp needs to be increased for a successful
3354 build with the HP compiler. _CLASSIC_TYPES and _HPUX_SOURCE need to
3355 be defined when building with the bundled compiler, or when using the
3356 @option{-Ac} option. These defines aren't necessary with @option{-Ae}.
3357
3358 It is best to explicitly configure the @samp{hppa64-hp-hpux11*} target
3359 with the @option{--with-ld=@dots{}} option. This overrides the standard
3360 search for ld. The two linkers supported on this target require different
3361 commands. The default linker is determined during configuration. As a
3362 result, it's not possible to switch linkers in the middle of a GCC build.
3363 This has been reported to sometimes occur in unified builds of binutils
3364 and GCC@.
3365
3366 A recent linker patch must be installed for the correct operation of
3367 GCC 3.3 and later. @code{PHSS_26559} and @code{PHSS_24304} are the
3368 oldest linker patches that are known to work. They are for HP-UX
3369 11.00 and 11.11, respectively. @code{PHSS_24303}, the companion to
3370 @code{PHSS_24304}, might be usable but it hasn't been tested. These
3371 patches have been superseded. Consult the HP patch database to obtain
3372 the currently recommended linker patch for your system.
3373
3374 The patches are necessary for the support of weak symbols on the
3375 32-bit port, and for the running of initializers and finalizers. Weak
3376 symbols are implemented using SOM secondary definition symbols. Prior
3377 to HP-UX 11, there are bugs in the linker support for secondary symbols.
3378 The patches correct a problem of linker core dumps creating shared
3379 libraries containing secondary symbols, as well as various other
3380 linking issues involving secondary symbols.
3381
3382 GCC 3.3 uses the ELF DT_INIT_ARRAY and DT_FINI_ARRAY capabilities to
3383 run initializers and finalizers on the 64-bit port. The 32-bit port
3384 uses the linker @option{+init} and @option{+fini} options for the same
3385 purpose. The patches correct various problems with the +init/+fini
3386 options, including program core dumps. Binutils 2.14 corrects a
3387 problem on the 64-bit port resulting from HP's non-standard use of
3388 the .init and .fini sections for array initializers and finalizers.
3389
3390 Although the HP and GNU linkers are both supported for the
3391 @samp{hppa64-hp-hpux11*} target, it is strongly recommended that the
3392 HP linker be used for link editing on this target.
3393
3394 At this time, the GNU linker does not support the creation of long
3395 branch stubs. As a result, it can't successfully link binaries
3396 containing branch offsets larger than 8 megabytes. In addition,
3397 there are problems linking shared libraries, linking executables
3398 with @option{-static}, and with dwarf2 unwind and exception support.
3399 It also doesn't provide stubs for internal calls to global functions
3400 in shared libraries, so these calls can't be overloaded.
3401
3402 The HP dynamic loader does not support GNU symbol versioning, so symbol
3403 versioning is not supported. It may be necessary to disable symbol
3404 versioning with @option{--disable-symvers} when using GNU ld.
3405
3406 POSIX threads are the default. The optional DCE thread library is not
3407 supported, so @option{--enable-threads=dce} does not work.
3408
3409 @html
3410 <hr />
3411 @end html
3412 @heading @anchor{x-x-linux-gnu}*-*-linux-gnu
3413
3414 Versions of libstdc++-v3 starting with 3.2.1 require bug fixes present
3415 in glibc 2.2.5 and later. More information is available in the
3416 libstdc++-v3 documentation.
3417
3418 @html
3419 <hr />
3420 @end html
3421 @heading @anchor{ix86-x-linux}i?86-*-linux*
3422
3423 As of GCC 3.3, binutils 2.13.1 or later is required for this platform.
3424 See @uref{http://gcc.gnu.org/PR10877,,bug 10877} for more information.
3425
3426 If you receive Signal 11 errors when building on GNU/Linux, then it is
3427 possible you have a hardware problem. Further information on this can be
3428 found on @uref{http://www.bitwizard.nl/sig11/,,www.bitwizard.nl}.
3429
3430 @html
3431 <hr />
3432 @end html
3433 @heading @anchor{ix86-x-solaris210}i?86-*-solaris2.10
3434 Use this for Solaris 10 or later on x86 and x86-64 systems. This
3435 configuration is supported by GCC 4.0 and later versions only.
3436
3437 It is recommended that you configure GCC to use the GNU assembler in
3438 @file{/usr/sfw/bin/gas} but the Sun linker, using the options
3439 @option{--with-gnu-as --with-as=/usr/sfw/bin/gas --without-gnu-ld
3440 --with-ld=/usr/ccs/bin/ld}.
3441
3442 @html
3443 <hr />
3444 @end html
3445 @heading @anchor{ia64-x-linux}ia64-*-linux
3446 IA-64 processor (also known as IPF, or Itanium Processor Family)
3447 running GNU/Linux.
3448
3449 If you are using the installed system libunwind library with
3450 @option{--with-system-libunwind}, then you must use libunwind 0.98 or
3451 later.
3452
3453 None of the following versions of GCC has an ABI that is compatible
3454 with any of the other versions in this list, with the exception that
3455 Red Hat 2.96 and Trillian 000171 are compatible with each other:
3456 3.1, 3.0.2, 3.0.1, 3.0, Red Hat 2.96, and Trillian 000717.
3457 This primarily affects C++ programs and programs that create shared libraries.
3458 GCC 3.1 or later is recommended for compiling linux, the kernel.
3459 As of version 3.1 GCC is believed to be fully ABI compliant, and hence no
3460 more major ABI changes are expected.
3461
3462 @html
3463 <hr />
3464 @end html
3465 @heading @anchor{ia64-x-hpux}ia64-*-hpux*
3466 Building GCC on this target requires the GNU Assembler. The bundled HP
3467 assembler will not work. To prevent GCC from using the wrong assembler,
3468 the option @option{--with-gnu-as} may be necessary.
3469
3470 The GCC libunwind library has not been ported to HPUX@. This means that for
3471 GCC versions 3.2.3 and earlier, @option{--enable-libunwind-exceptions}
3472 is required to build GCC@. For GCC 3.3 and later, this is the default.
3473 For gcc 3.4.3 and later, @option{--enable-libunwind-exceptions} is
3474 removed and the system libunwind library will always be used.
3475
3476 @html
3477 <hr />
3478 <!-- rs6000-ibm-aix*, powerpc-ibm-aix* -->
3479 @end html
3480 @heading @anchor{x-ibm-aix}*-ibm-aix*
3481 Support for AIX version 3 and older was discontinued in GCC 3.4.
3482 Support for AIX version 4.2 and older was discontinued in GCC 4.5.
3483
3484 ``out of memory'' bootstrap failures may indicate a problem with
3485 process resource limits (ulimit). Hard limits are configured in the
3486 @file{/etc/security/limits} system configuration file.
3487
3488 GCC can bootstrap with recent versions of IBM XLC, but bootstrapping
3489 with an earlier release of GCC is recommended. Bootstrapping with XLC
3490 requires a larger data segment, which can be enabled through the
3491 @var{LDR_CNTRL} environment variable, e.g.,
3492
3493 @smallexample
3494 % LDR_CNTRL=MAXDATA=0x50000000
3495 % export LDR_CNTRL
3496 @end smallexample
3497
3498 One can start with a pre-compiled version of GCC to build from
3499 sources. One may delete GCC's ``fixed'' header files when starting
3500 with a version of GCC built for an earlier release of AIX.
3501
3502 To speed up the configuration phases of bootstrapping and installing GCC,
3503 one may use GNU Bash instead of AIX @command{/bin/sh}, e.g.,
3504
3505 @smallexample
3506 % CONFIG_SHELL=/opt/freeware/bin/bash
3507 % export CONFIG_SHELL
3508 @end smallexample
3509
3510 and then proceed as described in @uref{build.html,,the build
3511 instructions}, where we strongly recommend specifying an absolute path
3512 to invoke @var{srcdir}/configure.
3513
3514 Because GCC on AIX is built as a 32-bit executable by default,
3515 (although it can generate 64-bit programs) the GMP and MPFR libraries
3516 required by gfortran must be 32-bit libraries. Building GMP and MPFR
3517 as static archive libraries works better than shared libraries.
3518
3519 Errors involving @code{alloca} when building GCC generally are due
3520 to an incorrect definition of @code{CC} in the Makefile or mixing files
3521 compiled with the native C compiler and GCC@. During the stage1 phase of
3522 the build, the native AIX compiler @strong{must} be invoked as @command{cc}
3523 (not @command{xlc}). Once @command{configure} has been informed of
3524 @command{xlc}, one needs to use @samp{make distclean} to remove the
3525 configure cache files and ensure that @env{CC} environment variable
3526 does not provide a definition that will confuse @command{configure}.
3527 If this error occurs during stage2 or later, then the problem most likely
3528 is the version of Make (see above).
3529
3530 The native @command{as} and @command{ld} are recommended for bootstrapping
3531 on AIX@. The GNU Assembler, GNU Linker, and GNU Binutils version 2.20
3532 is required to bootstrap on AIX 5@. The native AIX tools do
3533 interoperate with GCC@.
3534
3535 Building @file{libstdc++.a} requires a fix for an AIX Assembler bug
3536 APAR IY26685 (AIX 4.3) or APAR IY25528 (AIX 5.1). It also requires a
3537 fix for another AIX Assembler bug and a co-dependent AIX Archiver fix
3538 referenced as APAR IY53606 (AIX 5.2) or as APAR IY54774 (AIX 5.1)
3539
3540 @samp{libstdc++} in GCC 3.4 increments the major version number of the
3541 shared object and GCC installation places the @file{libstdc++.a}
3542 shared library in a common location which will overwrite the and GCC
3543 3.3 version of the shared library. Applications either need to be
3544 re-linked against the new shared library or the GCC 3.1 and GCC 3.3
3545 versions of the @samp{libstdc++} shared object needs to be available
3546 to the AIX runtime loader. The GCC 3.1 @samp{libstdc++.so.4}, if
3547 present, and GCC 3.3 @samp{libstdc++.so.5} shared objects can be
3548 installed for runtime dynamic loading using the following steps to set
3549 the @samp{F_LOADONLY} flag in the shared object for @emph{each}
3550 multilib @file{libstdc++.a} installed:
3551
3552 Extract the shared objects from the currently installed
3553 @file{libstdc++.a} archive:
3554 @smallexample
3555 % ar -x libstdc++.a libstdc++.so.4 libstdc++.so.5
3556 @end smallexample
3557
3558 Enable the @samp{F_LOADONLY} flag so that the shared object will be
3559 available for runtime dynamic loading, but not linking:
3560 @smallexample
3561 % strip -e libstdc++.so.4 libstdc++.so.5
3562 @end smallexample
3563
3564 Archive the runtime-only shared object in the GCC 3.4
3565 @file{libstdc++.a} archive:
3566 @smallexample
3567 % ar -q libstdc++.a libstdc++.so.4 libstdc++.so.5
3568 @end smallexample
3569
3570 Linking executables and shared libraries may produce warnings of
3571 duplicate symbols. The assembly files generated by GCC for AIX always
3572 have included multiple symbol definitions for certain global variable
3573 and function declarations in the original program. The warnings should
3574 not prevent the linker from producing a correct library or runnable
3575 executable.
3576
3577 AIX 4.3 utilizes a ``large format'' archive to support both 32-bit and
3578 64-bit object modules. The routines provided in AIX 4.3.0 and AIX 4.3.1
3579 to parse archive libraries did not handle the new format correctly.
3580 These routines are used by GCC and result in error messages during
3581 linking such as ``not a COFF file''. The version of the routines shipped
3582 with AIX 4.3.1 should work for a 32-bit environment. The @option{-g}
3583 option of the archive command may be used to create archives of 32-bit
3584 objects using the original ``small format''. A correct version of the
3585 routines is shipped with AIX 4.3.2 and above.
3586
3587 Some versions of the AIX binder (linker) can fail with a relocation
3588 overflow severe error when the @option{-bbigtoc} option is used to link
3589 GCC-produced object files into an executable that overflows the TOC@. A fix
3590 for APAR IX75823 (OVERFLOW DURING LINK WHEN USING GCC AND -BBIGTOC) is
3591 available from IBM Customer Support and from its
3592 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3593 website as PTF U455193.
3594
3595 The AIX 4.3.2.1 linker (bos.rte.bind_cmds Level 4.3.2.1) will dump core
3596 with a segmentation fault when invoked by any version of GCC@. A fix for
3597 APAR IX87327 is available from IBM Customer Support and from its
3598 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3599 website as PTF U461879. This fix is incorporated in AIX 4.3.3 and above.
3600
3601 The initial assembler shipped with AIX 4.3.0 generates incorrect object
3602 files. A fix for APAR IX74254 (64BIT DISASSEMBLED OUTPUT FROM COMPILER FAILS
3603 TO ASSEMBLE/BIND) is available from IBM Customer Support and from its
3604 @uref{http://techsupport.services.ibm.com/,,techsupport.services.ibm.com}
3605 website as PTF U453956. This fix is incorporated in AIX 4.3.1 and above.
3606
3607 AIX provides National Language Support (NLS)@. Compilers and assemblers
3608 use NLS to support locale-specific representations of various data
3609 formats including floating-point numbers (e.g., @samp{.} vs @samp{,} for
3610 separating decimal fractions). There have been problems reported where
3611 GCC does not produce the same floating-point formats that the assembler
3612 expects. If one encounters this problem, set the @env{LANG}
3613 environment variable to @samp{C} or @samp{En_US}.
3614
3615 A default can be specified with the @option{-mcpu=@var{cpu_type}}
3616 switch and using the configure option @option{--with-cpu-@var{cpu_type}}.
3617
3618 @html
3619 <hr />
3620 @end html
3621 @heading @anchor{iq2000-x-elf}iq2000-*-elf
3622 Vitesse IQ2000 processors. These are used in embedded
3623 applications. There are no standard Unix configurations.
3624
3625 @html
3626 <hr />
3627 @end html
3628 @heading @anchor{m32c-x-elf}m32c-*-elf
3629 Renesas M32C processor.
3630 This configuration is intended for embedded systems.
3631
3632 @html
3633 <hr />
3634 @end html
3635 @heading @anchor{m32r-x-elf}m32r-*-elf
3636 Renesas M32R processor.
3637 This configuration is intended for embedded systems.
3638
3639 @html
3640 <hr />
3641 @end html
3642 @heading @anchor{m6811-elf}m6811-elf
3643 Motorola 68HC11 family micro controllers. These are used in embedded
3644 applications. There are no standard Unix configurations.
3645
3646 @html
3647 <hr />
3648 @end html
3649 @heading @anchor{m6812-elf}m6812-elf
3650 Motorola 68HC12 family micro controllers. These are used in embedded
3651 applications. There are no standard Unix configurations.
3652
3653 @html
3654 <hr />
3655 @end html
3656 @heading @anchor{m68k-x-x}m68k-*-*
3657 By default,
3658 @samp{m68k-*-elf*}, @samp{m68k-*-rtems}, @samp{m68k-*-uclinux} and
3659 @samp{m68k-*-linux}
3660 build libraries for both M680x0 and ColdFire processors. If you only
3661 need the M680x0 libraries, you can omit the ColdFire ones by passing
3662 @option{--with-arch=m68k} to @command{configure}. Alternatively, you
3663 can omit the M680x0 libraries by passing @option{--with-arch=cf} to
3664 @command{configure}. These targets default to 5206 or 5475 code as
3665 appropriate for the target system when
3666 configured with @option{--with-arch=cf} and 68020 code otherwise.
3667
3668 The @samp{m68k-*-netbsd} and
3669 @samp{m68k-*-openbsd} targets also support the @option{--with-arch}
3670 option. They will generate ColdFire CFV4e code when configured with
3671 @option{--with-arch=cf} and 68020 code otherwise.
3672
3673 You can override the default processors listed above by configuring
3674 with @option{--with-cpu=@var{target}}. This @var{target} can either
3675 be a @option{-mcpu} argument or one of the following values:
3676 @samp{m68000}, @samp{m68010}, @samp{m68020}, @samp{m68030},
3677 @samp{m68040}, @samp{m68060}, @samp{m68020-40} and @samp{m68020-60}.
3678
3679 @html
3680 <hr />
3681 @end html
3682 @heading @anchor{m68k-x-uclinux}m68k-*-uclinux
3683 GCC 4.3 changed the uClinux configuration so that it uses the
3684 @samp{m68k-linux-gnu} ABI rather than the @samp{m68k-elf} ABI.
3685 It also added improved support for C++ and flat shared libraries,
3686 both of which were ABI changes. However, you can still use the
3687 original ABI by configuring for @samp{m68k-uclinuxoldabi} or
3688 @samp{m68k-@var{vendor}-uclinuxoldabi}.
3689
3690
3691 @html
3692 <hr />
3693 @end html
3694 @heading @anchor{mep-x-elf}mep-*-elf
3695 Toshiba Media embedded Processor.
3696 This configuration is intended for embedded systems.
3697
3698 @html
3699 <hr />
3700 @end html
3701 @heading @anchor{mips-x-x}mips-*-*
3702 If on a MIPS system you get an error message saying ``does not have gp
3703 sections for all it's [sic] sectons [sic]'', don't worry about it. This
3704 happens whenever you use GAS with the MIPS linker, but there is not
3705 really anything wrong, and it is okay to use the output file. You can
3706 stop such warnings by installing the GNU linker.
3707
3708 It would be nice to extend GAS to produce the gp tables, but they are
3709 optional, and there should not be a warning about their absence.
3710
3711 The libstdc++ atomic locking routines for MIPS targets requires MIPS II
3712 and later. A patch went in just after the GCC 3.3 release to
3713 make @samp{mips*-*-*} use the generic implementation instead. You can also
3714 configure for @samp{mipsel-elf} as a workaround. The
3715 @samp{mips*-*-linux*} target continues to use the MIPS II routines. More
3716 work on this is expected in future releases.
3717
3718 @c If you make --with-llsc the default for another target, please also
3719 @c update the description of the --with-llsc option.
3720
3721 The built-in @code{__sync_*} functions are available on MIPS II and
3722 later systems and others that support the @samp{ll}, @samp{sc} and
3723 @samp{sync} instructions. This can be overridden by passing
3724 @option{--with-llsc} or @option{--without-llsc} when configuring GCC.
3725 Since the Linux kernel emulates these instructions if they are
3726 missing, the default for @samp{mips*-*-linux*} targets is
3727 @option{--with-llsc}. The @option{--with-llsc} and
3728 @option{--without-llsc} configure options may be overridden at compile
3729 time by passing the @option{-mllsc} or @option{-mno-llsc} options to
3730 the compiler.
3731
3732 MIPS systems check for division by zero (unless
3733 @option{-mno-check-zero-division} is passed to the compiler) by
3734 generating either a conditional trap or a break instruction. Using
3735 trap results in smaller code, but is only supported on MIPS II and
3736 later. Also, some versions of the Linux kernel have a bug that
3737 prevents trap from generating the proper signal (@code{SIGFPE}). To enable
3738 the use of break, use the @option{--with-divide=breaks}
3739 @command{configure} option when configuring GCC@. The default is to
3740 use traps on systems that support them.
3741
3742 Cross-compilers for the MIPS as target using the MIPS assembler
3743 currently do not work, because the auxiliary programs
3744 @file{mips-tdump.c} and @file{mips-tfile.c} can't be compiled on
3745 anything but a MIPS@. It does work to cross compile for a MIPS
3746 if you use the GNU assembler and linker.
3747
3748 The assembler from GNU binutils 2.17 and earlier has a bug in the way
3749 it sorts relocations for REL targets (o32, o64, EABI). This can cause
3750 bad code to be generated for simple C++ programs. Also the linker
3751 from GNU binutils versions prior to 2.17 has a bug which causes the
3752 runtime linker stubs in very large programs, like @file{libgcj.so}, to
3753 be incorrectly generated. GNU Binutils 2.18 and later (and snapshots
3754 made after Nov. 9, 2006) should be free from both of these problems.
3755
3756 @html
3757 <hr />
3758 @end html
3759 @heading @anchor{mips-sgi-irix5}mips-sgi-irix5
3760
3761 In order to compile GCC on an SGI running IRIX 5, the @samp{compiler_dev.hdr}
3762 subsystem must be installed from the IDO CD-ROM supplied by SGI@.
3763 It is also available for download from
3764 @uref{ftp://ftp.sgi.com/sgi/IRIX5.3/iris-development-option-5.3.tardist}.
3765
3766 If you use the MIPS C compiler to bootstrap, it may be necessary
3767 to increase its table size for switch statements with the
3768 @option{-Wf,-XNg1500} option. If you use the @option{-O2}
3769 optimization option, you also need to use @option{-Olimit 3000}.
3770
3771 To enable debugging under IRIX 5, you must use GNU binutils 2.15 or
3772 later, and use the @option{--with-gnu-ld} @command{configure} option
3773 when configuring GCC@. You need to use GNU @command{ar} and @command{nm},
3774 also distributed with GNU binutils.
3775
3776 Some users have reported that @command{/bin/sh} will hang during bootstrap.
3777 This problem can be avoided by running the commands:
3778
3779 @smallexample
3780 % CONFIG_SHELL=/bin/ksh
3781 % export CONFIG_SHELL
3782 @end smallexample
3783
3784 before starting the build.
3785
3786 @html
3787 <hr />
3788 @end html
3789 @heading @anchor{mips-sgi-irix6}mips-sgi-irix6
3790
3791 If you are using SGI's MIPSpro @command{cc} as your bootstrap compiler, you must
3792 ensure that the N32 ABI is in use. To test this, compile a simple C
3793 file with @command{cc} and then run @command{file} on the
3794 resulting object file. The output should look like:
3795
3796 @smallexample
3797 test.o: ELF N32 MSB @dots{}
3798 @end smallexample
3799
3800 If you see:
3801
3802 @smallexample
3803 test.o: ELF 32-bit MSB @dots{}
3804 @end smallexample
3805
3806 or
3807
3808 @smallexample
3809 test.o: ELF 64-bit MSB @dots{}
3810 @end smallexample
3811
3812 then your version of @command{cc} uses the O32 or N64 ABI by default. You
3813 should set the environment variable @env{CC} to @samp{cc -n32}
3814 before configuring GCC@.
3815
3816 If you want the resulting @command{gcc} to run on old 32-bit systems
3817 with the MIPS R4400 CPU, you need to ensure that only code for the @samp{mips3}
3818 instruction set architecture (ISA) is generated. While GCC 3.x does
3819 this correctly, both GCC 2.95 and SGI's MIPSpro @command{cc} may change
3820 the ISA depending on the machine where GCC is built. Using one of them
3821 as the bootstrap compiler may result in @samp{mips4} code, which won't run at
3822 all on @samp{mips3}-only systems. For the test program above, you should see:
3823
3824 @smallexample
3825 test.o: ELF N32 MSB mips-3 @dots{}
3826 @end smallexample
3827
3828 If you get:
3829
3830 @smallexample
3831 test.o: ELF N32 MSB mips-4 @dots{}
3832 @end smallexample
3833
3834 instead, you should set the environment variable @env{CC} to @samp{cc
3835 -n32 -mips3} or @samp{gcc -mips3} respectively before configuring GCC@.
3836
3837 MIPSpro C 7.4 may cause bootstrap failures, due to a bug when inlining
3838 @code{memcmp}. Either add @code{-U__INLINE_INTRINSICS} to the @env{CC}
3839 environment variable as a workaround or upgrade to MIPSpro C 7.4.1m.
3840
3841 GCC on IRIX 6 is usually built to support the N32, O32 and N64 ABIs. If
3842 you build GCC on a system that doesn't have the N64 libraries installed
3843 or cannot run 64-bit binaries,
3844 you need to configure with @option{--disable-multilib} so GCC doesn't
3845 try to use them. This will disable building the O32 libraries, too.
3846 Look for @file{/usr/lib64/libc.so.1} to see if you
3847 have the 64-bit libraries installed.
3848
3849 To enable debugging for the O32 ABI, you must use GNU @command{as} from
3850 GNU binutils 2.15 or later. You may also use GNU @command{ld}, but
3851 this is not required and currently causes some problems with Ada.
3852
3853 The @option{--enable-libgcj}
3854 option is disabled by default: IRIX 6 uses a very low default limit
3855 (20480) for the command line length. Although @command{libtool} contains a
3856 workaround for this problem, at least the N64 @samp{libgcj} is known not
3857 to build despite this, running into an internal error of the native
3858 @command{ld}. A sure fix is to increase this limit (@samp{ncargs}) to
3859 its maximum of 262144 bytes. If you have root access, you can use the
3860 @command{systune} command to do this.
3861
3862 @code{wchar_t} support in @samp{libstdc++} is not available for old
3863 IRIX 6.5.x releases, @math{x < 19}. The problem cannot be autodetected
3864 and in order to build GCC for such targets you need to configure with
3865 @option{--disable-wchar_t}.
3866
3867 See @uref{http://freeware.sgi.com/} for more
3868 information about using GCC on IRIX platforms.
3869
3870 @html
3871 <hr />
3872 @end html
3873 @heading @anchor{moxie-x-elf}moxie-*-elf
3874 The moxie processor. See @uref{http://moxielogic.org/} for more
3875 information about this processor.
3876
3877 @html
3878 <hr />
3879 @end html
3880 @heading @anchor{powerpc-x-x}powerpc-*-*
3881
3882 You can specify a default version for the @option{-mcpu=@var{cpu_type}}
3883 switch by using the configure option @option{--with-cpu-@var{cpu_type}}.
3884
3885 You will need
3886 @uref{ftp://ftp.kernel.org/pub/linux/devel/binutils,,binutils 2.15}
3887 or newer for a working GCC@.
3888
3889 @html
3890 <hr />
3891 @end html
3892 @heading @anchor{powerpc-x-darwin}powerpc-*-darwin*
3893 PowerPC running Darwin (Mac OS X kernel).
3894
3895 Pre-installed versions of Mac OS X may not include any developer tools,
3896 meaning that you will not be able to build GCC from source. Tool
3897 binaries are available at
3898 @uref{http://developer.apple.com/darwin/projects/compiler/} (free
3899 registration required).
3900
3901 This version of GCC requires at least cctools-590.36. The
3902 cctools-590.36 package referenced from
3903 @uref{http://gcc.gnu.org/ml/gcc/2006-03/msg00507.html} will not work
3904 on systems older than 10.3.9 (aka darwin7.9.0).
3905
3906 @html
3907 <hr />
3908 @end html
3909 @heading @anchor{powerpc-x-elf}powerpc-*-elf
3910 PowerPC system in big endian mode, running System V.4.
3911
3912 @html
3913 <hr />
3914 @end html
3915 @heading @anchor{powerpc-x-linux-gnu}powerpc*-*-linux-gnu*
3916
3917 PowerPC system in big endian mode running Linux.
3918
3919 @html
3920 <hr />
3921 @end html
3922 @heading @anchor{powerpc-x-netbsd}powerpc-*-netbsd*
3923 PowerPC system in big endian mode running NetBSD@.
3924
3925 @html
3926 <hr />
3927 @end html
3928 @heading @anchor{powerpc-x-eabisim}powerpc-*-eabisim
3929 Embedded PowerPC system in big endian mode for use in running under the
3930 PSIM simulator.
3931
3932 @html
3933 <hr />
3934 @end html
3935 @heading @anchor{powerpc-x-eabi}powerpc-*-eabi
3936 Embedded PowerPC system in big endian mode.
3937
3938 @html
3939 <hr />
3940 @end html
3941 @heading @anchor{powerpcle-x-elf}powerpcle-*-elf
3942 PowerPC system in little endian mode, running System V.4.
3943
3944 @html
3945 <hr />
3946 @end html
3947 @heading @anchor{powerpcle-x-eabisim}powerpcle-*-eabisim
3948 Embedded PowerPC system in little endian mode for use in running under
3949 the PSIM simulator.
3950
3951 @html
3952 <hr />
3953 @end html
3954 @heading @anchor{powerpcle-x-eabi}powerpcle-*-eabi
3955 Embedded PowerPC system in little endian mode.
3956
3957 @html
3958 <hr />
3959 @end html
3960 @heading @anchor{s390-x-linux}s390-*-linux*
3961 S/390 system running GNU/Linux for S/390@.
3962
3963 @html
3964 <hr />
3965 @end html
3966 @heading @anchor{s390x-x-linux}s390x-*-linux*
3967 zSeries system (64-bit) running GNU/Linux for zSeries@.
3968
3969 @html
3970 <hr />
3971 @end html
3972 @heading @anchor{s390x-ibm-tpf}s390x-ibm-tpf*
3973 zSeries system (64-bit) running TPF@. This platform is
3974 supported as cross-compilation target only.
3975
3976 @html
3977 <hr />
3978 @end html
3979 @c Please use Solaris 2 to refer to all release of Solaris, starting
3980 @c with 2.0 until 2.6, 7, 8, etc. Solaris 1 was a marketing name for
3981 @c SunOS 4 releases which we don't use to avoid confusion. Solaris
3982 @c alone is too unspecific and must be avoided.
3983 @heading @anchor{x-x-solaris2}*-*-solaris2*
3984
3985 Sun does not ship a C compiler with Solaris 2. To bootstrap and install
3986 GCC you first have to install a pre-built compiler, see the
3987 @uref{binaries.html,,binaries page} for details.
3988
3989 The Solaris 2 @command{/bin/sh} will often fail to configure
3990 @file{libstdc++-v3}, @file{boehm-gc} or @file{libjava}. We therefore
3991 recommend using the following initial sequence of commands
3992
3993 @smallexample
3994 % CONFIG_SHELL=/bin/ksh
3995 % export CONFIG_SHELL
3996 @end smallexample
3997
3998 and proceed as described in @uref{configure.html,,the configure instructions}.
3999 In addition we strongly recommend specifying an absolute path to invoke
4000 @var{srcdir}/configure.
4001
4002 Solaris 2 comes with a number of optional OS packages. Some of these
4003 are needed to use GCC fully, namely @code{SUNWarc},
4004 @code{SUNWbtool}, @code{SUNWesu}, @code{SUNWhea}, @code{SUNWlibm},
4005 @code{SUNWsprot}, and @code{SUNWtoo}. If you did not install all
4006 optional packages when installing Solaris 2, you will need to verify that
4007 the packages that GCC needs are installed.
4008
4009 To check whether an optional package is installed, use
4010 the @command{pkginfo} command. To add an optional package, use the
4011 @command{pkgadd} command. For further details, see the Solaris 2
4012 documentation.
4013
4014 Trying to use the linker and other tools in
4015 @file{/usr/ucb} to install GCC has been observed to cause trouble.
4016 For example, the linker may hang indefinitely. The fix is to remove
4017 @file{/usr/ucb} from your @env{PATH}.
4018
4019 The build process works more smoothly with the legacy Sun tools so, if you
4020 have @file{/usr/xpg4/bin} in your @env{PATH}, we recommend that you place
4021 @file{/usr/bin} before @file{/usr/xpg4/bin} for the duration of the build.
4022
4023 We recommend the use of GNU binutils 2.14 or later, or the vendor tools
4024 (Sun @command{as}, Sun @command{ld}). Note that your mileage may vary
4025 if you use a combination of the GNU tools and the Sun tools: while the
4026 combination GNU @command{as} + Sun @command{ld} should reasonably work,
4027 the reverse combination Sun @command{as} + GNU @command{ld} is known to
4028 cause memory corruption at runtime in some cases for C++ programs.
4029
4030 The stock GNU binutils 2.15 release is broken on this platform because of a
4031 single bug. It has been fixed on the 2.15 branch in the CVS repository.
4032 You can obtain a working version by checking out the binutils-2_15-branch
4033 from the CVS repository or applying the patch
4034 @uref{http://sourceware.org/ml/binutils-cvs/2004-09/msg00036.html} to the
4035 release.
4036
4037 We recommend the use of GNU binutils 2.16 or later in conjunction with GCC
4038 4.x, or the vendor tools (Sun @command{as}, Sun @command{ld}). However,
4039 for Solaris 10 and above, an additional patch is required in order for the
4040 GNU linker to be able to cope with a new flavor of shared libraries. You
4041 can obtain a working version by checking out the binutils-2_16-branch from
4042 the CVS repository or applying the patch
4043 @uref{http://sourceware.org/ml/binutils-cvs/2005-07/msg00122.html} to the
4044 release.
4045
4046 Sun bug 4296832 turns up when compiling X11 headers with GCC 2.95 or
4047 newer: @command{g++} will complain that types are missing. These headers
4048 assume that omitting the type means @code{int}; this assumption worked for
4049 C89 but is wrong for C++, and is now wrong for C99 also.
4050
4051 @command{g++} accepts such (invalid) constructs with the option
4052 @option{-fpermissive}; it will assume that any missing type is @code{int}
4053 (as defined by C89).
4054
4055 There are patches for Solaris 7 (108376-21 or newer for SPARC,
4056 108377-20 for Intel), and Solaris 8 (108652-24 or newer for SPARC,
4057 108653-22 for Intel) that fix this bug.
4058
4059 Sun bug 4927647 sometimes causes random spurious testsuite failures
4060 related to missing diagnostic output. This bug doesn't affect GCC
4061 itself, rather it is a kernel bug triggered by the @command{expect}
4062 program which is used only by the GCC testsuite driver. When the bug
4063 causes the @command{expect} program to miss anticipated output, extra
4064 testsuite failures appear.
4065
4066 There are patches for Solaris 8 (117350-12 or newer for SPARC,
4067 117351-12 or newer for Intel) and Solaris 9 (117171-11 or newer for
4068 SPARC, 117172-11 or newer for Intel) that address this problem.
4069
4070 @html
4071 <hr />
4072 @end html
4073 @heading @anchor{sparc-sun-solaris2}sparc-sun-solaris2*
4074
4075 When GCC is configured to use binutils 2.14 or later the binaries
4076 produced are smaller than the ones produced using Sun's native tools;
4077 this difference is quite significant for binaries containing debugging
4078 information.
4079
4080 Starting with Solaris 7, the operating system is capable of executing
4081 64-bit SPARC V9 binaries. GCC 3.1 and later properly supports
4082 this; the @option{-m64} option enables 64-bit code generation.
4083 However, if all you want is code tuned for the UltraSPARC CPU, you
4084 should try the @option{-mtune=ultrasparc} option instead, which produces
4085 code that, unlike full 64-bit code, can still run on non-UltraSPARC
4086 machines.
4087
4088 When configuring on a Solaris 7 or later system that is running a kernel
4089 that supports only 32-bit binaries, one must configure with
4090 @option{--disable-multilib}, since we will not be able to build the
4091 64-bit target libraries.
4092
4093 GCC 3.3 and GCC 3.4 trigger code generation bugs in earlier versions of
4094 the GNU compiler (especially GCC 3.0.x versions), which lead to the
4095 miscompilation of the stage1 compiler and the subsequent failure of the
4096 bootstrap process. A workaround is to use GCC 3.2.3 as an intermediary
4097 stage, i.e.@: to bootstrap that compiler with the base compiler and then
4098 use it to bootstrap the final compiler.
4099
4100 GCC 3.4 triggers a code generation bug in versions 5.4 (Sun ONE Studio 7)
4101 and 5.5 (Sun ONE Studio 8) of the Sun compiler, which causes a bootstrap
4102 failure in form of a miscompilation of the stage1 compiler by the Sun
4103 compiler. This is Sun bug 4974440. This is fixed with patch 112760-07.
4104
4105 GCC 3.4 changed the default debugging format from STABS to DWARF-2 for
4106 32-bit code on Solaris 7 and later. If you use the Sun assembler, this
4107 change apparently runs afoul of Sun bug 4910101 (which is referenced as
4108 an x86-only problem by Sun, probably because they do not use DWARF-2).
4109 A symptom of the problem is that you cannot compile C++ programs like
4110 @command{groff} 1.19.1 without getting messages similar to the following:
4111
4112 @smallexample
4113 ld: warning: relocation error: R_SPARC_UA32: @dots{}
4114 external symbolic relocation against non-allocatable section
4115 .debug_info cannot be processed at runtime: relocation ignored.
4116 @end smallexample
4117
4118 To work around this problem, compile with @option{-gstabs+} instead of
4119 plain @option{-g}.
4120
4121 When configuring the GNU Multiple Precision Library (GMP) or the MPFR
4122 library on a Solaris 7 or later system, the canonical target triplet
4123 must be specified as the @command{build} parameter on the configure
4124 line. This triplet can be obtained by invoking ./config.guess in
4125 the toplevel source directory of GCC (and not that of GMP or MPFR).
4126 For example on a Solaris 7 system:
4127
4128 @smallexample
4129 % ./configure --build=sparc-sun-solaris2.7 --prefix=xxx
4130 @end smallexample
4131
4132 @html
4133 <hr />
4134 @end html
4135 @heading @anchor{sparc-sun-solaris27}sparc-sun-solaris2.7
4136
4137 Sun patch 107058-01 (1999-01-13) for Solaris 7/SPARC triggers a bug in
4138 the dynamic linker. This problem (Sun bug 4210064) affects GCC 2.8
4139 and later, including all EGCS releases. Sun formerly recommended
4140 107058-01 for all Solaris 7 users, but around 1999-09-01 it started to
4141 recommend it only for people who use Sun's compilers.
4142
4143 Here are some workarounds to this problem:
4144 @itemize @bullet
4145 @item
4146 Do not install Sun patch 107058-01 until after Sun releases a
4147 complete patch for bug 4210064. This is the simplest course to take,
4148 unless you must also use Sun's C compiler. Unfortunately 107058-01
4149 is preinstalled on some new Solaris 7-based hosts, so you may have to
4150 back it out.
4151
4152 @item
4153 Copy the original, unpatched Solaris 7
4154 @command{/usr/ccs/bin/as} into
4155 @command{/usr/local/libexec/gcc/sparc-sun-solaris2.7/3.4/as},
4156 adjusting the latter name to fit your local conventions and software
4157 version numbers.
4158
4159 @item
4160 Install Sun patch 106950-03 (1999-05-25) or later. Nobody with
4161 both 107058-01 and 106950-03 installed has reported the bug with GCC
4162 and Sun's dynamic linker. This last course of action is riskiest,
4163 for two reasons. First, you must install 106950 on all hosts that
4164 run code generated by GCC; it doesn't suffice to install it only on
4165 the hosts that run GCC itself. Second, Sun says that 106950-03 is
4166 only a partial fix for bug 4210064, but Sun doesn't know whether the
4167 partial fix is adequate for GCC@. Revision -08 or later should fix
4168 the bug. The current (as of 2004-05-23) revision is -24, and is included in
4169 the Solaris 7 Recommended Patch Cluster.
4170 @end itemize
4171
4172 GCC 3.3 triggers a bug in version 5.0 Alpha 03/27/98 of the Sun assembler,
4173 which causes a bootstrap failure when linking the 64-bit shared version of
4174 libgcc. A typical error message is:
4175
4176 @smallexample
4177 ld: fatal: relocation error: R_SPARC_32: file libgcc/sparcv9/_muldi3.o:
4178 symbol <unknown>: offset 0xffffffff7ec133e7 is non-aligned.
4179 @end smallexample
4180
4181 This bug has been fixed in the final 5.0 version of the assembler.
4182
4183 A similar problem was reported for version Sun WorkShop 6 99/08/18 of the
4184 Sun assembler, which causes a bootstrap failure with GCC 4.0.0:
4185
4186 @smallexample
4187 ld: fatal: relocation error: R_SPARC_DISP32:
4188 file .libs/libstdc++.lax/libsupc++convenience.a/vterminate.o:
4189 symbol <unknown>: offset 0xfccd33ad is non-aligned
4190 @end smallexample
4191
4192 This bug has been fixed in more recent revisions of the assembler.
4193
4194 @html
4195 <hr />
4196 @end html
4197 @heading @anchor{sparc-x-linux}sparc-*-linux*
4198
4199 GCC versions 3.0 and higher require binutils 2.11.2 and glibc 2.2.4
4200 or newer on this platform. All earlier binutils and glibc
4201 releases mishandled unaligned relocations on @code{sparc-*-*} targets.
4202
4203
4204 @html
4205 <hr />
4206 @end html
4207 @heading @anchor{sparc64-x-solaris2}sparc64-*-solaris2*
4208
4209 When configuring the GNU Multiple Precision Library (GMP) or the
4210 MPFR library, the canonical target triplet must be specified as
4211 the @command{build} parameter on the configure line. For example
4212 on a Solaris 7 system:
4213
4214 @smallexample
4215 % ./configure --build=sparc64-sun-solaris2.7 --prefix=xxx
4216 @end smallexample
4217
4218 The following compiler flags must be specified in the configure
4219 step in order to bootstrap this target with the Sun compiler:
4220
4221 @smallexample
4222 % CC="cc -xarch=v9 -xildoff" @var{srcdir}/configure [@var{options}] [@var{target}]
4223 @end smallexample
4224
4225 @option{-xarch=v9} specifies the SPARC-V9 architecture to the Sun toolchain
4226 and @option{-xildoff} turns off the incremental linker.
4227
4228 @html
4229 <hr />
4230 @end html
4231 @heading @anchor{sparcv9-x-solaris2}sparcv9-*-solaris2*
4232
4233 This is a synonym for sparc64-*-solaris2*.
4234
4235 @html
4236 <hr />
4237 @end html
4238 @heading @anchor{x-x-vxworks}*-*-vxworks*
4239 Support for VxWorks is in flux. At present GCC supports @emph{only} the
4240 very recent VxWorks 5.5 (aka Tornado 2.2) release, and only on PowerPC@.
4241 We welcome patches for other architectures supported by VxWorks 5.5.
4242 Support for VxWorks AE would also be welcome; we believe this is merely
4243 a matter of writing an appropriate ``configlette'' (see below). We are
4244 not interested in supporting older, a.out or COFF-based, versions of
4245 VxWorks in GCC 3.
4246
4247 VxWorks comes with an older version of GCC installed in
4248 @file{@var{$WIND_BASE}/host}; we recommend you do not overwrite it.
4249 Choose an installation @var{prefix} entirely outside @var{$WIND_BASE}.
4250 Before running @command{configure}, create the directories @file{@var{prefix}}
4251 and @file{@var{prefix}/bin}. Link or copy the appropriate assembler,
4252 linker, etc.@: into @file{@var{prefix}/bin}, and set your @var{PATH} to
4253 include that directory while running both @command{configure} and
4254 @command{make}.
4255
4256 You must give @command{configure} the
4257 @option{--with-headers=@var{$WIND_BASE}/target/h} switch so that it can
4258 find the VxWorks system headers. Since VxWorks is a cross compilation
4259 target only, you must also specify @option{--target=@var{target}}.
4260 @command{configure} will attempt to create the directory
4261 @file{@var{prefix}/@var{target}/sys-include} and copy files into it;
4262 make sure the user running @command{configure} has sufficient privilege
4263 to do so.
4264
4265 GCC's exception handling runtime requires a special ``configlette''
4266 module, @file{contrib/gthr_supp_vxw_5x.c}. Follow the instructions in
4267 that file to add the module to your kernel build. (Future versions of
4268 VxWorks will incorporate this module.)
4269
4270 @html
4271 <hr />
4272 @end html
4273 @heading @anchor{x86-64-x-x}x86_64-*-*, amd64-*-*
4274
4275 GCC supports the x86-64 architecture implemented by the AMD64 processor
4276 (amd64-*-* is an alias for x86_64-*-*) on GNU/Linux, FreeBSD and NetBSD@.
4277 On GNU/Linux the default is a bi-arch compiler which is able to generate
4278 both 64-bit x86-64 and 32-bit x86 code (via the @option{-m32} switch).
4279
4280 @html
4281 <hr />
4282 @end html
4283 @heading @anchor{xtensa-x-elf}xtensa*-*-elf
4284
4285 This target is intended for embedded Xtensa systems using the
4286 @samp{newlib} C library. It uses ELF but does not support shared
4287 objects. Designed-defined instructions specified via the
4288 Tensilica Instruction Extension (TIE) language are only supported
4289 through inline assembly.
4290
4291 The Xtensa configuration information must be specified prior to
4292 building GCC@. The @file{include/xtensa-config.h} header
4293 file contains the configuration information. If you created your
4294 own Xtensa configuration with the Xtensa Processor Generator, the
4295 downloaded files include a customized copy of this header file,
4296 which you can use to replace the default header file.
4297
4298 @html
4299 <hr />
4300 @end html
4301 @heading @anchor{xtensa-x-linux}xtensa*-*-linux*
4302
4303 This target is for Xtensa systems running GNU/Linux. It supports ELF
4304 shared objects and the GNU C library (glibc). It also generates
4305 position-independent code (PIC) regardless of whether the
4306 @option{-fpic} or @option{-fPIC} options are used. In other
4307 respects, this target is the same as the
4308 @uref{#xtensa*-*-elf,,@samp{xtensa*-*-elf}} target.
4309
4310 @html
4311 <hr />
4312 @end html
4313 @heading @anchor{windows}Microsoft Windows
4314
4315 @subheading Intel 16-bit versions
4316 The 16-bit versions of Microsoft Windows, such as Windows 3.1, are not
4317 supported.
4318
4319 However, the 32-bit port has limited support for Microsoft
4320 Windows 3.11 in the Win32s environment, as a target only. See below.
4321
4322 @subheading Intel 32-bit versions
4323
4324 The 32-bit versions of Windows, including Windows 95, Windows NT, Windows
4325 XP, and Windows Vista, are supported by several different target
4326 platforms. These targets differ in which Windows subsystem they target
4327 and which C libraries are used.
4328
4329 @itemize
4330 @item Cygwin @uref{#x-x-cygwin,,*-*-cygwin}: Cygwin provides a user-space
4331 Linux API emulation layer in the Win32 subsystem.
4332 @item Interix @uref{#x-x-interix,,*-*-interix}: The Interix subsystem
4333 provides native support for POSIX.
4334 @item MinGW @uref{#x-x-mingw32,,*-*-mingw32}: MinGW is a native GCC port for
4335 the Win32 subsystem that provides a subset of POSIX.
4336 @item MKS i386-pc-mks: NuTCracker from MKS. See
4337 @uref{http://www.mkssoftware.com/} for more information.
4338 @end itemize
4339
4340 @subheading Intel 64-bit versions
4341
4342 GCC contains support for x86-64 using the mingw-w64
4343 runtime library, available from @uref{http://mingw-w64.sourceforge.net/}.
4344 This library should be used with the target triple x86_64-pc-mingw32.
4345
4346 Presently Windows for Itanium is not supported.
4347
4348 @subheading Windows CE
4349
4350 Windows CE is supported as a target only on ARM (arm-wince-pe), Hitachi
4351 SuperH (sh-wince-pe), and MIPS (mips-wince-pe).
4352
4353 @subheading Other Windows Platforms
4354
4355 GCC no longer supports Windows NT on the Alpha or PowerPC.
4356
4357 GCC no longer supports the Windows POSIX subsystem. However, it does
4358 support the Interix subsystem. See above.
4359
4360 Old target names including *-*-winnt and *-*-windowsnt are no longer used.
4361
4362 PW32 (i386-pc-pw32) support was never completed, and the project seems to
4363 be inactive. See @uref{http://pw32.sourceforge.net/} for more information.
4364
4365 UWIN support has been removed due to a lack of maintenance.
4366
4367 @html
4368 <hr />
4369 @end html
4370 @heading @anchor{x-x-cygwin}*-*-cygwin
4371
4372 Ports of GCC are included with the
4373 @uref{http://www.cygwin.com/,,Cygwin environment}.
4374
4375 GCC will build under Cygwin without modification; it does not build
4376 with Microsoft's C++ compiler and there are no plans to make it do so.
4377
4378 Cygwin can be compiled with i?86-pc-cygwin.
4379
4380 @html
4381 <hr />
4382 @end html
4383 @heading @anchor{x-x-interix}*-*-interix
4384
4385 The Interix target is used by OpenNT, Interix, Services For UNIX (SFU),
4386 and Subsystem for UNIX-based Applications (SUA). Applications compiled
4387 with this target run in the Interix subsystem, which is separate from
4388 the Win32 subsystem. This target was last known to work in GCC 3.3.
4389
4390 For more information, see @uref{http://www.interix.com/}.
4391
4392 @html
4393 <hr />
4394 @end html
4395 @heading @anchor{x-x-mingw32}*-*-mingw32
4396
4397 GCC will build with and support only MinGW runtime 3.12 and later.
4398 Earlier versions of headers are incompatible with the new default semantics
4399 of @code{extern inline} in @code{-std=c99} and @code{-std=gnu99} modes.
4400
4401 @html
4402 <hr />
4403 @end html
4404 @heading @anchor{older}Older systems
4405
4406 GCC contains support files for many older (1980s and early
4407 1990s) Unix variants. For the most part, support for these systems
4408 has not been deliberately removed, but it has not been maintained for
4409 several years and may suffer from bitrot.
4410
4411 Starting with GCC 3.1, each release has a list of ``obsoleted'' systems.
4412 Support for these systems is still present in that release, but
4413 @command{configure} will fail unless the @option{--enable-obsolete}
4414 option is given. Unless a maintainer steps forward, support for these
4415 systems will be removed from the next release of GCC@.
4416
4417 Support for old systems as hosts for GCC can cause problems if the
4418 workarounds for compiler, library and operating system bugs affect the
4419 cleanliness or maintainability of the rest of GCC@. In some cases, to
4420 bring GCC up on such a system, if still possible with current GCC, may
4421 require first installing an old version of GCC which did work on that
4422 system, and using it to compile a more recent GCC, to avoid bugs in the
4423 vendor compiler. Old releases of GCC 1 and GCC 2 are available in the
4424 @file{old-releases} directory on the @uref{../mirrors.html,,GCC mirror
4425 sites}. Header bugs may generally be avoided using
4426 @command{fixincludes}, but bugs or deficiencies in libraries and the
4427 operating system may still cause problems.
4428
4429 Support for older systems as targets for cross-compilation is less
4430 problematic than support for them as hosts for GCC; if an enthusiast
4431 wishes to make such a target work again (including resurrecting any of
4432 the targets that never worked with GCC 2, starting from the last
4433 version before they were removed), patches
4434 @uref{../contribute.html,,following the usual requirements} would be
4435 likely to be accepted, since they should not affect the support for more
4436 modern targets.
4437
4438 For some systems, old versions of GNU binutils may also be useful,
4439 and are available from @file{pub/binutils/old-releases} on
4440 @uref{http://sourceware.org/mirrors.html,,sourceware.org mirror sites}.
4441
4442 Some of the information on specific systems above relates to
4443 such older systems, but much of the information
4444 about GCC on such systems (which may no longer be applicable to
4445 current GCC) is to be found in the GCC texinfo manual.
4446
4447 @html
4448 <hr />
4449 @end html
4450 @heading @anchor{elf}all ELF targets (SVR4, Solaris 2, etc.)
4451
4452 C++ support is significantly better on ELF targets if you use the
4453 @uref{./configure.html#with-gnu-ld,,GNU linker}; duplicate copies of
4454 inlines, vtables and template instantiations will be discarded
4455 automatically.
4456
4457
4458 @html
4459 <hr />
4460 <p>
4461 @end html
4462 @ifhtml
4463 @uref{./index.html,,Return to the GCC Installation page}
4464 @end ifhtml
4465 @end ifset
4466
4467 @c ***Old documentation******************************************************
4468 @ifset oldhtml
4469 @include install-old.texi
4470 @html
4471 <hr />
4472 <p>
4473 @end html
4474 @ifhtml
4475 @uref{./index.html,,Return to the GCC Installation page}
4476 @end ifhtml
4477 @end ifset
4478
4479 @c ***GFDL********************************************************************
4480 @ifset gfdlhtml
4481 @include fdl.texi
4482 @html
4483 <hr />
4484 <p>
4485 @end html
4486 @ifhtml
4487 @uref{./index.html,,Return to the GCC Installation page}
4488 @end ifhtml
4489 @end ifset
4490
4491 @c ***************************************************************************
4492 @c Part 6 The End of the Document
4493 @ifinfo
4494 @comment node-name, next, previous, up
4495 @node Concept Index, , GNU Free Documentation License, Top
4496 @end ifinfo
4497
4498 @ifinfo
4499 @unnumbered Concept Index
4500
4501 @printindex cp
4502
4503 @contents
4504 @end ifinfo
4505 @bye