2 # This Makefile fragment tries to be general-purpose enough to be
3 # used by at least coreutils, idutils, CPPI, Bison, and Autoconf.
5 ## Copyright (C) 2001-2009 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 3 of the License, or
10 ## (at your option) any later version.
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, see <http://www.gnu.org/licenses/>.
20 # This is reported not to work with make-3.79.1
21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
24 # Do not save the original name or timestamp in the .tar.gz file.
25 # Use --rsyncable if available.
27 $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
28 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
32 VC-tag = git tag -s -m '$(VERSION)'
34 VC_LIST = $(srcdir)/build-aux/vc-list-files
37 $(VC_LIST) | if test -f .x-$@; then grep -vEf .x-$@; else grep -v ChangeLog; fi
39 ifeq ($(origin prev_version_file), undefined)
40 prev_version_file = $(srcdir)/.prev-version
43 PREV_VERSION := $(shell cat $(prev_version_file))
44 VERSION_REGEXP = $(subst .,\.,$(VERSION))
45 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
48 this-vc-tag = v$(VERSION)
49 this-vc-tag-regexp = v$(VERSION_REGEXP)
51 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
52 tag-this-version = $(subst .,_,$(VERSION))
53 this-vc-tag = $(tag-package)-$(tag-this-version)
54 this-vc-tag-regexp = $(this-vc-tag)
56 my_distdir = $(PACKAGE)-$(VERSION)
58 # Old releases are stored here.
59 release_archive_dir ?= ../release
61 # Prevent programs like 'sort' from considering distinct strings to be equal.
62 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
69 # Collect the names of rules starting with `sc_'.
70 syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
71 $(srcdir)/$(ME) $(srcdir)/cfg.mk)
72 .PHONY: $(syntax-check-rules)
74 local-checks-available = \
76 .PHONY: $(local-checks-available)
78 # Arrange to print the name of each syntax-checking rule just before running it.
79 $(syntax-check-rules): %: %.m
80 $(patsubst %, %.m, $(syntax-check-rules)):
81 @echo $(patsubst sc_%.m, %, $@)
83 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
85 syntax-check: $(local-check)
86 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
87 # $$(find -type f -name '*.[chly]') && \
88 # { echo '$(ME): found conditional include' 1>&2; \
91 # grep -nE '^# *include <(string|stdlib)\.h>' \
92 # $(srcdir)/{lib,src}/*.[chy] && \
93 # { echo '$(ME): FIXME' 1>&2; \
95 # FIXME: don't allow `#include .strings\.h' anywhere
97 # By default, _prohibit_regexp does not ignore case.
99 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
101 # There are many rules below that prohibit constructs in this package.
102 # If the offending construct can be matched with a grep-E-style regexp,
103 # use this macro. The shell variables "re" and "msg" must be defined.
104 define _prohibit_regexp
105 dummy=; : so we do not need a semicolon before each use; \
106 test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
107 test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
108 grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
109 { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
112 sc_avoid_if_before_free:
113 @$(srcdir)/build-aux/useless-if-before-free \
114 $(useless_free_options) \
115 $$($(VC_LIST_EXCEPT)) && \
116 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
119 sc_cast_of_argument_to_free:
120 @re='\<free *\( *\(' msg='don'\''t cast free argument' \
123 sc_cast_of_x_alloc_return_value:
124 @re='\*\) *x(m|c|re)alloc\>' \
125 msg='don'\''t cast x*alloc return value' \
128 sc_cast_of_alloca_return_value:
129 @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
133 @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
136 # Don't use *scanf or the old ato* functions in `real' code.
137 # They provide no error checking mechanism.
138 # Instead, use strto* functions.
139 sc_prohibit_atoi_atof:
140 @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
141 msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
144 # Use STREQ rather than comparing strcmp == 0, or != 0.
146 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
147 $$($(VC_LIST_EXCEPT)) \
148 | grep -vE ':# *define STREQ\(' && \
149 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
152 # Using EXIT_SUCCESS as the first argument to error is misleading,
153 # since when that parameter is 0, error does not exit. Use `0' instead.
154 sc_error_exit_success:
155 @grep -nE 'error \(EXIT_SUCCESS,' \
156 $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
157 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
159 # `FATAL:' should be fully upper-cased in error messages
160 # `WARNING:' should be fully upper-cased, or fully lower-cased
161 sc_error_message_warn_fatal:
162 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
163 | grep -E '"Warning|"Fatal|"fatal' && \
164 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
167 # Error messages should not start with a capital letter
168 sc_error_message_uppercase:
169 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
171 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
172 { echo '$(ME): found capitalized error message' 1>&2; \
175 # Error messages should not end with a period
176 sc_error_message_period:
177 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
178 | grep -E '[^."]\."' && \
179 { echo '$(ME): found error message ending in period' 1>&2; \
183 @re=file''system ignore_case=1 \
184 msg='found use of "file''system"; spell it "file system"' \
187 # Don't use cpp tests of this symbol. All code assumes config.h is included.
188 sc_prohibit_have_config_h:
189 @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
190 { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
193 # Nearly all .c files must include <config.h>.
195 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
196 grep -L '^# *include <config\.h>' \
197 $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
199 { echo '$(ME): the above files do not include <config.h>' \
200 1>&2; exit 1; } || :; \
204 # You must include <config.h> before including any other header file.
205 sc_require_config_h_first:
206 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
208 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
209 grep '^# *include\>' $$i | sed 1q \
210 | grep '^# *include <config\.h>' > /dev/null \
211 || { echo $$i; fail=1; }; \
214 { echo '$(ME): the above files include some other header' \
215 'before <config.h>' 1>&2; exit 1; } || :; \
219 sc_prohibit_HAVE_MBRTOWC:
220 @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
223 # To use this "command" macro, you must first define two shell variables:
224 # h: the header, enclosed in <> or ""
225 # re: a regular expression that matches IFF something provided by $h is used.
226 define _header_without_use
227 h_esc=`echo "$$h"|sed 's/\./\\./g'`; \
228 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
229 files=$$(grep -l '^# *include '"$$h_esc" \
230 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
231 grep -LE "$$re" $$files | grep . && \
232 { echo "$(ME): the above files include $$h but don't use it" \
233 1>&2; exit 1; } || :; \
238 # Prohibit the inclusion of assert.h without an actual use of assert.
239 sc_prohibit_assert_without_use:
240 @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
242 # Prohibit the inclusion of getopt.h without an actual use.
243 sc_prohibit_getopt_without_use:
244 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
246 # Don't include quotearg.h unless you use one of its functions.
247 sc_prohibit_quotearg_without_use:
248 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
250 # Don't include quote.h unless you use one of its functions.
251 sc_prohibit_quote_without_use:
252 @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
254 # Don't include this header unless you use one of its functions.
255 sc_prohibit_long_options_without_use:
256 @h='"long-options.h"' re='\<parse_long_options *\(' \
257 $(_header_without_use)
259 # Don't include this header unless you use one of its functions.
260 sc_prohibit_inttostr_without_use:
261 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
262 $(_header_without_use)
264 # Don't include this header unless you use one of its functions.
265 sc_prohibit_error_without_use:
267 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
268 $(_header_without_use)
270 sc_prohibit_safe_read_without_use:
271 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
272 $(_header_without_use)
274 sc_prohibit_argmatch_without_use:
276 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
277 $(_header_without_use)
279 sc_prohibit_root_dev_ino_without_use:
280 @h='"root-dev-ino.h"' \
281 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
282 $(_header_without_use)
284 # Prohibit the inclusion of c-ctype.h without an actual use.
285 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
286 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
287 sc_prohibit_c_ctype_without_use:
288 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
291 _sp = $(_empty) $(_empty)
292 # The following list was generated by running:
293 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
294 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
296 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
297 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
298 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
299 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
300 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
301 # The following were extracted from "man signal.h" manually.
302 _sig_types_and_consts = \
303 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
304 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
305 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
306 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
307 sigstack sigval stack_t ucontext_t
308 # generated via this:
309 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
311 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
312 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
313 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
314 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
315 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
316 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
317 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
319 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
321 # Prohibit the inclusion of signal.h without an actual use.
322 sc_prohibit_signal_without_use:
324 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
325 $(_header_without_use)
328 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
329 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
332 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
334 # Each nonempty ChangeLog line must start with a year number, or a TAB.
336 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
338 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
339 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
343 # Ensure that each .c file containing a "main" function also
344 # calls set_program_name.
346 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
347 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
348 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
350 { echo '$(ME): the above files do not call set_program_name' \
351 1>&2; exit 1; } || :; \
355 # Require that the final line of each test-lib.sh-using test be this one:
357 # Note: this test requires GNU grep's --label= option.
358 sc_require_test_exit_idiom:
359 @if test -f $(srcdir)/tests/test-lib.sh; then \
361 for i in $$(grep -l -F /../test-lib.sh $$($(VC_LIST) tests)); do \
362 tail -n1 $$i | grep '^Exit \$$fail$$' > /dev/null \
363 && : || { die=1; echo $$i; } \
366 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
367 echo 1>&2 'Exit $$fail'; \
372 @re='\<the ''the\>' \
373 ignore_case=1 msg='found use of "the ''the";' \
378 msg='found trailing blank(s)' \
381 # Match lines like the following, but where there is only one space
382 # between the options and the description:
383 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
384 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
385 sc_two_space_separator_in_usage:
386 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
387 $$($(VC_LIST_EXCEPT)) && \
388 { echo "$(ME): help2man requires at least two spaces between"; \
389 echo "$(ME): an option and its description"; \
392 # Look for diagnostics that aren't marked for translation.
393 # This won't find any for which error's format string is on a separate line.
394 sc_unmarked_diagnostics:
396 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
397 | grep -v '_''(' && \
398 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
401 # Avoid useless parentheses like those in this example:
402 # #if defined (SYMBOL) || defined (SYM2)
403 sc_useless_cpp_parens:
404 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
405 { echo '$(ME): found useless parentheses in cpp directive' \
408 # Require the latest GPL.
410 @re='either ''version [^3]' msg='GPL vN, N!=3' \
414 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
416 sc_prohibit_cvs_keyword:
417 @re='\$$($(cvs_keywords))\$$' \
418 msg='do not use CVS keyword expansion' \
421 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
422 # This is a bit of a kludge, since it prevents use of the string
423 # even in comments, but for now it does the job with no false positives.
424 sc_prohibit_stat_st_blocks:
425 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
428 # Make sure we don't define any S_IS* macros in src/*.c files.
429 # They're already defined via gnulib's sys/stat.h replacement.
430 sc_prohibit_S_IS_definition:
431 @re='^ *# *define *S_IS' \
432 msg='do not define S_IS* macros; include <sys/stat.h>' \
435 # Each program that uses proper_name_utf8 must link with
436 # one of the ICONV libraries.
437 sc_proper_name_utf8_requires_ICONV:
438 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
439 if test "x$$progs" != x; then \
441 for p in $$progs; do \
442 dir=$$(dirname "$$p"); \
443 base=$$(basename "$$p" .c); \
444 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
445 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
448 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
452 # Warn about "c0nst struct Foo const foo[]",
453 # but not about "char const *const foo" or "#define const const".
455 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
456 msg='redundant "const" in declarations' \
459 sc_const_long_option:
460 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
461 | grep -Ev 'const struct option|struct option const' && { \
462 echo 1>&2 '$(ME): add "const" to the above declarations'; \
466 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
468 | grep -v '^Copyright .*Free Software' \
472 # Ensure that we don't accidentally insert an entry into an old NEWS block.
474 @if test -f $(srcdir)/NEWS; then \
475 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
476 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
479 # Update the hash stored above. Do this after each release and
480 # for any corrections to old entries.
481 update-NEWS-hash: NEWS
482 perl -pi -e 's/^(old_NEWS_hash = ).*/$${1}'"$(NEWS_hash)/" \
485 # Ensure that we use only the standard $(VAR) notation,
486 # not @...@ in Makefile.am, now that we can rely on automake
487 # to emit a definition for each substituted variable.
488 # We use perl rather than "grep -nE ..." to exempt a single
489 # use of an @...@-delimited variable name in src/Makefile.am.
491 @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/' \
492 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
493 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
494 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
496 news-date-check: NEWS
497 today=`date +%Y-%m-%d`; \
498 if head NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
502 echo "version or today's date is not in NEWS" 1>&2; \
506 sc_makefile_TAB_only_indentation:
507 @grep -nE '^ [ ]{8}' \
508 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
509 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
513 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
514 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
515 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
519 'you have changed the set of files with translatable diagnostics;\n\
520 apply the above patch\n'
522 # Verify that all source files using _() are listed in po/POTFILES.in.
523 po_file = po/POTFILES.in
525 @if test -f $(po_file); then \
526 grep -E -v '^(#|$$)' $(po_file) \
527 | grep -v '^src/false\.c$$' | sort > $@-1; \
529 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
530 test -r $$file || continue; \
537 base=`expr " $$file" : ' \(.*\)\..'`; \
538 { test -f $$base.l || test -f $$base.y; } && continue;; \
540 files="$$files $$file"; \
542 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
544 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
545 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
549 # Sometimes it is useful to change the PATH environment variable
550 # in Makefiles. When doing so, it's better not to use the Unix-centric
551 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
552 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
553 sc_makefile_path_separator_check:
554 @grep -nE 'PATH[=].*:' \
555 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
556 && { echo $(msg) 1>&2; exit 1; } || :
558 # Check that `make alpha' will not fail at the end of the process.
560 if test -d $(release_archive_dir); then :; else \
561 for file in $(distdir).tar.gz \
562 $(release_archive_dir)/$(distdir).tar.gz; do \
563 test -e $$file || continue; \
565 || { echo ERROR: $$file is not writable; fail=1; }; \
567 test "$$fail" && exit 1 || : ; \
570 v_etc_file = lib/version-etc.c
571 sample-test = tests/sample-test
572 texi = doc/$(PACKAGE).texi
573 # Make sure that the copyright date in $(v_etc_file) is up to date.
574 # Do the same for the $(sample-test) and the main doc/.texi file.
576 @if test -f $(v_etc_file); then \
577 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
579 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
582 @if test -f $(sample-test); then \
583 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
585 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
588 @if test -f $(texi); then \
589 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
591 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
596 $(VC) diff > vc-diffs || :
597 if test -s vc-diffs; then \
599 echo "Some files are locally modified:" 1>&2; \
605 cvs-check: vc-diff-check
607 ALL_RECURSIVE_TARGETS += maintainer-distcheck
608 maintainer-distcheck:
610 $(MAKE) taint-distcheck
614 # Don't make a distribution if checks fail.
615 # Also, make sure the NEWS file is up-to-date.
616 ALL_RECURSIVE_TARGETS += vc-dist
617 vc-dist: $(local-check) cvs-check maintainer-distcheck
618 XZ_OPT=-9ev $(MAKE) dist
620 # Use this to make sure we don't run these programs when building
621 # from a virgin tgz file, below.
622 null_AM_MAKEFLAGS = \
629 built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
631 warn_cflags = -Dlint -O -Werror -Wall -Wformat -Wshadow -Wpointer-arith
634 write_loser = printf '\#!%s\necho $$0: bad path 1>&2; exit 1\n' '$(SHELL)'
637 t=$(TMPDIR)/$(PACKAGE)/test
640 # More than once, tainted build and source directory names would
641 # have caused at least one "make check" test to apply "chmod 700"
642 # to all directories under $HOME. Make sure it doesn't happen again.
643 tp := $(shell echo "$(TMPDIR)/$(PACKAGE)-$$$$")
645 t_taint = '$(t_prefix) b'
646 fake_home = $(tp)/home
648 # Ensure that tests run from tainted build and src dir names work,
649 # and don't affect anything in $HOME. Create witness files in $HOME,
650 # record their attributes, and build/test. Then ensure that the
651 # witnesses were not affected.
652 ALL_RECURSIVE_TARGETS += taint-distcheck
653 taint-distcheck: $(DIST_ARCHIVES)
654 test -d $(t_taint) && chmod -R 700 $(t_taint) || :
655 -rm -rf $(t_taint) $(fake_home)
656 mkdir -p $(t_prefix) $(t_taint) $(fake_home)
657 GZIP=$(GZIP_ENV) $(AMTAR) -C $(t_taint) -zxf $(distdir).tar.gz
658 mkfifo $(fake_home)/fifo
660 mkdir -p $(fake_home)/d/e
661 ls -lR $(fake_home) $(t_prefix) > $(tp)/.ls-before
662 cd $(t_taint)/$(distdir) \
665 && HOME=$(fake_home) $(MAKE) check \
666 && ls -lR $(fake_home) $(t_prefix) > $(tp)/.ls-after \
667 && diff $(tp)/.ls-before $(tp)/.ls-after \
668 && test -d $(t_prefix)
671 # Verify that a twisted use of --program-transform-name=PROGRAM works.
672 define install-transform-check
673 echo running install-transform-check \
675 && $(MAKE) program_transform_name='s/.*/zyx/' \
676 prefix=$(pfx) install \
677 && test "$$(echo $(pfx)/bin/*)" = "$(pfx)/bin/zyx" \
678 && test "$$(find $(pfx)/share/man -type f|sed 's,.*/,,;s,\..*,,')" = "zyx"
681 # Install, then verify that all binaries and man pages are in place.
682 # Note that neither the binary, ginstall, nor the ].1 man page is installed.
684 $(MAKE) prefix=$(pfx) install \
685 && test ! -f $(pfx)/bin/ginstall \
687 for i in $(built_programs); do \
688 test "$$i" = ginstall && i=install; \
689 for j in "$(pfx)/bin/$$i" \
690 "$(pfx)/share/man/man1/$$i.1"; do \
691 case $$j in *'[.1') continue;; esac; \
693 || { echo "$$j not installed"; fail=1; }; \
696 test $$fail = 1 && exit 1 || :; \
700 define coreutils-path-check
702 if test -f $(srcdir)/src/true.c; then \
705 && ($(write_loser)) > $(bin)/loser \
706 && chmod a+x $(bin)/loser \
707 && for i in $(built_programs); do \
709 rm|expr|basename|echo|sort|ls|tr);; \
710 cat|dirname|mv|wc);; \
711 *) ln $(bin)/loser $(bin)/$$i;; \
714 && ln -sf ../src/true $(bin)/false \
715 && PATH=`pwd`/$(bin)$(PATH_SEPARATOR)$$PATH \
716 $(MAKE) -C tests check \
717 && { test -d gnulib-tests \
718 && $(MAKE) -C gnulib-tests check \
725 test $$fail = 1 && exit 1 || :; \
729 # Use -Wformat -Werror to detect format-string/arg-list mismatches.
730 # Also, check for shadowing problems with -Wshadow, and for pointer
731 # arithmetic problems with -Wpointer-arith.
732 # These CFLAGS are pretty strict. If you build this target, you probably
733 # have to have a recent version of gcc and glibc headers.
734 # The hard-linking for-loop below ensures that there is a bin/ directory
735 # full of all of the programs under test (except the ones that are required
736 # for basic Makefile rules), all symlinked to the just-built "false" program.
737 # This is to ensure that if ever a test neglects to make PATH include
738 # the build srcdir, these always-failing programs will run.
739 # Otherwise, it is too easy to test the wrong programs.
740 # Note that "false" itself is a symlink to true, so it too will malfunction.
741 ALL_RECURSIVE_TARGETS += my-distcheck
742 my-distcheck: $(DIST_ARCHIVES) $(local-check)
747 GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
749 && ./configure --disable-nls \
750 && $(MAKE) CFLAGS='$(warn_cflags)' \
751 AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
753 && $(install-transform-check) \
755 && $(coreutils-path-check) \
757 (cd $(t) && mv $(distdir) $(distdir).old \
758 && $(AMTAR) -zxf - ) < $(distdir).tar.gz
759 diff -ur $(t)/$(distdir).old $(t)/$(distdir)
761 @echo "========================"; \
762 echo "$(distdir).tar.gz is ready for distribution"; \
763 echo "========================"
769 tarz=/tmp/rel-check-tarz-$$$$; \
770 md5_tmp=/tmp/rel-check-md5-$$$$; \
772 trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
773 $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
774 echo "$(md5) -" > $$md5_tmp; \
775 md5sum -c $$md5_tmp < $$tarz
777 rel-files = $(DIST_ARCHIVES)
779 gnulib-version = $$(cd $(gnulib_dir) && git describe)
781 announcement: NEWS ChangeLog $(rel-files)
782 @./build-aux/announce-gen \
783 --release-type=$(RELEASE_TYPE) \
784 --package=$(PACKAGE) \
785 --prev=$(PREV_VERSION) \
787 --gpg-key-id=$(gpg_key_ID) \
789 --bootstrap-tools=autoconf,automake,bison,gnulib \
790 --gnulib-version=$(gnulib-version) \
791 --no-print-checksums \
792 $(addprefix --url-dir=, $(url_dir_list))
794 ## ---------------- ##
795 ## Updating files. ##
796 ## ---------------- ##
798 ftp-gnu = ftp://ftp.gnu.org/gnu
799 www-gnu = http://www.gnu.org
801 # Use mv, if you don't have/want move-if-change.
802 move_if_change ?= move-if-change
804 emit_upload_commands:
805 @echo =====================================
806 @echo =====================================
807 @echo "$(srcdir)/build-aux/gnupload $(GNUPLOADFLAGS) \\"
808 @echo " --to $(gnu_rel_host):$(PACKAGE) \\"
809 @echo " $(rel-files)"
810 @echo '# send the /tmp/announcement e-mail'
811 @echo =====================================
812 @echo =====================================
814 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
815 define emit-commit-log
816 printf '%s\n' 'post-release administrivia' '' \
817 '* NEWS: Add header line for next release.' \
818 '* .prev-version: Record previous version.' \
819 '* cfg.mk (old_NEWS_hash): Auto-update.'
822 .PHONY: alpha beta major
823 ALL_RECURSIVE_TARGETS += alpha beta major
824 alpha beta major: $(local-check) writable-files
826 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
827 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
830 $(MAKE) news-date-check
831 $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
832 if test -d $(release_archive_dir); then \
833 ln $(rel-files) $(release_archive_dir); \
834 chmod a-w $(rel-files); \
836 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
837 echo $(VERSION) > $(prev_version_file)
838 $(MAKE) update-NEWS-hash
839 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
840 $(emit-commit-log) > .ci-msg
841 $(VC) commit -F .ci-msg -a
845 @test -z "$(manual_title)" \
846 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
847 @cd '$(srcdir)/doc'; \
848 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
849 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
850 "$(PACKAGE_NAME) - $(manual_title)"
851 @echo " *** Upload the doc/manual directory to web-cvs."
856 $(MAKE) $(AM_MAKEFLAGS) clean
857 lcov --directory . --zerocounters
859 COVERAGE_CCOPTS ?= "-g --coverage"
860 COVERAGE_OUT ?= doc/coverage
863 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
864 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
865 mkdir -p $(COVERAGE_OUT)
866 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
870 genhtml --output-directory $(COVERAGE_OUT) \
871 $(COVERAGE_OUT)/$(PACKAGE).info \
872 --highlight --frames --legend \
873 --title "$(PACKAGE_NAME)"
875 coverage: init-coverage build-coverage gen-coverage
877 # Update gettext files.
878 PACKAGE ?= $(shell basename $(PWD))
879 PO_DOMAIN ?= $(PACKAGE)
880 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
883 rm -f $(PODIR)/*.po && \
884 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
885 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
886 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
887 echo 'en@quot' >> $(PODIR)/LINGUAS && \
888 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
890 INDENT_SOURCES ?= $(C_SOURCES)
893 indent $(INDENT_SOURCES)