]> git.saurik.com Git - bison.git/blobdiff - Makefile.maint
* README: Mention m4 1.4.3. Remove obsolete advice about
[bison.git] / Makefile.maint
index c3d8b8c983eaa5d3777b7a4a56091144a65ae3cf..e803a810210ac63a12be68b54da246865faa1795 100644 (file)
@@ -1,24 +1,57 @@
 # -*-Makefile-*-
-# This Makefile fragment is shared between fileutils, sh-utils, textutils,
+# This Makefile fragment is shared between the coreutils,
 # CPPI, Bison, and Autoconf.
 
-prev_version_file ?= .prev-version
+## Copyright (C) 2001, 2002, 2003, 2004 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., 51 Franklin Street, Fifth Floor, Boston, MA
+## 02110-1301, USA.
+
+# This is reported not to work with make-3.79.1
+# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
+ME := Makefile.maint
+
+# Do not save the original name or timestamp in the .tar.gz file.
+GZIP_ENV = \
+  "--no-name --best$$( \
+    case $$(gzip --help) in \
+    (*--rsyncable*) echo ' --rsyncable';; \
+    esac \
+  )"
+
+CVS = cvs
+
+ifeq ($(origin prev_version_file), undefined)
+  prev_version_file = .prev-version
+endif
 
-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)
 
 # Old releases are stored here.
 # Used for diffs and xdeltas.
 release_archive_dir ?= ../release
 
+# Prevent programs like 'sort' from considering distinct strings to be equal.
+# Doing it here saves us from having to set LC_ALL elsewhere in this file.
+export LC_ALL = C
+
 
 
 ## --------------- ##
@@ -26,7 +59,157 @@ release_archive_dir ?= ../release
 ## --------------- ##
 
 # Checks that don't require cvs.
