Re: [bug-hello] hello and current autotools

[Jim Meyering]

address@hidden (Karl Berry) wrote:
> Hi folks,
...
> - I heard in passing somewhere recently that m4/Makefile.am (I think?)
>   was no longer needed.  Is the idea to simply remove m4/Makefile* and
>   m4/Makefile from configure.ac?  It seems to work, but I thought I'd
>   ask, anyway.

Hi Karl,

That's right.
You can simply remove all m4/Makefile* files --
and configure.ac's reference to m4/Makefile.in,
and remove m4 from SUBDIRS in Makefile.am.

> - the distribution as it stands has a separate directory for man pages
>   (man) than the Texinfo manual (doc).  I'm not sure if that is better
>   than putting them together, or worse.  Any opinions?

I prefer to keep them separate, too.

> - What I have checked in now more or less works, for me anyway, but
>   plenty of infelicities remain.  (Aside from the actual C code, which
>   needs work too.)
>
> If you feel like looking at the code as it stands now, you can get it
> via cvs -d:ext:address@hidden:/cvsroot/hello co hello,
> or browse at http://savannah.gnu.org/cgi-bin/viewcvs/hello.

I took a few minutes to get this to build with gnulib-tool.
Here are a few suggestions:

Remove intl/ and put these lines in configure.ac:
  AM_GNU_GETTEXT_VERSION([0.13.1])
  AM_GNU_GETTEXT([external])

Use something like this derivation of bison's bootstrap script:

#! /bin/sh

# Bootstrap this package from CVS.

# Copyright (C) 2005 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 2, 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, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.

# Written by Paul Eggert.
# Adapted for use by hello by Jim Meyering

package=hello
SKIP_PO=t

# Ensure file names are sorted consistently across platforms;
# e.g., m4/ulonglong_gl.m4 should follow m4/ulonglong.m4.
LC_ALL=C
export LC_ALL

# Parse options.

for option
do
  case $option in
  --help)
    echo "$0: usage: $0 [--gnulib-srcdir=DIR] [--cvs-user=USERNAME] [--skip-po]"
    exit;;
  --gnulib-srcdir=*)
    GNULIB_SRCDIR=`expr "$option" : '--gnulib-srcdir=\(.*\)'`;;
  --cvs-user=*)
    CVS_USER=`expr "$option" : '--cvs-user=\(.*\)'`;;
  --skip-po)
    SKIP_PO=t;;
  *)
    echo >&2 "$0: $option: unknown option"
    exit 1;;
  esac
done

echo "$0: Bootstrapping CVS $package..."

build_cvs_prefix() {
  CVS_PREFIX=:${1}:
  if [ "${2}" != - ]; then
    CVS_PREFIX=${CVS_PREFIX}${2}@
  fi
}

# Get gnulib files.

case ${GNULIB_SRCDIR--} in
-)
  if [ ! -d gnulib ]; then
    echo "$0: getting gnulib files..."

    trap exit 1 2 13 15
    trap 'rm -fr gnulib; exit 1' 0

    case ${CVS_AUTH-anoncvs} in
    anoncvs)
      CVS_PREFIX='anoncvs@';;
    ssh)
      CVS_PREFIX="address@hidden";;
    *)
      echo "$0: $CVS_AUTH: Unknown CVS access method" >&2
      exit 1;;
    esac

    case $CVS_RSH in
    '') export CVS_RSH=ssh;;
    esac

    cvs -z3 -q -d ${CVS_PREFIX}subversions.gnu.org:/cvsroot/gnulib co gnulib || 
exit

    trap 0
  fi
  GNULIB_SRCDIR=gnulib
esac

<$GNULIB_SRCDIR/gnulib-tool || exit

gnulib_modules='
alloca
closeout
extensions
getopt
malloc
realloc
quote
quotearg
stdbool
unlocked-io
xalloc
xalloc-die
version-etc
'

previous_gnulib_modules=
while [ "$gnulib_modules" != "$previous_gnulib_modules" ]; do
  previous_gnulib_modules=$gnulib_modules
  gnulib_modules=`
    (echo "$gnulib_modules"
     for gnulib_module in $gnulib_modules; do
       $GNULIB_SRCDIR/gnulib-tool --extract-dependencies $gnulib_module
     done) | sort -u
  `
done

gnulib_files=`
  (for gnulib_module in $gnulib_modules; do
     $GNULIB_SRCDIR/gnulib-tool --extract-filelist $gnulib_module
   done) | sort -u
`

gnulib_dirs=`echo "$gnulib_files" | sed 's,/[^/]*$,,' | sort -u`
mkdir -p $gnulib_dirs || exit

