README.cvs

   1                                                                      -*-text-*-
   2
   3 -------------------------------------------------------------------------------
   4 Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
   5 1998, 1999, 2000, 2001, 2002, 2003, 2005, 2006 Free Software Foundation, Inc.
   6 This file is part of GNU Make.
   7
   8 GNU Make is free software; you can redistribute it and/or modify it under the
   9 terms of the GNU General Public License as published by the Free Software
  10 Foundation; either version 2, or (at your option) any later version.
  11
  12 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License along with
  17 GNU Make; see the file COPYING.  If not, write to the Free Software
  18 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19 -------------------------------------------------------------------------------
  20
  21 Obtaining CVS Code
  22 ------------------
  23
  24 This seems redundant, since if you're reading this you most likely have
  25 already performed this step; however, for completeness, you can obtain
  26 the GNU make source code via anonymous CVS from the FSF's Savannah
  27 project <http://savannah.gnu.org/projects/make/>:
  28
  29   $ cvs -d:pserver:anoncvs@cvs.savannah.gnu.org:/sources/make co make
  30
  31 You might want to use the "-z3" option to get compression, and you most
  32 certainly will want the -P option to avoid unneeded directories
  33 cluttering up your source.  Personally I add these (as well as -dP for
  34 update) to my ~/.cvsrc file.
  35
  36
  37 If you have an older version of CVS, you might have to login first.
  38 There is no password; just hit the ENTER key if you are asked for one.
  39
  40
  41 Building From CVS
  42 -----------------
  43
  44 To build GNU make from CVS, you will need Autoconf, Automake, and
  45 Gettext, and any tools that those utilities require (GNU m4, Perl,
  46 etc.).  See the configure.in file to find the minimum versions of each
  47 of these tools.  You will also need a copy of wget.
  48
  49 After checking out the code, you will need to perform these steps to get
  50 to the point where you can run "make".
  51
  52
  53  1) $ autoreconf -i -s
  54
  55     This rebuilds all the things that need rebuilding, installing
  56     missing files as symbolic links.
  57
  58     You may get warnings here about missing files like README, etc.
  59     Ignore them, they are harmless.
  60
  61
  62  2) $ ./configure
  63
  64     Generate a Makefile
  65
  66
  67  3) $ make update
  68
  69     Use wget to retrieve various other files that GNU make relies on,
  70     but does not keep in its own source tree.
  71
  72     NB: You may need GNU make to correctly perform this step; if you use
  73     a platform-local make you may get problems with missing files in doc/.
  74
  75
  76 At this point you have successfully brought your CVS copy of the GNU
  77 make source directory up to the point where it can be treated
  78 more-or-less like the official package you would get from ftp.gnu.org.
  79 That is, you can just run:
  80
  81   $ make && make check && make install
  82
  83 to build and install GNU make.
  84
  85
  86 Creating a Package
  87 ------------------
  88
  89 Once you have performed the above steps (including the configuration and
  90 build) you can create a GNU make package.  This is very simple, just
  91 run:
  92
  93   $ make dist-gzip
  94
  95 and, if you like:
  96
  97   $ make dist-bzip2
  98
  99 Even better, you should run this:
 100
 101   $ make distcheck
 102
 103 Which will build both .gz and .bz2 package files, then unpack them into
 104 a temporary location, try to build them, and repack them, verifying that
 105 everything works, you get the same results, _and_ no extraneous files
 106 are left over after the "distclean" rule--whew!!  Now, _that_ is why
 107 converting to Automake is worth the trouble!  A big "huzzah!" to Tom
 108 T. and the AutoToolers!
 109
 110
 111 That's it, you're done!
 112
 113
 114 Windows builds from CVS
 115 -----------------------
 116
 117 If you have a UNIX emulation like CYGWIN you can opt to run the general
 118 build procedure above; it will work.  Be sure to read
 119 README.W32.template for information on options you might want to use
 120 when running ./configure.
 121
 122 If you can't or don't want to do that, then rename the file
 123 README.W32.template to README.W32 and follow those instructions.
 124
 125
 126 Appendix A - For The Brave
 127 --------------------------
 128
 129 For those of you who trust me implicitly, or are just brave (or
 130 foolhardy), here is a canned sequence of commands to build a GNU make
 131 distribution package from a virgin CVS source checkout (assuming all the
 132 prerequisites are available of course).
 133
 134 This list is eminently suitable for a quick swipe o' the mouse and a
 135 swift click o' mouse-2 into an xterm.  Go for it!
 136
 137
 138 autoreconf -i -s
 139 ./configure
 140 make update
 141 make
 142 make check
 143 make distcheck