-local-check: changelog-check po-check writable-files copyright-check
+# Run `changelog-check' last, as previous test may reveal problems requiring
+# new ChangeLog entries.
+local-checks-available = \
+  po-check copyright-check writable-files m4-check author_mark_check \
+  changelog-check strftime-check syntax-check makefile_path_separator_check \
+  makefile-check
+.PHONY: $(local-checks-available)
+
+local-check = $(filter-out $(local-checks-to-skip), $(local-checks-available))
+
+# Make sure C source files in src/ don't include xalloc.h directly,
+# since they all already include it via sys2.h.
+# It's not a big deal -- just aesthetics.
+.PHONY: $(syntax-check-rules)
+syntax-check-rules = \
+  sc_cast_of_argument_to_free \
+  sc_cast_of_x_alloc_return_value \
+  sc_changelog \
+  sc_error_exit_success \
+  sc_space_tab \
+  sc_sun_os_names \
+  sc_system_h_headers \
+  sc_unmarked_diagnostics \
+  sc_xalloc_h_in_src
+
+syntax-check: $(syntax-check-rules)
+#      @grep -E '#  *include <(limits|std(def|arg|bool))\.h>'          \
+#          $$(find -type f -name '*.[chly]') &&                        \
+#        { echo '$(ME): found conditional include' 1>&2;               \
+#          exit 1; } || :
+
+#      grep -E '^#  *include <(string|stdlib)\.h>'                     \
+#          $(srcdir)/{lib,src}/*.[chy] &&                              \
+#        { echo '$(ME): FIXME' 1>&2;                                   \
+#          exit 1; } || :
+# FIXME: don't allow `#include .strings\.h' anywhere
+
+# Look for diagnostics that aren't marked for translation.
+# This won't find any for which error's format string is on a separate line.
+sc_unmarked_diagnostics:
+       @grep --exclude=$(srcdir)/src/shred.c -E                        \
+           '\<error \([^"]*"[^"]*[a-z]{3}' $(srcdir)/{lib,src}/*.c     \
+         | grep -v '_(' &&                                             \
+         { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
+           exit 1; } || :
+
+sc_cast_of_argument_to_free:
+       @grep -E '\<free \(\(' $(srcdir)/{lib,src}/*.[chly] &&          \
+         { echo '$(ME): don'\''t cast free argument' 1>&2;             \
+           exit 1; } || :
+
+sc_cast_of_x_alloc_return_value:
+       @grep -E --exclude=$(srcdir)/lib/regex.c                        \
+           '\*\) *x(m|c|re)alloc\>' $(srcdir)/{lib,src}/*.[chy] &&     \
+         { echo '$(ME): don'\''t cast x*alloc return value' 1>&2;      \
+           exit 1; } || :
+
+sc_space_tab:
+       @( cvsu --list ) > /dev/null 2>&1 || : &&                       \
+         grep '[ ]     '                                               \
+            $$(cvsu --list | grep -vEf .x-$@ ) &&                      \
+         { echo '$(ME): found SPACE-TAB sequence; remove the SPACE'    \
+               1>&2; exit 1; } || :
+
+# Using EXIT_SUCCESS as the first argument to error is misleading,
+# since when that parameter is 0, error does not exit.  Use `0' instead.
+sc_error_exit_success:
+       @grep -F 'error (EXIT_SUCCESS,'                                 \
+           $$(find -type f -name '*.[chly]') &&                        \
+         { echo '$(ME): found error (EXIT_SUCCESS' 1>&2;               \
+           exit 1; } || :
+
+# FIXME: merge this with sc_system_h_headers below.
+# xalloc.h is included via system.h, so should not be included
+# directly by any file in src/.
+sc_xalloc_h_in_src:
+       @if test -f $(srcdir)/src/sys2.h; then                          \
+         if grep 'xalloc\.h' $(srcdir)/src/*.c; then                   \
+           exit 1;                                                     \
+         fi;                                                           \
+       fi
+
+# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
+
+# Each nonempty line must start with a year number, or a TAB.
+sc_changelog:
+       @grep '^[^12    ]' $$(find . -name ChangeLog -maxdepth 2) &&    \
+         { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
+           exit 1; } || :
+
+header_regexp = \
+  alloca\
+  |closeout\
+  |ctype\
+  |dirent\
+  |errno\
+  |fcntl\
+  |inttypes\
+  |limits\
+  |locale\
+  |pathmax\
+  |std(lib|bool)\
+  |string\
+  |sys/(stat|dir|time)\
+  |time\
+  |unistd\
+  |utime\
+  |version-etc\
+  |xalloc
+h_re := $(shell echo '$(header_regexp)'|tr -d ' ')
+
+# Files in src/ should not include directly any of
+# the headers already included via system.h.
+# Get list of candidates with this:
+# grep -h include src/sys*.h|sed 's/.*include //'|sort -
+sc_system_h_headers:
+       @( cvsu --list ) > /dev/null 2>&1 || : &&                       \
+       grep -E '^# *include ["<]($(h_re))\.h[">]'                      \
+           $$(cvsu --list src | grep -Ev 'sys(2|tem)\.h$$')            \
+         && { echo '$(ME): the above are already included via system.h'\
+               1>&2; exit 1; } || :
+
+sc_sun_os_names:
+       @( cvsu --list ) > /dev/null 2>&1 || : && \
+       grep -Ei \
+           'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
+         $$(cvsu --list | grep -vEf .x-$@ ) &&                 \
+         { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;  \
+           exit 1; } || :
+
+# Ensure that date's --help output stays in sync with the info
+# documentation for GNU strftime.  The only exception is %N,
+# which date accepts but GNU strftime does not.
+extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
+strftime-check:
+       if test -f $(srcdir)/src/date.c; then                           \
+         grep '^  %.  ' $(srcdir)/src/date.c | sort                    \
+           | $(extract_char) > $@-src;                                 \
+         { echo N;                                                     \
+           info libc date calendar format | grep '^    `%.'\'          \
+             | $(extract_char); } | sort > $@-info;                    \
+         diff -u $@-src $@-info || exit 1;                             \
+         rm -f $@-src $@-info;                                         \
+       fi
+
+# Ensure that we use only the standard $(VAR) notation,
+# not @...@ in Makefile.am, now that we can rely on automake
+# to emit a definition for each substituted variable.
+makefile-check:
+       grep -E '@[A-Z_0-9]+@' `find . -name Makefile.am` \
+         && { echo 'Makefile.maint: use $(...), not @...@' 1>&2; exit 1; } || :
 
 changelog-check:
        if head ChangeLog | grep 'Version $(VERSION)' >/dev/null; then \
@@ -36,15 +219,48 @@ changelog-check:
          exit 1; \
        fi
 
+m4-check:
+       @grep 'AC_DEFUN([^[]' m4/*.m4 \
+         && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
+              exit 1; } || :
+
 # 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 > $@-1; \
-         grep -E -l '\b_\(' lib/*.c src/*.c | sort > $@-2; \
+         files=; \
+         for file in lib/*.[chly] src/*.[chly]; do \
+           case $$file in \
+           *.[ch]) \
+             base=`expr " $$file" : ' \(.*\)\..'`; \
+             { test -f $$base.l || test -f $$base.y; } && continue;; \
+           esac; \
+           files="$$files $$file"; \
+         done; \
+         grep -E -l '\bN?_\([^)"]*("|$$)' $$files | sort > $@-2; \
          diff -u $@-1 $@-2 || exit 1; \
          rm -f $@-1 $@-2; \
        fi
 
+# In a definition of #define AUTHORS "... and ..." where the RHS contains
+# the English word `and', the string must be marked with `N_ (...)' so that
+# gettext recognizes it as a string requiring translation.
+author_mark_check:
+       @grep '^# *define AUTHORS "[^"]* and ' src/*.c |grep -v ' N_ (' && \
+         { echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
+           exit 1; } || :
+
+# Sometimes it is useful to change the PATH environment variable
+# in Makefiles.  When doing so, it's better not to use the Unix-centric
+# path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
+# It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
+# and there probably aren't many projects with so many Makefile.am files
+# that we'd have to worry about limits on command line length.
+msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
+makefile_path_separator_check:
+       @grep 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
+         && { echo $(msg) 1>&2; exit 1; } || :
+
 # Check that `make alpha' will not fail at the end of the process.
 writable-files:
        if test -d $(release_archive_dir); then :; else                 \
@@ -59,28 +275,30 @@ writable-files:
        done;                                                           \
        test "$$fail" && exit 1 || :
 
-# Make sure that the copyright date in lib/version-etc.c is up to date.
+v_etc_file = lib/version-etc.c
+# Make sure that the copyright date in $(v_etc_file) is up to date.
 copyright-check:
-       @if test -f lib/version-etc.c; then \
-         grep 'N_("Copyright (C) $(shell date +%Y) Free' lib/version-etc.c \
+       @if test -f $(v_etc_file); then \
+         grep '"Copyright (C) $(shell date +%Y) Free' $(v_etc_file) \
            >/dev/null \
-         || { echo 'out of date copyright in $<; update it' 1>&2; exit 1; }; \
+         || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
+              exit 1; }; \
        fi
 
 
 # Sanity checks with the CVS repository.
 cvs-tag-check:
        echo $(this-cvs-tag); \
-       if cvs -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
+       if $(CVS) -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
          echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
          exit 1; \
        else :; fi
 
 cvs-diff-check:
-       if cvs diff | grep -v '^?' >cvs-diffs; then             \
-         rm cvs-diffs;                                         \
-       else                                                    \
-         echo "Some files are locally modified:" 1>&2;         \
+       if $(CVS) diff >cvs-diffs; then                         \
+         rm cvs-diffs;                                         \
+       else                                                    \
+         echo "Some files are locally modified:" 1>&2;         \
          cat cvs-diffs;                                        \
          exit 1;                                               \
        fi
@@ -92,18 +310,12 @@ maintainer-distcheck: changelog-check
        $(MAKE) my-distcheck
 
 
-# Do not save the original name or timestamp in the .tar.gz file.
-GZIP_ENV = '--no-name --best'
-
-# Automake 1.4 does not define AMTAR.
-AMTAR ?= $(TAR)
-
 # 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: cvs-check maintainer-distcheck
-       cvs update po
-       cvs tag -c $(this-cvs-tag)
+cvs-dist: $(local-check) cvs-check maintainer-distcheck
+       $(CVS) update po
+       $(CVS) tag -c $(this-cvs-tag)
        $(MAKE) dist
 
 # Use this to make sure we don't run these programs when building
@@ -119,10 +331,11 @@ null_AM_MAKEFLAGS = \
 # 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
+TMPDIR ?= /tmp
+t=$(TMPDIR)/$(PACKAGE)/test
+my-distcheck: $(local-check)
        -rm -rf $(t)
-       mkdir $(t)
+       mkdir -p $(t)
        GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
        cd $(t)/$(distdir) \
          && ./configure --disable-nls \
@@ -131,132 +344,61 @@ my-distcheck: writable-files po-check
          && $(MAKE) dvi \
          && $(MAKE) check \
          && $(MAKE) distclean
-       cd $(t) && mv $(distdir) $(distdir).old \
-         && $(AMTAR) -zxf ../$(distdir).tar.gz
+       (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))
+WGET = wget
+WGETFLAGS = -C off
 
 tgz-md5 = $(shell md5sum < $(my_distdir).tar.gz|sed 's/  -//')
 tgz-sha1 = $(shell sha1sum < $(my_distdir).tar.gz|sed 's/  -//')
 bz2-md5 = $(shell md5sum < $(my_distdir).tar.bz2|sed 's/  -//')
 bz2-sha1 = $(shell sha1sum < $(my_distdir).tar.bz2|sed 's/  -//')
-tgz-size = $(shell du --human $(my_distdir).tar.gz|sed 's/\([Mk]\).*/ \1B/')
-bz2-size = $(shell du --human $(my_distdir).tar.bz2|sed 's/\([Mk]\).*/ \1B/')
-xd-size = $(shell du --human $(xd-delta)|sed 's/\([Mk]\).*/ \1B/')
+xdelta-md5 = $(shell md5sum < $(xd-delta)|sed 's/  -//')
+xdelta-sha1 = $(shell sha1sum < $(xd-delta)|sed 's/  -//')
+tgz-size = $(shell du --human $(my_distdir).tar.gz|sed 's/\([MkK]\).*/ \1B/')
+bz2-size = $(shell du --human $(my_distdir).tar.bz2|sed 's/\([MkK]\).*/ \1B/')
+xd-size = $(shell du --human $(xd-delta)|sed 's/\([MkK]\).*/ \1B/')
 
 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); \
