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 - Automake <http://www.gnu.org/software/automake/>
  15 - Autoconf <http://www.gnu.org/software/autoconf/>
  16 - Bison <http://www.gnu.org/software/bison/>
  17 - Gettext <http://www.gnu.org/software/gettext/>
  18 - Gperf <http://www.gnu.org/software/gperf/>
  19 - Gzip <http://www.gnu.org/software/gzip/>
  20 - Perl <http://www.cpan.org/>
  21 - Rsync <http://samba.anu.edu.au/rsync/>
  22 - Tar <http://www.gnu.org/software/tar/>
  23
  24 Valgrind <http://valgrind.org/> is also highly recommended, if
  25 Valgrind supports your architecture.
  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 * LZMA
  31
  32 The coreutils build procedure can build distribution tarballs with the
  33 LZMA compression scheme.  This feature is so new that it is not
  34 supported by the latest version of Automake.  If you don't care about
  35 building LZMA tarballs, you can manually remove the string "dist-lzma"
  36 from configure.ac before bootstrapping.
  37
  38 If you do want to build LZMA tarballs, you'll need to make sure you
  39 have the latest stable version of the LZMA Utils
  40 <http://tukaani.org/lzma/>.  Also, you'll need a version of
  41 Automake that supports the dist-lzma feature, which was added to
  42 Automake on 2007-10-09 but is not yet available in a stable Automake
  43 version.  So until Automake 1.11 comes out, you'll need to get the
  44 bleeding-edge Automake version with a command like this:
  45
  46         $ git clone git://git.sv.gnu.org/automake
  47         $ cd automake
  48         $ ./bootstrap
  49         $ ./configure
  50         $ make install
  51
  52 and build and install that version.
  53
  54 * First GIT checkout
  55
  56 You can get a copy of the source repository like this:
  57
  58         $ git clone git://git.sv.gnu.org/coreutils
  59
  60 The next step is to get other files needed to build, which are
  61 extracted from other source packages:
  62
  63         $ ./bootstrap
  64
  65 And there you are!  Just
  66
  67         $ ./configure
  68         $ make
  69         $ make check
  70
  71 At this point, there should be no difference between your local copy,
  72 and the GIT master copy:
  73
  74         $ git diff
  75
  76 should output no difference.
  77
  78 Enjoy!
  79
  80 -----
  81
  82 Copyright (C) 2002-2007 Free Software Foundation, Inc.
  83
  84 This program is free software: you can redistribute it and/or modify
  85 it under the terms of the GNU General Public License as published by
  86 the Free Software Foundation, either version 3 of the License, or
  87 (at your option) any later version.
  88
  89 This program is distributed in the hope that it will be useful,
  90 but WITHOUT ANY WARRANTY; without even the implied warranty of
  91 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  92 GNU General Public License for more details.
  93
  94 You should have received a copy of the GNU General Public License
  95 along with this program.  If not, see <http://www.gnu.org/licenses/>.