gcc/doc/configfiles.texi

   1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
   2 @c This is part of the GCC manual.
   3 @c For copying conditions, see the file gcc.texi.
   4
   5 @node Configuration Files
   6 @chapter Files Created by @code{configure}
   7
   8 Here we spell out what files will be set up by @code{configure}.  Normally
   9 you need not be concerned with these files.
  10
  11 @itemize @bullet
  12 @item
  13 @ifset INTERNALS
  14 A file named @file{config.h} is created that contains a @samp{#include}
  15 of the top-level config file for the machine you will run the compiler
  16 on (@pxref{Config}).  This file is responsible for defining information
  17 about the host machine.  It includes @file{tm.h}.
  18 @end ifset
  19 @ifclear INTERNALS
  20 A file named @file{config.h} is created that contains a @samp{#include}
  21 of the top-level config file for the machine you will run the compiler
  22 on (@pxref{Config,,The Configuration File, gcc.info, Using and Porting
  23 GCC}).  This file is responsible for defining information about the host
  24 machine.  It includes @file{tm.h}.
  25 @end ifclear
  26
  27 The top-level config file is located in the subdirectory @file{config}.
  28 Its name is always @file{xm-@var{something}.h}; usually
  29 @file{xm-@var{machine}.h}, but there are some exceptions.
  30
  31 If your system does not support symbolic links, you might want to
  32 set up @file{config.h} to contain a @samp{#include} command which
  33 refers to the appropriate file.
  34
  35 @item
  36 A file named @file{tconfig.h} is created which includes the top-level config
  37 file for your target machine.  This is used for compiling certain
  38 programs to run on that machine.
  39
  40 @item
  41 A file named @file{tm.h} is created which includes the
  42 machine-description macro file for your target machine.  It should be in
  43 the subdirectory @file{config} and its name is often
  44 @file{@var{machine}.h}.
  45
  46 @item
  47 The command file @file{configure} also constructs the file
  48 @file{Makefile} by adding some text to the template file
  49 @file{Makefile.in}.  The additional text comes from files in the
  50 @file{config} directory, named @file{t-@var{target}} and
  51 @file{x-@var{host}}.  If these files do not exist, it means nothing
  52 needs to be added for a given target or host.
  53 @end itemize