Re: Makefile.maint (Was: TODO)

[Akim Demaille]

| > Index: .prev-version
| Minor nit, but could this be a more dos-friendly name (no leading dot
| supported)?

OK, I changed this to config/prev-version.txt (for Autoconf).

| > +# Systems where /bin/sh is not the default shell need this.  The $(shell)
| > +# command below won't work with e.g. stock DOS/Windows shells.
| > +SHELL = /bin/sh
| 
| This sounds a bit like the $(shell) command doesn't work on DOS/Windows
| due to/regardless of the setting of SHELL.  On DJGPP, at least, this
| is not true - setting SHELL like this ensure unixy commands work just
| fine in a makefile (only when SHELL isn't set in a makefile does make
| default to the broken DOS command interpreter).
| So perhaps
| 
|    # Systems where /bin/sh is not the default shell need this.  This is
|    # especially needed on DOS/Windows, where the $(shell) command below
|    # wouldn't work with the stock shell.
| 
| would be more appropriate.  I don't know if this would apply to Cygwin as
| well, but I would think it odd if having SHELL=/bin/sh broke its make.

I leave the decision to update this comment to Jim.


Jim, thanks for your updated Makefile.maint.  I integrated your
changes, and added some more.  I tried hard to make it compatible for
Fetish and Autoconf (and the rest of the world :).

The most important changes, I guess, are about updating the files.
You hard coded some paths in Makefile.maint, and that made it
impossible to use for Autoconf.  So I kept _default_ values which are
yours, but made it possible to define other values.  Unfortunately
ftp.gnu.org seems down, so I can't really check that it works.
Nonetheless, it seems to be the right way.

Also, I had to rename a few vars to avoid GNU Make extensions on
variables names.

Index: ChangeLog
from  Akim Demaille  <address@hidden>

        * Makefile.maint, GNUmakefile: New, from Jim Meyering.
        * config/prev-version.txt: New.
        * config/move-if-change: New, for GNU libc.

Index: GNUmakefile
===================================================================
RCS file: GNUmakefile
diff -N GNUmakefile
--- /dev/null   Sat Apr 14 17:46:23 2001
+++ GNUmakefile Sat Jun 9 11:04:35 2001
@@ -0,0 +1,32 @@
+# Having a separate GNUmakefile lets me `include' the dynamically
+# generated rules created via Makefile.maint as well as Makefile.maint itself.
+# This makefile is used only if you run GNU Make.
+# It is necessary if you want to build targets usually of interest
+# only to the maintainer.
+
+# Systems where /bin/sh is not the default shell need this.  The $(shell)
+# command below won't work with e.g. stock DOS/Windows shells.
+SHELL = /bin/sh
+
+have-Makefile := $(shell test -f Makefile && echo yes)
+
+# If the user runs GNU make but has not yet run ./configure,
+# give them a diagnostic.
+ifeq ($(have-Makefile),yes)
+
+include Makefile
+include $(srcdir)/Makefile.maint
+
+else
+
+all:
+       @echo There seems to be no Makefile in this directory.
+       @echo "You must run ./configure before running \`make'."
+       @exit 1
+
+endif
+
+# Tell version 3.79 and up of GNU make to not build goals in this
+# directory in parallel.  This is necessary in case someone tries to
+# build multiple targets on one command line.
+.NOTPARALLEL:
Index: Makefile.am
===================================================================
RCS file: /cvs/autoconf/Makefile.am,v
retrieving revision 1.52
diff -u -u -r1.52 Makefile.am
--- Makefile.am 2001/06/06 08:49:33 1.52
+++ Makefile.am 2001/06/09 18:04:35
@@ -52,7 +52,8 @@
              acversion.in \
              autoconf.in autoheader.in autoreconf.in autoupdate.in ifnames.in \
              autoscan.in \
-             $(distpkgdataDATA)
+             $(distpkgdataDATA) \
+             GNUmakefile Makefile.maint
 
 # Files that should be removed, but which Automake does not know:
 # the frozen files and the scripts.
@@ -90,8 +91,8 @@
 
 
 ## maintainer-check ##
-
-maintainer-check:
+maintainer-check: maintainer-check-tests
+maintainer-check-tests:
        cd tests && make maintainer-check
 
 ## ----------------------------------- ##
