summaryrefslogtreecommitdiff
path: root/README.dev
diff options
context:
space:
mode:
Diffstat (limited to 'README.dev')
-rw-r--r--README.dev52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.dev b/README.dev
new file mode 100644
index 0000000..7706d33
--- /dev/null
+++ b/README.dev
@@ -0,0 +1,52 @@
+$Id: README.dev,v 1.15 2008/03/25 13:51:20 karl Exp $
+This README.dev file describes the development environment.
+
+ Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008
+ Free Software Foundation, Inc.
+
+ Copying and distribution of this file, with or without modification,
+ are permitted in any medium without royalty provided the copyright
+ notice and this notice are preserved.
+
+The development sources for GNU Texinfo are available through anonymous
+CVS at Savannah:
+ http://savannah.gnu.org/cvs/?group=texinfo
+
+This distribution uses whatever versions of Automake, Autoconf, and
+Gettext are listed in NEWS; usually the latest ones released. If you
+are getting the sources from CVS (or change configure.ac), you'll need
+to have these tools installed to (re)build. You'll also need help2man.
+All of these programs are available from ftp://ftp.gnu.org/gnu.
+
+After getting the CVS sources, and installing the tools above, you can run
+ ./autogen.sh
+and then
+ ./configure CFLAGS='-g -Wdeclaration-after-statement' --enable-maintainer-mode
+and then
+ make
+
+After the initial autogen && configure, simply running make should suffice.
+
+The reason for that particular -W is that intermixing declarations with
+statementts is an easy thing to do accidentally, gcc won't warn about it
+by default, and other compilers that don't support it are still
+widespread. Lots of other -W options can be useful too, and patches are
+welcome to resolve the diagnostics. Or if you're not using gcc, of
+course you shouldn't include it at all.
+
+This distribution also uses Gnulib (http://www.gnu.org/software/gnulib)
+to share common files, with the files being checked in to CVS. If you
+get automake/conf/etc. errors from ./autogen.sh, please try doing a CVS
+checkout of gnulib (in a separate directory to the texinfo checkout),
+and then run
+ ../gnulib/gnulib-tool --update
+in your top-level Texinfo directory. (gnulib-tool is in the gnulib CVS tree.)
+
+For the record, a first time invocation would be
+ gnulib-tool --import --m4-base=gnulib/m4 --source-base=gnulib/lib \
+ --no-vc-files getopt
+
+Many more modules have been added since. The currently-used gnulib
+modules and other gnulib information are recorded in
+gnulib/m4/gnulib-cache.m4. Given a source checkout of gnulib, you can
+update the files with gnulib-tool --import.