These notes intend to help people working on the checked-out sources.
These requirements do not apply when building from a distribution tarball.
+See also HACKING for more detailed contribution guidelines.
* Requirements
We've opted to keep only the highest-level sources in the GIT repository.
This eases our maintenance burden, (fewer merges etc.), but imposes more
requirements on anyone wishing to build from the just-checked-out sources.
-For example, you have to use the latest stable versions of the maintainer
-tools we depend upon, including:
-
-- Automake <http://www.gnu.org/software/automake/>
-- Autoconf <http://www.gnu.org/software/autoconf/>
-- Bison <http://www.gnu.org/software/bison/>
-- Gettext <http://www.gnu.org/software/gettext/>
-- Gperf <http://www.gnu.org/software/gperf/>
-- Gzip <http://www.gnu.org/software/gzip/>
-- Perl <http://www.cpan.org/>
-- Rsync <http://samba.anu.edu.au/rsync/>
-- Tar <http://www.gnu.org/software/tar/>
+Note the requirements to build the released archive are much less and
+are just the requirements of the standard ./configure && make procedure.
+Specific development tools and versions will be checked for and listed by
+the bootstrap script. See README-prereq for specific notes on obtaining
+these prerequisite tools.
Valgrind <http://valgrind.org/> is also highly recommended, if
-Valgrind supports your architecture.
+Valgrind supports your architecture. See also README-valgrind.
-Only building the initial full source tree will be a bit painful.
-Later, a plain `git pull && make' should be sufficient.
+While building from a just-cloned source tree may require installing a
+few prerequisites, later, a plain 'git pull && make' should be sufficient.
-* LZMA
+* First GIT checkout
-The coreutils build procedure can build distribution tarballs with the
-LZMA compression scheme. This feature is so new that it is not
-supported by the latest version of Automake. If you don't care about
-building LZMA tarballs, you can manually remove the string "dist-lzma"
-from configure.ac before bootstrapping.
+You can get a copy of the source repository like this:
-If you do want to build LZMA tarballs, you'll need to make sure you
-have the latest stable version of the LZMA Utils
-<http://tukaani.org/lzma/>. Also, you'll need a version of
-Automake that supports the dist-lzma feature, which was added to
-Automake on 2007-10-09 but is not yet available in a stable Automake
-version. So until Automake 1.11 comes out, you'll need to get the
-bleeding-edge Automake version with a command like this:
+ $ git clone git://git.sv.gnu.org/coreutils
+ $ cd coreutils
- $ git clone git://git.sv.gnu.org/automake
- $ cd automake
- $ ./bootstrap
- $ ./configure
- $ make install
+As an optional step, if you already have a copy of the gnulib git
+repository, then you can use it as a reference to reduce download
+time and disk space requirements:
-and build and install that version.
+ $ export GNULIB_SRCDIR=/path/to/gnulib
-* First GIT checkout
+The next step is to get and check other files needed to build,
+which are extracted from other source packages:
-You can get a copy of the source repository like this:
+ $ ./bootstrap
- $ git clone git://git.sv.gnu.org/coreutils
+To use the most-recent gnulib (as opposed to the gnulib version that
+the package last synchronized to), do this next:
-The next step is to get other files needed to build, which are
-extracted from other source packages:
-
- $ ./bootstrap
+ $ git submodule foreach git pull origin master
+ $ git commit -m 'build: update gnulib submodule to latest' gnulib
And there you are! Just
- $ ./configure
- $ make
- $ make check
+ $ ./configure --quiet #[--enable-gcc-warnings] [*]
+ $ make
+ $ make check
At this point, there should be no difference between your local copy,
and the GIT master copy:
- $ git diff
+ $ git diff
should output no difference.
Enjoy!
+[*] The --enable-gcc-warnings option is useful only with glibc
+and with a very recent version of gcc. You'll probably also have
+to use recent system headers. If you configure with this option,
+and spot a problem, please be sure to send the report to the bug
+reporting address of this package, and not to that of gnulib, even
+if the problem seems to originate in a gnulib-provided file.
+
+* Submitting patches
+
+If you develop a fix or a new feature, please send it to the
+appropriate bug-reporting address as reported by the --help option of
+each program. One way to do this is to use vc-dwim
+<http://www.gnu.org/software/vc-dwim/>), as follows.
+
+ Run the command "vc-dwim --help", copy its definition of the
+ "git-changelog-symlink-init" function into your shell, and then run
+ this function at the top-level directory of the package.
+
+ Edit the (empty) ChangeLog file that this command creates, creating a
+ properly-formatted entry according to the GNU coding standards
+ <http://www.gnu.org/prep/standards/html_node/Change-Logs.html>.
+
+ Make your changes.
+
+ Run the command "vc-dwim" and make sure its output (the diff of all
+ your changes) looks good.
+
+ Run "vc-dwim --commit".
+
+ Run the command "git format-patch --stdout -1", and email its output
+ in, using the output's subject line.
+
-----
-Copyright (C) 2002-2007 Free Software Foundation, Inc.
+Copyright (C) 2002-2013 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
projects / platform / upstream / coreutils.git / blobdiff