Makefile.maint

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