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 # Use --rsyncable if available.
29 $(shell gzip --help|grep rsyncable >/dev/null && echo --rsyncable)
30 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
34 # cvsu is part of the cvsutils package: http://www.red-bean.com/cvsutils/
36 if test -x $(srcdir)/build-aux/cvsu; then \
37 $(srcdir)/build-aux/cvsu --find --types=AFGM $$*; \
40 if (!$$1 && $$3 !~ /^-/) { \
42 sub(/CVS\/Entries/, "", f); \
45 $$(find $${*-*} -name Entries -print) /dev/null; \
50 $(CVS_LIST) | if test -f .x-$@; then grep -vEf .x-$@; else grep -v ChangeLog; fi
52 ifeq ($(origin prev_version_file), undefined)
53 prev_version_file = .prev-version
56 PREV_VERSION := $(shell cat $(prev_version_file))
57 VERSION_REGEXP = $(subst .,\.,$(VERSION))
59 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
60 tag-this-version = $(subst .,_,$(VERSION))
61 this-cvs-tag = $(tag-package)-$(tag-this-version)
62 my_distdir = $(PACKAGE)-$(VERSION)
64 # Old releases are stored here.
65 # Used for diffs and xdeltas.
66 release_archive_dir ?= ../release
68 # Prevent programs like 'sort' from considering distinct strings to be equal.
69 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
78 # FIXME: add a check to prohibit definition in src/*.c of symbols defined
79 # in system.h. E.g. today I removed from tail.c a useless definition of
80 # ENOSYS. It was useless because system.h ensures it's defined.
82 # Checks that don't require cvs.
83 # Run `changelog-check' last, as previous test may reveal problems requiring
84 # new ChangeLog entries.
85 local-checks-available = \
86 po-check copyright-check writable-files m4-check author_mark_check \
87 changelog-check patch-check strftime-check $(syntax-check-rules) \
88 makefile_path_separator_check \
90 .PHONY: $(local-checks-available)
92 local-check = $(filter-out $(local-checks-to-skip), $(local-checks-available))
94 # Collect the names of rules starting with `sc_'.
95 syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' $(ME))
96 .PHONY: $(syntax-check-rules)
98 syntax-check: $(syntax-check-rules)
99 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
100 # $$(find -type f -name '*.[chly]') && \
101 # { echo '$(ME): found conditional include' 1>&2; \
104 # grep -nE '^# *include <(string|stdlib)\.h>' \
105 # $(srcdir)/{lib,src}/*.[chy] && \
106 # { echo '$(ME): FIXME' 1>&2; \
108 # FIXME: don't allow `#include .strings\.h' anywhere
110 sc_cast_of_argument_to_free:
111 @grep -nE '\<free \(\(' $(srcdir)/{lib,src}/*.[chly] && \
112 { echo '$(ME): don'\''t cast free argument' 1>&2; \
115 sc_cast_of_x_alloc_return_value:
116 @grep -nE --exclude=$(srcdir)/lib/regex.c \
117 '\*\) *x(m|c|re)alloc\>' \
118 $(srcdir)/{lib,src}/*.[chy] && \
119 { echo '$(ME): don'\''t cast x*alloc return value' 1>&2; \
122 sc_cast_of_alloca_return_value:
123 @grep -nE '\*\) *alloca\>' \
124 $(srcdir)/src/*.[chy] && \
125 { echo '$(ME): don'\''t cast alloca return value' 1>&2; \
129 @grep -n '[ ] ' $$($(CVS_LIST_EXCEPT)) && \
130 { echo '$(ME): found SPACE-TAB sequence; remove the SPACE' \
133 # Don't use the old ato* functions in `real' code.
134 # They provide no error checking mechanism.
135 # Instead, use strto* functions.
136 sc_prohibit_atoi_atof:
137 @grep -nE '\<ato([filq]|ll)\>' $$($(CVS_LIST_EXCEPT)) && \
138 { echo '$(ME): do not use ato''f, ato''i, ato''l, ato''ll, or ato''q' \
141 # Using EXIT_SUCCESS as the first argument to error is misleading,
142 # since when that parameter is 0, error does not exit. Use `0' instead.
143 sc_error_exit_success:
144 @grep -nF 'error (EXIT_SUCCESS,' \
145 $$(find -type f -name '*.[chly]') && \
146 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; \
150 @grep -ni 'file''system' $$($(CVS_LIST_EXCEPT)) && \
151 { echo '$(ME): found use of "file''system";' \
152 'rewrite to use "file system"' 1>&2; \
155 sc_no_if_have_config_h:
156 @grep -n '^# *if HAVE_CONFIG_H' $$($(CVS_LIST_EXCEPT)) && \
157 { echo '$(ME): found use of #if HAVE_CONFIG_H; use #ifdef' \
160 # Nearly all .c files must include <config.h>.
162 @grep -L '^# *include <config\.h>' \
163 $$($(CVS_LIST_EXCEPT) | grep '\.c$$') \
165 { echo '$(ME): the above files do not include <config.h>' \
168 # Prohibit the inclusion of assert.h without an actual use of assert.
169 sc_prohibit_assert_without_use:
170 @files=$$(grep -l '# *include <assert\.h>' \
171 $$($(CVS_LIST_EXCEPT) | grep '\.c$$')) && \
172 grep -L '\<assert (' $$files \
174 { echo "$(ME): the above files include <assert.h> but don't use it" \
178 @grep -nE '\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
179 $$($(CVS_LIST_EXCEPT)) && \
180 { echo '$(ME): do not use HAVE''_FCNTL_H or O''_NDELAY' \
183 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
185 # Each nonempty line must start with a year number, or a TAB.
187 @grep -n '^[^12 ]' $$(find . -maxdepth 2 -name ChangeLog) && \
188 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
191 # Ensure that dd's definition of LONGEST_SYMBOL stays in sync
192 # with the strings from the two affected variables.
193 dd_c = $(srcdir)/src/dd.c
194 sc_dd_max_sym_length:
195 ifneq ($(wildcard $(dd_c)),)
196 @len=$$( (sed -n '/conversions\[\] =$$/,/^};/p' $(dd_c);\
197 sed -n '/flags\[\] =$$/,/^};/p' $(dd_c) ) \
198 |sed -n '/"/s/^[^"]*"\([^"]*\)".*/\1/p' \
199 | wc --max-line-length); \
200 max=$$(sed -n '/^#define LONGEST_SYMBOL /s///p' $(dd_c) \
201 |tr -d '"' | wc --max-line-length); \
202 if test "$$len" = "$$max"; then :; else \
203 echo 'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \
208 # Many m4 macros names once began with `jm_'.
209 # On 2004-04-13, they were all changed to start with gl_ instead.
210 # Make sure that none are inadvertently reintroduced.
211 sc_prohibit_jm_in_m4:
212 @grep -nE 'jm_[A-Z]' \
213 $$($(CVS_LIST) $(srcdir)/m4 |grep '\.m4$$') && \
214 { echo '$(ME): do not use jm_ in m4 macro names' \
218 @t1=sc-root.expected; t2=sc-root.actual; \
219 grep -nl '^PRIV_CHECK_ARG=require-root' \
220 $$($(CVS_LIST) tests) |sed s,tests,., |sort > $$t1; \
221 sed -n 's, cd \([^ ]*\) .*MAKE..check TESTS=\(.*\),./\1/\2,p' \
222 $(srcdir)/tests/Makefile.am |sort > $$t2; \
223 diff -u $$t1 $$t2 || diff=1; \
226 && { echo 'tests/Makefile.am: missing check-root action'>&2; \
229 # Create a list of regular expressions matching the names
230 # of files included from system.h. Exclude a couple.
232 @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \
233 | grep -Ev 'sys/(param|file)\.h' \
234 | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
238 # Files in src/ should not include directly any of
239 # the headers already included via system.h.
240 sc_system_h_headers: .re-list
241 @if test -f $(srcdir)/src/system.h; then \
242 trap 'rc=$$?; rm -f .re-list; exit $$rc' 0 1 2 3 15; \
243 grep -nE -f .re-list \
244 $$($(CVS_LIST) src | \
245 grep -Ev '((copy|system)\.h|parse-gram\.c)$$') \
246 && { echo '$(ME): the above are already included via system.h'\
247 1>&2; exit 1; } || :; \
252 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
253 $$($(CVS_LIST_EXCEPT)) && \
254 { echo '$(ME): found misuse of Sun OS version numbers' 1>&2; \
261 @grep -n '[ ]$$' $$($(CVS_LIST_EXCEPT)) && \
262 { echo '$(ME): found trailing blank(s)' \
265 sc_two_space_separator_in_usage:
266 @grep -n '^ *--[a-z][0-9A-Za-z-]* [^ ].*\\$$' \
267 $$($(CVS_LIST_EXCEPT)) && \
268 { echo "$(ME): help2man requires at least two spaces between"; \
269 echo "$(ME): an option and its description"; \
272 # Look for diagnostics that aren't marked for translation.
273 # This won't find any for which error's format string is on a separate line.
274 sc_unmarked_diagnostics:
276 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(CVS_LIST_EXCEPT)) \
277 | grep -v '_''(' && \
278 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
281 # Avoid useless parentheses like those in this example:
282 # #if defined (SYMBOL) || defined (SYM2)
283 sc_useless_cpp_parens:
284 @grep -n '^# *if .*defined *(' $$($(CVS_LIST_EXCEPT)) && \
285 { echo '$(ME): found useless parentheses in cpp directive' \
288 # Ensure that the c99-to-c89 patch applies cleanly.
289 # For now, it affects only remove.c. Eventually, we'll probably
290 # have to copy all of src/ before running patch.
292 cp src/remove.c tmp-remove.c
293 patch -V never --fuzz=0 tmp-remove.c src/c99-to-c89.diff
296 # Ensure that date's --help output stays in sync with the info
297 # documentation for GNU strftime. The only exception is %N,
298 # which date accepts but GNU strftime does not.
299 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
301 if test -f $(srcdir)/src/date.c; then \
302 grep '^ %. ' $(srcdir)/src/date.c | sort \
303 | $(extract_char) > $@-src; \
305 info libc date calendar format | grep '^ `%.'\' \
306 | $(extract_char); } | sort > $@-info; \
307 diff -u $@-src $@-info || exit 1; \
308 rm -f $@-src $@-info; \
311 # Ensure that we use only the standard $(VAR) notation,
312 # not @...@ in Makefile.am, now that we can rely on automake
313 # to emit a definition for each substituted variable.
315 grep -nE '@[A-Z_0-9]+@' `find . -name Makefile.am` \
316 && { echo 'Makefile.maint: use $$(...), not @...@' 1>&2; exit 1; } || :
318 news-date-check: NEWS
319 today=`date +%Y-%m-%d`; \
320 if head NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
324 echo "version or today's date is not in NEWS" 1>&2; \
329 if head ChangeLog | grep 'Version $(VERSION_REGEXP)\.$$' \
333 echo "$(VERSION) not in ChangeLog" 1>&2; \
338 @grep -n 'AC_DEFUN([^[]' m4/*.m4 \
339 && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
342 # Verify that all source files using _() are listed in po/POTFILES.in.
343 # FIXME: don't hard-code file names below; use a more general mechanism.
345 if test -f po/POTFILES.in; then \
346 grep -E -v '^(#|$$)' po/POTFILES.in \
347 | grep -v '^src/false\.c$$' | sort > $@-1; \
349 for file in $$($(CVS_LIST_EXCEPT)) lib/*.[ch]; do \
351 djgpp/* | man/*) continue;; \
355 base=`expr " $$file" : ' \(.*\)\..'`; \
356 { test -f $$base.l || test -f $$base.y; } && continue;; \
358 files="$$files $$file"; \
360 grep -E -l '\bN?_\([^)"]*("|$$)' $$files | sort -u > $@-2; \
361 diff -u $@-1 $@-2 || exit 1; \
365 # In a definition of #define AUTHORS "... and ..." where the RHS contains
366 # the English word `and', the string must be marked with `N_ (...)' so that
367 # gettext recognizes it as a string requiring translation.
369 @grep -n '^# *define AUTHORS "[^"]* and ' src/*.c |grep -v ' N_ (' && \
370 { echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
373 # Sometimes it is useful to change the PATH environment variable
374 # in Makefiles. When doing so, it's better not to use the Unix-centric
375 # path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
376 # It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
377 # and there probably aren't many projects with so many Makefile.am files
378 # that we'd have to worry about limits on command line length.
379 msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
380 makefile_path_separator_check:
381 @grep -n 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
382 && { echo $(msg) 1>&2; exit 1; } || :
384 # Check that `make alpha' will not fail at the end of the process.
386 if test -d $(release_archive_dir); then :; else \
387 mkdir $(release_archive_dir); \
389 for file in $(distdir).tar.gz $(xd-delta) \
390 $(release_archive_dir)/$(distdir).tar.gz \
391 $(release_archive_dir)/$(xd-delta); do \
392 test -e $$file || continue; \
394 || { echo ERROR: $$file is not writable; fail=1; }; \
396 test "$$fail" && exit 1 || :
398 v_etc_file = lib/version-etc.c
399 # Make sure that the copyright date in $(v_etc_file) is up to date.
401 @if test -f $(v_etc_file); then \
402 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
404 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
409 # Sanity checks with the CVS repository.
411 echo $(this-cvs-tag); \
412 if $(CVS) -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
413 echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
418 if $(CVS) diff >cvs-diffs; then \
421 echo "Some files are locally modified:" 1>&2; \
426 cvs-check: cvs-diff-check cvs-tag-check
428 maintainer-distcheck: changelog-check
433 # Tag before making distribution. Also, don't make a distribution if
434 # checks fail. Also, make sure the NEWS file is up-to-date.
435 # FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
436 cvs-dist: $(local-check) cvs-check maintainer-distcheck
438 $(CVS) tag -c $(this-cvs-tag)
441 # Use this to make sure we don't run these programs when building
442 # from a virgin tgz file, below.
443 null_AM_MAKEFLAGS = \
450 # Detect format-string/arg-list mismatches that would normally be obscured
451 # by the use of _(). The --disable-nls effectively defines away that macro,
452 # and building with CFLAGS='-Wformat -Werror' causes any format warning to be
453 # treated as a failure. Also, check for shadowing problems with -Wshadow.
454 # These CFLAGS are pretty strict. If you build this target, you probably
455 # have to have a recent version of gcc and glibc headers.
457 t=$(TMPDIR)/$(PACKAGE)/test
458 my-distcheck: $(local-check) $(release_archive_dir)/$(prev-tgz)
461 GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
463 && ./configure --disable-nls \
464 && $(MAKE) CFLAGS='-Werror -Wall -Wformat -Wshadow' \
465 AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
469 (cd $(t) && mv $(distdir) $(distdir).old \
470 && $(AMTAR) -zxf - ) < $(distdir).tar.gz
471 diff -ur $(t)/$(distdir).old $(t)/$(distdir)
473 @echo "========================"; \
474 echo "$(distdir).tar.gz is ready for distribution"; \
475 echo "========================"
481 tarz=/tmp/rel-check-tarz-$$$$; \
482 md5_tmp=/tmp/rel-check-md5-$$$$; \
484 trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
485 $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
486 echo "$(md5) -" > $$md5_tmp; \
487 md5sum -c $$md5_tmp < $$tarz
489 prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
490 xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
492 rel-files = $(xd-delta) $(DIST_ARCHIVES)
493 announcement: NEWS ChangeLog $(rel-files)
495 --release-type=$(RELEASE_TYPE) \
496 --package=$(PACKAGE) \
497 --prev=$(PREV_VERSION) \
499 --release-archive-directory=$(release_archive_dir) \
500 --gpg-key-id=$(gpg_key_ID) \
502 $(addprefix --url-dir=, $(url_dir_list)) \
505 ## ---------------- ##
506 ## Updating files. ##
507 ## ---------------- ##
509 ftp-gnu = ftp://ftp.gnu.org/gnu
510 www-gnu = http://www.gnu.org
512 # Use mv, if you don't have/want move-if-change.
513 move_if_change ?= move-if-change
516 # --------------------- #
517 # Updating everything. #
518 # --------------------- #
521 local_updates ?= wget-update cvs-update po-update
522 update: $(local_updates)
525 # ------------------- #
526 # Updating PO files. #
527 # ------------------- #
529 po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
530 .PHONY: do-po-update po-update
532 tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
536 $(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
538 cd po && $(MAKE) update-po
542 if test -d "po"; then \
543 $(MAKE) do-po-update; \
546 # -------------------------- #
547 # Updating GNU build tools. #
548 # -------------------------- #
550 # The following pseudo table associates a local directory and a URL
551 # with each of the files that belongs to some other package and is
552 # regularly updated from the specified URL.
554 $(srcdir)/build-aux/config.guess \
555 $(srcdir)/build-aux/config.sub \
556 $(srcdir)/build-aux/texinfo.tex \
557 $(srcdir)/src/ansi2knr.c
559 get-targets = $(patsubst %, get-%, $(wget_files))
561 config.guess-url_prefix = $(ftp-gnu)/build-aux/
562 config.sub-url_prefix = $(ftp-gnu)/build-aux/
564 ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
566 texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
568 standards.texi-url_prefix = $(www-gnu)/prep/
569 make-stds.texi-url_prefix = $(standards.texi-url_prefix)
571 target = $(patsubst get-%, %, $@)
572 url = $($(notdir $(target))-url_prefix)$(notdir $(target))
574 .PHONY: $(get-targets)
576 $(WGET) $(WGETFLAGS) $(url) -O $(target).t \
577 && $(move_if_change) $(target).t $(target)
580 $(srcdir)/build-aux/depcomp \
581 $(srcdir)/build-aux/install-sh \
582 $(srcdir)/build-aux/missing \
583 $(srcdir)/build-aux/mkinstalldirs \
584 $(srcdir)/src/ansi2knr.c
585 automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
587 wget-update: $(get-targets)
592 for f in $(cvs_files); do \
593 test -f $$f || { echo "*** skipping $$f" 1>&2; continue; }; \
594 cvs diff $$f > /dev/null \
595 || { echo "*** $$f is locally modified; skipping it" 1>&2; \
596 fail=yes; continue; }; \
597 file=$$(basename $$f); \
598 echo checking out $$file...; \
599 $(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t \
600 && $(move_if_change) $$f.t $$f; \
602 test "$$fail" && exit 1
604 emit_upload_commands:
605 @echo =====================================
606 @echo =====================================
607 @echo "$(srcdir)/gnupload $(GNUPLOADFLAGS) \\"
608 @echo " --to $(gnu_rel_host):coreutils \\"
609 @echo " $(rel-files)"
610 @echo '# send the /tmp/announcement e-mail'
611 @echo =====================================
612 @echo =====================================
614 $(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
615 xdelta delta -9 $^ $@ || :
617 .PHONY: alpha beta major
618 alpha beta major: news-date-check $(local-check)
620 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
621 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1; }}\
625 $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
626 ln $(rel-files) $(release_archive_dir)
627 chmod a-w $(rel-files)
628 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
629 echo $(VERSION) > $(prev_version_file)
630 $(CVS) ci -m. $(prev_version_file)