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