Makefile.maint

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