@@ -203,13 +204,19 @@
 autoconf.m4f: $(m4sources)
 
 
-## ---------- ##
-## Updating.  ##
-## ---------- ##
-
-wget-update:
-       $(WGET) ftp://ftp.gnu.org/gnu/GNUinfo/standards.texi -O 
$(srcdir)/doc/standards.texi
-       $(WGET) ftp://ftp.gnu.org/gnu/GNUinfo/make-stds.texi -O 
$(srcdir)/doc/make-stds.texi
-       $(WGET) ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex    -O 
$(srcdir)/doc/texinfo.tex
-       $(WGET) ftp://ftp.gnu.org/gnu/config/config.guess    -O 
$(srcdir)/config/config.guess
-       $(WGET) ftp://ftp.gnu.org/gnu/config/config.sub      -O 
$(srcdir)/config/config.sub
+## ---------------------------- ##
+## Customizing Makefile.maint.  ##
+## ---------------------------- ##
+
+move_if_change = $(srcdir)/config/move_if_change
+prev_version_file = $(srcdir)/config/prev-version.txt
+
+# Uploading betas.
+hosts = alpha
+alpha_host = alpha.gnu.org
+alpha_url_dir = gnu/autoconf
+
+# Files to update automatically.
+wget_files = $(srcdir)/config/config.guess $(srcdir)/config/config.sub \
+            $(srcdir)/doc/texinfo.tex \
+            $(srcdir)/doc/install.texi $(srcdir)/doc/make-stds.texi
Index: Makefile.in
===================================================================
RCS file: /cvs/autoconf/Makefile.in,v
retrieving revision 1.134
diff -u -u -r1.134 Makefile.in
--- Makefile.in 2001/06/06 08:49:33 1.134
+++ Makefile.in 2001/06/09 18:04:36
@@ -93,7 +93,7 @@
 
 pkgdata_DATA = $(distpkgdataDATA) $(nodistpkgdataDATA)
 
-EXTRA_DIST = ChangeLog.0 ChangeLog.1 ChangeLog.2              BUGS INSTALL.txt 
             acversion.in              autoconf.in autoheader.in autoreconf.in 
autoupdate.in ifnames.in              autoscan.in              
$(distpkgdataDATA)
+EXTRA_DIST = ChangeLog.0 ChangeLog.1 ChangeLog.2              BUGS INSTALL.txt 
             acversion.in              autoconf.in autoheader.in autoreconf.in 
autoupdate.in ifnames.in              autoscan.in              
$(distpkgdataDATA)              GNUmakefile Makefile.maint
 
 
 # Files that should be removed, but which Automake does not know:
@@ -105,6 +105,18 @@
 
 edit = sed     -e 's,@SHELL\@,$(SHELL),g'      -e 's,@PERL\@,$(PERL),g'        
-e 's,@datadir\@,$(pkgdatadir),g'       -e 's,@bindir\@,$(bindir),g'    -e 
's,@autoconf-name\@,'`echo autoconf | sed '$(transform)'`',g'        -e 
's,@autoheader-name\@,'`echo autoheader | sed '$(transform)'`',g'    -e 
's,@M4\@,$(M4),g'    -e 's,@AWK\@,$(AWK),g'  -e 's,@VERSION\@,$(VERSION),g'  -e 
's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g'
 
+
+move_if_change = $(srcdir)/config/move_if_change
+prev_version_file = $(srcdir)/config/prev-version.txt
+
+# Uploading betas.
+hosts = alpha
+alpha_host = alpha.gnu.org
+alpha_url_dir = gnu/autoconf
+
+# Files to update automatically.
+wget_files = $(srcdir)/config/config.guess $(srcdir)/config/config.sub         
     $(srcdir)/doc/texinfo.tex       $(srcdir)/doc/install.texi 
$(srcdir)/doc/make-stds.texi
+
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
 mkinstalldirs = $(SHELL) $(top_srcdir)/config/mkinstalldirs
 CONFIG_CLEAN_FILES = 
@@ -426,7 +438,8 @@
        $(MAKEINFO) $< --no-headers --no-validate --no-split --output=$@
        if test '$(srcdir)' != '.'; then cp $@ $(srcdir); rm -f $@; fi
 
-maintainer-check:
+maintainer-check: maintainer-check-tests
+maintainer-check-tests:
        cd tests && make maintainer-check
 
 install-data-hook: INSTALL.txt
