Makefile.maint

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