+       $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
        echo "$(md5)  -" > $$md5_tmp; \
        md5sum -c $$md5_tmp < $$tarz
 
 prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
 xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
 
-GZIP = gzip
-BZIP2 = bzip2
-$(my_distdir).tar.bz2: $(my_distdir).tar.gz
-       $(GZIP) -dc $< > $(my_distdir).tar
+signatures ?= $(distdir).tar.bz2.asc $(distdir).tar.gz.asc
+%.asc: %
        rm -f $@
-       $(BZIP2) -9 $(my_distdir).tar
-
-rel-files = $(xd-delta) $(distdir).tar.bz2 $(distdir).tar.gz
-announcement: NEWS ChangeLog $(rel-files)
-       @( \
-         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))"; \
-           echo "  $$url/$(my_distdir).tar.bz2  ($(bz2-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 compressed tar files:"; \
-         echo; \
-         echo "$(tgz-md5)  $(my_distdir).tar.gz"; \
-         echo "$(bz2-md5)  $(my_distdir).tar.bz2"; \
-         echo "$(tgz-sha1)  $(my_distdir).tar.gz"; \
-         echo "$(bz2-sha1)  $(my_distdir).tar.bz2"; \
-         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"'; \
-       )
-
-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))
-
-.PHONY: $(get-targets)
-$(get-targets):
-       $(WGET) $(url) -O $(target).t \
-         && $(move_if_change) $(target).t $(target)
-
-automake_repo=:pserver:anoncvs@anoncvs.cygnus.com:/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
+       gpg --armor --detach-sign -o $@ $<
+
+rel-files = $(xd-delta) $(distdir).tar.bz2 $(distdir).tar.gz $(signatures)
+announce_gen ?= ./announce-gen
+announcement: NEWS ChangeLog $(rel-files) $(signatures)
+       @$(announce_gen)                                                \
+           --release-type=$(RELEASE_TYPE)                              \
+           --package=$(PACKAGE)                                        \
+           --prev=$(PREV_VERSION)                                      \
+           --curr=$(VERSION)                                           \
+           --release-archive-directory=$(release_archive_dir)          \
+           --news=NEWS                                                 \
+           $(addprefix --url-dir=, $(url_dir_list))                    \
+
+
+define emit-upload-commands
        echo =====================================
        echo =====================================
-       echo 'for host in $(a_host) $(b_host); do \'
-       echo '  rsync -e ssh --pro -av $(xd-delta) $(my_distdir).tar.bz2 \'
-       echo '    $(my_distdir).tar.gz $$host:$(real_dir); done'
+       echo upload $(PACKAGE) $(PREV_VERSION) $(VERSION)
        echo '# send the /tmp/announcement e-mail'
        echo =====================================
        echo =====================================
@@ -265,12 +407,13 @@ endef
 $(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
        xdelta delta -9 $^ $@ || :
 
-alpha: local-check
+.PHONY: alpha beta major
+alpha beta major: $(local-check)
        $(MAKE) cvs-dist
        $(MAKE) $(xd-delta)
-       $(MAKE) -s announcement > /tmp/announce-$(my_distdir)
+       $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
        ln $(rel-files) $(release_archive_dir)
        chmod a-w $(rel-files)
        echo $(VERSION) > $(prev_version_file)
-       cvs ci -m. $(prev_version_file)
-       @$(emit-rsync-commands)
+       $(CVS) ci -m. $(prev_version_file)
+       @$(emit-upload-commands)