@@ -504,13 +517,6 @@
        fi
 
 autoconf.m4f: $(m4sources)
-
-wget-update:
-       $(WGET) ftp://ftp.gnu.org/gnu/GNUinfo/standards.texi -O 
$(srcdir)/doc/standards.texi
-       $(WGET) ftp://ftp.gnu.org/gnu/GNUinfo/make-stds.texi -O 
$(srcdir)/doc/make-stds.texi
-       $(WGET) ftp://ftp.gnu.org/gnu/texinfo/texinfo.tex    -O 
$(srcdir)/doc/texinfo.tex
-       $(WGET) ftp://ftp.gnu.org/gnu/config/config.guess    -O 
$(srcdir)/config/config.guess
-       $(WGET) ftp://ftp.gnu.org/gnu/config/config.sub      -O 
$(srcdir)/config/config.sub
 
 # Tell versions [3.59,3.63) of GNU make to not export all variables.
 # Otherwise a system limit (for SysV at least) may be exceeded.
Index: Makefile.maint
===================================================================
RCS file: Makefile.maint
diff -N Makefile.maint
--- /dev/null   Sat Apr 14 17:46:23 2001
+++ Makefile.maint Sat Jun 9 11:04:36 2001
@@ -0,0 +1,223 @@
+# -*-Makefile-*-
+# This Makefile fragment is shared between fileutils, sh-utils, textutils.
+
+maintainer-check:
+       if head ChangeLog| grep 'Version $(VERSION)' > /dev/null; then \
+         :; \
+       else \
+         echo "$(VERSION) not in ChangeLog; not tagging" 1>&2; \
+         exit 1; \
+       fi
+       $(MAKE) distcheck
+       $(MAKE) my-distcheck
+
+prev_version_file ?= .prev-version
+
+THIS_VERSION_REGEXP = $(subst .,\.,$(VERSION))
+PREV_VERSION := $(shell cat $(prev_version_file))
+PREV_VERSION_REGEXP := $(shell echo $(PREV_VERSION)|sed 's/\./\\./g')
+
+tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
+tag-this-version = $(subst .,_,$(VERSION))
+tag-prev-version = $(subst .,_,$(PREV_VERSION))
+this-cvs-tag = $(tag-package)-$(tag-this-version)
+prev-cvs-tag = $(tag-package)-$(tag-prev-version)
+my_distdir = $(PACKAGE)-$(VERSION)
+
+# Verify that all source files using _() are listed in po/POTFILES.in.
+po-check:
+       if test -f po/POTFILES.in; then \
+         grep -E -v '^(#|$$)' po/POTFILES.in | sort > address@hidden; \
+         grep -E -l '\b_\(' lib/*.c src/*.c | sort > address@hidden; \
+         diff -u address@hidden address@hidden || exit 1; \
+         rm -f address@hidden address@hidden; \
+       fi
+
+# Do not save the original name or timestamp in the .tar.gz file.
+GZIP_ENV = --no-name
+
+# Tag before making distribution.  Also, don't make a distribution if
+# checks fail.  Also, make sure the NEWS file is up-to-date.
+# FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
+cvs-dist: maintainer-check
+       echo $(this-cvs-tag); \
+       if cvs -n log -h README| grep -e $(this-cvs-tag): > /dev/null; then \
+         echo "VERSION not new; not tagging" 1>&2; \
+         exit 1; \
+       fi; \
+       cvs update po; \
+       cvs tag -c $(this-cvs-tag)
+       $(MAKE) dist
+
+# Use this to make sure we don't run these programs when building
+# from a virgin tgz file, below.
+null_AM_MAKEFLAGS = \
+  ACLOCAL=false \
+  AUTOCONF=false \
+  AUTOMAKE=false \
+  AUTOHEADER=false \
+  MAKEINFO=false
+
+# Detect format-string/arg-list mismatches that would normally be obscured
+# by the use of _().  The --disable-nls effectively defines away that macro,
+# and building with CFLAGS='-Wformat -Werror' causes any format warning to be
+# treated as a failure.
+t=./=test
+my-distcheck: writable-files po-check
+       -rm -rf $(t)
+       mkdir $(t)
+       GZIP=$(GZIP) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
+       cd $(t)/$(distdir) \
+         && ./configure --disable-nls \
+         && $(MAKE) CFLAGS='-Wformat -Werror' \
+             AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
+         && $(MAKE) dvi \
+         && $(MAKE) check \
+         && $(MAKE) distclean
+       cd $(t) && mv $(distdir) $(distdir).old \
+         && $(AMTAR) -zxf ../$(distdir).tar.gz
+       diff -ur $(t)/$(distdir).old $(t)/$(distdir)
+       -rm -rf $(t)
+       @echo "========================"; \
+       echo "$(distdir).tar.gz is ready for distribution"; \
+       echo "========================"
+
+# This must be the same name on both hosts.
+# Make it a symlink that points to the right place.
+real_dir = fetish-ftp
+
+url_dir_list = $(foreach x,$(hosts),ftp://$($(x)_host)/$($(x)_url_dir))
+
+md5 = $(shell md5sum < $(my_distdir).tar.gz|sed 's/  -//')
+sha1 = $(shell sha1sum < $(my_distdir).tar.gz|sed 's/  -//')
+tgz-size = $(shell du --human $(my_distdir).tar.gz|sed 's/M.*/MB/')
+xd-size = $(shell du --human $(xd-delta)|sed 's/M.*/MB/')
+
+rel-check:
+       tarz=/tmp/rel-check-tarz-$$$$; \
+       md5_tmp=/tmp/rel-check-md5-$$$$; \
+       set -e; \
+       trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
+       wget -q --output-document=$$tarz $(url); \
+       echo "$(md5)  -" > $$md5_tmp; \
+       md5sum -c $$md5_tmp < $$tarz
+
+release-archive-dir = ../release
+prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
+xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
+
+announcement: NEWS ChangeLog $(distdir).tar.gz
+       @( \
+         echo Subject: $(my_distdir) released; \
+         echo; \
+         echo FIXME: put comments here; \
+         echo; \
+         for url in $(url_dir_list); do \
+           echo "  $$url/$(my_distdir).tar.gz   ($(tgz-size))"; \
+         done; \
+         echo; \
+         echo And here are xdelta-style diffs; \
+         echo; \
+         for url in $(url_dir_list); do \
+           echo "  $$url/$(xd-delta)   ($(xd-size))"; \
+         done; \
+         echo; \
+         echo "Here are the MD5 and SHA1 signatures for the .tar.gz file"; \
+         echo; \
+         echo "$(md5)  $(my_distdir).tar.gz"; \
+         echo "$(sha1)  $(my_distdir).tar.gz"; \
+         echo; \
+         echo NEWS:; \
+         sed -n "/$(THIS_VERSION_REGEXP)/,/^\[$(PREV_VERSION_REGEXP)/p" NEWS \
+           | grep -v '^\['; \
+         echo; \
+         echo ChangeLog entries:; \
+         find . -name ChangeLog -maxdepth 2 \
+           | xargs cvs diff -up -r$(prev-cvs-tag) -rHEAD \
+           | sed -n 's/^+//p' \
+           | perl -ne 'm!^\+\+ (\./)?! or print,next;' \
+             -e 'print "\n"."*"x70 ."\n"; s///; print; print "*"x70 ."\n"'; \
+       )
+
+writable-files:
+       for file in $(distdir).tar.gz $(xd-delta)                       \
+         ../release/$(distdir).tar.gz ../release/$(xd-delta); do       \
+         test -e $$file || continue;                                   \
+         test -w $$file                                                \
+           || { echo ERROR: $$file is not writable; fail=1; };         \
+       done;                                                           \
+       test "$$fail" && exit 1 || :
+
+WGET = wget
+ftp-gnu = ftp://ftp.gnu.org/gnu
+
+# Use mv, if you don't have/want move-if-change.
+move-if-change ?= move-if-change
+
+# The following pseudo table associates a local directory and a URL
+# with each of the files that belongs to some other package and is
+# regularly updated from the specified URL.
+wget_files ?= $(srcdir)/config.guess $(srcdir)/config.sub \
+              $(srcdir)/src/ansi2knr.c \
+             $(srcdir)/doc/texinfo.tex
+get-targets = $(patsubst %, get-%, $(wget_files))
+
+config.guess-url_prefix = $(ftp-gnu)/config/
+config.sub-url_prefix = $(ftp-gnu)/config/
+
+ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
+
+texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
+
+standards.texi-url_prefix = $(ftp-gnu)/GNUinfo/
+make-stds.texi-url_prefix = $(ftp-gnu)/GNUinfo/
+
+target = $(patsubst get-%, %, $@)
+url = $($(notdir $(target))-url_prefix)$(notdir $(target))
+local_file = $($(target)-local_dir)/$(target)
+
+.PHONY: $(get-targets)
+$(get-targets):
+       $(WGET) $(url) -O $(target).t \
+         && $(move-if-change) $(target).t $(local_file)
+
+automake_repo=:pserver:address@hidden:/cvs/automake
+.PHONY: wget-update
+wget-update: $(get-targets)
+       for f in depcomp missing; do                                    \
+         test -f $$f || continue;                                      \
+         echo checking out $$f...;                                     \
+         cvs -d $(automake_repo) co -p automake/lib/$$f > $$f.t        \
+           && $(move-if-change) $$f.t $$f;                             \
+       done
+
+define emit-rsync-commands
+       echo =====================================
+       echo =====================================
+       echo 'for host in $(a_host) $(b_host); do \'
+       echo '  rsync -e ssh --pro -av $(xd-delta) $(my_distdir).tar.gz \'
+       echo '    $$host:$(real_dir); done'
+       echo '# send the /tmp/announcement e-mail'
+       echo =====================================
+       echo =====================================
+endef
+
+# Make sure that the copyright date in lib/version-etc.c is up to date.
+check-copyright:
+       @if test -f lib/version-etc.c; then \
+         grep 'N_("Copyright (C) $(shell date +%Y) Free' lib/version-etc.c > 
/dev/null \
+         || { echo 'out of date copyright in $<; update it' 1>&2; exit 1; }; \
+       fi
+
+alpha: writable-files po-check check-copyright
+       $(MAKE) cvs-dist
+       $(MAKE) -s announcement > /tmp/announce-$(my_distdir)
+       ln $(distdir).tar.gz ../release
+       chmod a-w $(distdir).tar.gz
+       cd $(release-archive-dir) \
+         && xdelta delta -9 $(prev-tgz) $(distdir).tar.gz $(xd-delta) || :
+       ln $(release-archive-dir)/$(xd-delta) .
+       chmod a-w $(release-archive-dir)/$(xd-delta)
+       echo $(VERSION) > $(prev_version_file)
+       cvs ci -m. $(prev_version_file)
+       @$(emit-rsync-commands)
Index: config/Makefile.am
===================================================================
RCS file: /cvs/autoconf/config/Makefile.am,v
retrieving revision 1.1
diff -u -u -r1.1 Makefile.am
--- config/Makefile.am 2001/05/22 14:43:50 1.1
+++ config/Makefile.am 2001/06/09 18:04:36
@@ -1 +1 @@
-## Nothing to do here.
+EXTRA_DIST = move-if-change prev-version.txt
Index: config/Makefile.in
===================================================================
RCS file: /cvs/autoconf/config/Makefile.in,v
retrieving revision 1.2
diff -u -u -r1.2 Makefile.in
--- config/Makefile.in 2001/06/02 12:30:14 1.2
+++ config/Makefile.in 2001/06/09 18:04:36
@@ -66,6 +66,8 @@
 PERL = @PERL@
 PERLSCRIPTS = @PERLSCRIPTS@
 VERSION = @VERSION@
+
+EXTRA_DIST = move-if-change prev-version.txt
 mkinstalldirs = $(SHELL) $(top_srcdir)/config/mkinstalldirs
 CONFIG_CLEAN_FILES = 
 DIST_COMMON =  Makefile.am Makefile.in config.guess config.sub \
Index: config/move-if-change
===================================================================
RCS file: move-if-change
diff -N move-if-change
--- /dev/null   Sat Apr 14 17:46:23 2001
+++ config/move-if-change Sat Jun 9 11:04:36 2001
@@ -0,0 +1,17 @@
+#!/bin/sh
+# Like mv $1 $2, but if the files are the same, just delete $1.
+# Status is 0 if $2 is changed, 1 otherwise.
+if
+test -r $2
+then
+if
+cmp -s $1 $2
+then
+echo $2 is unchanged
+rm -f $1
+else
+mv -f $1 $2
+fi
+else
+mv -f $1 $2
+fi