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