gcc/doc/makefile.texi

   1 @c Copyright (C) 2001, 2002 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 Makefile
   6 @subsection Makefile Targets
   7 @cindex makefile targets
   8 @cindex targets, makefile
   9
  10 @table @code
  11 @item all
  12 This is the default target.  Depending on what your build/host/target
  13 configuration is, it coordinates all the things that need to be built.
  14
  15 @item doc
  16 Produce info-formatted documentation.  Also, @code{make dvi} is
  17 available for DVI-formatted documentation, and @code{make
  18 generated-manpages} to generate man pages.
  19
  20 @item mostlyclean
  21 Delete the files made while building the compiler.
  22
  23 @item clean
  24 That, and all the other files built by @code{make all}.
  25
  26 @item distclean
  27 That, and all the files created by @code{configure}.
  28
  29 @item extraclean
  30 That, and any temporary or intermediate files, like emacs backup files.
  31
  32 @item maintainer-clean
  33 Distclean plus any file that can be generated from other files.  Note
  34 that additional tools may be required beyond what is normally needed to
  35 build gcc.
  36
  37 @item install
  38 Installs gcc.
  39
  40 @item uninstall
  41 Deletes installed files.
  42
  43 @item check
  44 Run the testsuite.  This creates a @file{testsuite} subdirectory that
  45 has various @file{.sum} and @file{.log} files containing the results of
  46 the testing.  You can run subsets with, for example, @code{make check-gcc}.
  47 You can specify specific tests by setting RUNTESTFLAGS to be the name
  48 of the @file{.exp} file, optionally followed by (for some tests) an equals
  49 and a file wildcard, like:
  50
  51 @example
  52 make check-gcc RUNTESTFLAGS="execute.exp=19980413-*"
  53 @end example
  54
  55 Note that running the testsuite may require additional tools be
  56 installed, such as TCL or dejagnu.
  57
  58 @item bootstrap
  59 Builds gcc three times---once with the native compiler, once with the
  60 native-built compiler it just built, and once with the compiler it built
  61 the second time.  In theory, the last two should produce the same
  62 results, which @code{make compare} can check.  Each step of this process
  63 is called a ``stage'', and the results of each stage @var{N}
  64 (@var{N} = 1@dots{}3) are copied to a subdirectory @file{stage@var{N}/}.
  65
  66 @item bootstrap-lean
  67 Like @code{bootstrap}, except that the various stages are removed once
  68 they're no longer needed.  This saves disk space.
  69
  70 @item bubblestrap
  71 Once bootstrapped, this incrementally rebuilds each of the three stages,
  72 one at a time.  It does this by ``bubbling'' the stages up from their
  73 subdirectories, rebuilding them, and copying them back to their
  74 subdirectories.  This will allow you to, for example, quickly rebuild a
  75 bootstrapped compiler after changing the sources, without having to do a
  76 full bootstrap.
  77
  78 @item quickstrap
  79 Rebuilds the most recently built stage.  Since each stage requires
  80 special invocation, using this target means you don't have to keep track
  81 of which stage you're on or what invocation that stage needs.
  82
  83 @item cleanstrap
  84 Removed everything (@code{make clean}) and rebuilds (@code{make bootstrap}).
  85
  86 @item stage@var{N} (@var{N} = 1@dots{}4)
  87 For each stage, moves the appropriate files to the @file{stage@var{N}}
  88 subdirectory.
  89
  90 @item unstage@var{N} (@var{N} = 1@dots{}4)
  91 Undoes the corresponding @code{stage@var{N}}.
  92
  93 @item restage@var{N} (@var{N} = 1@dots{}4)
  94 Undoes the corresponding @code{stage@var{N}} and rebuilds it with the
  95 appropriate flags.
  96
  97 @item compare
  98 Compares the results of stages 2 and 3.  This ensures that the compiler
  99 is running properly, since it should produce the same object files
 100 regardless of how it itself was compiled.
 101
 102 @end table