for gnulib_file in $gnulib_files; do
  dest=$gnulib_file

  case $gnulib_file in
  m4/onceonly_2_57.m4) dest=m4/onceonly.m4;;
  # These will be overwritten by autopoint, which still uses
  # old jm_.* macro names, so we have to keep both copies.
  # m4/gettext.m4 isn't mentioned here, since it's patched below.
  m4/glibc21.m4 | m4/inttypes_h.m4 | m4/lib-ld.m4 | \
  m4/lib-prefix.m4 | m4/po.m4 | m4/stdint_h.m4 | m4/uintmax_t.m4 | \
  m4/ulonglong.m4)
    dest=`expr $gnulib_file : '\(.*\).m4'`_gl.m4;;
  esac

  rm -f $dest &&
  echo "$0: Copying file $GNULIB_SRCDIR/$gnulib_file" &&
  cp -p $GNULIB_SRCDIR/$gnulib_file $dest || exit
done

echo "$0: patching m4/gettext.m4 so that AM_INTL_SUBDIR is empty ..."
sed '
  /^AC_DEFUN(\[AM_INTL_SUBDIR],/,/^]/c\
    AC_DEFUN([AM_INTL_SUBDIR], [])
' m4/gettext.m4 >m4/gettext_gl.m4 || exit


# Get translations.

case $SKIP_PO in
'')
  echo "$0: getting translations into po (please ignore the robots.txt ERROR 
404)..."
  (cd po &&
   rm -f dummy `ls | sed -n '/\.gmo$/p; /\.po/p'` &&
   wget -nv -nd -r -l 1 -A .po -C off \
     http://www2.iro.umontreal.ca/~gnutra/po/maint/$package/ &&
   ls *.po | sed 's/\.po$//' >LINGUAS
  ) || exit;;
esac


# Generate autoconf and automake snippets.

(echo '# This file is generated automatically by "bootstrap".' &&
 echo 'AC_DEFUN([GNULIB_AUTOCONF_SNIPPET],[' &&
 $GNULIB_SRCDIR/gnulib-tool --extract-autoconf-snippet $gnulib_modules &&
 echo '])'
) >m4/gnulib.m4 || exit

(echo '# This file is generated automatically by "bootstrap".' &&
 $GNULIB_SRCDIR/gnulib-tool --extract-automake-snippet $gnulib_modules
) >lib/gnulib.mk || exit


# Reconfigure, getting other files.

echo "$0: autoreconf --verbose --install --force ..."
autoreconf --verbose --install --force || exit


# We don't need intl, so remove it.
# Remove aclocal.m4 too, so that it gets rebuilt.
intl_files_to_remove='
  aclocal.m4
  intl
  m4/codeset.m4
  m4/gettext.m4
  m4/glibc21.m4
  m4/intdiv0.m4
  m4/intmax.m4
  m4/inttypes_h.m4
  m4/inttypes.m4
  m4/inttypes-pri.m4
  m4/isc-posix.m4
  m4/lcmessage.m4
  m4/lib-ld.m4
  m4/lib-prefix.m4
  m4/longdouble.m4
  m4/longlong.m4
  m4/po.m4
  m4/printf-posix.m4
  m4/signed.m4
  m4/size_max.m4
  m4/stdint_h.m4
  m4/uintmax_t.m4
  m4/ulonglong.m4
  m4/wchar_t.m4
  m4/wint_t.m4
  m4/xsize.m4
'
echo $0: rm -fr $intl_files_to_remove ...
rm -fr $intl_files_to_remove || exit

# Patch what appears to be a bug in gettext 0.14.1;
# remove this once the bug is fixed.
grep @top_builddir@ po/Makefile.in.in >/dev/null || {
  echo "$0: prepending 'address@hidden@' to po/Makefile.in.in ... "
  old_contents=`cat po/Makefile.in.in` || exit
  cat >po/Makefile.in.in <<EOF
address@hidden@
$old_contents
EOF
}

# Put bug-reporting address into po/Makevars.
if test -d po; then
  echo "$0: sed '/^MSGID_BUGS_ADDRESS *=/s/=.*/= address@hidden/'" \
      "po/Makevars.template >po/Makevars ..."
  sed '/^MSGID_BUGS_ADDRESS *=/s/=.*/= bug-'"$package"'@gnu.org/' \
      po/Makevars.template >po/Makevars
fi


if test -f src/parse-gram.c; then
  # if src/parse-gram.[ch] are out of date, rebuild them.
  parse_gram_y=`find src/parse-gram.y \
                   '(' -newer src/parse-gram.c -o -newer src/parse-gram.h ')' \
                   -print` || exit
  case $parse_gram_y in
  ?*)
    echo "$0: warning: bootstrapping with old src/parse-gram.[ch] files."

    echo "$0: touch -c src/parse-gram.[ch] ... "
    touch -c src/parse-gram.[ch] || exit

    echo "$0: ./configure --disable-nls ..."
    ./configure --disable-nls || exit

    echo "$0: (cd lib && make) ..."
    (cd lib && make) || exit

    echo "$0: (cd src && make) ..."
    (cd src && make) || exit

    echo "$0: rm -f src/parse-gram.c src/parse-gram.h ..."
    rm -f src/parse-gram.c src/parse-gram.h || exit

    echo "$0: (cd src && make parse-gram.c parse-gram.h) ..."
    (cd src && make parse-gram.c parse-gram.h) || exit

    echo "$0: make distclean ..."
    make distclean || exit;;
  esac
