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