README.dev

   1 $Id: README.dev,v 1.15 2008/03/25 13:51:20 karl Exp $
   2 This README.dev file describes the development environment.
   3
   4   Copyright (C) 2002, 2003, 2005, 2006, 2007, 2008
   5   Free Software Foundation, Inc.
   6
   7   Copying and distribution of this file, with or without modification,
   8   are permitted in any medium without royalty provided the copyright
   9   notice and this notice are preserved.
  10
  11 The development sources for GNU Texinfo are available through anonymous
  12 CVS at Savannah:
  13   http://savannah.gnu.org/cvs/?group=texinfo
  14
  15 This distribution uses whatever versions of Automake, Autoconf, and
  16 Gettext are listed in NEWS; usually the latest ones released.  If you
  17 are getting the sources from CVS (or change configure.ac), you'll need
  18 to have these tools installed to (re)build.  You'll also need help2man.
  19 All of these programs are available from ftp://ftp.gnu.org/gnu.
  20
  21 After getting the CVS sources, and installing the tools above, you can run
  22  ./autogen.sh
  23 and then
  24  ./configure CFLAGS='-g -Wdeclaration-after-statement' --enable-maintainer-mode
  25 and then
  26  make
  27
  28 After the initial autogen && configure, simply running make should suffice.
  29
  30 The reason for that particular -W is that intermixing declarations with
  31 statementts is an easy thing to do accidentally, gcc won't warn about it
  32 by default, and other compilers that don't support it are still
  33 widespread.  Lots of other -W options can be useful too, and patches are
  34 welcome to resolve the diagnostics.  Or if you're not using gcc, of
  35 course you shouldn't include it at all.
  36
  37 This distribution also uses Gnulib (http://www.gnu.org/software/gnulib)
  38 to share common files, with the files being checked in to CVS.  If you
  39 get automake/conf/etc. errors from ./autogen.sh, please try doing a CVS
  40 checkout of gnulib (in a separate directory to the texinfo checkout),
  41 and then run
  42   ../gnulib/gnulib-tool --update
  43 in your top-level Texinfo directory.  (gnulib-tool is in the gnulib CVS tree.)
  44
  45 For the record, a first time invocation would be
  46   gnulib-tool --import --m4-base=gnulib/m4 --source-base=gnulib/lib \
  47               --no-vc-files getopt
  48
  49 Many more modules have been added since.  The currently-used gnulib
  50 modules and other gnulib information are recorded in
  51 gnulib/m4/gnulib-cache.m4.  Given a source checkout of gnulib, you can
  52 update the files with gnulib-tool --import.