OSDN Git Service

update
[pf3gnuchains/gcc-fork.git] / gcc / INSTALL
1 This file documents the installation of the GNU compiler.  Copyright
2 (C) 1988, 1989, 1992, 1994, 1995 Free Software Foundation, Inc.  You
3 may copy, distribute, and modify it freely as long as you preserve this
4 copyright notice and permission notice.
5
6 Installing GNU CC
7 *****************
8
9    Note most of this information is out of date and superceded by the
10 EGCS install procedures.  It is provided for historical reference only.
11
12    Here is the procedure for installing GNU CC on a Unix system.  See
13 *Note VMS Install::, for VMS systems.  In this section we assume you
14 compile in the same directory that contains the source files; see *Note
15 Other Dir::, to find out how to compile in a separate directory on Unix
16 systems.
17
18    You cannot install GNU C by itself on MSDOS; it will not compile
19 under any MSDOS compiler except itself.  You need to get the complete
20 compilation package DJGPP, which includes binaries as well as sources,
21 and includes all the necessary compilation tools and libraries.
22
23   1. If you have built GNU CC previously in the same directory for a
24      different target machine, do `make distclean' to delete all files
25      that might be invalid.  One of the files this deletes is
26      `Makefile'; if `make distclean' complains that `Makefile' does not
27      exist, it probably means that the directory is already suitably
28      clean.
29
30   2. On a System V release 4 system, make sure `/usr/bin' precedes
31      `/usr/ucb' in `PATH'.  The `cc' command in `/usr/ucb' uses
32      libraries which have bugs.
33
34   3. Specify the host, build and target machine configurations.  You do
35      this by running the file `configure'.
36
37      The "build" machine is the system which you are using, the "host"
38      machine is the system where you want to run the resulting compiler
39      (normally the build machine), and the "target" machine is the
40      system for which you want the compiler to generate code.
41
42      If you are building a compiler to produce code for the machine it
43      runs on (a native compiler), you normally do not need to specify
44      any operands to `configure'; it will try to guess the type of
45      machine you are on and use that as the build, host and target
46      machines.  So you don't need to specify a configuration when
47      building a native compiler unless `configure' cannot figure out
48      what your configuration is or guesses wrong.
49
50      In those cases, specify the build machine's "configuration name"
51      with the `--build' option; the host and target will default to be
52      the same as the build machine.  (If you are building a
53      cross-compiler, see *Note Cross-Compiler::.)
54
55      Here is an example:
56
57           ./configure --build=sparc-sun-sunos4.1
58
59      A configuration name may be canonical or it may be more or less
60      abbreviated.
61
62      A canonical configuration name has three parts, separated by
63      dashes.  It looks like this: `CPU-COMPANY-SYSTEM'.  (The three
64      parts may themselves contain dashes; `configure' can figure out
65      which dashes serve which purpose.)  For example,
66      `m68k-sun-sunos4.1' specifies a Sun 3.
67
68      You can also replace parts of the configuration by nicknames or
69      aliases.  For example, `sun3' stands for `m68k-sun', so
70      `sun3-sunos4.1' is another way to specify a Sun 3.  You can also
71      use simply `sun3-sunos', since the version of SunOS is assumed by
72      default to be version 4.
73
74      You can specify a version number after any of the system types,
75      and some of the CPU types.  In most cases, the version is
76      irrelevant, and will be ignored.  So you might as well specify the
77      version if you know it.
78
79      See *Note Configurations::, for a list of supported configuration
80      names and notes on many of the configurations.  You should check
81      the notes in that section before proceeding any further with the
82      installation of GNU CC.
83
84      There are four additional options you can specify independently to
85      describe variant hardware and software configurations.  These are
86      `--with-gnu-as', `--with-gnu-ld', `--with-stabs' and `--nfp'.
87
88     `--with-gnu-as'
89           If you will use GNU CC with the GNU assembler (GAS), you
90           should declare this by using the `--with-gnu-as' option when
91           you run `configure'.
92
93           Using this option does not install GAS.  It only modifies the
94           output of GNU CC to work with GAS.  Building and installing
95           GAS is up to you.
96
97           Conversely, if you *do not* wish to use GAS and do not specify
98           `--with-gnu-as' when building GNU CC, it is up to you to make
99           sure that GAS is not installed.  GNU CC searches for a
100           program named `as' in various directories; if the program it
101           finds is GAS, then it runs GAS.  If you are not sure where
102           GNU CC finds the assembler it is using, try specifying `-v'
103           when you run it.
104
105           The systems where it makes a difference whether you use GAS
106           are
107           `hppa1.0-ANY-ANY', `hppa1.1-ANY-ANY', `i386-ANY-sysv',
108           `i386-ANY-isc',
109           `i860-ANY-bsd', `m68k-bull-sysv',
110           `m68k-hp-hpux', `m68k-sony-bsd',
111           `m68k-altos-sysv', `m68000-hp-hpux',
112           `m68000-att-sysv', `ANY-lynx-lynxos', and `mips-ANY').  On
113           any other system, `--with-gnu-as' has no effect.
114
115           On the systems listed above (except for the HP-PA, for ISC on
116           the 386, and for `mips-sgi-irix5.*'), if you use GAS, you
117           should also use the GNU linker (and specify `--with-gnu-ld').
118
119     `--with-gnu-ld'
120           Specify the option `--with-gnu-ld' if you plan to use the GNU
121           linker with GNU CC.
122
123           This option does not cause the GNU linker to be installed; it
124           just modifies the behavior of GNU CC to work with the GNU
125           linker.
126
127     `--with-stabs'
128           On MIPS based systems and on Alphas, you must specify whether
129           you want GNU CC to create the normal ECOFF debugging format,
130           or to use BSD-style stabs passed through the ECOFF symbol
131           table.  The normal ECOFF debug format cannot fully handle
132           languages other than C.  BSD stabs format can handle other
133           languages, but it only works with the GNU debugger GDB.
134
135           Normally, GNU CC uses the ECOFF debugging format by default;
136           if you prefer BSD stabs, specify `--with-stabs' when you
137           configure GNU CC.
138
139           No matter which default you choose when you configure GNU CC,
140           the user can use the `-gcoff' and `-gstabs+' options to
141           specify explicitly the debug format for a particular
142           compilation.
143
144           `--with-stabs' is meaningful on the ISC system on the 386,
145           also, if `--with-gas' is used.  It selects use of stabs
146           debugging information embedded in COFF output.  This kind of
147           debugging information supports C++ well; ordinary COFF
148           debugging information does not.
149
150           `--with-stabs' is also meaningful on 386 systems running
151           SVR4.  It selects use of stabs debugging information embedded
152           in ELF output.  The C++ compiler currently (2.6.0) does not
153           support the DWARF debugging information normally used on 386
154           SVR4 platforms; stabs provide a workable alternative.  This
155           requires gas and gdb, as the normal SVR4 tools can not
156           generate or interpret stabs.
157
158     `--nfp'
159           On certain systems, you must specify whether the machine has
160           a floating point unit.  These systems include
161           `m68k-sun-sunosN' and `m68k-isi-bsd'.  On any other system,
162           `--nfp' currently has no effect, though perhaps there are
163           other systems where it could usefully make a difference.
164
165     `--enable-haifa'
166
167     `--disable-haifa'
168           Use `--enable-haifa' to enable use of an experimental
169           instruction scheduler (from IBM Haifa).  This may or may not
170           produce better code.  Some targets on which it is known to be
171           a win enable it by default; use `--disable-haifa' to disable
172           it in these cases.  `configure' will print out whether the
173           Haifa scheduler is enabled when it is run.
174
175     `--enable-threads=TYPE'
176           Certain systems, notably Linux-based GNU systems, can't be
177           relied on to supply a threads facility for the Objective C
178           runtime and so will default to single-threaded runtime.  They
179           may, however, have a library threads implementation
180           available, in which case threads can be enabled with this
181           option by supplying a suitable TYPE, probably `posix'.  The
182           possibilities for TYPE are `single', `posix', `win32',
183           `solaris', `irix' and `mach'.
184
185      The `configure' script searches subdirectories of the source
186      directory for other compilers that are to be integrated into GNU
187      CC.  The GNU compiler for C++, called G++ is in a subdirectory
188      named `cp'.  `configure' inserts rules into `Makefile' to build
189      all of those compilers.
190
191      Here we spell out what files will be set up by `configure'.
192      Normally you need not be concerned with these files.
193
194         * A file named `config.h' is created that contains a `#include'
195           of the top-level config file for the machine you will run the
196           compiler on (*note The Configuration File:
197           (gcc.info)Config.).  This file is responsible for defining
198           information about the host machine.  It includes `tm.h'.
199
200           The top-level config file is located in the subdirectory
201           `config'.  Its name is always `xm-SOMETHING.h'; usually
202           `xm-MACHINE.h', but there are some exceptions.
203
204           If your system does not support symbolic links, you might
205           want to set up `config.h' to contain a `#include' command
206           which refers to the appropriate file.
207
208         * A file named `tconfig.h' is created which includes the
209           top-level config file for your target machine.  This is used
210           for compiling certain programs to run on that machine.
211
212         * A file named `tm.h' is created which includes the
213           machine-description macro file for your target machine.  It
214           should be in the subdirectory `config' and its name is often
215           `MACHINE.h'.
216
217         * The command file `configure' also constructs the file
218           `Makefile' by adding some text to the template file
219           `Makefile.in'.  The additional text comes from files in the
220           `config' directory, named `t-TARGET' and `x-HOST'.  If these
221           files do not exist, it means nothing needs to be added for a
222           given target or host.
223
224   4. The standard directory for installing GNU CC is `/usr/local/lib'.
225      If you want to install its files somewhere else, specify
226      `--prefix=DIR' when you run `configure'.  Here DIR is a directory
227      name to use instead of `/usr/local' for all purposes with one
228      exception: the directory `/usr/local/include' is searched for
229      header files no matter where you install the compiler.  To override
230      this name, use the `--local-prefix' option below.
231
232   5. Specify `--local-prefix=DIR' if you want the compiler to search
233      directory `DIR/include' for locally installed header files
234      *instead* of `/usr/local/include'.
235
236      You should specify `--local-prefix' *only* if your site has a
237      different convention (not `/usr/local') for where to put
238      site-specific files.
239
240      The default value for `--local-prefix' is `/usr/local' regardless
241      of the value of `--prefix'.  Specifying `--prefix' has no effect
242      on which directory GNU CC searches for local header files.  This
243      may seem counterintuitive, but actually it is logical.
244
245      The purpose of `--prefix' is to specify where to *install GNU CC*.
246      The local header files in `/usr/local/include'--if you put any in
247      that directory--are not part of GNU CC.  They are part of other
248      programs--perhaps many others.  (GNU CC installs its own header
249      files in another directory which is based on the `--prefix' value.)
250
251      *Do not* specify `/usr' as the `--local-prefix'!  The directory
252      you use for `--local-prefix' *must not* contain any of the
253      system's standard header files.  If it did contain them, certain
254      programs would be miscompiled (including GNU Emacs, on certain
255      targets), because this would override and nullify the header file
256      corrections made by the `fixincludes' script.
257
258      Indications are that people who use this option use it based on
259      mistaken ideas of what it is for.  People use it as if it specified
260      where to install part of GNU CC.  Perhaps they make this assumption
261      because installing GNU CC creates the directory.
262
263   6. Make sure the Bison parser generator is installed.  (This is
264      unnecessary if the Bison output files `c-parse.c' and `cexp.c' are
265      more recent than `c-parse.y' and `cexp.y' and you do not plan to
266      change the `.y' files.)
267
268      Bison versions older than Sept 8, 1988 will produce incorrect
269      output for `c-parse.c'.
270
271   7. If you have chosen a configuration for GNU CC which requires other
272      GNU tools (such as GAS or the GNU linker) instead of the standard
273      system tools, install the required tools in the build directory
274      under the names `as', `ld' or whatever is appropriate.  This will
275      enable the compiler to find the proper tools for compilation of
276      the program `enquire'.
277
278      Alternatively, you can do subsequent compilation using a value of
279      the `PATH' environment variable such that the necessary GNU tools
280      come before the standard system tools.
281
282   8. Build the compiler.  Just type `make LANGUAGES=c' in the compiler
283      directory.
284
285      `LANGUAGES=c' specifies that only the C compiler should be
286      compiled.  The makefile normally builds compilers for all the
287      supported languages; currently, C, C++ and Objective C.  However,
288      C is the only language that is sure to work when you build with
289      other non-GNU C compilers.  In addition, building anything but C
290      at this stage is a waste of time.
291
292      In general, you can specify the languages to build by typing the
293      argument `LANGUAGES="LIST"', where LIST is one or more words from
294      the list `c', `c++', and `objective-c'.  If you have any
295      additional GNU compilers as subdirectories of the GNU CC source
296      directory, you may also specify their names in this list.
297
298      Ignore any warnings you may see about "statement not reached" in
299      `insn-emit.c'; they are normal.  Also, warnings about "unknown
300      escape sequence" are normal in `genopinit.c' and perhaps some
301      other files.  Likewise, you should ignore warnings about "constant
302      is so large that it is unsigned" in `insn-emit.c' and
303      `insn-recog.c' and a warning about a comparison always being zero
304      in `enquire.o'.  Any other compilation errors may represent bugs in
305      the port to your machine or operating system, and should be
306      investigated and reported.
307
308      Some commercial compilers fail to compile GNU CC because they have
309      bugs or limitations.  For example, the Microsoft compiler is said
310      to run out of macro space.  Some Ultrix compilers run out of
311      expression space; then you need to break up the statement where
312      the problem happens.
313
314   9. If you are building a cross-compiler, stop here.  *Note
315      Cross-Compiler::.
316
317  10. Move the first-stage object files and executables into a
318      subdirectory with this command:
319
320           make stage1
321
322      The files are moved into a subdirectory named `stage1'.  Once
323      installation is complete, you may wish to delete these files with
324      `rm -r stage1'.
325
326  11. If you have chosen a configuration for GNU CC which requires other
327      GNU tools (such as GAS or the GNU linker) instead of the standard
328      system tools, install the required tools in the `stage1'
329      subdirectory under the names `as', `ld' or whatever is
330      appropriate.  This will enable the stage 1 compiler to find the
331      proper tools in the following stage.
332
333      Alternatively, you can do subsequent compilation using a value of
334      the `PATH' environment variable such that the necessary GNU tools
335      come before the standard system tools.
336
337  12. Recompile the compiler with itself, with this command:
338
339           make CC="stage1/xgcc -Bstage1/" CFLAGS="-g -O2"
340
341      This is called making the stage 2 compiler.
342
343      The command shown above builds compilers for all the supported
344      languages.  If you don't want them all, you can specify the
345      languages to build by typing the argument `LANGUAGES="LIST"'.  LIST
346      should contain one or more words from the list `c', `c++',
347      `objective-c', and `proto'.  Separate the words with spaces.
348      `proto' stands for the programs `protoize' and `unprotoize'; they
349      are not a separate language, but you use `LANGUAGES' to enable or
350      disable their installation.
351
352      If you are going to build the stage 3 compiler, then you might
353      want to build only the C language in stage 2.
354
355      Once you have built the stage 2 compiler, if you are short of disk
356      space, you can delete the subdirectory `stage1'.
357
358      On a 68000 or 68020 system lacking floating point hardware, unless
359      you have selected a `tm.h' file that expects by default that there
360      is no such hardware, do this instead:
361
362           make CC="stage1/xgcc -Bstage1/" CFLAGS="-g -O2 -msoft-float"
363
364  13. If you wish to test the compiler by compiling it with itself one
365      more time, install any other necessary GNU tools (such as GAS or
366      the GNU linker) in the `stage2' subdirectory as you did in the
367      `stage1' subdirectory, then do this:
368
369           make stage2
370           make CC="stage2/xgcc -Bstage2/" CFLAGS="-g -O2"
371
372      This is called making the stage 3 compiler.  Aside from the `-B'
373      option, the compiler options should be the same as when you made
374      the stage 2 compiler.  But the `LANGUAGES' option need not be the
375      same.  The command shown above builds compilers for all the
376      supported languages; if you don't want them all, you can specify
377      the languages to build by typing the argument `LANGUAGES="LIST"',
378      as described above.
379
380      If you do not have to install any additional GNU tools, you may
381      use the command
382
383           make bootstrap LANGUAGES=LANGUAGE-LIST BOOT_CFLAGS=OPTION-LIST
384
385      instead of making `stage1', `stage2', and performing the two
386      compiler builds.
387
388  14. Then compare the latest object files with the stage 2 object
389      files--they ought to be identical, aside from time stamps (if any).
390
391      On some systems, meaningful comparison of object files is
392      impossible; they always appear "different."  This is currently
393      true on Solaris and some systems that use ELF object file format.
394      On some versions of Irix on SGI machines and DEC Unix (OSF/1) on
395      Alpha systems, you will not be able to compare the files without
396      specifying `-save-temps'; see the description of individual
397      systems above to see if you get comparison failures.  You may have
398      similar problems on other systems.
399
400      Use this command to compare the files:
401
402           make compare
403
404      This will mention any object files that differ between stage 2 and
405      stage 3.  Any difference, no matter how innocuous, indicates that
406      the stage 2 compiler has compiled GNU CC incorrectly, and is
407      therefore a potentially serious bug which you should investigate
408      and report.
409
410      If your system does not put time stamps in the object files, then
411      this is a faster way to compare them (using the Bourne shell):
412
413           for file in *.o; do
414           cmp $file stage2/$file
415           done
416
417      If you have built the compiler with the `-mno-mips-tfile' option on
418      MIPS machines, you will not be able to compare the files.
419
420  15. Install the compiler driver, the compiler's passes and run-time
421      support with `make install'.  Use the same value for `CC',
422      `CFLAGS' and `LANGUAGES' that you used when compiling the files
423      that are being installed.  One reason this is necessary is that
424      some versions of Make have bugs and recompile files gratuitously
425      when you do this step.  If you use the same variable values, those
426      files will be recompiled properly.
427
428      For example, if you have built the stage 2 compiler, you can use
429      the following command:
430
431           make install CC="stage2/xgcc -Bstage2/" CFLAGS="-g -O" LANGUAGES="LIST"
432
433      This copies the files `cc1', `cpp' and `libgcc.a' to files `cc1',
434      `cpp' and `libgcc.a' in the directory
435      `/usr/local/lib/gcc-lib/TARGET/VERSION', which is where the
436      compiler driver program looks for them.  Here TARGET is the target
437      machine type specified when you ran `configure', and VERSION is
438      the version number of GNU CC.  This naming scheme permits various
439      versions and/or cross-compilers to coexist.  It also copies the
440      executables for compilers for other languages (e.g., `cc1plus' for
441      C++) to the same directory.
442
443      This also copies the driver program `xgcc' into
444      `/usr/local/bin/gcc', so that it appears in typical execution
445      search paths.  It also copies `gcc.1' into `/usr/local/man/man1'
446      and info pages into `/usr/local/info'.
447
448      On some systems, this command causes recompilation of some files.
449      This is usually due to bugs in `make'.  You should either ignore
450      this problem, or use GNU Make.
451
452      *Warning: there is a bug in `alloca' in the Sun library.  To avoid
453      this bug, be sure to install the executables of GNU CC that were
454      compiled by GNU CC.  (That is, the executables from stage 2 or 3,
455      not stage 1.)  They use `alloca' as a built-in function and never
456      the one in the library.*
457
458      (It is usually better to install GNU CC executables from stage 2
459      or 3, since they usually run faster than the ones compiled with
460      some other compiler.)
461
462  16. If you're going to use C++, it's likely that you need to also
463      install a C++ runtime library.  Just as GNU C does not distribute
464      a C runtime library, it also does not include a C++ runtime
465      library.  All I/O functionality, special class libraries, etc., are
466      provided by the C++ runtime library.
467
468      Here's one way to build and install a C++ runtime library for GNU
469      CC:
470
471         * Build and install GNU CC, so that invoking `gcc' obtains the
472           GNU CC that was just built.
473
474         * Obtain a copy of a compatible `libstdc++' distribution.  For
475           example, the `libstdc++-2.8.0.tar.gz' distribution should be
476           compatible with GCC 2.8.0.  GCC distributors normally
477           distribute `libstdc++' as well.
478
479         * Set the `CXX' environment variable to `gcc' while running the
480           `libstdc++' distribution's `configure' command.  Use the same
481           `configure' options that you used when you invoked GCC's
482           `configure' command.
483
484         * Invoke `make' to build the C++ runtime.
485
486         * Invoke `make install' to install the C++ runtime.
487
488      To summarize, after building and installing GNU CC, invoke the
489      following shell commands in the topmost directory of the C++
490      library distribution.  For CONFIGURE-OPTIONS, use the same options
491      that you used to configure GNU CC.
492
493           $ CXX=gcc ./configure CONFIGURE-OPTIONS
494           $ make
495           $ make install
496
497  17. GNU CC includes a runtime library for Objective-C because it is an
498      integral part of the language.  You can find the files associated
499      with the library in the subdirectory `objc'.  The GNU Objective-C
500      Runtime Library requires header files for the target's C library in
501      order to be compiled,and also requires the header files for the
502      target's thread library if you want thread support.  *Note
503      Cross-Compilers and Header Files: Cross Headers, for discussion
504      about header files issues for cross-compilation.
505
506      When you run `configure', it picks the appropriate Objective-C
507      thread implementation file for the target platform.  In some
508      situations, you may wish to choose a different back-end as some
509      platforms support multiple thread implementations or you may wish
510      to disable thread support completely.  You do this by specifying a
511      value for the OBJC_THREAD_FILE makefile variable on the command
512      line when you run make, for example:
513
514           make CC="stage2/xgcc -Bstage2/" CFLAGS="-g -O2" OBJC_THREAD_FILE=thr-single
515
516      Below is a list of the currently available back-ends.
517
518         * thr-single Disable thread support, should work for all
519           platforms.
520
521         * thr-decosf1 DEC OSF/1 thread support.
522
523         * thr-irix SGI IRIX thread support.
524
525         * thr-mach Generic MACH thread support, known to work on
526           NEXTSTEP.
527
528         * thr-os2 IBM OS/2 thread support.
529
530         * thr-posix Generix POSIX thread support.
531
532         * thr-pthreads PCThreads on Linux-based GNU systems.
533
534         * thr-solaris SUN Solaris thread support.
535
536         * thr-win32 Microsoft Win32 API thread support.
537
538 Configurations Supported by GNU CC
539 ==================================
540
541    Here are the possible CPU types:
542
543      1750a, a29k, alpha, arm, cN, clipper, dsp16xx, elxsi, h8300,
544      hppa1.0, hppa1.1, i370, i386, i486, i586, i860, i960, m32r,
545      m68000, m68k, m88k, mips, mipsel, mips64, mips64el, ns32k,
546      powerpc, powerpcle, pyramid, romp, rs6000, sh, sparc, sparclite,
547      sparc64, vax, we32k.
548
549    Here are the recognized company names.  As you can see, customary
550 abbreviations are used rather than the longer official names.
551
552      acorn, alliant, altos, apollo, apple, att, bull, cbm, convergent,
553      convex, crds, dec, dg, dolphin, elxsi, encore, harris, hitachi,
554      hp, ibm, intergraph, isi, mips, motorola, ncr, next, ns, omron,
555      plexus, sequent, sgi, sony, sun, tti, unicom, wrs.
556
557    The company name is meaningful only to disambiguate when the rest of
558 the information supplied is insufficient.  You can omit it, writing
559 just `CPU-SYSTEM', if it is not needed.  For example, `vax-ultrix4.2'
560 is equivalent to `vax-dec-ultrix4.2'.
561
562    Here is a list of system types:
563
564      386bsd, aix, acis, amigaos, aos, aout, aux, bosx, bsd, clix, coff,
565      ctix, cxux, dgux, dynix, ebmon, ecoff, elf, esix, freebsd, hms,
566      genix, gnu, linux-gnu, hiux, hpux, iris, irix, isc, luna, lynxos,
567      mach, minix, msdos, mvs, netbsd, newsos, nindy, ns, osf, osfrose,
568      ptx, riscix, riscos, rtu, sco, sim, solaris, sunos, sym, sysv,
569      udi, ultrix, unicos, uniplus, unos, vms, vsta, vxworks, winnt,
570      xenix.
571
572 You can omit the system type; then `configure' guesses the operating
573 system from the CPU and company.
574
575    You can add a version number to the system type; this may or may not
576 make a difference.  For example, you can write `bsd4.3' or `bsd4.4' to
577 distinguish versions of BSD.  In practice, the version number is most
578 needed for `sysv3' and `sysv4', which are often treated differently.
579
580    If you specify an impossible combination such as `i860-dg-vms', then
581 you may get an error message from `configure', or it may ignore part of
582 the information and do the best it can with the rest.  `configure'
583 always prints the canonical name for the alternative that it used.  GNU
584 CC does not support all possible alternatives.
585
586    Often a particular model of machine has a name.  Many machine names
587 are recognized as aliases for CPU/company combinations.  Thus, the
588 machine name `sun3', mentioned above, is an alias for `m68k-sun'.
589 Sometimes we accept a company name as a machine name, when the name is
590 popularly used for a particular machine.  Here is a table of the known
591 machine names:
592
593      3300, 3b1, 3bN, 7300, altos3068, altos, apollo68, att-7300,
594      balance, convex-cN, crds, decstation-3100, decstation, delta,
595      encore, fx2800, gmicro, hp7NN, hp8NN, hp9k2NN, hp9k3NN, hp9k7NN,
596      hp9k8NN, iris4d, iris, isi68, m3230, magnum, merlin, miniframe,
597      mmax, news-3600, news800, news, next, pbd, pc532, pmax, powerpc,
598      powerpcle, ps2, risc-news, rtpc, sun2, sun386i, sun386, sun3,
599      sun4, symmetry, tower-32, tower.
600
601 Remember that a machine name specifies both the cpu type and the company
602 name.  If you want to install your own homemade configuration files,
603 you can use `local' as the company name to access them.  If you use
604 configuration `CPU-local', the configuration name without the cpu prefix
605 is used to form the configuration file names.
606
607    Thus, if you specify `m68k-local', configuration uses files
608 `m68k.md', `local.h', `m68k.c', `xm-local.h', `t-local', and `x-local',
609 all in the directory `config/m68k'.
610
611    Here is a list of configurations that have special treatment or
612 special things you must know:
613
614 `1750a-*-*'
615      MIL-STD-1750A processors.
616
617      The MIL-STD-1750A cross configuration produces output for
618      `as1750', an assembler/linker available under the GNU Public
619      License for the 1750A. `as1750' can be obtained at
620      *ftp://ftp.fta-berlin.de/pub/crossgcc/1750gals/*.  A similarly
621      licensed simulator for the 1750A is available from same address.
622
623      You should ignore a fatal error during the building of libgcc
624      (libgcc is not yet implemented for the 1750A.)
625
626      The `as1750' assembler requires the file `ms1750.inc', which is
627      found in the directory `config/1750a'.
628
629      GNU CC produced the same sections as the Fairchild F9450 C
630      Compiler, namely:
631
632     `Normal'
633           The program code section.
634
635     `Static'
636           The read/write (RAM) data section.
637
638     `Konst'
639           The read-only (ROM) constants section.
640
641     `Init'
642           Initialization section (code to copy KREL to SREL).
643
644      The smallest addressable unit is 16 bits (BITS_PER_UNIT is 16).
645      This means that type `char' is represented with a 16-bit word per
646      character.  The 1750A's "Load/Store Upper/Lower Byte" instructions
647      are not used by GNU CC.
648
649 `alpha-*-osf1'
650      Systems using processors that implement the DEC Alpha architecture
651      and are running the DEC Unix (OSF/1) operating system, for example
652      the DEC Alpha AXP systems.CC.)
653
654      GNU CC writes a `.verstamp' directive to the assembler output file
655      unless it is built as a cross-compiler.  It gets the version to
656      use from the system header file `/usr/include/stamp.h'.  If you
657      install a new version of DEC Unix, you should rebuild GCC to pick
658      up the new version stamp.
659
660      Note that since the Alpha is a 64-bit architecture,
661      cross-compilers from 32-bit machines will not generate code as
662      efficient as that generated when the compiler is running on a
663      64-bit machine because many optimizations that depend on being
664      able to represent a word on the target in an integral value on the
665      host cannot be performed.  Building cross-compilers on the Alpha
666      for 32-bit machines has only been tested in a few cases and may
667      not work properly.
668
669      `make compare' may fail on old versions of DEC Unix unless you add
670      `-save-temps' to `CFLAGS'.  On these systems, the name of the
671      assembler input file is stored in the object file, and that makes
672      comparison fail if it differs between the `stage1' and `stage2'
673      compilations.  The option `-save-temps' forces a fixed name to be
674      used for the assembler input file, instead of a randomly chosen
675      name in `/tmp'.  Do not add `-save-temps' unless the comparisons
676      fail without that option.  If you add `-save-temps', you will have
677      to manually delete the `.i' and `.s' files after each series of
678      compilations.
679
680      GNU CC now supports both the native (ECOFF) debugging format used
681      by DBX and GDB and an encapsulated STABS format for use only with
682      GDB.  See the discussion of the `--with-stabs' option of
683      `configure' above for more information on these formats and how to
684      select them.
685
686      There is a bug in DEC's assembler that produces incorrect line
687      numbers for ECOFF format when the `.align' directive is used.  To
688      work around this problem, GNU CC will not emit such alignment
689      directives while writing ECOFF format debugging information even
690      if optimization is being performed.  Unfortunately, this has the
691      very undesirable side-effect that code addresses when `-O' is
692      specified are different depending on whether or not `-g' is also
693      specified.
694
695      To avoid this behavior, specify `-gstabs+' and use GDB instead of
696      DBX.  DEC is now aware of this problem with the assembler and
697      hopes to provide a fix shortly.
698
699 `arc-*-elf'
700      Argonaut ARC processor.  This configuration is intended for
701      embedded systems.
702
703 `arm-*-aout'
704      Advanced RISC Machines ARM-family processors.  These are often
705      used in embedded applications.  There are no standard Unix
706      configurations.  This configuration corresponds to the basic
707      instruction sequences and will produce `a.out' format object
708      modules.
709
710      You may need to make a variant of the file `arm.h' for your
711      particular configuration.
712
713 `arm-*-linuxaout'
714      Any of the ARM family processors running the Linux-based GNU
715      system with the `a.out' binary format (ELF is not yet supported).
716      You must use version 2.8.1.0.7 or later of the GNU/Linux binutils,
717      which you can download from `sunsite.unc.edu:/pub/Linux/GCC' and
718      other mirror sites for Linux-based GNU systems.
719
720 `arm-*-riscix'
721      The ARM2 or ARM3 processor running RISC iX, Acorn's port of BSD
722      Unix.  If you are running a version of RISC iX prior to 1.2 then
723      you must specify the version number during configuration.  Note
724      that the assembler shipped with RISC iX does not support stabs
725      debugging information; a new version of the assembler, with stabs
726      support included, is now available from Acorn and via ftp
727      `ftp.acorn.com:/pub/riscix/as+xterm.tar.Z'.  To enable stabs
728      debugging, pass `--with-gnu-as' to configure.
729
730      You will need to install GNU `sed' before you can run configure.
731
732 `a29k'
733      AMD Am29k-family processors.  These are normally used in embedded
734      applications.  There are no standard Unix configurations.  This
735      configuration corresponds to AMD's standard calling sequence and
736      binary interface and is compatible with other 29k tools.
737
738      You may need to make a variant of the file `a29k.h' for your
739      particular configuration.
740
741 `a29k-*-bsd'
742      AMD Am29050 used in a system running a variant of BSD Unix.
743
744 `decstation-*'
745      DECstations can support three different personalities: Ultrix, DEC
746      OSF/1, and OSF/rose.  To configure GCC for these platforms use the
747      following configurations:
748
749     `decstation-ultrix'
750           Ultrix configuration.
751
752     `decstation-osf1'
753           Dec's version of OSF/1.
754
755     `decstation-osfrose'
756           Open Software Foundation reference port of OSF/1 which uses
757           the OSF/rose object file format instead of ECOFF.  Normally,
758           you would not select this configuration.
759
760      The MIPS C compiler needs to be told to increase its table size
761      for switch statements with the `-Wf,-XNg1500' option in order to
762      compile `cp/parse.c'.  If you use the `-O2' optimization option,
763      you also need to use `-Olimit 3000'.  Both of these options are
764      automatically generated in the `Makefile' that the shell script
765      `configure' builds.  If you override the `CC' make variable and
766      use the MIPS compilers, you may need to add `-Wf,-XNg1500 -Olimit
767      3000'.
768
769 `elxsi-elxsi-bsd'
770      The Elxsi's C compiler has known limitations that prevent it from
771      compiling GNU C.  Please contact `mrs@cygnus.com' for more details.
772
773 `dsp16xx'
774      A port to the AT&T DSP1610 family of processors.
775
776 `h8300-*-*'
777      Hitachi H8/300 series of processors.
778
779      The calling convention and structure layout has changed in release
780      2.6.  All code must be recompiled.  The calling convention now
781      passes the first three arguments in function calls in registers.
782      Structures are no longer a multiple of 2 bytes.
783
784 `hppa*-*-*'
785      There are several variants of the HP-PA processor which run a
786      variety of operating systems.  GNU CC must be configured to use
787      the correct processor type and operating system, or GNU CC will
788      not function correctly.  The easiest way to handle this problem is
789      to *not* specify a target when configuring GNU CC, the `configure'
790      script will try to automatically determine the right processor
791      type and operating system.
792
793      `-g' does not work on HP-UX, since that system uses a peculiar
794      debugging format which GNU CC does not know about.  However, `-g'
795      will work if you also use GAS and GDB in conjunction with GCC.  We
796      highly recommend using GAS for all HP-PA configurations.
797
798      You should be using GAS-2.6 (or later) along with GDB-4.16 (or
799      later).  These can be retrieved from all the traditional GNU ftp
800      archive sites.
801
802      GAS will need to be installed into a directory before `/bin',
803      `/usr/bin', and `/usr/ccs/bin' in your search path.  You should
804      install GAS before you build GNU CC.
805
806      To enable debugging, you must configure GNU CC with the
807      `--with-gnu-as' option before building.
808
809 `i370-*-*'
810      This port is very preliminary and has many known bugs.  We hope to
811      have a higher-quality port for this machine soon.
812
813 `i386-*-linux-gnuoldld'
814      Use this configuration to generate `a.out' binaries on Linux-based
815      GNU systems if you do not have gas/binutils version 2.5.2 or later
816      installed. This is an obsolete configuration.
817
818 `i386-*-linux-gnuaout'
819      Use this configuration to generate `a.out' binaries on Linux-based
820      GNU systems. This configuration is being superseded. You must use
821      gas/binutils version 2.5.2 or later.
822
823 `i386-*-linux-gnu'
824      Use this configuration to generate ELF binaries on Linux-based GNU
825      systems.  You must use gas/binutils version 2.5.2 or later.
826
827 `i386-*-sco'
828      Compilation with RCC is recommended.  Also, it may be a good idea
829      to link with GNU malloc instead of the malloc that comes with the
830      system.
831
832 `i386-*-sco3.2v4'
833      Use this configuration for SCO release 3.2 version 4.
834
835 `i386-*-sco3.2v5*'
836      Use this for the SCO OpenServer Release family including 5.0.0,
837      5.0.2, 5.0.4, Internet FastStart 1.0, and Internet FastStart 1.1.
838
839      GNU CC can generate ELF binaries (if you specify `-melf') or COFF
840      binaries (the default).  If you are going to build your compiler
841      in ELF mode (once you have bootstrapped the first stage compiler)
842      you *must* specify `-melf' as part of `CC', *not* `CFLAGS', for
843      example as `CC="stage1/xgcc -melf -Bstage1/" '.  If you do not do
844      this, the bootstrap will generate incorrect versions of `libgcc.a'.
845
846      You must have TLS597 (from ftp.sco.com/TLS) installed for ELF
847      binaries to work correctly. Note that Open Server 5.0.2 *does*
848      need TLS597 installed.
849
850      *NOTE:* You must follow the instructions about invoking `make
851      bootstrap' because the native OpenServer compiler builds a
852      `cc1plus' that will not correctly parse many valid C++ programs.
853      You must do a `make bootstrap' if you are building with the native
854      compiler.
855
856 `i386-*-isc'
857      It may be a good idea to link with GNU malloc instead of the
858      malloc that comes with the system.
859
860      In ISC version 4.1, `sed' core dumps when building `deduced.h'.
861      Use the version of `sed' from version 4.0.
862
863 `i386-*-esix'
864      It may be good idea to link with GNU malloc instead of the malloc
865      that comes with the system.
866
867 `i386-ibm-aix'
868      You need to use GAS version 2.1 or later, and LD from GNU binutils
869      version 2.2 or later.
870
871 `i386-sequent-bsd'
872      Go to the Berkeley universe before compiling.
873
874 `i386-sequent-ptx1*'
875      Sequent DYNIX/ptx 1.x.
876
877 `i386-sequent-ptx2*'
878      Sequent DYNIX/ptx 2.x.
879
880 `i386-sun-sunos4'
881      You may find that you need another version of GNU CC to begin
882      bootstrapping with, since the current version when built with the
883      system's own compiler seems to get an infinite loop compiling part
884      of `libgcc2.c'.  GNU CC version 2 compiled with GNU CC (any
885      version) seems not to have this problem.
886
887      See *Note Sun Install::, for information on installing GNU CC on
888      Sun systems.
889
890 `i[345]86-*-winnt3.5'
891      This version requires a GAS that has not yet been released.  Until
892      it is, you can get a prebuilt binary version via anonymous ftp from
893      `cs.washington.edu:pub/gnat' or `cs.nyu.edu:pub/gnat'. You must
894      also use the Microsoft header files from the Windows NT 3.5 SDK.
895      Find these on the CDROM in the `/mstools/h' directory dated
896      9/4/94.  You must use a fixed version of Microsoft linker made
897      especially for NT 3.5, which is also is available on the NT 3.5
898      SDK CDROM.  If you do not have this linker, can you also use the
899      linker from Visual C/C++ 1.0 or 2.0.
900
901      Installing GNU CC for NT builds a wrapper linker, called `ld.exe',
902      which mimics the behaviour of Unix `ld' in the specification of
903      libraries (`-L' and `-l').  `ld.exe' looks for both Unix and
904      Microsoft named libraries.  For example, if you specify `-lfoo',
905      `ld.exe' will look first for `libfoo.a' and then for `foo.lib'.
906
907      You may install GNU CC for Windows NT in one of two ways,
908      depending on whether or not you have a Unix-like shell and various
909      Unix-like utilities.
910
911        1. If you do not have a Unix-like shell and few Unix-like
912           utilities, you will use a DOS style batch script called
913           `configure.bat'.  Invoke it as `configure winnt' from an
914           MSDOS console window or from the program manager dialog box.
915           `configure.bat' assumes you have already installed and have
916           in your path a Unix-like `sed' program which is used to
917           create a working `Makefile' from `Makefile.in'.
918
919           `Makefile' uses the Microsoft Nmake program maintenance
920           utility and the Visual C/C++ V8.00 compiler to build GNU CC.
921           You need only have the utilities `sed' and `touch' to use
922           this installation method, which only automatically builds the
923           compiler itself.  You must then examine what `fixinc.winnt'
924           does, edit the header files by hand and build `libgcc.a'
925           manually.
926
927        2. The second type of installation assumes you are running a
928           Unix-like shell, have a complete suite of Unix-like utilities
929           in your path, and have a previous version of GNU CC already
930           installed, either through building it via the above
931           installation method or acquiring a pre-built binary.  In this
932           case, use the `configure' script in the normal fashion.
933
934 `i860-intel-osf1'
935      This is the Paragon.  If you have version 1.0 of the operating
936      system, you need to take special steps to build GNU CC due to
937      peculiarities of the system.  Newer system versions have no
938      problem.  See the section `Installation Problems' in the GNU CC
939      Manual.
940
941 `*-lynx-lynxos'
942      LynxOS 2.2 and earlier comes with GNU CC 1.x already installed as
943      `/bin/gcc'.  You should compile with this instead of `/bin/cc'.
944      You can tell GNU CC to use the GNU assembler and linker, by
945      specifying `--with-gnu-as --with-gnu-ld' when configuring.  These
946      will produce COFF format object files and executables;  otherwise
947      GNU CC will use the installed tools, which produce `a.out' format
948      executables.
949
950 `m32r-*-elf'
951      Mitsubishi M32R processor.  This configuration is intended for
952      embedded systems.
953
954 `m68000-hp-bsd'
955      HP 9000 series 200 running BSD.  Note that the C compiler that
956      comes with this system cannot compile GNU CC; contact
957      `law@cygnus.com' to get binaries of GNU CC for bootstrapping.
958
959 `m68k-altos'
960      Altos 3068.  You must use the GNU assembler, linker and debugger.
961      Also, you must fix a kernel bug.  Details in the file
962      `README.ALTOS'.
963
964 `m68k-apple-aux'
965      Apple Macintosh running A/UX.  You may configure GCC  to use
966      either the system assembler and linker or the GNU assembler and
967      linker.  You should use the GNU configuration if you can,
968      especially if you also want to use GNU C++.  You enabled that
969      configuration with + the `--with-gnu-as' and `--with-gnu-ld'
970      options to `configure'.
971
972      Note the C compiler that comes with this system cannot compile GNU
973      CC.  You can fine binaries of GNU CC for bootstrapping on
974      `jagubox.gsfc.nasa.gov'.  You will also a patched version of
975      `/bin/ld' there that raises some of the arbitrary limits found in
976      the original.
977
978 `m68k-att-sysv'
979      AT&T 3b1, a.k.a. 7300 PC.  Special procedures are needed to
980      compile GNU CC with this machine's standard C compiler, due to
981      bugs in that compiler.  You can bootstrap it more easily with
982      previous versions of GNU CC if you have them.
983
984      Installing GNU CC on the 3b1 is difficult if you do not already
985      have GNU CC running, due to bugs in the installed C compiler.
986      However, the following procedure might work.  We are unable to
987      test it.
988
989        1. Comment out the `#include "config.h"' line near the start of
990           `cccp.c' and do `make cpp'.  This makes a preliminary version
991           of GNU cpp.
992
993        2. Save the old `/lib/cpp' and copy the preliminary GNU cpp to
994           that file name.
995
996        3. Undo your change in `cccp.c', or reinstall the original
997           version, and do `make cpp' again.
998
999        4. Copy this final version of GNU cpp into `/lib/cpp'.
1000
1001        5. Replace every occurrence of `obstack_free' in the file
1002           `tree.c' with `_obstack_free'.
1003
1004        6. Run `make' to get the first-stage GNU CC.
1005
1006        7. Reinstall the original version of `/lib/cpp'.
1007
1008        8. Now you can compile GNU CC with itself and install it in the
1009           normal fashion.
1010
1011 `m68k-bull-sysv'
1012      Bull DPX/2 series 200 and 300 with BOS-2.00.45 up to BOS-2.01. GNU
1013      CC works either with native assembler or GNU assembler. You can use
1014      GNU assembler with native coff generation by providing
1015      `--with-gnu-as' to the configure script or use GNU assembler with
1016      dbx-in-coff encapsulation by providing `--with-gnu-as --stabs'.
1017      For any problem with native assembler or for availability of the
1018      DPX/2 port of GAS, contact `F.Pierresteguy@frcl.bull.fr'.
1019
1020 `m68k-crds-unox'
1021      Use `configure unos' for building on Unos.
1022
1023      The Unos assembler is named `casm' instead of `as'.  For some
1024      strange reason linking `/bin/as' to `/bin/casm' changes the
1025      behavior, and does not work.  So, when installing GNU CC, you
1026      should install the following script as `as' in the subdirectory
1027      where the passes of GCC are installed:
1028
1029           #!/bin/sh
1030           casm $*
1031
1032      The default Unos library is named `libunos.a' instead of `libc.a'.
1033      To allow GNU CC to function, either change all references to
1034      `-lc' in `gcc.c' to `-lunos' or link `/lib/libc.a' to
1035      `/lib/libunos.a'.
1036
1037      When compiling GNU CC with the standard compiler, to overcome bugs
1038      in the support of `alloca', do not use `-O' when making stage 2.
1039      Then use the stage 2 compiler with `-O' to make the stage 3
1040      compiler.  This compiler will have the same characteristics as the
1041      usual stage 2 compiler on other systems.  Use it to make a stage 4
1042      compiler and compare that with stage 3 to verify proper
1043      compilation.
1044
1045      (Perhaps simply defining `ALLOCA' in `x-crds' as described in the
1046      comments there will make the above paragraph superfluous.  Please
1047      inform us of whether this works.)
1048
1049      Unos uses memory segmentation instead of demand paging, so you
1050      will need a lot of memory.  5 Mb is barely enough if no other
1051      tasks are running.  If linking `cc1' fails, try putting the object
1052      files into a library and linking from that library.
1053
1054 `m68k-hp-hpux'
1055      HP 9000 series 300 or 400 running HP-UX.  HP-UX version 8.0 has a
1056      bug in the assembler that prevents compilation of GNU CC.  To fix
1057      it, get patch PHCO_4484 from HP.
1058
1059      In addition, if you wish to use gas `--with-gnu-as' you must use
1060      gas version 2.1 or later, and you must use the GNU linker version
1061      2.1 or later.  Earlier versions of gas relied upon a program which
1062      converted the gas output into the native HP/UX format, but that
1063      program has not been kept up to date.  gdb does not understand
1064      that native HP/UX format, so you must use gas if you wish to use
1065      gdb.
1066
1067 `m68k-sun'
1068      Sun 3.  We do not provide a configuration file to use the Sun FPA
1069      by default, because programs that establish signal handlers for
1070      floating point traps inherently cannot work with the FPA.
1071
1072      See *Note Sun Install::, for information on installing GNU CC on
1073      Sun systems.
1074
1075 `m88k-*-svr3'
1076      Motorola m88k running the AT&T/Unisoft/Motorola V.3 reference port.
1077      These systems tend to use the Green Hills C, revision 1.8.5, as the
1078      standard C compiler.  There are apparently bugs in this compiler
1079      that result in object files differences between stage 2 and stage
1080      3.  If this happens, make the stage 4 compiler and compare it to
1081      the stage 3 compiler.  If the stage 3 and stage 4 object files are
1082      identical, this suggests you encountered a problem with the
1083      standard C compiler; the stage 3 and 4 compilers may be usable.
1084
1085      It is best, however, to use an older version of GNU CC for
1086      bootstrapping if you have one.
1087
1088 `m88k-*-dgux'
1089      Motorola m88k running DG/UX.  To build 88open BCS native or cross
1090      compilers on DG/UX, specify the configuration name as
1091      `m88k-*-dguxbcs' and build in the 88open BCS software development
1092      environment.  To build ELF native or cross compilers on DG/UX,
1093      specify `m88k-*-dgux' and build in the DG/UX ELF development
1094      environment.  You set the software development environment by
1095      issuing `sde-target' command and specifying either `m88kbcs' or
1096      `m88kdguxelf' as the operand.
1097
1098      If you do not specify a configuration name, `configure' guesses the
1099      configuration based on the current software development
1100      environment.
1101
1102 `m88k-tektronix-sysv3'
1103      Tektronix XD88 running UTekV 3.2e.  Do not turn on optimization
1104      while building stage1 if you bootstrap with the buggy Green Hills
1105      compiler.  Also, The bundled LAI System V NFS is buggy so if you
1106      build in an NFS mounted directory, start from a fresh reboot, or
1107      avoid NFS all together.  Otherwise you may have trouble getting
1108      clean comparisons between stages.
1109
1110 `mips-mips-bsd'
1111      MIPS machines running the MIPS operating system in BSD mode.  It's
1112      possible that some old versions of the system lack the functions
1113      `memcpy', `memcmp', and `memset'.  If your system lacks these, you
1114      must remove or undo the definition of `TARGET_MEM_FUNCTIONS' in
1115      `mips-bsd.h'.
1116
1117      The MIPS C compiler needs to be told to increase its table size
1118      for switch statements with the `-Wf,-XNg1500' option in order to
1119      compile `cp/parse.c'.  If you use the `-O2' optimization option,
1120      you also need to use `-Olimit 3000'.  Both of these options are
1121      automatically generated in the `Makefile' that the shell script
1122      `configure' builds.  If you override the `CC' make variable and
1123      use the MIPS compilers, you may need to add `-Wf,-XNg1500 -Olimit
1124      3000'.
1125
1126 `mips-mips-riscos*'
1127      The MIPS C compiler needs to be told to increase its table size
1128      for switch statements with the `-Wf,-XNg1500' option in order to
1129      compile `cp/parse.c'.  If you use the `-O2' optimization option,
1130      you also need to use `-Olimit 3000'.  Both of these options are
1131      automatically generated in the `Makefile' that the shell script
1132      `configure' builds.  If you override the `CC' make variable and
1133      use the MIPS compilers, you may need to add `-Wf,-XNg1500 -Olimit
1134      3000'.
1135
1136      MIPS computers running RISC-OS can support four different
1137      personalities: default, BSD 4.3, System V.3, and System V.4 (older
1138      versions of RISC-OS don't support V.4).  To configure GCC for
1139      these platforms use the following configurations:
1140
1141     `mips-mips-riscos`rev''
1142           Default configuration for RISC-OS, revision `rev'.
1143
1144     `mips-mips-riscos`rev'bsd'
1145           BSD 4.3 configuration for RISC-OS, revision `rev'.
1146
1147     `mips-mips-riscos`rev'sysv4'
1148           System V.4 configuration for RISC-OS, revision `rev'.
1149
1150     `mips-mips-riscos`rev'sysv'
1151           System V.3 configuration for RISC-OS, revision `rev'.
1152
1153      The revision `rev' mentioned above is the revision of RISC-OS to
1154      use.  You must reconfigure GCC when going from a RISC-OS revision
1155      4 to RISC-OS revision 5.  This has the effect of avoiding a linker
1156      bug.
1157
1158 `mips-sgi-*'
1159      In order to compile GCC on an SGI running IRIX 4, the "c.hdr.lib"
1160      option must be installed from the CD-ROM supplied from Silicon
1161      Graphics.  This is found on the 2nd CD in release 4.0.1.
1162
1163      In order to compile GCC on an SGI running IRIX 5, the
1164      "compiler_dev.hdr" subsystem must be installed from the IDO CD-ROM
1165      supplied by Silicon Graphics.
1166
1167      `make compare' may fail on version 5 of IRIX unless you add
1168      `-save-temps' to `CFLAGS'.  On these systems, the name of the
1169      assembler input file is stored in the object file, and that makes
1170      comparison fail if it differs between the `stage1' and `stage2'
1171      compilations.  The option `-save-temps' forces a fixed name to be
1172      used for the assembler input file, instead of a randomly chosen
1173      name in `/tmp'.  Do not add `-save-temps' unless the comparisons
1174      fail without that option.  If you do you `-save-temps', you will
1175      have to manually delete the `.i' and `.s' files after each series
1176      of compilations.
1177
1178      The MIPS C compiler needs to be told to increase its table size
1179      for switch statements with the `-Wf,-XNg1500' option in order to
1180      compile `cp/parse.c'.  If you use the `-O2' optimization option,
1181      you also need to use `-Olimit 3000'.  Both of these options are
1182      automatically generated in the `Makefile' that the shell script
1183      `configure' builds.  If you override the `CC' make variable and
1184      use the MIPS compilers, you may need to add `-Wf,-XNg1500 -Olimit
1185      3000'.
1186
1187      On Irix version 4.0.5F, and perhaps on some other versions as well,
1188      there is an assembler bug that reorders instructions incorrectly.
1189      To work around it, specify the target configuration
1190      `mips-sgi-irix4loser'.  This configuration inhibits assembler
1191      optimization.
1192
1193      In a compiler configured with target `mips-sgi-irix4', you can turn
1194      off assembler optimization by using the `-noasmopt' option.  This
1195      compiler option passes the option `-O0' to the assembler, to
1196      inhibit reordering.
1197
1198      The `-noasmopt' option can be useful for testing whether a problem
1199      is due to erroneous assembler reordering.  Even if a problem does
1200      not go away with `-noasmopt', it may still be due to assembler
1201      reordering--perhaps GNU CC itself was miscompiled as a result.
1202
1203      To enable debugging under Irix 5, you must use GNU as 2.5 or later,
1204      and use the `--with-gnu-as' configure option when configuring gcc.
1205      GNU as is distributed as part of the binutils package.
1206
1207 `mips-sony-sysv'
1208      Sony MIPS NEWS.  This works in NEWSOS 5.0.1, but not in 5.0.2
1209      (which uses ELF instead of COFF).  Support for 5.0.2 will probably
1210      be provided soon by volunteers.  In particular, the linker does
1211      not like the code generated by GCC when shared libraries are
1212      linked in.
1213
1214 `ns32k-encore'
1215      Encore ns32000 system.  Encore systems are supported only under
1216      BSD.
1217
1218 `ns32k-*-genix'
1219      National Semiconductor ns32000 system.  Genix has bugs in `alloca'
1220      and `malloc'; you must get the compiled versions of these from GNU
1221      Emacs.
1222
1223 `ns32k-sequent'
1224      Go to the Berkeley universe before compiling.
1225
1226 `ns32k-utek'
1227      UTEK ns32000 system ("merlin").  The C compiler that comes with
1228      this system cannot compile GNU CC; contact `tektronix!reed!mason'
1229      to get binaries of GNU CC for bootstrapping.
1230
1231 `romp-*-aos'
1232 `romp-*-mach'
1233      The only operating systems supported for the IBM RT PC are AOS and
1234      MACH.  GNU CC does not support AIX running on the RT.  We
1235      recommend you compile GNU CC with an earlier version of itself; if
1236      you compile GNU CC with `hc', the Metaware compiler, it will work,
1237      but you will get mismatches between the stage 2 and stage 3
1238      compilers in various files.  These errors are minor differences in
1239      some floating-point constants and can be safely ignored; the stage
1240      3 compiler is correct.
1241
1242 `rs6000-*-aix'
1243 `powerpc-*-aix'
1244      Various early versions of each release of the IBM XLC compiler
1245      will not bootstrap GNU CC.  Symptoms include differences between
1246      the stage2 and stage3 object files, and errors when compiling
1247      `libgcc.a' or `enquire'.  Known problematic releases include:
1248      xlc-1.2.1.8, xlc-1.3.0.0 (distributed with AIX 3.2.5), and
1249      xlc-1.3.0.19.  Both xlc-1.2.1.28 and xlc-1.3.0.24 (PTF 432238) are
1250      known to produce working versions of GNU CC, but most other recent
1251      releases correctly bootstrap GNU CC.  Also, releases of AIX prior
1252      to AIX 3.2.4 include a version of the IBM assembler which does not
1253      accept debugging directives: assembler updates are available as
1254      PTFs.  Also, if you are using AIX 3.2.5 or greater and the GNU
1255      assembler, you must have a version modified after October 16th,
1256      1995 in order for the GNU C compiler to build.  See the file
1257      `README.RS6000' for more details on of these problems.
1258
1259      GNU CC does not yet support the 64-bit PowerPC instructions.
1260
1261      Objective C does not work on this architecture because it makes
1262      assumptions that are incompatible with the calling conventions.
1263
1264      AIX on the RS/6000 provides support (NLS) for environments outside
1265      of the United States.  Compilers and assemblers use NLS to support
1266      locale-specific representations of various objects including
1267      floating-point numbers ("." vs "," for separating decimal
1268      fractions).  There have been problems reported where the library
1269      linked with GNU CC does not produce the same floating-point
1270      formats that the assembler accepts.  If you have this problem, set
1271      the LANG environment variable to "C" or "En_US".
1272
1273      Due to changes in the way that GNU CC invokes the binder (linker)
1274      for AIX 4.1, you may now receive warnings of duplicate symbols
1275      from the link step that were not reported before.  The assembly
1276      files generated by GNU CC for AIX have always included multiple
1277      symbol definitions for certain global variable and function
1278      declarations in the original program.  The warnings should not
1279      prevent the linker from producing a correct library or runnable
1280      executable.
1281
1282      By default, AIX 4.1 produces code that can be used on either Power
1283      or PowerPC processors.
1284
1285      You can specify a default version for the `-mcpu='CPU_TYPE switch
1286      by using the configure option `--with-cpu-'CPU_TYPE.
1287
1288 `powerpc-*-elf'
1289 `powerpc-*-sysv4'
1290      PowerPC system in big endian mode, running System V.4.
1291
1292      You can specify a default version for the `-mcpu='CPU_TYPE switch
1293      by using the configure option `--with-cpu-'CPU_TYPE.
1294
1295 `powerpc-*-linux-gnu'
1296      PowerPC system in big endian mode, running the Linux-based GNU
1297      system.
1298
1299      You can specify a default version for the `-mcpu='CPU_TYPE switch
1300      by using the configure option `--with-cpu-'CPU_TYPE.
1301
1302 `powerpc-*-eabiaix'
1303      Embedded PowerPC system in big endian mode with -mcall-aix
1304      selected as the default.
1305
1306      You can specify a default version for the `-mcpu='CPU_TYPE switch
1307      by using the configure option `--with-cpu-'CPU_TYPE.
1308
1309 `powerpc-*-eabisim'
1310      Embedded PowerPC system in big endian mode for use in running
1311      under the PSIM simulator.
1312
1313      You can specify a default version for the `-mcpu='CPU_TYPE switch
1314      by using the configure option `--with-cpu-'CPU_TYPE.
1315
1316 `powerpc-*-eabi'
1317      Embedded PowerPC system in big endian mode.
1318
1319      You can specify a default version for the `-mcpu='CPU_TYPE switch
1320      by using the configure option `--with-cpu-'CPU_TYPE.
1321
1322 `powerpcle-*-elf'
1323 `powerpcle-*-sysv4'
1324      PowerPC system in little endian mode, running System V.4.
1325
1326      You can specify a default version for the `-mcpu='CPU_TYPE switch
1327      by using the configure option `--with-cpu-'CPU_TYPE.
1328
1329 `powerpcle-*-solaris2*'
1330      PowerPC system in little endian mode, running Solaris 2.5.1 or
1331      higher.
1332
1333      You can specify a default version for the `-mcpu='CPU_TYPE switch
1334      by using the configure option `--with-cpu-'CPU_TYPE.  Beta
1335      versions of the Sun 4.0 compiler do not seem to be able to build
1336      GNU CC correctly.  There are also problems with the host assembler
1337      and linker that are fixed by using the GNU versions of these tools.
1338
1339 `powerpcle-*-eabisim'
1340      Embedded PowerPC system in little endian mode for use in running
1341      under the PSIM simulator.
1342
1343 `powerpcle-*-eabi'
1344      Embedded PowerPC system in little endian mode.
1345
1346      You can specify a default version for the `-mcpu='CPU_TYPE switch
1347      by using the configure option `--with-cpu-'CPU_TYPE.
1348
1349 `powerpcle-*-winnt'
1350 `powerpcle-*-pe'
1351      PowerPC system in little endian mode running Windows NT.
1352
1353      You can specify a default version for the `-mcpu='CPU_TYPE switch
1354      by using the configure option `--with-cpu-'CPU_TYPE.
1355
1356 `vax-dec-ultrix'
1357      Don't try compiling with Vax C (`vcc').  It produces incorrect code
1358      in some cases (for example, when `alloca' is used).
1359
1360      Meanwhile, compiling `cp/parse.c' with pcc does not work because of
1361      an internal table size limitation in that compiler.  To avoid this
1362      problem, compile just the GNU C compiler first, and use it to
1363      recompile building all the languages that you want to run.
1364
1365 `sparc-sun-*'
1366      See *Note Sun Install::, for information on installing GNU CC on
1367      Sun systems.
1368
1369 `vax-dec-vms'
1370      See *Note VMS Install::, for details on how to install GNU CC on
1371      VMS.
1372
1373 `we32k-*-*'
1374      These computers are also known as the 3b2, 3b5, 3b20 and other
1375      similar names.  (However, the 3b1 is actually a 68000; see *Note
1376      Configurations::.)
1377
1378      Don't use `-g' when compiling with the system's compiler.  The
1379      system's linker seems to be unable to handle such a large program
1380      with debugging information.
1381
1382      The system's compiler runs out of capacity when compiling `stmt.c'
1383      in GNU CC.  You can work around this by building `cpp' in GNU CC
1384      first, then use that instead of the system's preprocessor with the
1385      system's C compiler to compile `stmt.c'.  Here is how:
1386
1387           mv /lib/cpp /lib/cpp.att
1388           cp cpp /lib/cpp.gnu
1389           echo '/lib/cpp.gnu -traditional ${1+"$@"}' > /lib/cpp
1390           chmod +x /lib/cpp
1391
1392      The system's compiler produces bad code for some of the GNU CC
1393      optimization files.  So you must build the stage 2 compiler without
1394      optimization.  Then build a stage 3 compiler with optimization.
1395      That executable should work.  Here are the necessary commands:
1396
1397           make LANGUAGES=c CC=stage1/xgcc CFLAGS="-Bstage1/ -g"
1398           make stage2
1399           make CC=stage2/xgcc CFLAGS="-Bstage2/ -g -O"
1400
1401      You may need to raise the ULIMIT setting to build a C++ compiler,
1402      as the file `cc1plus' is larger than one megabyte.
1403
1404 Compilation in a Separate Directory
1405 ===================================
1406
1407    If you wish to build the object files and executables in a directory
1408 other than the one containing the source files, here is what you must
1409 do differently:
1410
1411   1. Make sure you have a version of Make that supports the `VPATH'
1412      feature.  (GNU Make supports it, as do Make versions on most BSD
1413      systems.)
1414
1415   2. If you have ever run `configure' in the source directory, you must
1416      undo the configuration.  Do this by running:
1417
1418           make distclean
1419
1420   3. Go to the directory in which you want to build the compiler before
1421      running `configure':
1422
1423           mkdir gcc-sun3
1424           cd gcc-sun3
1425
1426      On systems that do not support symbolic links, this directory must
1427      be on the same file system as the source code directory.
1428
1429   4. Specify where to find `configure' when you run it:
1430
1431           ../gcc/configure ...
1432
1433      This also tells `configure' where to find the compiler sources;
1434      `configure' takes the directory from the file name that was used to
1435      invoke it.  But if you want to be sure, you can specify the source
1436      directory with the `--srcdir' option, like this:
1437
1438           ../gcc/configure --srcdir=../gcc OTHER OPTIONS
1439
1440      The directory you specify with `--srcdir' need not be the same as
1441      the one that `configure' is found in.
1442
1443    Now, you can run `make' in that directory.  You need not repeat the
1444 configuration steps shown above, when ordinary source files change.  You
1445 must, however, run `configure' again when the configuration files
1446 change, if your system does not support symbolic links.
1447
1448 Building and Installing a Cross-Compiler
1449 ========================================
1450
1451    GNU CC can function as a cross-compiler for many machines, but not
1452 all.
1453
1454    * Cross-compilers for the Mips as target using the Mips assembler
1455      currently do not work, because the auxiliary programs
1456      `mips-tdump.c' and `mips-tfile.c' can't be compiled on anything
1457      but a Mips.  It does work to cross compile for a Mips if you use
1458      the GNU assembler and linker.
1459
1460    * Cross-compilers between machines with different floating point
1461      formats have not all been made to work.  GNU CC now has a floating
1462      point emulator with which these can work, but each target machine
1463      description needs to be updated to take advantage of it.
1464
1465    * Cross-compilation between machines of different word sizes is
1466      somewhat problematic and sometimes does not work.
1467
1468    Since GNU CC generates assembler code, you probably need a
1469 cross-assembler that GNU CC can run, in order to produce object files.
1470 If you want to link on other than the target machine, you need a
1471 cross-linker as well.  You also need header files and libraries suitable
1472 for the target machine that you can install on the host machine.
1473
1474 Steps of Cross-Compilation
1475 --------------------------
1476
1477    To compile and run a program using a cross-compiler involves several
1478 steps:
1479
1480    * Run the cross-compiler on the host machine to produce assembler
1481      files for the target machine.  This requires header files for the
1482      target machine.
1483
1484    * Assemble the files produced by the cross-compiler.  You can do this
1485      either with an assembler on the target machine, or with a
1486      cross-assembler on the host machine.
1487
1488    * Link those files to make an executable.  You can do this either
1489      with a linker on the target machine, or with a cross-linker on the
1490      host machine.  Whichever machine you use, you need libraries and
1491      certain startup files (typically `crt....o') for the target
1492      machine.
1493
1494    It is most convenient to do all of these steps on the same host
1495 machine, since then you can do it all with a single invocation of GNU
1496 CC.  This requires a suitable cross-assembler and cross-linker.  For
1497 some targets, the GNU assembler and linker are available.
1498
1499 Configuring a Cross-Compiler
1500 ----------------------------
1501
1502    To build GNU CC as a cross-compiler, you start out by running
1503 `configure'.  Use the `--target=TARGET' to specify the target type.  If
1504 `configure' was unable to correctly identify the system you are running
1505 on, also specify the `--build=BUILD' option.  For example, here is how
1506 to configure for a cross-compiler that produces code for an HP 68030
1507 system running BSD on a system that `configure' can correctly identify:
1508
1509      ./configure --target=m68k-hp-bsd4.3
1510
1511 Tools and Libraries for a Cross-Compiler
1512 ----------------------------------------
1513
1514    If you have a cross-assembler and cross-linker available, you should
1515 install them now.  Put them in the directory `/usr/local/TARGET/bin'.
1516 Here is a table of the tools you should put in this directory:
1517
1518 `as'
1519      This should be the cross-assembler.
1520
1521 `ld'
1522      This should be the cross-linker.
1523
1524 `ar'
1525      This should be the cross-archiver: a program which can manipulate
1526      archive files (linker libraries) in the target machine's format.
1527
1528 `ranlib'
1529      This should be a program to construct a symbol table in an archive
1530      file.
1531
1532    The installation of GNU CC will find these programs in that
1533 directory, and copy or link them to the proper place to for the
1534 cross-compiler to find them when run later.
1535
1536    The easiest way to provide these files is to build the Binutils
1537 package and GAS.  Configure them with the same `--host' and `--target'
1538 options that you use for configuring GNU CC, then build and install
1539 them.  They install their executables automatically into the proper
1540 directory.  Alas, they do not support all the targets that GNU CC
1541 supports.
1542
1543    If you want to install libraries to use with the cross-compiler,
1544 such as a standard C library, put them in the directory
1545 `/usr/local/TARGET/lib'; installation of GNU CC copies all the files in
1546 that subdirectory into the proper place for GNU CC to find them and
1547 link with them.  Here's an example of copying some libraries from a
1548 target machine:
1549
1550      ftp TARGET-MACHINE
1551      lcd /usr/local/TARGET/lib
1552      cd /lib
1553      get libc.a
1554      cd /usr/lib
1555      get libg.a
1556      get libm.a
1557      quit
1558
1559 The precise set of libraries you'll need, and their locations on the
1560 target machine, vary depending on its operating system.
1561
1562    Many targets require "start files" such as `crt0.o' and `crtn.o'
1563 which are linked into each executable; these too should be placed in
1564 `/usr/local/TARGET/lib'.  There may be several alternatives for
1565 `crt0.o', for use with profiling or other compilation options.  Check
1566 your target's definition of `STARTFILE_SPEC' to find out what start
1567 files it uses.  Here's an example of copying these files from a target
1568 machine:
1569
1570      ftp TARGET-MACHINE
1571      lcd /usr/local/TARGET/lib
1572      prompt
1573      cd /lib
1574      mget *crt*.o
1575      cd /usr/lib
1576      mget *crt*.o
1577      quit
1578
1579 `libgcc.a' and Cross-Compilers
1580 ------------------------------
1581
1582    Code compiled by GNU CC uses certain runtime support functions
1583 implicitly.  Some of these functions can be compiled successfully with
1584 GNU CC itself, but a few cannot be.  These problem functions are in the
1585 source file `libgcc1.c'; the library made from them is called
1586 `libgcc1.a'.
1587
1588    When you build a native compiler, these functions are compiled with
1589 some other compiler-the one that you use for bootstrapping GNU CC.
1590 Presumably it knows how to open code these operations, or else knows how
1591 to call the run-time emulation facilities that the machine comes with.
1592 But this approach doesn't work for building a cross-compiler.  The
1593 compiler that you use for building knows about the host system, not the
1594 target system.
1595
1596    So, when you build a cross-compiler you have to supply a suitable
1597 library `libgcc1.a' that does the job it is expected to do.
1598
1599    To compile `libgcc1.c' with the cross-compiler itself does not work.
1600 The functions in this file are supposed to implement arithmetic
1601 operations that GNU CC does not know how to open code for your target
1602 machine.  If these functions are compiled with GNU CC itself, they will
1603 compile into infinite recursion.
1604
1605    On any given target, most of these functions are not needed.  If GNU
1606 CC can open code an arithmetic operation, it will not call these
1607 functions to perform the operation.  It is possible that on your target
1608 machine, none of these functions is needed.  If so, you can supply an
1609 empty library as `libgcc1.a'.
1610
1611    Many targets need library support only for multiplication and
1612 division.  If you are linking with a library that contains functions for
1613 multiplication and division, you can tell GNU CC to call them directly
1614 by defining the macros `MULSI3_LIBCALL', and the like.  These macros
1615 need to be defined in the target description macro file.  For some
1616 targets, they are defined already.  This may be sufficient to avoid the
1617 need for libgcc1.a; if so, you can supply an empty library.
1618
1619    Some targets do not have floating point instructions; they need other
1620 functions in `libgcc1.a', which do floating arithmetic.  Recent
1621 versions of GNU CC have a file which emulates floating point.  With a
1622 certain amount of work, you should be able to construct a floating
1623 point emulator that can be used as `libgcc1.a'.  Perhaps future
1624 versions will contain code to do this automatically and conveniently.
1625 That depends on whether someone wants to implement it.
1626
1627    Some embedded targets come with all the necessary `libgcc1.a'
1628 routines written in C or assembler.  These targets build `libgcc1.a'
1629 automatically and you do not need to do anything special for them.
1630 Other embedded targets do not need any `libgcc1.a' routines since all
1631 the necessary operations are supported by the hardware.
1632
1633    If your target system has another C compiler, you can configure GNU
1634 CC as a native compiler on that machine, build just `libgcc1.a' with
1635 `make libgcc1.a' on that machine, and use the resulting file with the
1636 cross-compiler.  To do this, execute the following on the target
1637 machine:
1638
1639      cd TARGET-BUILD-DIR
1640      ./configure --host=sparc --target=sun3
1641      make libgcc1.a
1642
1643 And then this on the host machine:
1644
1645      ftp TARGET-MACHINE
1646      binary
1647      cd TARGET-BUILD-DIR
1648      get libgcc1.a
1649      quit
1650
1651    Another way to provide the functions you need in `libgcc1.a' is to
1652 define the appropriate `perform_...' macros for those functions.  If
1653 these definitions do not use the C arithmetic operators that they are
1654 meant to implement, you should be able to compile them with the
1655 cross-compiler you are building.  (If these definitions already exist
1656 for your target file, then you are all set.)
1657
1658    To build `libgcc1.a' using the perform macros, use
1659 `LIBGCC1=libgcc1.a OLDCC=./xgcc' when building the compiler.
1660 Otherwise, you should place your replacement library under the name
1661 `libgcc1.a' in the directory in which you will build the
1662 cross-compiler, before you run `make'.
1663
1664 Cross-Compilers and Header Files
1665 --------------------------------
1666
1667    If you are cross-compiling a standalone program or a program for an
1668 embedded system, then you may not need any header files except the few
1669 that are part of GNU CC (and those of your program).  However, if you
1670 intend to link your program with a standard C library such as `libc.a',
1671 then you probably need to compile with the header files that go with
1672 the library you use.
1673
1674    The GNU C compiler does not come with these files, because (1) they
1675 are system-specific, and (2) they belong in a C library, not in a
1676 compiler.
1677
1678    If the GNU C library supports your target machine, then you can get
1679 the header files from there (assuming you actually use the GNU library
1680 when you link your program).
1681
1682    If your target machine comes with a C compiler, it probably comes
1683 with suitable header files also.  If you make these files accessible
1684 from the host machine, the cross-compiler can use them also.
1685
1686    Otherwise, you're on your own in finding header files to use when
1687 cross-compiling.
1688
1689    When you have found suitable header files, put them in the directory
1690 `/usr/local/TARGET/include', before building the cross compiler.  Then
1691 installation will run fixincludes properly and install the corrected
1692 versions of the header files where the compiler will use them.
1693
1694    Provide the header files before you build the cross-compiler, because
1695 the build stage actually runs the cross-compiler to produce parts of
1696 `libgcc.a'.  (These are the parts that *can* be compiled with GNU CC.)
1697 Some of them need suitable header files.
1698
1699    Here's an example showing how to copy the header files from a target
1700 machine.  On the target machine, do this:
1701
1702      (cd /usr/include; tar cf - .) > tarfile
1703
1704    Then, on the host machine, do this:
1705
1706      ftp TARGET-MACHINE
1707      lcd /usr/local/TARGET/include
1708      get tarfile
1709      quit
1710      tar xf tarfile
1711
1712 Actually Building the Cross-Compiler
1713 ------------------------------------
1714
1715    Now you can proceed just as for compiling a single-machine compiler
1716 through the step of building stage 1.  If you have not provided some
1717 sort of `libgcc1.a', then compilation will give up at the point where
1718 it needs that file, printing a suitable error message.  If you do
1719 provide `libgcc1.a', then building the compiler will automatically
1720 compile and link a test program called `libgcc1-test'; if you get
1721 errors in the linking, it means that not all of the necessary routines
1722 in `libgcc1.a' are available.
1723
1724    You must provide the header file `float.h'.  One way to do this is
1725 to compile `enquire' and run it on your target machine.  The job of
1726 `enquire' is to run on the target machine and figure out by experiment
1727 the nature of its floating point representation.  `enquire' records its
1728 findings in the header file `float.h'.  If you can't produce this file
1729 by running `enquire' on the target machine, then you will need to come
1730 up with a suitable `float.h' in some other way (or else, avoid using it
1731 in your programs).
1732
1733    Do not try to build stage 2 for a cross-compiler.  It doesn't work to
1734 rebuild GNU CC as a cross-compiler using the cross-compiler, because
1735 that would produce a program that runs on the target machine, not on the
1736 host.  For example, if you compile a 386-to-68030 cross-compiler with
1737 itself, the result will not be right either for the 386 (because it was
1738 compiled into 68030 code) or for the 68030 (because it was configured
1739 for a 386 as the host).  If you want to compile GNU CC into 68030 code,
1740 whether you compile it on a 68030 or with a cross-compiler on a 386, you
1741 must specify a 68030 as the host when you configure it.
1742
1743    To install the cross-compiler, use `make install', as usual.
1744
1745 Installing GNU CC on the Sun
1746 ============================
1747
1748    On Solaris (version 2.1), do not use the linker or other tools in
1749 `/usr/ucb' to build GNU CC.  Use `/usr/ccs/bin'.
1750
1751    Make sure the environment variable `FLOAT_OPTION' is not set when
1752 you compile `libgcc.a'.  If this option were set to `f68881' when
1753 `libgcc.a' is compiled, the resulting code would demand to be linked
1754 with a special startup file and would not link properly without special
1755 pains.
1756
1757    There is a bug in `alloca' in certain versions of the Sun library.
1758 To avoid this bug, install the binaries of GNU CC that were compiled by
1759 GNU CC.  They use `alloca' as a built-in function and never the one in
1760 the library.
1761
1762    Some versions of the Sun compiler crash when compiling GNU CC.  The
1763 problem is a segmentation fault in cpp.  This problem seems to be due to
1764 the bulk of data in the environment variables.  You may be able to avoid
1765 it by using the following command to compile GNU CC with Sun CC:
1766
1767      make CC="TERMCAP=x OBJS=x LIBFUNCS=x STAGESTUFF=x cc"
1768
1769    SunOS 4.1.3 and 4.1.3_U1 have bugs that can cause intermittent core
1770 dumps when compiling GNU CC.  A common symptom is an internal compiler
1771 error which does not recur if you run it again.  To fix the problem,
1772 install Sun recommended patch 100726 (for SunOS 4.1.3) or 101508 (for
1773 SunOS 4.1.3_U1), or upgrade to a later SunOS release.
1774
1775 Installing GNU CC on VMS
1776 ========================
1777
1778    The VMS version of GNU CC is distributed in a backup saveset
1779 containing both source code and precompiled binaries.
1780
1781    To install the `gcc' command so you can use the compiler easily, in
1782 the same manner as you use the VMS C compiler, you must install the VMS
1783 CLD file for GNU CC as follows:
1784
1785   1. Define the VMS logical names `GNU_CC' and `GNU_CC_INCLUDE' to
1786      point to the directories where the GNU CC executables
1787      (`gcc-cpp.exe', `gcc-cc1.exe', etc.) and the C include files are
1788      kept respectively.  This should be done with the commands:
1789
1790           $ assign /system /translation=concealed -
1791             disk:[gcc.] gnu_cc
1792           $ assign /system /translation=concealed -
1793             disk:[gcc.include.] gnu_cc_include
1794
1795      with the appropriate disk and directory names.  These commands can
1796      be placed in your system startup file so they will be executed
1797      whenever the machine is rebooted.  You may, if you choose, do this
1798      via the `GCC_INSTALL.COM' script in the `[GCC]' directory.
1799
1800   2. Install the `GCC' command with the command line:
1801
1802           $ set command /table=sys$common:[syslib]dcltables -
1803             /output=sys$common:[syslib]dcltables gnu_cc:[000000]gcc
1804           $ install replace sys$common:[syslib]dcltables
1805
1806   3. To install the help file, do the following:
1807
1808           $ library/help sys$library:helplib.hlb gcc.hlp
1809
1810      Now you can invoke the compiler with a command like `gcc /verbose
1811      file.c', which is equivalent to the command `gcc -v -c file.c' in
1812      Unix.
1813
1814    If you wish to use GNU C++ you must first install GNU CC, and then
1815 perform the following steps:
1816
1817   1. Define the VMS logical name `GNU_GXX_INCLUDE' to point to the
1818      directory where the preprocessor will search for the C++ header
1819      files.  This can be done with the command:
1820
1821           $ assign /system /translation=concealed -
1822             disk:[gcc.gxx_include.] gnu_gxx_include
1823
1824      with the appropriate disk and directory name.  If you are going to
1825      be using a C++ runtime library, this is where its install
1826      procedure will install its header files.
1827
1828   2. Obtain the file `gcc-cc1plus.exe', and place this in the same
1829      directory that `gcc-cc1.exe' is kept.
1830
1831      The GNU C++ compiler can be invoked with a command like `gcc /plus
1832      /verbose file.cc', which is equivalent to the command `g++ -v -c
1833      file.cc' in Unix.
1834
1835    We try to put corresponding binaries and sources on the VMS
1836 distribution tape.  But sometimes the binaries will be from an older
1837 version than the sources, because we don't always have time to update
1838 them.  (Use the `/version' option to determine the version number of
1839 the binaries and compare it with the source file `version.c' to tell
1840 whether this is so.)  In this case, you should use the binaries you get
1841 to recompile the sources.  If you must recompile, here is how:
1842
1843   1. Execute the command procedure `vmsconfig.com' to set up the files
1844      `tm.h', `config.h', `aux-output.c', and `md.', and to create files
1845      `tconfig.h' and `hconfig.h'.  This procedure also creates several
1846      linker option files used by `make-cc1.com' and a data file used by
1847      `make-l2.com'.
1848
1849           $ @vmsconfig.com
1850
1851   2. Setup the logical names and command tables as defined above.  In
1852      addition, define the VMS logical name `GNU_BISON' to point at the
1853      to the directories where the Bison executable is kept.  This
1854      should be done with the command:
1855
1856           $ assign /system /translation=concealed -
1857             disk:[bison.] gnu_bison
1858
1859      You may, if you choose, use the `INSTALL_BISON.COM' script in the
1860      `[BISON]' directory.
1861
1862   3. Install the `BISON' command with the command line:
1863
1864           $ set command /table=sys$common:[syslib]dcltables -
1865             /output=sys$common:[syslib]dcltables -
1866             gnu_bison:[000000]bison
1867           $ install replace sys$common:[syslib]dcltables
1868
1869   4. Type `@make-gcc' to recompile everything (alternatively, submit
1870      the file `make-gcc.com' to a batch queue).  If you wish to build
1871      the GNU C++ compiler as well as the GNU CC compiler, you must
1872      first edit `make-gcc.com' and follow the instructions that appear
1873      in the comments.
1874
1875   5. In order to use GCC, you need a library of functions which GCC
1876      compiled code will call to perform certain tasks, and these
1877      functions are defined in the file `libgcc2.c'.  To compile this
1878      you should use the command procedure `make-l2.com', which will
1879      generate the library `libgcc2.olb'.  `libgcc2.olb' should be built
1880      using the compiler built from the same distribution that
1881      `libgcc2.c' came from, and `make-gcc.com' will automatically do
1882      all of this for you.
1883
1884      To install the library, use the following commands:
1885
1886           $ library gnu_cc:[000000]gcclib/delete=(new,eprintf)
1887           $ library gnu_cc:[000000]gcclib/delete=L_*
1888           $ library libgcc2/extract=*/output=libgcc2.obj
1889           $ library gnu_cc:[000000]gcclib libgcc2.obj
1890
1891      The first command simply removes old modules that will be replaced
1892      with modules from `libgcc2' under different module names.  The
1893      modules `new' and `eprintf' may not actually be present in your
1894      `gcclib.olb'--if the VMS librarian complains about those modules
1895      not being present, simply ignore the message and continue on with
1896      the next command.  The second command removes the modules that
1897      came from the previous version of the library `libgcc2.c'.
1898
1899      Whenever you update the compiler on your system, you should also
1900      update the library with the above procedure.
1901
1902   6. You may wish to build GCC in such a way that no files are written
1903      to the directory where the source files reside.  An example would
1904      be the when the source files are on a read-only disk.  In these
1905      cases, execute the following DCL commands (substituting your
1906      actual path names):
1907
1908           $ assign dua0:[gcc.build_dir.]/translation=concealed, -
1909                    dua1:[gcc.source_dir.]/translation=concealed  gcc_build
1910           $ set default gcc_build:[000000]
1911
1912      where the directory `dua1:[gcc.source_dir]' contains the source
1913      code, and the directory `dua0:[gcc.build_dir]' is meant to contain
1914      all of the generated object files and executables.  Once you have
1915      done this, you can proceed building GCC as described above.  (Keep
1916      in mind that `gcc_build' is a rooted logical name, and thus the
1917      device names in each element of the search list must be an actual
1918      physical device name rather than another rooted logical name).
1919
1920   7. *If you are building GNU CC with a previous version of GNU CC, you
1921      also should check to see that you have the newest version of the
1922      assembler*.  In particular, GNU CC version 2 treats global constant
1923      variables slightly differently from GNU CC version 1, and GAS
1924      version 1.38.1 does not have the patches required to work with GCC
1925      version 2.  If you use GAS 1.38.1, then `extern const' variables
1926      will not have the read-only bit set, and the linker will generate
1927      warning messages about mismatched psect attributes for these
1928      variables.  These warning messages are merely a nuisance, and can
1929      safely be ignored.
1930
1931      If you are compiling with a version of GNU CC older than 1.33,
1932      specify `/DEFINE=("inline=")' as an option in all the
1933      compilations.  This requires editing all the `gcc' commands in
1934      `make-cc1.com'.  (The older versions had problems supporting
1935      `inline'.)  Once you have a working 1.33 or newer GNU CC, you can
1936      change this file back.
1937
1938   8. If you want to build GNU CC with the VAX C compiler, you will need
1939      to make minor changes in `make-cccp.com' and `make-cc1.com' to
1940      choose alternate definitions of `CC', `CFLAGS', and `LIBS'.  See
1941      comments in those files.  However, you must also have a working
1942      version of the GNU assembler (GNU as, aka GAS) as it is used as
1943      the back-end for GNU CC to produce binary object modules and is
1944      not included in the GNU CC sources.  GAS is also needed to compile
1945      `libgcc2' in order to build `gcclib' (see above); `make-l2.com'
1946      expects to be able to find it operational in
1947      `gnu_cc:[000000]gnu-as.exe'.
1948
1949      To use GNU CC on VMS, you need the VMS driver programs `gcc.exe',
1950      `gcc.com', and `gcc.cld'.  They are distributed with the VMS
1951      binaries (`gcc-vms') rather than the GNU CC sources.  GAS is also
1952      included in `gcc-vms', as is Bison.
1953
1954      Once you have successfully built GNU CC with VAX C, you should use
1955      the resulting compiler to rebuild itself.  Before doing this, be
1956      sure to restore the `CC', `CFLAGS', and `LIBS' definitions in
1957      `make-cccp.com' and `make-cc1.com'.  The second generation
1958      compiler will be able to take advantage of many optimizations that
1959      must be suppressed when building with other compilers.
1960
1961    Under previous versions of GNU CC, the generated code would
1962 occasionally give strange results when linked with the sharable
1963 `VAXCRTL' library.  Now this should work.
1964
1965    Even with this version, however, GNU CC itself should not be linked
1966 with the sharable `VAXCRTL'.  The version of `qsort' in `VAXCRTL' has a
1967 bug (known to be present in VMS versions V4.6 through V5.5) which
1968 causes the compiler to fail.
1969
1970    The executables are generated by `make-cc1.com' and `make-cccp.com'
1971 use the object library version of `VAXCRTL' in order to make use of the
1972 `qsort' routine in `gcclib.olb'.  If you wish to link the compiler
1973 executables with the shareable image version of `VAXCRTL', you should
1974 edit the file `tm.h' (created by `vmsconfig.com') to define the macro
1975 `QSORT_WORKAROUND'.
1976
1977    `QSORT_WORKAROUND' is always defined when GNU CC is compiled with
1978 VAX C, to avoid a problem in case `gcclib.olb' is not yet available.
1979
1980 `collect2'
1981 ==========
1982
1983    GNU CC uses a utility called `collect2' on nearly all systems to
1984 arrange to call various initialization functions at start time.
1985
1986    The program `collect2' works by linking the program once and looking
1987 through the linker output file for symbols with particular names
1988 indicating they are constructor functions.  If it finds any, it creates
1989 a new temporary `.c' file containing a table of them, compiles it, and
1990 links the program a second time including that file.
1991
1992    The actual calls to the constructors are carried out by a subroutine
1993 called `__main', which is called (automatically) at the beginning of
1994 the body of `main' (provided `main' was compiled with GNU CC).  Calling
1995 `__main' is necessary, even when compiling C code, to allow linking C
1996 and C++ object code together.  (If you use `-nostdlib', you get an
1997 unresolved reference to `__main', since it's defined in the standard
1998 GCC library.  Include `-lgcc' at the end of your compiler command line
1999 to resolve this reference.)
2000
2001    The program `collect2' is installed as `ld' in the directory where
2002 the passes of the compiler are installed.  When `collect2' needs to
2003 find the *real* `ld', it tries the following file names:
2004
2005    * `real-ld' in the directories listed in the compiler's search
2006      directories.
2007
2008    * `real-ld' in the directories listed in the environment variable
2009      `PATH'.
2010
2011    * The file specified in the `REAL_LD_FILE_NAME' configuration macro,
2012      if specified.
2013
2014    * `ld' in the compiler's search directories, except that `collect2'
2015      will not execute itself recursively.
2016
2017    * `ld' in `PATH'.
2018
2019    "The compiler's search directories" means all the directories where
2020 `gcc' searches for passes of the compiler.  This includes directories
2021 that you specify with `-B'.
2022
2023    Cross-compilers search a little differently:
2024
2025    * `real-ld' in the compiler's search directories.
2026
2027    * `TARGET-real-ld' in `PATH'.
2028
2029    * The file specified in the `REAL_LD_FILE_NAME' configuration macro,
2030      if specified.
2031
2032    * `ld' in the compiler's search directories.
2033
2034    * `TARGET-ld' in `PATH'.
2035
2036    `collect2' explicitly avoids running `ld' using the file name under
2037 which `collect2' itself was invoked.  In fact, it remembers up a list
2038 of such names--in case one copy of `collect2' finds another copy (or
2039 version) of `collect2' installed as `ld' in a second place in the
2040 search path.
2041
2042    `collect2' searches for the utilities `nm' and `strip' using the
2043 same algorithm as above for `ld'.
2044
2045 Standard Header File Directories
2046 ================================
2047
2048    `GCC_INCLUDE_DIR' means the same thing for native and cross.  It is
2049 where GNU CC stores its private include files, and also where GNU CC
2050 stores the fixed include files.  A cross compiled GNU CC runs
2051 `fixincludes' on the header files in `$(tooldir)/include'.  (If the
2052 cross compilation header files need to be fixed, they must be installed
2053 before GNU CC is built.  If the cross compilation header files are
2054 already suitable for ANSI C and GNU CC, nothing special need be done).
2055
2056    `GPLUS_INCLUDE_DIR' means the same thing for native and cross.  It
2057 is where `g++' looks first for header files.  The C++ library installs
2058 only target independent header files in that directory.
2059
2060    `LOCAL_INCLUDE_DIR' is used only for a native compiler.  It is
2061 normally `/usr/local/include'.  GNU CC searches this directory so that
2062 users can install header files in `/usr/local/include'.
2063
2064    `CROSS_INCLUDE_DIR' is used only for a cross compiler.  GNU CC
2065 doesn't install anything there.
2066
2067    `TOOL_INCLUDE_DIR' is used for both native and cross compilers.  It
2068 is the place for other packages to install header files that GNU CC will
2069 use.  For a cross-compiler, this is the equivalent of `/usr/include'.
2070 When you build a cross-compiler, `fixincludes' processes any header
2071 files in this directory.
2072