fi

echo "$0: done.  Now you can run './configure'."

[notice that I've remove getopt* and gettext.h from src/Makefile.am.
Those files should be removed from src/, too, since they're now in lib/.
You can also remove src/version.c and use lib/version-etc.c instead,
but I didn't do that.  ]

Then, with the following patches, just run

  ./bootstrap && ./configure && make

Index: configure.ac
===================================================================
RCS file: /cvsroot/hello/hello/configure.ac,v
retrieving revision 1.2
diff -u -p -r1.2 configure.ac
--- configure.ac        28 Mar 2005 00:40:42 -0000      1.2
+++ configure.ac        28 Mar 2005 09:13:35 -0000
@@ -11,24 +11,23 @@ AC_PREREQ(2.59)
 dnl Checks for programs.
 # We need a C compiler.
 AC_PROG_CC
+gl_USE_SYSTEM_EXTENSIONS
 
 # GNU help2man creates man pages from --help output; in many cases, this
 # is sufficient, and obviates the need to maintain man pages separately.
 AM_MISSING_PROG(HELP2MAN, help2man)
 
-dnl Checks for header files.
-AC_HEADER_STDC([])
+GNULIB_AUTOCONF_SNIPPET
+
 AC_CHECK_HEADERS([string.h fcntl.h sys/file.h sys/param.h])
 
 # i18n support from GNU gettext.
-AM_GNU_GETTEXT_VERSION([0.14.3])
-AM_GNU_GETTEXT()
+AM_GNU_GETTEXT_VERSION([0.13.1])
+AM_GNU_GETTEXT([external])
 
 AC_CONFIG_FILES([Makefile \
            contrib/Makefile \
            doc/Makefile \
-           intl/Makefile \
-          m4/Makefile \
            man/Makefile \
            po/Makefile.in \
            src/Makefile \
Index: Makefile.am
===================================================================
RCS file: /cvsroot/hello/hello/Makefile.am,v
retrieving revision 1.2
diff -u -p -r1.2 Makefile.am
--- Makefile.am 28 Mar 2005 00:40:42 -0000      1.2
+++ Makefile.am 28 Mar 2005 09:13:35 -0000
@@ -1,6 +1,6 @@
 ## Process this file with automake to produce Makefile.in (in this,
 ## and all subdirectories).
-## 
+##
 ## Makefile for the toplevel directory of GNU hello.
 ## Copyright (C) 1997, 1998, 2005 Free Software Foundation, Inc.
 ##
@@ -29,7 +29,7 @@ ke_PRE = @ke_PRE@
 DISTCLEANFILES = stamp-h
 EXTRA_DIST = BUGS ChangeLog.O config.rpath
 
-SUBDIRS = contrib doc intl po src man m4 tests
+SUBDIRS = contrib doc po src man tests
 
 # To produce a diff against the previous version, untar this version
 # and the previous version in the same directory and run `make diff'.
Index: src/Makefile.am
===================================================================
RCS file: /cvsroot/hello/hello/src/Makefile.am,v
retrieving revision 1.2
diff -u -p -r1.2 Makefile.am
--- src/Makefile.am     28 Mar 2005 00:40:42 -0000      1.2
+++ src/Makefile.am     28 Mar 2005 09:13:35 -0000
@@ -18,14 +18,13 @@
 ## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 bin_PROGRAMS = hello
-hello_SOURCES = hello.c version.c getopt.c getopt1.c getopt.h system.h 
-noinst_HEADERS = gettext.h
+hello_SOURCES = hello.c version.c system.h
 
-hello_LDADD = @LIBINTL@ @ALLOCA@
+hello_LDADD = $(LIBINTL)
 
 localedir = $(datadir)/locale
 
-INCLUDES = -I. -I$(srcdir) -I.. -I../intl -I$(top_srcdir)/intl
+INCLUDES = -I.. -I$(srcdir) -I$(top_srcdir)/lib -I../lib
 DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@
 
 ## # Automake cannot handle this now (version 1.0).
Index: src/hello.c
===================================================================
RCS file: /cvsroot/hello/hello/src/hello.c,v
retrieving revision 1.1
diff -u -p -r1.1 hello.c
--- src/hello.c 6 Dec 2004 00:50:51 -0000       1.1
+++ src/hello.c 28 Mar 2005 09:13:35 -0000
@@ -38,11 +38,7 @@
 #include <unistd.h>
 #endif
 
-#if HAVE_LOCALE_H
-# include <locale.h>
-#else
-# define setlocale(Category, Locale)
-#endif
+#include <locale.h>
 #include "gettext.h"
 #define _(str) gettext (str)
 #define N_(str) gettext_noop (str)