gcc/doc/gccint.texi

   1 \input texinfo  @c -*-texinfo-*-
   2 @c %**start of header
   3 @setfilename gccint.info
   4 @c INTERNALS is used by md.texi to determine whether to include the
   5 @c whole of that file, in the internals manual, or only the part
   6 @c dealing with constraints, in the user manual.
   7 @set INTERNALS
   8
   9 @c See miscellaneous notes in gcc.texi on checks/things to do.
  10
  11 @include gcc-common.texi
  12
  13 @settitle GNU Compiler Collection (GCC) Internals
  14
  15 @c Create a separate index for command line options.
  16 @defcodeindex op
  17 @c Merge the standard indexes into a single one.
  18 @syncodeindex fn cp
  19 @syncodeindex vr cp
  20 @syncodeindex ky cp
  21 @syncodeindex pg cp
  22 @syncodeindex tp cp
  23
  24 @c %**end of header
  25
  26 @c Use with @@smallbook.
  27
  28 @c Cause even numbered pages to be printed on the left hand side of
  29 @c the page and odd numbered pages to be printed on the right hand
  30 @c side of the page.  Using this, you can print on both sides of a
  31 @c sheet of paper and have the text on the same part of the sheet.
  32
  33 @c The text on right hand pages is pushed towards the right hand
  34 @c margin and the text on left hand pages is pushed toward the left
  35 @c hand margin.
  36 @c (To provide the reverse effect, set bindingoffset to -0.75in.)
  37
  38 @c @tex
  39 @c \global\bindingoffset=0.75in
  40 @c \global\normaloffset =0.75in
  41 @c @end tex
  42
  43 @copying
  44 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
  45 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc.
  46
  47 Permission is granted to copy, distribute and/or modify this document
  48 under the terms of the GNU Free Documentation License, Version 1.2 or
  49 any later version published by the Free Software Foundation; with the
  50 Invariant Sections being ``GNU General Public License'' and ``Funding
  51 Free Software'', the Front-Cover texts being (a) (see below), and with
  52 the Back-Cover Texts being (b) (see below).  A copy of the license is
  53 included in the section entitled ``GNU Free Documentation License''.
  54
  55 (a) The FSF's Front-Cover Text is:
  56
  57      A GNU Manual
  58
  59 (b) The FSF's Back-Cover Text is:
  60
  61      You have freedom to copy and modify this GNU Manual, like GNU
  62      software.  Copies published by the Free Software Foundation raise
  63      funds for GNU development.
  64 @end copying
  65 @ifnottex
  66 @dircategory Programming
  67 @direntry
  68 * gccint: (gccint).            Internals of the GNU Compiler Collection.
  69 @end direntry
  70 This file documents the internals of the GNU compilers.
  71 @sp 1
  72 Published by the Free Software Foundation@*
  73 59 Temple Place - Suite 330@*
  74 Boston, MA 02111-1307 USA
  75 @sp 1
  76 @insertcopying
  77 @end ifnottex
  78
  79 @setchapternewpage odd
  80 @titlepage
  81 @center @titlefont{GNU Compiler Collection Internals}
  82 @sp 2
  83 @center Richard M. Stallman
  84 @sp 3
  85 @center Last updated 28 December 2002
  86 @sp 1
  87
  88 @center for GCC @value{version-GCC}
  89 @page
  90 @vskip 0pt plus 1filll
  91 For GCC Version @value{version-GCC}@*
  92 @sp 1
  93 Published by the Free Software Foundation @*
  94 59 Temple Place---Suite 330@*
  95 Boston, MA 02111-1307, USA@*
  96 Last printed April, 1998.@*
  97 Printed copies are available for $50 each.@*
  98 @c Update this ISBN when printing a new edition.
  99 @ifset FSFPRINT
 100 ISBN 1-882114-37-X
 101 @end ifset
 102 @sp 1
 103 @insertcopying
 104 @end titlepage
 105 @summarycontents
 106 @contents
 107 @page
 108
 109 @node Top, Contributing,, (DIR)
 110 @top Introduction
 111 @cindex introduction
 112
 113 This manual documents the internals of the GNU compilers, including
 114 how to port them to new targets and some information about how to
 115 write front ends for new languages.  It corresponds to GCC version
 116 @value{version-GCC}.  The use of the GNU compilers is documented in a
 117 separate manual.  @xref{Top,, Introduction, gcc, Using the GNU
 118 Compiler Collection (GCC)}.
 119
 120 This manual is mainly a reference manual rather than a tutorial.  It
 121 discusses how to contribute to GCC (@pxref{Contributing}), the
 122 characteristics of the machines supported by GCC as hosts and targets
 123 (@pxref{Portability}), how GCC relates to the ABIs on such systems
 124 (@pxref{Interface}), and the characteristics of the languages for
 125 which GCC front ends are written (@pxref{Languages}).  It then
 126 describes the GCC source tree structure and build system, some of the
 127 interfaces to GCC front ends, and how support for a target system is
 128 implemented in GCC@.
 129
 130 Additional tutorial information is linked to from
 131 @uref{http://gcc.gnu.org/readings.html}.
 132
 133 @menu
 134 * Contributing::    How to contribute to testing and developing GCC.
 135 * Portability::     Goals of GCC's portability features.
 136 * Interface::       Function-call interface of GCC output.
 137 * Libgcc::          Low-level runtime library used by GCC.
 138 * Languages::       Languages for which GCC front ends are written.
 139 * Source Tree::     GCC source tree structure and build system.
 140 * Passes::          Order of passes, what they do, and what each file is for.
 141 * Trees::           The source representation used by the C and C++ front ends.
 142 * RTL::             The intermediate representation that most passes work on.
 143 * Machine Desc::    How to write machine description instruction patterns.
 144 * Target Macros::   How to write the machine description C macros and functions.
 145 * Host Config::     Writing the @file{xm-@var{machine}.h} file.
 146 * Fragments::       Writing the @file{t-@var{target}} and @file{x-@var{host}} files.
 147 * Collect2::        How @code{collect2} works; how it finds @code{ld}.
 148 * Header Dirs::     Understanding the standard header file directories.
 149 * Type Information:: GCC's memory management; generating type information.
 150
 151 * Funding::         How to help assure funding for free software.
 152 * GNU Project::     The GNU Project and GNU/Linux.
 153
 154 * Copying::         GNU General Public License says
 155                      how you can copy and share GCC.
 156 * GNU Free Documentation License:: How you can copy and share this manual.
 157 * Contributors::    People who have contributed to GCC.
 158
 159 * Option Index::    Index to command line options.
 160 * Index::           Index of concepts and symbol names.
 161 @end menu
 162
 163 @include contribute.texi
 164 @include portability.texi
 165 @include interface.texi
 166 @include libgcc.texi
 167 @include languages.texi
 168 @include sourcebuild.texi
 169 @include passes.texi
 170 @include c-tree.texi
 171 @include rtl.texi
 172 @include md.texi
 173 @include tm.texi
 174 @include hostconfig.texi
 175 @include fragments.texi
 176 @include collect2.texi
 177 @include headerdirs.texi
 178 @include gty.texi
 179
 180 @include funding.texi
 181 @include gnu.texi
 182 @include gpl.texi
 183
 184 @c ---------------------------------------------------------------------
 185 @c GFDL
 186 @c ---------------------------------------------------------------------
 187
 188 @include fdl.texi
 189
 190 @include contrib.texi
 191
 192 @c ---------------------------------------------------------------------
 193 @c Indexes
 194 @c ---------------------------------------------------------------------
 195
 196 @node Option Index
 197 @unnumbered Option Index
 198
 199 GCC's command line options are indexed here without any initial @samp{-}
 200 or @samp{--}.  Where an option has both positive and negative forms
 201 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
 202 relevant entries in the manual are indexed under the most appropriate
 203 form; it may sometimes be useful to look up both forms.
 204
 205 @printindex op
 206
 207 @node Index
 208 @unnumbered Index
 209
 210 @printindex cp
 211
 212 @c ---------------------------------------------------------------------
 213 @c Epilogue
 214 @c ---------------------------------------------------------------------
 215
 216 @bye