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