summaryrefslogtreecommitdiff
path: root/README-hacking
diff options
context:
space:
mode:
authorAndreas Gruenbacher <agruen@suse.de>2010-02-17 16:39:58 +0100
committerAndreas Gruenbacher <agruen@suse.de>2010-04-12 16:27:55 +0200
commit7fa8417c05f8d56b0c6b09412be7a52c30212c32 (patch)
treed945113753e3b2c8c3560cf0bd5466e18cb8345d /README-hacking
parent8d5ea52c7a41f56c296baab0fe23392d38263393 (diff)
downloadpatch-7fa8417c05f8d56b0c6b09412be7a52c30212c32.tar.gz
Convert to automake and use a git submodule for gnulib
* configure.ac: Add automake and gnulib macros, replace several obsolete macros. * Makefile.am, lib/Makefile.am, src/Makefile.am, tests/Makefile.am: Add for automake. * autogen.sh, INSTALL, Makefile.in, mkinstalldirs, update-version.sh: Obsolete; remove. * README-hacking: Import from diffutils, replace cvs with git. * build-aux: Move gnulib auxiliary files here from the top-level directory. * gnulib: Add gnulib git submodule. * bootstrap, bootstrap.conf: Import from gnulib and adjust. * gl/lib: Remove gnulib files from the repository; they are now imported into lib/ from gnulib as needed. * tests/test-lib.sh: Use $abs_top_builddir exported from tests/Makefile.am here instead of $PWD. * m4/utimbuf.m4: This macro has been removed from gnulib. Add it here for now; this will be replaced by gnulib's utimens module soon.
Diffstat (limited to 'README-hacking')
-rw-r--r--README-hacking66
1 files changed, 66 insertions, 0 deletions
diff --git a/README-hacking b/README-hacking
new file mode 100644
index 0000000..8928ab0
--- /dev/null
+++ b/README-hacking
@@ -0,0 +1,66 @@
+-*- outline -*-
+
+These notes intend to help people working on the checked-out sources.
+These requirements do not apply when building from a distribution tarball.
+
+* 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/>
+- Gettext <http://www.gnu.org/software/gettext/>
+- Gzip <http://www.gnu.org/software/gzip/>
+- M4 <http://www.gnu.org/software/m4/>
+- Tar <http://www.gnu.org/software/tar/>
+- Wget <http://www.gnu.org/software/wget/>
+
+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.
+
+* First checkout
+
+Obviously, if you are reading these notes, you did manage to check out
+this package from CVS. The next step is to get other files needed to
+build, which are extracted from other source packages:
+
+ $ ./bootstrap
+
+And there you are! Just
+
+ $ ./configure
+ $ make
+ $ make check
+
+At this point, there should be no difference between your local copy,
+and the master:
+
+ $ git status
+
+should show no difference.
+
+Enjoy!
+
+-----
+
+Copyright (C) 2002-2007, 2009-2010 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
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+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/>.