summaryrefslogtreecommitdiff
path: root/README-hacking
diff options
context:
space:
mode:
authorPádraig Brady <P@draigBrady.com>2008-10-21 22:40:12 +0100
committerPádraig Brady <P@draigBrady.com>2008-10-22 16:31:57 +0100
commit99f49949825acc53ae3f0a711ea3e8f96699442d (patch)
tree5e423a95e8dfa967d0c29e5e620e55163cf4274b /README-hacking
parent5afac2aee1313126ece1eb958d5e0fba6837e93b (diff)
downloadcoreutils-99f49949825acc53ae3f0a711ea3e8f96699442d.tar.xz
Add better checks and docs for build tools
Prompted by a report from Ed Avis: <http://thread.gmane.org/gmane.comp.gnu.coreutils.bugs/14710> * README-hacking: Organise LZMA and Valgrind as as optional requirements rather than in their own sections. Mention bootstrap will now check tool versions. * README-prereq: Make a start on specific instructions for optaining build tools. Currently we just have notes for Fedora linux. * bootstrap.conf: Add the list of tools and versions required. * bootstrap: Add the logic to check for the required tools, and list all required tools and versions if any are missing.
Diffstat (limited to 'README-hacking')
-rw-r--r--README-hacking35
1 files changed, 21 insertions, 14 deletions
diff --git a/README-hacking b/README-hacking
index 2e3c83a89..f51bb0143 100644
--- a/README-hacking
+++ b/README-hacking
@@ -8,8 +8,8 @@ These requirements do not apply when building from a distribution tarball.
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:
+Specific tools and versions will be checked for and listed by the
+bootstrap script shown below, and will include:
- Automake <http://www.gnu.org/software/automake/>
- Autoconf <http://www.gnu.org/software/autoconf/>
@@ -22,13 +22,15 @@ tools we depend upon, including:
- Rsync <http://samba.anu.edu.au/rsync/>
- Tar <http://www.gnu.org/software/tar/>
-Valgrind <http://valgrind.org/> is also highly recommended, if
-Valgrind supports your architecture.
-
Only building the initial full source tree will be a bit painful.
Later, a plain `git pull && make' should be sufficient.
-* LZMA
+- Valgrind
+
+Valgrind <http://valgrind.org/> is also highly recommended, if
+Valgrind supports your architecture. See also README-valgrind.
+
+- LZMA
This package's build procedure uses LZMA to create a compressed
distribution tarball. Using this feature of Automake requires
@@ -40,23 +42,24 @@ from <http://tukaani.org/lzma/>.
You can get a copy of the source repository like this:
- $ git clone git://git.sv.gnu.org/coreutils
+ $ git clone git://git.sv.gnu.org/coreutils
+ $ cd coreutils
-The next step is to get other files needed to build, which are
-extracted from other source packages:
+The next step is to get and check other files needed to build,
+which are extracted from other source packages:
- $ ./bootstrap
+ $ ./bootstrap
And there you are! Just
- $ ./configure
- $ make
- $ make check
+ $ ./configure
+ $ 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.
@@ -78,3 +81,7 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Local Variables:
+indent-tabs-mode: nil
+End: