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