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 Specific tools and versions will be checked for and listed by the
  12 bootstrap script shown below, and will include:
  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 - Git <http://git.or.cz/>
  19 - Gperf <http://www.gnu.org/software/gperf/>
  20 - Gzip <http://www.gnu.org/software/gzip/>
  21 - Perl <http://www.cpan.org/>
  22 - Rsync <http://samba.anu.edu.au/rsync/>
  23 - Tar <http://www.gnu.org/software/tar/>
  24
  25 Only building the initial full source tree will be a bit painful.
  26 Later, a plain `git pull && make' should be sufficient.
  27
  28 - Valgrind
  29
  30 Valgrind <http://valgrind.org/> is also highly recommended, if
  31 Valgrind supports your architecture. See also README-valgrind.
  32
  33 - LZMA
  34
  35 This package's build procedure uses LZMA to create a compressed
  36 distribution tarball.  Using this feature of Automake requires
  37 version 1.10.1 or newer, as well as the lzma program itself.
  38 Make sure you have the latest stable version of the LZMA Utils
  39 from <http://tukaani.org/lzma/>.
  40
  41 * First GIT checkout
  42
  43 You can get a copy of the source repository like this:
  44
  45         $ git clone git://git.sv.gnu.org/coreutils
  46         $ cd coreutils
  47
  48 The next step is to get and check other files needed to build,
  49 which are extracted from other source packages:
  50
  51         $ ./bootstrap
  52
  53 And there you are!  Just
  54
  55         $ ./configure
  56         $ make
  57         $ make check
  58
  59 At this point, there should be no difference between your local copy,
  60 and the GIT master copy:
  61
  62         $ git diff
  63
  64 should output no difference.
  65
  66 Enjoy!
  67
  68 -----
  69
  70 Copyright (C) 2002-2008 Free Software Foundation, Inc.
  71
  72 This program is free software: you can redistribute it and/or modify
  73 it under the terms of the GNU General Public License as published by
  74 the Free Software Foundation, either version 3 of the License, or
  75 (at your option) any later version.
  76
  77 This program is distributed in the hope that it will be useful,
  78 but WITHOUT ANY WARRANTY; without even the implied warranty of
  79 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  80 GNU General Public License for more details.
  81
  82 You should have received a copy of the GNU General Public License
  83 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  84
  85 Local Variables:
  86 indent-tabs-mode: nil
  87 End: