README-hacking

   1 -*- outline -*-
   2
   3 These notes intend to help people working on the checked-out sources.
   4 These requirements do not apply when building from a distribution tarball.
   5
   6 * Requirements
   7
   8 We've opted to keep only the highest-level sources in the GIT repository.
   9 This eases our maintenance burden, (fewer merges etc.), but imposes more
  10 requirements on anyone wishing to build from the just-checked-out sources.
  11 For example, you have to use the latest stable versions of the maintainer
  12 tools we depend upon, including:
  13
  14 - Autoconf 2.60+ <http://www.gnu.org/software/autoconf/>
  15 - Automake 1.10+ <http://www.gnu.org/software/automake/>
  16 - Help2man 1.29+ <http://www.gnu.org/software/help2man/>
  17 - M4 1.4.5+ <http://www.gnu.org/software/m4/>
  18 - Perl 5.005_03+ <http://www.cpan.org/>
  19 - Texinfo 4.8+ <http://www.gnu.org/software/texinfo/>
  20
  21 The following are useful as well, if you want to be able to run commands
  22 like "make dist" or "make distcheck":
  23
  24 - Gzip <http://www.gnu.org/software/gzip/>
  25 - Tar <http://www.gnu.org/software/tar/>
  26
  27 Only building the initial full source tree will be a bit painful.
  28 Later, a plain `git pull && make' should be sufficient.
  29
  30 * First GIT checkout
  31
  32 You can get a copy of the source repository like this:
  33
  34         $ git clone git://git.sv.gnu.org/autoconf
  35
  36 The next step is to generate files like configure and Makefile.in:
  37
  38         $ cd autoconf
  39         $ autoreconf -vi
  40
  41 Since we're building autoconf itself, and its tests are picky, the
  42 following procedure includes an extra step to ensure that some
  43 generated files are regenerated using the tools just build by "make":
  44
  45         $ ./configure
  46         $ make
  47         $ ( PATH=`pwd`/tests:$PATH; autoreconf -vi )
  48         $ make check
  49
  50 At this point, there should be no difference between your local copy,
  51 and the GIT master copy:
  52
  53         $ git diff
  54
  55 should output no difference.
  56
  57 You may find it useful to install the git-merge-changelog merge driver:
  58 http://git.sv.gnu.org/gitweb/?p=gnulib.git;a=blob;f=lib/git-merge-changelog.c
  59
  60 Enjoy!
  61
  62 -----
  63
  64 Copyright (C) 2002-2008 Free Software Foundation, Inc.
  65
  66 This program is free software: you can redistribute it and/or modify
  67 it under the terms of the GNU General Public License as published by
  68 the Free Software Foundation, either version 3 of the License, or
  69 (at your option) any later version.
  70
  71 This program is distributed in the hope that it will be useful,
  72 but WITHOUT ANY WARRANTY; without even the implied warranty of
  73 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  74 GNU General Public License for more details.
  75
  76 You should have received a copy of the GNU General Public License
  77 along with this program.  If not, see <http://www.gnu.org/licenses/>.