[bison.git] / Makefile.maint

# -*-Makefile-*-
# This Makefile fragment is shared between the coreutils,
# CPPI, Bison, and Autoconf.

## 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., 59 Temple Place - Suite 330, Boston, MA
## 02111-1307, 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

PREV_VERSION := $(shell cat $(prev_version_file))

tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
tag-this-version = $(subst .,_,$(VERSION))
this-cvs-tag = $(tag-package)-$(tag-this-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


## --------------- ##
## Sanity checks.  ##
## --------------- ##

# Checks that don't require cvs.
# 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 \
	  :; \
	else \
	  echo "$(VERSION) not in ChangeLog" 1>&2; \
	  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; \
	  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			\
	  mkdir $(release_archive_dir);					\
	fi
	for file in $(distdir).tar.gz $(xd-delta)			\
	            $(release_archive_dir)/$(distdir).tar.gz		\
	            $(release_archive_dir)/$(xd-delta); do		\
	  test -e $$file || continue;					\
	  test -w $$file						\
	    || { echo ERROR: $$file is not writable; fail=1; };		\
	done;								\
	test "$$fail" && exit 1 || :

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 $(v_etc_file); then \
	  grep '"Copyright (C) $(shell date +%Y) Free' $(v_etc_file) \
	    >/dev/null \
	  || { 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 \
	  echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
	  exit 1; \
	else :; fi

cvs-diff-check:
	if $(CVS) diff >cvs-diffs; then				\
	  rm cvs-diffs;						\
	else							\
	  echo "Some files are locally modified:" 1>&2;		\
	  cat cvs-diffs;					\
	  exit 1;						\
	fi

cvs-check: cvs-diff-check cvs-tag-check

maintainer-distcheck: changelog-check
	$(MAKE) distcheck
	$(MAKE) my-distcheck


# 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: $(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
# 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.
TMPDIR ?= /tmp
t=$(TMPDIR)/$(PACKAGE)/test
my-distcheck: $(local-check)
	-rm -rf $(t)
	mkdir -p $(t)
	GZIP=$(GZIP_ENV) $(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 "========================"

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/  -//')
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) $(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

signatures ?= $(distdir).tar.bz2.asc $(distdir).tar.gz.asc
%.asc: %
	rm -f $@
	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))			\


## ---------------- ##
## Updating files.  ##
## ---------------- ##

ftp-gnu = ftp://ftp.gnu.org/gnu
www-gnu = http://www.gnu.org

# Use mv, if you don't have/want move-if-change.
move_if_change ?= move-if-change


# --------------------- #
# Updating everything.  #
# --------------------- #

.PHONY: update
local_updates ?= wget-update cvs-update po-update
update: $(local_updates)


# ------------------- #
# Updating PO files.  #
# ------------------- #

po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
.PHONY: do-po-update po-update
do-po-update:
	tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
	rm -rf $$tmppo && \
	mkdir $$tmppo && \
	(cd $$tmppo && \
	  $(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
	cp $$tmppo/*.po po
	cd po && $(MAKE) update-po
	$(MAKE) po-check

po-update:
	if test -d "po"; then \
	  $(MAKE) do-po-update; \
	fi

# -------------------------- #
# Updating GNU build tools.  #
# -------------------------- #

# 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/config.guess \
              $(srcdir)/config/config.sub \
              $(srcdir)/src/ansi2knr.c \
	      $(srcdir)/config/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 = $(www-gnu)/prep/
make-stds.texi-url_prefix = $(standards.texi-url_prefix)

target = $(patsubst get-%, %, $@)
url = $($(notdir $(target))-url_prefix)$(notdir $(target))

.PHONY: $(get-targets)
$(get-targets):
	$(WGET) $(WGETFLAGS) $(url) -O $(target).t \
	  && $(move_if_change) $(target).t $(target)

cvs_files ?= \
  $(srcdir)/src/ansi2knr.c \
  $(srcdir)/config/depcomp \
  $(srcdir)/config/install-sh \
  $(srcdir)/config/missing \
  $(srcdir)/config/mkinstalldirs
automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
.PHONY: wget-update
wget-update: $(get-targets)

.PHONY: cvs-update
cvs-update:
	fail=;								\
	for f in $(cvs_files); do					\
	  test -f $$f || { echo "*** skipping $$f" 1>&2; continue; };	\
	  cvs diff $$f > /dev/null					\
	    || { echo "*** $$f is locally modified; skipping it" 1>&2;	\
		 fail=yes; continue; };					\
	  file=$$(basename $$f);					\
	  echo checking out $$file...;					\
	  $(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t	\
	    && $(move_if_change) $$f.t $$f;				\
	done;								\
	test "$$fail" && exit 1

define emit-upload-commands
	echo =====================================
	echo =====================================
	echo upload $(PACKAGE) $(PREV_VERSION) $(VERSION)
	echo '# send the /tmp/announcement e-mail'
	echo =====================================
	echo =====================================
endef

$(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
	xdelta delta -9 $^ $@ || :

.PHONY: alpha beta major
alpha beta major: $(local-check)
	$(MAKE) cvs-dist
	$(MAKE) $(xd-delta)
	$(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-upload-commands)
Commit	Line	Data
d074a105	1	# --Makefile--
603f1cfd	2	# This Makefile fragment is shared between the coreutils,
8aeac3ca	3	# CPPI, Bison, and Autoconf.
69b5cec4	4
f97de324	5	## Copyright (C) 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
69b5cec4 AD	6	##
	7	## This program is free software; you can redistribute it and/or modify
	8	## it under the terms of the GNU General Public License as published by
	9	## the Free Software Foundation; either version 2, or (at your option)
	10	## any later version.
	11	##
	12	## This program is distributed in the hope that it will be useful,
	13	## but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	## GNU General Public License for more details.
	16	##
	17	## You should have received a copy of the GNU General Public License
	18	## along with this program; if not, write to the Free Software
	19	## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	20	## 02111-1307, USA.
d074a105	21
603f1cfd AD	22	# This is reported not to work with make-3.79.1
	23	# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
	24	ME := Makefile.maint
	25
0a3b9e5f	26	# Do not save the original name or timestamp in the .tar.gz file.
f97de324 PE	27	GZIP_ENV = \
	28	"--no-name --best$$( \
	29	case $$(gzip --help) in \
	30	(--rsyncable) echo ' --rsyncable';; \
	31	esac \
	32	)"
0a3b9e5f	33
0a3b9e5f AD	34	CVS = cvs
0a3b9e5f AD	35
603f1cfd AD	36	ifeq ($(origin prev_version_file), undefined)
	37	prev_version_file = .prev-version
	38	endif
d074a105	39
d074a105	40	PREV_VERSION := $(shell cat $(prev_version_file))
d074a105 AD	41
	42	tag-package = $(shell echo "$(PACKAGE)" \| tr '[:lower:]' '[:upper:]')
	43	tag-this-version = $(subst .,_,$(VERSION))
d074a105	44	this-cvs-tag = $(tag-package)-$(tag-this-version)
d074a105 AD	45	my_distdir = $(PACKAGE)-$(VERSION)
	46
	47	# Old releases are stored here.
	48	# Used for diffs and xdeltas.
	49	release_archive_dir ?= ../release
	50
603f1cfd AD	51	# Prevent programs like 'sort' from considering distinct strings to be equal.
	52	# Doing it here saves us from having to set LC_ALL elsewhere in this file.
	53	export LC_ALL = C
	54
d074a105 AD	55
	56
	57	## --------------- ##
	58	## Sanity checks. ##
	59	## --------------- ##
	60
8aeac3ca AD	61	# Checks that don't require cvs.
	62	# Run `changelog-check' last, as previous test may reveal problems requiring
	63	# new ChangeLog entries.
603f1cfd	64	local-checks-available = \
8aeac3ca	65	po-check copyright-check writable-files m4-check author_mark_check \
603f1cfd AD	66	changelog-check strftime-check syntax-check makefile_path_separator_check \
	67	makefile-check
	68	.PHONY: $(local-checks-available)
	69
	70	local-check = $(filter-out $(local-checks-to-skip), $(local-checks-available))
8aeac3ca AD	71
	72	# Make sure C source files in src/ don't include xalloc.h directly,
	73	# since they all already include it via sys2.h.
	74	# It's not a big deal -- just aesthetics.
603f1cfd AD	75	.PHONY: $(syntax-check-rules)
	76	syntax-check-rules = \
	77	sc_cast_of_argument_to_free \
	78	sc_cast_of_x_alloc_return_value \
	79	sc_changelog \
	80	sc_error_exit_success \
	81	sc_space_tab \
	82	sc_sun_os_names \
	83	sc_system_h_headers \
	84	sc_unmarked_diagnostics \
	85	sc_xalloc_h_in_src
	86
	87	syntax-check: $(syntax-check-rules)
	88	# @grep -E '# *include <(limits\|std(def\|arg\|bool))\.h>' \
	89	# $$(find -type f -name '*.[chly]') && \
	90	# { echo '$(ME): found conditional include' 1>&2; \
	91	# exit 1; } \|\| :
	92
	93	# grep -E '^# *include <(string\|stdlib)\.h>' \
	94	# $(srcdir)/{lib,src}/*.[chy] && \
	95	# { echo '$(ME): FIXME' 1>&2; \
	96	# exit 1; } \|\| :
	97	# FIXME: don't allow `#include .strings\.h' anywhere
	98
	99	# Look for diagnostics that aren't marked for translation.
	100	# This won't find any for which error's format string is on a separate line.
	101	sc_unmarked_diagnostics:
	102	@grep --exclude=$(srcdir)/src/shred.c -E \
	103	'\<error \([^"]"[^"][a-z]{3}' $(srcdir)/{lib,src}/*.c \
	104	\| grep -v '_(' && \
	105	{ echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
	106	exit 1; } \|\| :
	107
	108	sc_cast_of_argument_to_free:
	109	@grep -E '\<free \(\(' $(srcdir)/{lib,src}/*.[chly] && \
	110	{ echo '$(ME): don'\''t cast free argument' 1>&2; \
	111	exit 1; } \|\| :
	112
	113	sc_cast_of_x_alloc_return_value:
	114	@grep -E --exclude=$(srcdir)/lib/regex.c \
	115	'\\) x(m\|c\|re)alloc\>' $(srcdir)/{lib,src}/*.[chy] && \
	116	{ echo '$(ME): don'\''t cast x*alloc return value' 1>&2; \
	117	exit 1; } \|\| :
	118
	119	sc_space_tab:
	120	@( cvsu --list ) > /dev/null 2>&1 \|\| : && \
	121	grep '[ ] ' \
	122	$$(cvsu --list \| grep -vEf .x-$@ ) && \
	123	{ echo '$(ME): found SPACE-TAB sequence; remove the SPACE' \
	124	1>&2; exit 1; } \|\| :
	125
	126	# Using EXIT_SUCCESS as the first argument to error is misleading,
	127	# since when that parameter is 0, error does not exit. Use `0' instead.
	128	sc_error_exit_success:
	129	@grep -F 'error (EXIT_SUCCESS,' \
	130	$$(find -type f -name '*.[chly]') && \
	131	{ echo '$(ME): found error (EXIT_SUCCESS' 1>&2; \
	132	exit 1; } \|\| :
	133
	134	# FIXME: merge this with sc_system_h_headers below.
	135	# xalloc.h is included via system.h, so should not be included
	136	# directly by any file in src/.
	137	sc_xalloc_h_in_src:
	138	@if test -f $(srcdir)/src/sys2.h; then \
8aeac3ca AD	139	if grep 'xalloc\.h' $(srcdir)/src/*.c; then \
	140	exit 1; \
	141	fi; \
	142	fi
	143
603f1cfd AD	144	# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
	145
	146	# Each nonempty line must start with a year number, or a TAB.
	147	sc_changelog:
	148	@grep '^[^12 ]' $$(find . -name ChangeLog -maxdepth 2) && \
	149	{ echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
	150	exit 1; } \|\| :
	151
	152	header_regexp = \
	153	alloca\
	154	\|closeout\
	155	\|ctype\
	156	\|dirent\
	157	\|errno\
	158	\|fcntl\
	159	\|inttypes\
	160	\|limits\
	161	\|locale\
	162	\|pathmax\
	163	\|std(lib\|bool)\
	164	\|string\
	165	\|sys/(stat\|dir\|time)\
	166	\|time\
	167	\|unistd\
	168	\|utime\
	169	\|version-etc\
	170	\|xalloc
	171	h_re := $(shell echo '$(header_regexp)'\|tr -d ' ')
	172
	173	# Files in src/ should not include directly any of
	174	# the headers already included via system.h.
	175	# Get list of candidates with this:
	176	# grep -h include src/sys.h\|sed 's/.include //'\|sort -
	177	sc_system_h_headers:
	178	@( cvsu --list ) > /dev/null 2>&1 \|\| : && \
	179	grep -E '^# *include ["<]($(h_re))\.h[">]' \
	180	$$(cvsu --list src \| grep -Ev 'sys(2\|tem)\.h$$') \
	181	&& { echo '$(ME): the above are already included via system.h'\
	182	1>&2; exit 1; } \|\| :
	183
	184	sc_sun_os_names:
	185	@( cvsu --list ) > /dev/null 2>&1 \|\| : && \
	186	grep -Ei \
	187	'solaris[^[:alnum:]]*2\.(7\|8\|9\|[1-9][0-9])\|sunos[^[:alnum:]][6-9]' \
	188	$$(cvsu --list \| grep -vEf .x-$@ ) && \
	189	{ echo '$(ME): found misuse of Sun OS version numbers' 1>&2; \
	190	exit 1; } \|\| :
	191
8aeac3ca AD	192	# Ensure that date's --help output stays in sync with the info
	193	# documentation for GNU strftime. The only exception is %N,
	194	# which date accepts but GNU strftime does not.
	195	extract_char = sed 's/^[^%][^%]%\(.\)./\1/'
	196	strftime-check:
	197	if test -f $(srcdir)/src/date.c; then \
	198	grep '^ %. ' $(srcdir)/src/date.c \| sort \
	199	\| $(extract_char) > $@-src; \
	200	{ echo N; \
	201	info libc date calendar format \| grep '^ `%.'\' \
	202	\| $(extract_char); } \| sort > $@-info; \
	203	diff -u $@-src $@-info \|\| exit 1; \
	204	rm -f $@-src $@-info; \
	205	fi
d074a105	206
603f1cfd AD	207	# Ensure that we use only the standard $(VAR) notation,
	208	# not @...@ in Makefile.am, now that we can rely on automake
	209	# to emit a definition for each substituted variable.
	210	makefile-check:
	211	grep -E '@[A-Z_0-9]+@' `find . -name Makefile.am` \
	212	&& { echo 'Makefile.maint: use $(...), not @...@' 1>&2; exit 1; } \|\| :
	213
d074a105 AD	214	changelog-check:
	215	if head ChangeLog \| grep 'Version $(VERSION)' >/dev/null; then \
	216	:; \
	217	else \
	218	echo "$(VERSION) not in ChangeLog" 1>&2; \
	219	exit 1; \
	220	fi
	221
8aeac3ca AD	222	m4-check:
	223	@grep 'AC_DEFUN([^[]' m4/*.m4 \
	224	&& { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
	225	exit 1; } \|\| :
	226
d074a105 AD	227	# Verify that all source files using _() are listed in po/POTFILES.in.
	228	po-check:
	229	if test -f po/POTFILES.in; then \
	230	grep -E -v '^(#\|$$)' po/POTFILES.in \| sort > $@-1; \
8a1dd2fe PE	231	files=; \
	232	for file in lib/.[chly] src/.[chly]; do \
	233	case $$file in \
	234	*.[ch]) \
	235	base=`expr " $$file" : ' \(.*\)\..'`; \
	236	{ test -f $$base.l \|\| test -f $$base.y; } && continue;; \
	237	esac; \
	238	files="$$files $$file"; \
	239	done; \
	240	grep -E -l '\bN?_\([^)"]*("\|$$)' $$files \| sort > $@-2; \
d074a105 AD	241	diff -u $@-1 $@-2 \|\| exit 1; \
	242	rm -f $@-1 $@-2; \
	243	fi
	244
8aeac3ca AD	245	# In a definition of #define AUTHORS "... and ..." where the RHS contains
	246	# the English word `and', the string must be marked with `N_ (...)' so that
	247	# gettext recognizes it as a string requiring translation.
	248	author_mark_check:
	249	@grep '^# define AUTHORS "[^"] and ' src/*.c \|grep -v ' N_ (' && \
	250	{ echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
	251	exit 1; } \|\| :
	252
603f1cfd AD	253	# Sometimes it is useful to change the PATH environment variable
	254	# in Makefiles. When doing so, it's better not to use the Unix-centric
	255	# path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
	256	# It'd be better to use `find -print0 ...\|xargs -0 ...', but less portable,
	257	# and there probably aren't many projects with so many Makefile.am files
	258	# that we'd have to worry about limits on command line length.
	259	msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
	260	makefile_path_separator_check:
	261	@grep 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
	262	&& { echo $(msg) 1>&2; exit 1; } \|\| :
	263
d074a105 AD	264	# Check that `make alpha' will not fail at the end of the process.
	265	writable-files:
	266	if test -d $(release_archive_dir); then :; else \
	267	mkdir $(release_archive_dir); \
	268	fi
	269	for file in $(distdir).tar.gz $(xd-delta) \
	270	$(release_archive_dir)/$(distdir).tar.gz \
	271	$(release_archive_dir)/$(xd-delta); do \
	272	test -e $$file \|\| continue; \
	273	test -w $$file \
	274	\|\| { echo ERROR: $$file is not writable; fail=1; }; \
	275	done; \
	276	test "$$fail" && exit 1 \|\| :
	277
8aeac3ca AD	278	v_etc_file = lib/version-etc.c
8aeac3ca AD	279	# Make sure that the copyright date in $(v_etc_file) is up to date.
d074a105	280	copyright-check:
8aeac3ca AD	281	@if test -f $(v_etc_file); then \
8aeac3ca AD	282	grep '"Copyright (C) $(shell date +%Y) Free' $(v_etc_file) \
d074a105	283	>/dev/null \
8aeac3ca AD	284	\|\| { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
8aeac3ca AD	285	exit 1; }; \
d074a105 AD	286	fi
	287
	288
	289	# Sanity checks with the CVS repository.
	290	cvs-tag-check:
	291	echo $(this-cvs-tag); \
0a3b9e5f	292	if $(CVS) -n log -h README \| grep -e $(this-cvs-tag): >/dev/null; then \
d074a105 AD	293	echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
	294	exit 1; \
	295	else :; fi
	296
	297	cvs-diff-check:
603f1cfd AD	298	if $(CVS) diff >cvs-diffs; then \
	299	rm cvs-diffs; \
	300	else \
	301	echo "Some files are locally modified:" 1>&2; \
69b5cec4 AD	302	cat cvs-diffs; \
69b5cec4 AD	303	exit 1; \
d074a105 AD	304	fi
	305
	306	cvs-check: cvs-diff-check cvs-tag-check
	307
	308	maintainer-distcheck: changelog-check
	309	$(MAKE) distcheck
	310	$(MAKE) my-distcheck
	311
	312
d074a105 AD	313	# Tag before making distribution. Also, don't make a distribution if
	314	# checks fail. Also, make sure the NEWS file is up-to-date.
	315	# FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
8aeac3ca	316	cvs-dist: $(local-check) cvs-check maintainer-distcheck
0a3b9e5f AD	317	$(CVS) update po
0a3b9e5f AD	318	$(CVS) tag -c $(this-cvs-tag)
d074a105 AD	319	$(MAKE) dist
	320
	321	# Use this to make sure we don't run these programs when building
	322	# from a virgin tgz file, below.
	323	null_AM_MAKEFLAGS = \
	324	ACLOCAL=false \
	325	AUTOCONF=false \
	326	AUTOMAKE=false \
	327	AUTOHEADER=false \
	328	MAKEINFO=false
	329
	330	# Detect format-string/arg-list mismatches that would normally be obscured
	331	# by the use of _(). The --disable-nls effectively defines away that macro,
	332	# and building with CFLAGS='-Wformat -Werror' causes any format warning to be
	333	# treated as a failure.
603f1cfd AD	334	TMPDIR ?= /tmp
603f1cfd AD	335	t=$(TMPDIR)/$(PACKAGE)/test
8aeac3ca	336	my-distcheck: $(local-check)
d074a105	337	-rm -rf $(t)
603f1cfd	338	mkdir -p $(t)
d074a105 AD	339	GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
	340	cd $(t)/$(distdir) \
	341	&& ./configure --disable-nls \
	342	&& $(MAKE) CFLAGS='-Wformat -Werror' \
	343	AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
	344	&& $(MAKE) dvi \
	345	&& $(MAKE) check \
	346	&& $(MAKE) distclean
603f1cfd AD	347	(cd $(t) && mv $(distdir) $(distdir).old \
603f1cfd AD	348	&& $(AMTAR) -zxf - ) < $(distdir).tar.gz
d074a105 AD	349	diff -ur $(t)/$(distdir).old $(t)/$(distdir)
	350	-rm -rf $(t)
	351	@echo "========================"; \
	352	echo "$(distdir).tar.gz is ready for distribution"; \
	353	echo "========================"
	354
a1a44c02 PE	355	WGET = wget
	356	WGETFLAGS = -C off
	357
d074a105 AD	358	tgz-md5 = $(shell md5sum < $(my_distdir).tar.gz\|sed 's/ -//')
	359	tgz-sha1 = $(shell sha1sum < $(my_distdir).tar.gz\|sed 's/ -//')
	360	bz2-md5 = $(shell md5sum < $(my_distdir).tar.bz2\|sed 's/ -//')
	361	bz2-sha1 = $(shell sha1sum < $(my_distdir).tar.bz2\|sed 's/ -//')
32f0598d AD	362	xdelta-md5 = $(shell md5sum < $(xd-delta)\|sed 's/ -//')
	363	xdelta-sha1 = $(shell sha1sum < $(xd-delta)\|sed 's/ -//')
	364	tgz-size = $(shell du --human $(my_distdir).tar.gz\|sed 's/\([MkK]\).*/ \1B/')
	365	bz2-size = $(shell du --human $(my_distdir).tar.bz2\|sed 's/\([MkK]\).*/ \1B/')
	366	xd-size = $(shell du --human $(xd-delta)\|sed 's/\([MkK]\).*/ \1B/')
d074a105 AD	367
	368	rel-check:
	369	tarz=/tmp/rel-check-tarz-$$$$; \
	370	md5_tmp=/tmp/rel-check-md5-$$$$; \
	371	set -e; \
	372	trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
a1a44c02	373	$(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
d074a105 AD	374	echo "$(md5) -" > $$md5_tmp; \
	375	md5sum -c $$md5_tmp < $$tarz
	376
	377	prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
	378	xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
	379
603f1cfd AD	380	signatures ?= $(distdir).tar.bz2.asc $(distdir).tar.gz.asc
	381	%.asc: %
	382	rm -f $@
	383	gpg --armor --detach-sign -o $@ $<
	384
	385	rel-files = $(xd-delta) $(distdir).tar.bz2 $(distdir).tar.gz $(signatures)
	386	announce_gen ?= ./announce-gen
	387	announcement: NEWS ChangeLog $(rel-files) $(signatures)
	388	@$(announce_gen) \
	389	--release-type=$(RELEASE_TYPE) \
	390	--package=$(PACKAGE) \
	391	--prev=$(PREV_VERSION) \
	392	--curr=$(VERSION) \
	393	--release-archive-directory=$(release_archive_dir) \
	394	--news=NEWS \
	395	$(addprefix --url-dir=, $(url_dir_list)) \
d074a105	396
8aeac3ca AD	397
	398	## ---------------- ##
	399	## Updating files. ##
	400	## ---------------- ##
	401
8aeac3ca	402	ftp-gnu = ftp://ftp.gnu.org/gnu
603f1cfd	403	www-gnu = http://www.gnu.org
8aeac3ca AD	404
	405	# Use mv, if you don't have/want move-if-change.
	406	move_if_change ?= move-if-change
	407
	408
	409	# --------------------- #
	410	# Updating everything. #
	411	# --------------------- #
	412
	413	.PHONY: update
cc13ba4d AD	414	local_updates ?= wget-update cvs-update po-update
cc13ba4d AD	415	update: $(local_updates)
8aeac3ca AD	416
	417
	418	# ------------------- #
	419	# Updating PO files. #
	420	# ------------------- #
	421
	422	po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
	423	.PHONY: do-po-update po-update
	424	do-po-update:
	425	tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
	426	rm -rf $$tmppo && \
	427	mkdir $$tmppo && \
603f1cfd AD	428	(cd $$tmppo && \
603f1cfd AD	429	$(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
8aeac3ca AD	430	cp $$tmppo/*.po po
	431	cd po && $(MAKE) update-po
	432	$(MAKE) po-check
	433
	434	po-update:
	435	if test -d "po"; then \
	436	$(MAKE) do-po-update; \
	437	fi
	438
	439	# -------------------------- #
	440	# Updating GNU build tools. #
	441	# -------------------------- #
	442
	443	# The following pseudo table associates a local directory and a URL
	444	# with each of the files that belongs to some other package and is
	445	# regularly updated from the specified URL.
	446	wget_files ?= $(srcdir)/config/config.guess \
	447	$(srcdir)/config/config.sub \
	448	$(srcdir)/src/ansi2knr.c \
	449	$(srcdir)/config/texinfo.tex
	450	get-targets = $(patsubst %, get-%, $(wget_files))
	451
	452	config.guess-url_prefix = $(ftp-gnu)/config/
	453	config.sub-url_prefix = $(ftp-gnu)/config/
	454
	455	ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
	456
	457	texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
	458
603f1cfd AD	459	standards.texi-url_prefix = $(www-gnu)/prep/
603f1cfd AD	460	make-stds.texi-url_prefix = $(standards.texi-url_prefix)
8aeac3ca AD	461
	462	target = $(patsubst get-%, %, $@)
	463	url = $($(notdir $(target))-url_prefix)$(notdir $(target))
	464
	465	.PHONY: $(get-targets)
	466	$(get-targets):
a1a44c02	467	$(WGET) $(WGETFLAGS) $(url) -O $(target).t \
8aeac3ca AD	468	&& $(move_if_change) $(target).t $(target)
8aeac3ca AD	469
603f1cfd AD	470	cvs_files ?= \
	471	$(srcdir)/src/ansi2knr.c \
	472	$(srcdir)/config/depcomp \
	473	$(srcdir)/config/install-sh \
	474	$(srcdir)/config/missing \
	475	$(srcdir)/config/mkinstalldirs
8aeac3ca AD	476	automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
	477	.PHONY: wget-update
	478	wget-update: $(get-targets)
	479
	480	.PHONY: cvs-update
	481	cvs-update:
603f1cfd AD	482	fail=; \
	483	for f in $(cvs_files); do \
	484	test -f $$f \|\| { echo "*** skipping $$f" 1>&2; continue; }; \
	485	cvs diff $$f > /dev/null \
	486	\|\| { echo "*** $$f is locally modified; skipping it" 1>&2; \
	487	fail=yes; continue; }; \
	488	file=$$(basename $$f); \
	489	echo checking out $$file...; \
	490	$(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t \
	491	&& $(move_if_change) $$f.t $$f; \
	492	done; \
	493	test "$$fail" && exit 1
8aeac3ca	494
32f0598d	495	define emit-upload-commands
d074a105 AD	496	echo =====================================
d074a105 AD	497	echo =====================================
32f0598d	498	echo upload $(PACKAGE) $(PREV_VERSION) $(VERSION)
d074a105 AD	499	echo '# send the /tmp/announcement e-mail'
	500	echo =====================================
	501	echo =====================================
	502	endef
	503
	504	$(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
	505	xdelta delta -9 $^ $@ \|\| :
	506
603f1cfd AD	507	.PHONY: alpha beta major
603f1cfd AD	508	alpha beta major: $(local-check)
d074a105 AD	509	$(MAKE) cvs-dist
d074a105 AD	510	$(MAKE) $(xd-delta)
603f1cfd	511	$(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
d074a105 AD	512	ln $(rel-files) $(release_archive_dir)
	513	chmod a-w $(rel-files)
	514	echo $(VERSION) > $(prev_version_file)
0a3b9e5f	515	$(CVS) ci -m. $(prev_version_file)
32f0598d	516	@$(emit-upload-commands)