2 # This Makefile fragment is shared between the coreutils,
3 # CPPI, Bison, and Autoconf.
5 ## Copyright (C) 2001-2006 Free Software Foundation, Inc.
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)
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.
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
22 # This is reported not to work with make-3.79.1
23 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
26 # Do not save the original name or timestamp in the .tar.gz file.
27 GZIP_ENV = '--no-name --best --rsyncable'
31 # cvsu is part of the cvsutils package: http://www.red-bean.com/cvsutils/
32 CVS_LIST = $(srcdir)/build-aux/cvsu --find --types=AFGM
34 ifeq ($(origin prev_version_file), undefined)
35 prev_version_file = .prev-version
38 PREV_VERSION := $(shell cat $(prev_version_file))
39 VERSION_REGEXP = $(subst .,\.,$(VERSION))
41 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
42 tag-this-version = $(subst .,_,$(VERSION))
43 this-cvs-tag = $(tag-package)-$(tag-this-version)
44 my_distdir = $(PACKAGE)-$(VERSION)
46 # Old releases are stored here.
47 # Used for diffs and xdeltas.
48 release_archive_dir ?= ../release
50 # Prevent programs like 'sort' from considering distinct strings to be equal.
51 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
60 # FIXME: add a check to prohibit definition in src/*.c of symbols defined
61 # in system.h. E.g. today I removed from tail.c a useless definition of
62 # ENOSYS. It was useless because system.h ensures it's defined.
64 # Checks that don't require cvs.
65 # Run `changelog-check' last, as previous test may reveal problems requiring
66 # new ChangeLog entries.
67 local-checks-available = \
68 po-check copyright-check writable-files m4-check author_mark_check \
69 changelog-check strftime-check $(syntax-check-rules) \
70 makefile_path_separator_check \
72 .PHONY: $(local-checks-available)
74 local-check = $(filter-out $(local-checks-to-skip), $(local-checks-available))
76 .PHONY: $(syntax-check-rules)
77 syntax-check-rules = \
78 sc_cast_of_argument_to_free \
79 sc_cast_of_x_alloc_return_value \
80 sc_cast_of_alloca_return_value \
81 sc_dd_max_sym_length \
82 sc_error_exit_success \
84 sc_no_if_have_config_h \
86 sc_prohibit_atoi_atof \
87 sc_prohibit_jm_in_m4 \
88 sc_prohibit_assert_without_use \
96 sc_two_space_separator_in_usage \
97 sc_unmarked_diagnostics \
100 syntax-check: $(syntax-check-rules)
101 # @grep -E '# *include <(limits|std(def|arg|bool))\.h>' \
102 # $$(find -type f -name '*.[chly]') && \
103 # { echo '$(ME): found conditional include' 1>&2; \
106 # grep -E '^# *include <(string|stdlib)\.h>' \
107 # $(srcdir)/{lib,src}/*.[chy] && \
108 # { echo '$(ME): FIXME' 1>&2; \
110 # FIXME: don't allow `#include .strings\.h' anywhere
112 sc_cast_of_argument_to_free:
113 @grep -E '\<free \(\(' $(srcdir)/{lib,src}/*.[chly] && \
114 { echo '$(ME): don'\''t cast free argument' 1>&2; \
117 sc_cast_of_x_alloc_return_value:
118 @grep -E --exclude=$(srcdir)/lib/regex.c \
119 '\*\) *x(m|c|re)alloc\>' \
120 $(srcdir)/{lib,src}/*.[chy] && \
121 { echo '$(ME): don'\''t cast x*alloc return value' 1>&2; \
124 sc_cast_of_alloca_return_value:
125 @grep -E '\*\) *alloca\>' \
126 $(srcdir)/src/*.[chy] && \
127 { echo '$(ME): don'\''t cast alloca return value' 1>&2; \
131 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
133 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
134 { echo '$(ME): found SPACE-TAB sequence; remove the SPACE' \
137 # Don't use atoi, atof, atol, atoll, or atoq in `real' code.
138 # They provide no error checking mechanism.
139 # Instead, use strto* functions.
140 sc_prohibit_atoi_atof:
141 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
142 grep -E '\<(ato[filq]|atoll)\>' \
143 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
144 { echo '$(ME): do not use atof, atoi, atol, atoll, or atoq' \
147 # Using EXIT_SUCCESS as the first argument to error is misleading,
148 # since when that parameter is 0, error does not exit. Use `0' instead.
149 sc_error_exit_success:
150 @grep -F 'error (EXIT_SUCCESS,' \
151 $$(find -type f -name '*.[chly]') && \
152 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; \
156 @grep -i 'filesystem' \
157 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
158 { echo '$(ME): found use of "filesystem";' \
159 'rewrite to use "file system"' 1>&2; \
162 sc_no_if_have_config_h:
163 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
164 grep '^# *if HAVE_CONFIG_H' \
165 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
166 { echo '$(ME): found use of #if HAVE_CONFIG_H; use #ifdef' \
169 # Nearly all .c files must include <config.h>.
171 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
172 grep -L '^# *include <config\.h>' \
173 $$($(CVS_LIST) | grep '\.c$$' | grep -vEf .x-$@ ) \
175 { echo '$(ME): the above files do not include <config.h>' \
178 # Prohibit the inclusion of assert.h without an actual use of assert.
179 sc_prohibit_assert_without_use:
180 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
181 grep -L '\<assert (' \
182 $$(grep -l '# *include <assert\.h>' \
183 $$($(CVS_LIST) | grep '\.c$$' | grep -vEf .x-$@ )) \
185 { echo "$(ME): the above files include <assert.h> but don't use it" \
189 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
190 grep -E '\<(HAVE_FCNTL_H|O_NDELAY)\>' \
191 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
192 { echo '$(ME): do not use HAVE_FCNTL_H or O_NDELAY' \
195 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
197 # Each nonempty line must start with a year number, or a TAB.
199 @grep '^[^12 ]' $$(find . -maxdepth 2 -name ChangeLog) && \
200 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
203 # Ensure that dd's definition of LONGEST_SYMBOL stays in sync
204 # with the strings from the two affected variables.
205 dd_c = $(srcdir)/src/dd.c
206 sc_dd_max_sym_length:
207 @test -f $(dd_c) || exit 0; \
208 len=$$( (sed -n '/conversions\[\] =$$/,/^};/p' $(dd_c); \
209 sed -n '/flags\[\] =$$/,/^};/p' $(dd_c) ) \
210 |sed -n '/"/s/^[^"]*"\([^"]*\)".*/\1/p' \
211 | wc --max-line-length); \
212 max=$$(sed -n '/^#define LONGEST_SYMBOL /s///p' $(dd_c) \
213 |tr -d '"' | wc --max-line-length); \
214 if test "$$len" = "$$max"; then :; else \
215 echo 'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \
219 # Many m4 macros names once began with `jm_'.
220 # On 2004-04-13, they were all changed to start with gl_ instead.
221 # Make sure that none are inadvertently reintroduced.
222 sc_prohibit_jm_in_m4:
223 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
225 $$($(CVS_LIST) $(srcdir)/m4 |grep '\.m4$$') && \
226 { echo '$(ME): do not use jm_ in m4 macro names' \
230 @t1=sc-root.expected; t2=sc-root.actual; \
231 grep -l '^PRIV_CHECK_ARG=require-root' \
232 $$($(CVS_LIST) tests) |sed s,tests,., |sort > $$t1; \
233 sed -n 's, cd \([^ ]*\) .*MAKE..check TESTS=\(.*\),./\1/\2,p' \
234 $(srcdir)/tests/Makefile.am |sort > $$t2; \
235 diff -u $$t1 $$t2 || diff=1; \
238 && { echo 'tests/Makefile.am: missing check-root action'>&2; \
241 # Create a list of regular expressions matching the names
242 # of files included from system.h. Exclude a couple.
244 @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \
245 | grep -Ev 'sys/(param|file)\.h' \
246 | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
250 # Files in src/ should not include directly any of
251 # the headers already included via system.h.
252 sc_system_h_headers: .re-list
253 @if test -f $(srcdir)/src/system.h; then \
254 ( $(CVS_LIST) ) > /dev/null 2>&1 || exit 0; \
255 trap 'rc=$$?; rm -f .re-list; exit $$rc' 0 1 2 3 15; \
256 grep -E -f .re-list \
257 $$($(CVS_LIST) src | grep -Ev '(copy|system)\.h$$') \
258 && { echo '$(ME): the above are already included via system.h'\
259 1>&2; exit 1; } || :; \
263 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
265 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
266 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
267 { echo '$(ME): found misuse of Sun OS version numbers' 1>&2; \
274 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
276 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
277 { echo '$(ME): found trailing blank(s)' \
280 sc_two_space_separator_in_usage:
281 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
282 grep '^ *--[a-z][0-9A-Za-z-]* [^ ].*\\$$' \
283 $$($(CVS_LIST) | grep 'src/.*\.c$$' | grep -vEf .x-$@) && \
284 { echo "$(ME): help2man requires at least two spaces between"; \
285 echo "$(ME): an option and its description"; \
288 # Look for diagnostics that aren't marked for translation.
289 # This won't find any for which error's format string is on a separate line.
290 sc_unmarked_diagnostics:
291 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
293 '\<error \([^"]*"[^"]*[a-z]{3}' \
294 $$($(CVS_LIST) | grep -vEf .x-$@ ) \
296 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
299 # Avoid useless parentheses like those in this example:
300 # #if defined (SYMBOL) || defined (SYM2)
301 sc_useless_cpp_parens:
302 @( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
303 grep '^# *if .*defined *(' \
304 $$($(CVS_LIST) | grep -vEf .x-$@ ) && \
305 { echo '$(ME): found useless parentheses in cpp directive' \
308 # Ensure that date's --help output stays in sync with the info
309 # documentation for GNU strftime. The only exception is %N,
310 # which date accepts but GNU strftime does not.
311 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
313 if test -f $(srcdir)/src/date.c; then \
314 grep '^ %. ' $(srcdir)/src/date.c | sort \
315 | $(extract_char) > $@-src; \
317 info libc date calendar format | grep '^ `%.'\' \
318 | $(extract_char); } | sort > $@-info; \
319 diff -u $@-src $@-info || exit 1; \
320 rm -f $@-src $@-info; \
323 # Ensure that we use only the standard $(VAR) notation,
324 # not @...@ in Makefile.am, now that we can rely on automake
325 # to emit a definition for each substituted variable.
327 grep -E '@[A-Z_0-9]+@' `find . -name Makefile.am` \
328 && { echo 'Makefile.maint: use $$(...), not @...@' 1>&2; exit 1; } || :
330 news-date-check: NEWS
331 today=`date +%Y-%m-%d`; \
332 if head NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
336 echo "version or today's date is not in NEWS" 1>&2; \
341 if head ChangeLog | grep 'Version $(VERSION_REGEXP)\.$$' \
345 echo "$(VERSION) not in ChangeLog" 1>&2; \
350 @grep 'AC_DEFUN([^[]' m4/*.m4 \
351 && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
354 # Verify that all source files using _() are listed in po/POTFILES.in.
355 # FIXME: don't hard-code src/false.c below; use a more general mechanism.
357 ( $(CVS_LIST) ) > /dev/null 2>&1 || : && \
358 if test -f po/POTFILES.in; then \
359 grep -E -v '^(#|$$)' po/POTFILES.in \
360 | grep -v '^src/false\.c$$' | sort > $@-1; \
362 for file in $$($(CVS_LIST) lib src | grep '\.[chly]$$'); do \
365 base=`expr " $$file" : ' \(.*\)\..'`; \
366 { test -f $$base.l || test -f $$base.y; } && continue;; \
368 files="$$files $$file"; \
370 grep -E -l '\bN?_\([^)"]*("|$$)' $$files | sort > $@-2; \
371 diff -u $@-1 $@-2 || exit 1; \
375 # In a definition of #define AUTHORS "... and ..." where the RHS contains
376 # the English word `and', the string must be marked with `N_ (...)' so that
377 # gettext recognizes it as a string requiring translation.
379 @grep '^# *define AUTHORS "[^"]* and ' src/*.c |grep -v ' N_ (' && \
380 { echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
383 # Sometimes it is useful to change the PATH environment variable
384 # in Makefiles. When doing so, it's better not to use the Unix-centric
385 # path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
386 # It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
387 # and there probably aren't many projects with so many Makefile.am files
388 # that we'd have to worry about limits on command line length.
389 msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
390 makefile_path_separator_check:
391 @grep 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
392 && { echo $(msg) 1>&2; exit 1; } || :
394 # Check that `make alpha' will not fail at the end of the process.
396 if test -d $(release_archive_dir); then :; else \
397 mkdir $(release_archive_dir); \
399 for file in $(distdir).tar.gz $(xd-delta) \
400 $(release_archive_dir)/$(distdir).tar.gz \
401 $(release_archive_dir)/$(xd-delta); do \
402 test -e $$file || continue; \
404 || { echo ERROR: $$file is not writable; fail=1; }; \
406 test "$$fail" && exit 1 || :
408 v_etc_file = lib/version-etc.c
409 # Make sure that the copyright date in $(v_etc_file) is up to date.
411 @if test -f $(v_etc_file); then \
412 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
414 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
419 # Sanity checks with the CVS repository.
421 echo $(this-cvs-tag); \
422 if $(CVS) -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
423 echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
428 if $(CVS) diff >cvs-diffs; then \
431 echo "Some files are locally modified:" 1>&2; \
436 cvs-check: cvs-diff-check cvs-tag-check
438 maintainer-distcheck: changelog-check
443 # Tag before making distribution. Also, don't make a distribution if
444 # checks fail. Also, make sure the NEWS file is up-to-date.
445 # FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
446 cvs-dist: $(local-check) cvs-check maintainer-distcheck
448 $(CVS) tag -c $(this-cvs-tag)
451 # Use this to make sure we don't run these programs when building
452 # from a virgin tgz file, below.
453 null_AM_MAKEFLAGS = \
460 # Detect format-string/arg-list mismatches that would normally be obscured
461 # by the use of _(). The --disable-nls effectively defines away that macro,
462 # and building with CFLAGS='-Wformat -Werror' causes any format warning to be
463 # treated as a failure. Also, check for shadowing problems with -Wshadow.
464 # These CFLAGS are pretty strict. If you build this target, you probably
465 # have to have a recent version of gcc and glibc headers.
467 t=$(TMPDIR)/$(PACKAGE)/test
468 my-distcheck: $(local-check) $(release_archive_dir)/$(prev-tgz)
471 GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
473 && ./configure --disable-nls \
474 && $(MAKE) CFLAGS='-Werror -Wall -Wformat -Wshadow' \
475 AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
479 (cd $(t) && mv $(distdir) $(distdir).old \
480 && $(AMTAR) -zxf - ) < $(distdir).tar.gz
481 diff -ur $(t)/$(distdir).old $(t)/$(distdir)
483 @echo "========================"; \
484 echo "$(distdir).tar.gz is ready for distribution"; \
485 echo "========================"
491 tarz=/tmp/rel-check-tarz-$$$$; \
492 md5_tmp=/tmp/rel-check-md5-$$$$; \
494 trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
495 $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
496 echo "$(md5) -" > $$md5_tmp; \
497 md5sum -c $$md5_tmp < $$tarz
499 prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
500 xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
502 rel-files = $(xd-delta) $(DIST_ARCHIVES)
503 announcement: NEWS ChangeLog $(rel-files)
505 --release-type=$(RELEASE_TYPE) \
506 --package=$(PACKAGE) \
507 --prev=$(PREV_VERSION) \
509 --release-archive-directory=$(release_archive_dir) \
510 --gpg-key-id=$(gpg_key_ID) \
512 $(addprefix --url-dir=, $(url_dir_list)) \
515 ## ---------------- ##
516 ## Updating files. ##
517 ## ---------------- ##
519 ftp-gnu = ftp://ftp.gnu.org/gnu
520 www-gnu = http://www.gnu.org
522 # Use mv, if you don't have/want move-if-change.
523 move_if_change ?= move-if-change
526 # --------------------- #
527 # Updating everything. #
528 # --------------------- #
531 local_updates ?= wget-update cvs-update po-update
532 update: $(local_updates)
535 # ------------------- #
536 # Updating PO files. #
537 # ------------------- #
539 po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
540 .PHONY: do-po-update po-update
542 tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
546 $(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
548 cd po && $(MAKE) update-po
552 if test -d "po"; then \
553 $(MAKE) do-po-update; \
556 # -------------------------- #
557 # Updating GNU build tools. #
558 # -------------------------- #
560 # The following pseudo table associates a local directory and a URL
561 # with each of the files that belongs to some other package and is
562 # regularly updated from the specified URL.
564 $(srcdir)/build-aux/config.guess \
565 $(srcdir)/build-aux/config.sub \
566 $(srcdir)/build-aux/texinfo.tex \
567 $(srcdir)/src/ansi2knr.c
569 get-targets = $(patsubst %, get-%, $(wget_files))
571 config.guess-url_prefix = $(ftp-gnu)/build-aux/
572 config.sub-url_prefix = $(ftp-gnu)/build-aux/
574 ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
576 texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
578 standards.texi-url_prefix = $(www-gnu)/prep/
579 make-stds.texi-url_prefix = $(standards.texi-url_prefix)
581 target = $(patsubst get-%, %, $@)
582 url = $($(notdir $(target))-url_prefix)$(notdir $(target))
584 .PHONY: $(get-targets)
586 $(WGET) $(WGETFLAGS) $(url) -O $(target).t \
587 && $(move_if_change) $(target).t $(target)
590 $(srcdir)/build-aux/depcomp \
591 $(srcdir)/build-aux/install-sh \
592 $(srcdir)/build-aux/missing \
593 $(srcdir)/build-aux/mkinstalldirs \
594 $(srcdir)/src/ansi2knr.c
595 automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
597 wget-update: $(get-targets)
602 for f in $(cvs_files); do \
603 test -f $$f || { echo "*** skipping $$f" 1>&2; continue; }; \
604 cvs diff $$f > /dev/null \
605 || { echo "*** $$f is locally modified; skipping it" 1>&2; \
606 fail=yes; continue; }; \
607 file=$$(basename $$f); \
608 echo checking out $$file...; \
609 $(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t \
610 && $(move_if_change) $$f.t $$f; \
612 test "$$fail" && exit 1
614 emit_upload_commands:
615 @echo =====================================
616 @echo =====================================
617 @echo "$(srcdir)/gnupload $(GNUPLOADFLAGS) \\"
618 @echo " --to $(gnu_rel_host):coreutils \\"
619 @echo " $(rel-files)"
620 @echo '# send the /tmp/announcement e-mail'
621 @echo =====================================
622 @echo =====================================
624 $(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
625 xdelta delta -9 $^ $@ || :
627 .PHONY: alpha beta major
628 alpha beta major: news-date-check $(local-check)
631 $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
632 ln $(rel-files) $(release_archive_dir)
633 chmod a-w $(rel-files)
634 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
635 echo $(VERSION) > $(prev_version_file)
636 $(CVS) ci -m. $(prev_version_file)