2 # This Makefile fragment tries to be general-purpose enough to be
3 # used by many projects via the gnulib maintainer-makefile module.
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 # Override this in cfg.mk if you use a non-standard build-aux directory.
25 build_aux ?= $(srcdir)/build-aux
27 # Do not save the original name or timestamp in the .tar.gz file.
28 # Use --rsyncable if available.
30 $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
31 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
33 # cfg.mk must define the gpg_key_ID used by this package.
36 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
38 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
41 $(VC_LIST) | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; else grep -v ChangeLog; fi
43 ifeq ($(origin prev_version_file), undefined)
44 prev_version_file = $(srcdir)/.prev-version
47 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
48 VERSION_REGEXP = $(subst .,\.,$(VERSION))
49 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
52 this-vc-tag = v$(VERSION)
53 this-vc-tag-regexp = v$(VERSION_REGEXP)
55 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
56 tag-this-version = $(subst .,_,$(VERSION))
57 this-vc-tag = $(tag-package)-$(tag-this-version)
58 this-vc-tag-regexp = $(this-vc-tag)
60 my_distdir = $(PACKAGE)-$(VERSION)
62 # Old releases are stored here.
63 release_archive_dir ?= ../release
65 # Prevent programs like 'sort' from considering distinct strings to be equal.
66 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
73 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
75 # Collect the names of rules starting with `sc_'.
76 syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
77 $(srcdir)/$(ME) $(_cfg_mk))
78 .PHONY: $(syntax-check-rules)
80 local-checks-available = \
82 .PHONY: $(local-checks-available)
84 # Arrange to print the name of each syntax-checking rule just before running it.
85 $(syntax-check-rules): %: %.m
86 $(patsubst %, %.m, $(syntax-check-rules)):
87 @echo $(patsubst sc_%.m, %, $@)
89 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
91 syntax-check: $(local-check)
92 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
93 # $$(find -type f -name '*.[chly]') && \
94 # { echo '$(ME): found conditional include' 1>&2; \
97 # grep -nE '^# *include <(string|stdlib)\.h>' \
98 # $(srcdir)/{lib,src}/*.[chy] && \
99 # { echo '$(ME): FIXME' 1>&2; \
101 # FIXME: don't allow `#include .strings\.h' anywhere
103 # By default, _prohibit_regexp does not ignore case.
105 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
107 # There are many rules below that prohibit constructs in this package.
108 # If the offending construct can be matched with a grep-E-style regexp,
109 # use this macro. The shell variables "re" and "msg" must be defined.
110 define _prohibit_regexp
111 dummy=; : so we do not need a semicolon before each use; \
112 test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
113 test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
114 grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
115 { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
118 sc_avoid_if_before_free:
119 @$(build_aux)/useless-if-before-free \
120 $(useless_free_options) \
121 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
122 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
125 sc_cast_of_argument_to_free:
126 @re='\<free *\( *\(' msg='don'\''t cast free argument' \
129 sc_cast_of_x_alloc_return_value:
130 @re='\*\) *x(m|c|re)alloc\>' \
131 msg='don'\''t cast x*alloc return value' \
134 sc_cast_of_alloca_return_value:
135 @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
139 @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
142 # Don't use *scanf or the old ato* functions in `real' code.
143 # They provide no error checking mechanism.
144 # Instead, use strto* functions.
145 sc_prohibit_atoi_atof:
146 @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
147 msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
150 # Use STREQ rather than comparing strcmp == 0, or != 0.
152 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
153 $$($(VC_LIST_EXCEPT)) \
154 | grep -vE ':# *define STREQ\(' && \
155 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
158 # Using EXIT_SUCCESS as the first argument to error is misleading,
159 # since when that parameter is 0, error does not exit. Use `0' instead.
160 sc_error_exit_success:
161 @grep -nE 'error \(EXIT_SUCCESS,' \
162 $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
163 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
165 # `FATAL:' should be fully upper-cased in error messages
166 # `WARNING:' should be fully upper-cased, or fully lower-cased
167 sc_error_message_warn_fatal:
168 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
169 | grep -E '"Warning|"Fatal|"fatal' && \
170 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
173 # Error messages should not start with a capital letter
174 sc_error_message_uppercase:
175 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
177 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
178 { echo '$(ME): found capitalized error message' 1>&2; \
181 # Error messages should not end with a period
182 sc_error_message_period:
183 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
184 | grep -E '[^."]\."' && \
185 { echo '$(ME): found error message ending in period' 1>&2; \
189 @re=file''system ignore_case=1 \
190 msg='found use of "file''system"; spell it "file system"' \
193 # Don't use cpp tests of this symbol. All code assumes config.h is included.
194 sc_prohibit_have_config_h:
195 @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
196 { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
199 # Nearly all .c files must include <config.h>. However, we also permit this
200 # via inclusion of a package-specific header, if cfg.mk specified one.
201 # config_h_header must be suitable for grep -E.
202 config_h_header ?= <config\.h>
204 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
205 grep -EL '^# *include $(config_h_header)' \
206 $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
208 { echo '$(ME): the above files do not include <config.h>' \
209 1>&2; exit 1; } || :; \
213 # You must include <config.h> before including any other header file.
214 # This can possibly be via a package-specific header, if given by cfg.mk.
215 sc_require_config_h_first:
216 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
218 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
219 grep '^# *include\>' $$i | sed 1q \
220 | grep -E '^# *include $(config_h_header)' > /dev/null \
221 || { echo $$i; fail=1; }; \
224 { echo '$(ME): the above files include some other header' \
225 'before <config.h>' 1>&2; exit 1; } || :; \
229 sc_prohibit_HAVE_MBRTOWC:
230 @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
233 # To use this "command" macro, you must first define two shell variables:
234 # h: the header, enclosed in <> or ""
235 # re: a regular expression that matches IFF something provided by $h is used.
236 define _header_without_use
237 h_esc=`echo "$$h"|sed 's/\./\\./g'`; \
238 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
239 files=$$(grep -l '^# *include '"$$h_esc" \
240 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
241 grep -LE "$$re" $$files | grep . && \
242 { echo "$(ME): the above files include $$h but don't use it" \
243 1>&2; exit 1; } || :; \
248 # Prohibit the inclusion of assert.h without an actual use of assert.
249 sc_prohibit_assert_without_use:
250 @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
252 # Prohibit the inclusion of getopt.h without an actual use.
253 sc_prohibit_getopt_without_use:
254 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
256 # Don't include quotearg.h unless you use one of its functions.
257 sc_prohibit_quotearg_without_use:
258 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
260 # Don't include quote.h unless you use one of its functions.
261 sc_prohibit_quote_without_use:
262 @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
264 # Don't include this header unless you use one of its functions.
265 sc_prohibit_long_options_without_use:
266 @h='"long-options.h"' re='\<parse_long_options *\(' \
267 $(_header_without_use)
269 # Don't include this header unless you use one of its functions.
270 sc_prohibit_inttostr_without_use:
271 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
272 $(_header_without_use)
274 # Don't include this header unless you use one of its functions.
275 sc_prohibit_error_without_use:
277 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
278 $(_header_without_use)
280 sc_prohibit_safe_read_without_use:
281 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
282 $(_header_without_use)
284 sc_prohibit_argmatch_without_use:
286 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
287 $(_header_without_use)
289 sc_prohibit_root_dev_ino_without_use:
290 @h='"root-dev-ino.h"' \
291 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
292 $(_header_without_use)
294 # Prohibit the inclusion of c-ctype.h without an actual use.
295 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
296 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
297 sc_prohibit_c_ctype_without_use:
298 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
301 _sp = $(_empty) $(_empty)
302 # The following list was generated by running:
303 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
304 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
306 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
307 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
308 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
309 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
310 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
311 # The following were extracted from "man signal.h" manually.
312 _sig_types_and_consts = \
313 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
314 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
315 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
316 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
317 sigstack sigval stack_t ucontext_t
318 # generated via this:
319 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
321 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
322 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
323 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
324 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
325 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
326 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
327 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
329 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
331 # Prohibit the inclusion of signal.h without an actual use.
332 sc_prohibit_signal_without_use:
334 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
335 $(_header_without_use)
338 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
339 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
342 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
344 # Each nonempty ChangeLog line must start with a year number, or a TAB.
346 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
348 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
349 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
353 # Ensure that each .c file containing a "main" function also
354 # calls set_program_name.
356 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
357 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
358 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
360 { echo '$(ME): the above files do not call set_program_name' \
361 1>&2; exit 1; } || :; \
365 # Require that the final line of each test-lib.sh-using test be this one:
367 # Note: this test requires GNU grep's --label= option.
368 Exit_witness_file ?= tests/test-lib.sh
369 Exit_base := $(notdir $(Exit_witness_file))
370 sc_require_test_exit_idiom:
371 @if test -f $(srcdir)/$(Exit_witness_file); then \
373 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
374 $$($(VC_LIST) tests)); do \
375 tail -n1 $$i | grep '^Exit .' > /dev/null \
376 && : || { die=1; echo $$i; } \
379 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
380 echo 1>&2 'Exit something'; \
385 @re='\<the ''the\>' \
386 ignore_case=1 msg='found use of "the ''the";' \
391 msg='found trailing blank(s)' \
394 # Match lines like the following, but where there is only one space
395 # between the options and the description:
396 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
397 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
398 sc_two_space_separator_in_usage:
399 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
400 $$($(VC_LIST_EXCEPT)) && \
401 { echo "$(ME): help2man requires at least two spaces between"; \
402 echo "$(ME): an option and its description"; \
405 # Look for diagnostics that aren't marked for translation.
406 # This won't find any for which error's format string is on a separate line.
407 sc_unmarked_diagnostics:
409 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
410 | grep -v '_''(' && \
411 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
414 # Avoid useless parentheses like those in this example:
415 # #if defined (SYMBOL) || defined (SYM2)
416 sc_useless_cpp_parens:
417 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
418 { echo '$(ME): found useless parentheses in cpp directive' \
421 # Require the latest GPL.
423 @re='either ''version [^3]' msg='GPL vN, N!=3' \
427 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
429 sc_prohibit_cvs_keyword:
430 @re='\$$($(cvs_keywords))\$$' \
431 msg='do not use CVS keyword expansion' \
434 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
435 # This is a bit of a kludge, since it prevents use of the string
436 # even in comments, but for now it does the job with no false positives.
437 sc_prohibit_stat_st_blocks:
438 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
441 # Make sure we don't define any S_IS* macros in src/*.c files.
442 # They're already defined via gnulib's sys/stat.h replacement.
443 sc_prohibit_S_IS_definition:
444 @re='^ *# *define *S_IS' \
445 msg='do not define S_IS* macros; include <sys/stat.h>' \
448 # Each program that uses proper_name_utf8 must link with
449 # one of the ICONV libraries.
450 sc_proper_name_utf8_requires_ICONV:
451 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
452 if test "x$$progs" != x; then \
454 for p in $$progs; do \
455 dir=$$(dirname "$$p"); \
456 base=$$(basename "$$p" .c); \
457 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
458 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
461 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
465 # Warn about "c0nst struct Foo const foo[]",
466 # but not about "char const *const foo" or "#define const const".
468 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
469 msg='redundant "const" in declarations' \
472 sc_const_long_option:
473 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
474 | grep -Ev 'const struct option|struct option const' && { \
475 echo 1>&2 '$(ME): add "const" to the above declarations'; \
479 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
481 | grep -v '^Copyright .*Free Software' \
485 # Ensure that we don't accidentally insert an entry into an old NEWS block.
487 @if test -f $(srcdir)/NEWS; then \
488 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
489 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
492 # Update the hash stored above. Do this after each release and
493 # for any corrections to old entries.
494 update-NEWS-hash: NEWS
495 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
498 # Ensure that we use only the standard $(VAR) notation,
499 # not @...@ in Makefile.am, now that we can rely on automake
500 # to emit a definition for each substituted variable.
501 # We use perl rather than "grep -nE ..." to exempt a single
502 # use of an @...@-delimited variable name in src/Makefile.am.
504 @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/' \
505 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
506 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
507 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
509 news-date-check: NEWS
510 today=`date +%Y-%m-%d`; \
511 if head $(srcdir)/NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
515 echo "version or today's date is not in NEWS" 1>&2; \
519 sc_makefile_TAB_only_indentation:
520 @grep -nE '^ [ ]{8}' \
521 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
522 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
526 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
527 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
528 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
532 'you have changed the set of files with translatable diagnostics;\n\
533 apply the above patch\n'
535 # Verify that all source files using _() are listed in po/POTFILES.in.
536 po_file = po/POTFILES.in
538 @if test -f $(po_file); then \
539 grep -E -v '^(#|$$)' $(po_file) \
540 | grep -v '^src/false\.c$$' | sort > $@-1; \
542 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
543 test -r $$file || continue; \
545 *.m4|*.mk) continue ;; \
551 base=`expr " $$file" : ' \(.*\)\..'`; \
552 { test -f $$base.l || test -f $$base.y; } && continue;; \
554 files="$$files $$file"; \
556 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
558 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
559 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
563 # Sometimes it is useful to change the PATH environment variable
564 # in Makefiles. When doing so, it's better not to use the Unix-centric
565 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
566 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
567 sc_makefile_path_separator_check:
568 @grep -nE 'PATH[=].*:' \
569 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
570 && { echo $(msg) 1>&2; exit 1; } || :
572 # Check that `make alpha' will not fail at the end of the process.
574 if test -d $(release_archive_dir); then :; else \
575 for file in $(distdir).tar.gz \
576 $(release_archive_dir)/$(distdir).tar.gz; do \
577 test -e $$file || continue; \
579 || { echo ERROR: $$file is not writable; fail=1; }; \
581 test "$$fail" && exit 1 || : ; \
584 v_etc_file = lib/version-etc.c
585 sample-test = tests/sample-test
586 texi = doc/$(PACKAGE).texi
587 # Make sure that the copyright date in $(v_etc_file) is up to date.
588 # Do the same for the $(sample-test) and the main doc/.texi file.
590 @if test -f $(v_etc_file); then \
591 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
593 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
596 @if test -f $(sample-test); then \
597 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
599 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
602 @if test -f $(texi); then \
603 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
605 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
610 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
611 if test -s vc-diffs; then \
613 echo "Some files are locally modified:" 1>&2; \
619 cvs-check: vc-diff-check
621 ALL_RECURSIVE_TARGETS += maintainer-distcheck
622 maintainer-distcheck:
624 $(MAKE) taint-distcheck
628 # Don't make a distribution if checks fail.
629 # Also, make sure the NEWS file is up-to-date.
630 ALL_RECURSIVE_TARGETS += vc-dist
631 vc-dist: $(local-check) cvs-check maintainer-distcheck
632 XZ_OPT=9ev $(MAKE) dist
634 # Use this to make sure we don't run these programs when building
635 # from a virgin tgz file, below.
636 null_AM_MAKEFLAGS = \
643 built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
645 rel-files = $(DIST_ARCHIVES)
647 gnulib_dir ?= $(srcdir)/gnulib
648 gnulib-version = $$(cd $(gnulib_dir) && git describe)
649 bootstrap-tools ?= autoconf,automake,gnulib
651 announcement: NEWS ChangeLog $(rel-files)
652 @$(build_aux)/announce-gen \
653 --release-type=$(RELEASE_TYPE) \
654 --package=$(PACKAGE) \
655 --prev=$(PREV_VERSION) \
657 --gpg-key-id=$(gpg_key_ID) \
659 --bootstrap-tools=$(bootstrap-tools) \
660 --gnulib-version=$(gnulib-version) \
661 --no-print-checksums \
662 $(addprefix --url-dir=, $(url_dir_list))
664 ## ---------------- ##
665 ## Updating files. ##
666 ## ---------------- ##
668 ftp-gnu = ftp://ftp.gnu.org/gnu
669 www-gnu = http://www.gnu.org
671 emit_upload_commands:
672 @echo =====================================
673 @echo =====================================
674 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
675 @echo " --to $(gnu_rel_host):$(PACKAGE) \\"
676 @echo " $(rel-files)"
677 @echo '# send the /tmp/announcement e-mail'
678 @echo =====================================
679 @echo =====================================
681 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
682 define emit-commit-log
683 printf '%s\n' 'post-release administrivia' '' \
684 '* NEWS: Add header line for next release.' \
685 '* .prev-version: Record previous version.' \
686 '* cfg.mk (old_NEWS_hash): Auto-update.'
689 .PHONY: no-submodule-changes
690 no-submodule-changes:
691 if test -d $(srcdir)/.git; then \
692 diff=$$(cd $(srcdir) && git submodule -q foreach \
693 git diff-index --name-only HEAD) \
695 case $$diff in '') ;; \
696 *) echo '$(ME): submodule files are locally modified:'; \
697 echo "$$diff"; exit 1;; esac; \
702 .PHONY: alpha beta major
703 ALL_RECURSIVE_TARGETS += alpha beta major
704 alpha beta major: $(local-check) writable-files no-submodule-changes
706 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
707 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
710 $(MAKE) news-date-check
711 $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
712 if test -d $(release_archive_dir); then \
713 ln $(rel-files) $(release_archive_dir); \
714 chmod a-w $(rel-files); \
716 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
717 echo $(VERSION) > $(prev_version_file)
718 $(MAKE) update-NEWS-hash
719 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
720 $(emit-commit-log) > .ci-msg
721 $(VC) commit -F .ci-msg -a
725 @test -z "$(manual_title)" \
726 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
727 @cd '$(srcdir)/doc'; \
728 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
729 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
730 "$(PACKAGE_NAME) - $(manual_title)"
731 @echo " *** Upload the doc/manual directory to web-cvs."
736 $(MAKE) $(AM_MAKEFLAGS) clean
737 lcov --directory . --zerocounters
739 COVERAGE_CCOPTS ?= "-g --coverage"
740 COVERAGE_OUT ?= doc/coverage
743 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
744 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
745 mkdir -p $(COVERAGE_OUT)
746 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
750 genhtml --output-directory $(COVERAGE_OUT) \
751 $(COVERAGE_OUT)/$(PACKAGE).info \
752 --highlight --frames --legend \
753 --title "$(PACKAGE_NAME)"
755 coverage: init-coverage build-coverage gen-coverage
757 # Update gettext files.
758 PACKAGE ?= $(shell basename $(PWD))
759 PO_DOMAIN ?= $(PACKAGE)
760 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
763 rm -f $(PODIR)/*.po && \
764 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
765 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
766 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
767 echo 'en@quot' >> $(PODIR)/LINGUAS && \
768 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
770 INDENT_SOURCES ?= $(C_SOURCES)
773 indent $(INDENT_SOURCES)
775 # If you want to set UPDATE_COPYRIGHT_* environment variables,
776 # put the assignments in this variable.
777 update-copyright-env ?=
779 # Run this rule once per year (usually early in January)
780 # to update all FSF copyright year lists in your project.
781 # If you have an additional project-specific rule,
782 # add it in cfg.mk along with a line 'update-copyright: prereq'.
783 # By default, exclude all variants of COPYING; you can also
784 # add exemptions (such as ChangeLog..* for rotated change logs)
785 # in the file .x-update-copyright.
786 .PHONY: update-copyright
788 grep -l -w Copyright $$($(VC_LIST_EXCEPT)) \
789 $(srcdir)/ChangeLog | grep -v COPYING \
790 | $(update-copyright-env) xargs $(build_aux)/$@