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-2010 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)'
35 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
37 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
39 # You can override this variable in cfg.mk to set your own regexp
40 # matching files to ignore.
41 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$
43 # This is to preprocess robustly the output of $(VC_LIST), so that even
44 # when $(srcdir) is a pathological name like "....", the leading sed command
45 # removes only the intended prefix.
46 _dot_escaped_srcdir = $(subst .,\.,$(srcdir))
48 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only
49 # when $(srcdir) is not ".".
51 _prepend_srcdir_prefix =
53 _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|'
56 # In order to be able to consistently filter "."-relative names,
57 # (i.e., with no $(srcdir) prefix), this definition is careful to
58 # remove any $(srcdir) prefix, and to restore what it removes.
60 $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
61 | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
62 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
63 | grep -Ev -e '$(VC_LIST_ALWAYS_EXCLUDE_REGEX)' \
64 $(_prepend_srcdir_prefix)
66 ifeq ($(origin prev_version_file), undefined)
67 prev_version_file = $(srcdir)/.prev-version
70 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
71 VERSION_REGEXP = $(subst .,\.,$(VERSION))
72 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
75 this-vc-tag = v$(VERSION)
76 this-vc-tag-regexp = v$(VERSION_REGEXP)
78 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
79 tag-this-version = $(subst .,_,$(VERSION))
80 this-vc-tag = $(tag-package)-$(tag-this-version)
81 this-vc-tag-regexp = $(this-vc-tag)
83 my_distdir = $(PACKAGE)-$(VERSION)
85 # Old releases are stored here.
86 release_archive_dir ?= ../release
88 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
89 # Use alpha.gnu.org for alpha and beta releases.
90 # Use ftp.gnu.org for stable releases.
91 gnu_ftp_host-alpha = alpha.gnu.org
92 gnu_ftp_host-beta = alpha.gnu.org
93 gnu_ftp_host-stable = ftp.gnu.org
94 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
96 ifeq ($(gnu_rel_host),ftp.gnu.org)
97 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
99 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
102 # Override this in cfg.mk if you are using a different format in your
104 today = $(shell date +%Y-%m-%d)
105 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
107 # Prevent programs like 'sort' from considering distinct strings to be equal.
108 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
111 ## --------------- ##
113 ## --------------- ##
115 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
117 # Collect the names of rules starting with `sc_'.
118 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
119 $(srcdir)/$(ME) $(_cfg_mk)))
120 .PHONY: $(syntax-check-rules)
122 local-checks-available = \
123 $(syntax-check-rules)
124 .PHONY: $(local-checks-available)
126 # Arrange to print the name of each syntax-checking rule just before running it.
127 $(syntax-check-rules): %: %.m
128 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
129 .PHONY: $(sc_m_rules_)
131 @echo $(patsubst sc_%.m, %, $@)
133 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
135 syntax-check: $(local-check)
136 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
137 # $$(find -type f -name '*.[chly]') && \
138 # { echo '$(ME): found conditional include' 1>&2; \
141 # grep -nE '^# *include <(string|stdlib)\.h>' \
142 # $(srcdir)/{lib,src}/*.[chy] && \
143 # { echo '$(ME): FIXME' 1>&2; \
145 # FIXME: don't allow `#include .strings\.h' anywhere
147 # By default, _prohibit_regexp does not ignore case.
149 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
151 # There are many rules below that prohibit constructs in this package.
152 # If the offending construct can be matched with a grep-E-style regexp,
153 # use this macro. The shell variables "re" and "msg" must be defined.
154 define _prohibit_regexp
155 dummy=; : so we do not need a semicolon before each use; \
156 test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
157 test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
158 grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
159 { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
162 sc_avoid_if_before_free:
163 @$(build_aux)/useless-if-before-free \
164 $(useless_free_options) \
165 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
166 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
169 sc_cast_of_argument_to_free:
170 @re='\<free *\( *\(' msg='don'\''t cast free argument' \
173 sc_cast_of_x_alloc_return_value:
174 @re='\*\) *x(m|c|re)alloc\>' \
175 msg='don'\''t cast x*alloc return value' \
178 sc_cast_of_alloca_return_value:
179 @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
183 @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
186 # Don't use *scanf or the old ato* functions in `real' code.
187 # They provide no error checking mechanism.
188 # Instead, use strto* functions.
189 sc_prohibit_atoi_atof:
190 @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
191 msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
194 # Use STREQ rather than comparing strcmp == 0, or != 0.
196 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
197 $$($(VC_LIST_EXCEPT)) \
198 | grep -vE ':# *define STREQ\(' && \
199 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
202 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
203 # Convert all uses automatically, via these two commands:
204 # git grep -l '\<exit *(1)' \
205 # | grep -vEf .x-sc_prohibit_magic_number_exit \
206 # | xargs --no-run-if-empty \
207 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
208 # git grep -l '\<exit *(0)' \
209 # | grep -vEf .x-sc_prohibit_magic_number_exit \
210 # | xargs --no-run-if-empty \
211 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
212 sc_prohibit_magic_number_exit:
213 @re='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
214 msg='use EXIT_* values rather than magic number' \
217 # Using EXIT_SUCCESS as the first argument to error is misleading,
218 # since when that parameter is 0, error does not exit. Use `0' instead.
219 sc_error_exit_success:
220 @grep -nE 'error \(EXIT_SUCCESS,' \
221 $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
222 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
224 # `FATAL:' should be fully upper-cased in error messages
225 # `WARNING:' should be fully upper-cased, or fully lower-cased
226 sc_error_message_warn_fatal:
227 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
228 | grep -E '"Warning|"Fatal|"fatal' && \
229 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
232 # Error messages should not start with a capital letter
233 sc_error_message_uppercase:
234 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
236 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
237 { echo '$(ME): found capitalized error message' 1>&2; \
240 # Error messages should not end with a period
241 sc_error_message_period:
242 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
243 | grep -E '[^."]\."' && \
244 { echo '$(ME): found error message ending in period' 1>&2; \
248 @re=file''system ignore_case=1 \
249 msg='found use of "file''system"; spell it "file system"' \
252 # Don't use cpp tests of this symbol. All code assumes config.h is included.
253 sc_prohibit_have_config_h:
254 @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
255 { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
258 # Nearly all .c files must include <config.h>. However, we also permit this
259 # via inclusion of a package-specific header, if cfg.mk specified one.
260 # config_h_header must be suitable for grep -E.
261 config_h_header ?= <config\.h>
263 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
264 grep -EL '^# *include $(config_h_header)' \
265 $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
267 { echo '$(ME): the above files do not include <config.h>' \
268 1>&2; exit 1; } || :; \
272 # You must include <config.h> before including any other header file.
273 # This can possibly be via a package-specific header, if given by cfg.mk.
274 sc_require_config_h_first:
275 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
277 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
278 grep '^# *include\>' $$i | sed 1q \
279 | grep -E '^# *include $(config_h_header)' > /dev/null \
280 || { echo $$i; fail=1; }; \
283 { echo '$(ME): the above files include some other header' \
284 'before <config.h>' 1>&2; exit 1; } || :; \
288 sc_prohibit_HAVE_MBRTOWC:
289 @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
292 # To use this "command" macro, you must first define two shell variables:
293 # h: the header, enclosed in <> or ""
294 # re: a regular expression that matches IFF something provided by $h is used.
295 define _sc_header_without_use
296 dummy=; : so we do not need a semicolon before each use; \
297 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
298 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
299 files=$$(grep -l '^# *include '"$$h_esc" \
300 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
301 grep -LE "$$re" $$files | grep . && \
302 { echo "$(ME): the above files include $$h but don't use it" \
303 1>&2; exit 1; } || :; \
308 # Prohibit the inclusion of assert.h without an actual use of assert.
309 sc_prohibit_assert_without_use:
310 @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
312 # Prohibit the inclusion of close-stream.h without an actual use.
313 sc_prohibit_close_stream_without_use:
314 @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
316 # Prohibit the inclusion of getopt.h without an actual use.
317 sc_prohibit_getopt_without_use:
318 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
320 # Don't include quotearg.h unless you use one of its functions.
321 sc_prohibit_quotearg_without_use:
322 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
324 # Don't include quote.h unless you use one of its functions.
325 sc_prohibit_quote_without_use:
326 @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
328 # Don't include this header unless you use one of its functions.
329 sc_prohibit_long_options_without_use:
330 @h='"long-options.h"' re='\<parse_long_options *\(' \
331 $(_sc_header_without_use)
333 # Don't include this header unless you use one of its functions.
334 sc_prohibit_inttostr_without_use:
335 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
336 $(_sc_header_without_use)
338 # Don't include this header unless you use one of its functions.
339 sc_prohibit_ignore_value_without_use:
340 @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
341 $(_sc_header_without_use)
343 # Don't include this header unless you use one of its functions.
344 sc_prohibit_error_without_use:
346 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
347 $(_sc_header_without_use)
349 # Don't include xalloc.h unless you use one of its functions.
350 # Consider these symbols:
351 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
352 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
353 # Divide into two sets on case, and filter each through this:
354 # | sort | perl -MRegexp::Assemble -le \
355 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
356 # Note this was produced by the above:
358 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
359 # But we can do better, in at least two ways:
360 # 1) take advantage of two "dup"-suffixed strings:
361 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
362 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
364 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
365 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
366 _xa2 = X([CZ]|N?M)ALLOC
367 sc_prohibit_xalloc_without_use:
369 re='\<($(_xa1)|$(_xa2)) *\('\
370 $(_sc_header_without_use)
372 # Extract function names:
373 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/hash.h
375 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
376 _hash_fn = \<($(_hash_re)) *\(
377 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
378 sc_prohibit_hash_without_use:
380 re='$(_hash_fn)|$(_hash_struct)'\
381 $(_sc_header_without_use)
383 sc_prohibit_hash_pjw_without_use:
385 re='\<hash_pjw *\(' \
386 $(_sc_header_without_use)
388 sc_prohibit_safe_read_without_use:
389 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
390 $(_sc_header_without_use)
392 sc_prohibit_argmatch_without_use:
394 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
395 $(_sc_header_without_use)
397 sc_prohibit_canonicalize_without_use:
398 @h='"canonicalize.h"' \
399 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
400 $(_sc_header_without_use)
402 sc_prohibit_root_dev_ino_without_use:
403 @h='"root-dev-ino.h"' \
404 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
405 $(_sc_header_without_use)
407 sc_prohibit_openat_without_use:
409 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
410 $(_sc_header_without_use)
412 # Prohibit the inclusion of c-ctype.h without an actual use.
413 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
414 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
415 sc_prohibit_c_ctype_without_use:
416 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_sc_header_without_use)
419 _sp = $(_empty) $(_empty)
420 # The following list was generated by running:
421 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
422 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
424 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
425 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
426 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
427 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
428 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
429 # The following were extracted from "man signal.h" manually.
430 _sig_types_and_consts = \
431 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
432 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
433 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
434 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
435 sigstack sigval stack_t ucontext_t
436 # generated via this:
437 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
439 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
440 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
441 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
442 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
443 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
444 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
445 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
447 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
449 # Prohibit the inclusion of signal.h without an actual use.
450 sc_prohibit_signal_without_use:
452 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
453 $(_sc_header_without_use)
455 # Get the list of symbol names with this:
456 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
458 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \
459 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \
460 INT_STRLEN_BOUND INT_BUFSIZE_BOUND
461 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
462 # Prohibit the inclusion of intprops.h without an actual use.
463 sc_prohibit_intprops_without_use:
465 re='\<($(_intprops_syms_re)) *\(' \
466 $(_sc_header_without_use)
469 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
470 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
473 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
475 # Each nonempty ChangeLog line must start with a year number, or a TAB.
477 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
479 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
480 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
484 # Ensure that each .c file containing a "main" function also
485 # calls set_program_name.
487 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
488 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
489 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
491 { echo '$(ME): the above files do not call set_program_name' \
492 1>&2; exit 1; } || :; \
496 # Require that the final line of each test-lib.sh-using test be this one:
498 # Note: this test requires GNU grep's --label= option.
499 Exit_witness_file ?= tests/test-lib.sh
500 Exit_base := $(notdir $(Exit_witness_file))
501 sc_require_test_exit_idiom:
502 @if test -f $(srcdir)/$(Exit_witness_file); then \
504 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
505 $$($(VC_LIST) tests)); do \
506 tail -n1 $$i | grep '^Exit .' > /dev/null \
507 && : || { die=1; echo $$i; } \
510 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
511 echo 1>&2 'Exit something'; \
516 @re='\<the ''the\>' \
517 ignore_case=1 msg='found use of "the ''the";' \
522 msg='found trailing blank(s)' \
525 # Match lines like the following, but where there is only one space
526 # between the options and the description:
527 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
528 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
529 sc_two_space_separator_in_usage:
530 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
531 $$($(VC_LIST_EXCEPT)) && \
532 { echo "$(ME): help2man requires at least two spaces between"; \
533 echo "$(ME): an option and its description"; \
536 # Look for diagnostics that aren't marked for translation.
537 # This won't find any for which error's format string is on a separate line.
538 sc_unmarked_diagnostics:
540 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
541 | grep -v '_''(' && \
542 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
545 # Avoid useless parentheses like those in this example:
546 # #if defined (SYMBOL) || defined (SYM2)
547 sc_useless_cpp_parens:
548 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
549 { echo '$(ME): found useless parentheses in cpp directive' \
552 # Require the latest GPL.
554 @re='either ''version [^3]' msg='GPL vN, N!=3' \
557 # Require the latest GFDL. Two regexp, since some .texi files end up
558 # line wrapping between 'Free Documentation License,' and 'Version'.
559 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
561 @re='$(_GFDL_regexp)' msg='GFDL vN, N!=3' \
564 # Don't use Texinfo @acronym{} as it is not a good idea.
566 @if $(VC_LIST_EXCEPT) | grep -lE '\.texi$$' >/dev/null; then \
567 grep -nE '@acronym{' \
568 $$($(VC_LIST_EXCEPT) | grep -E '\.texi$$') && \
569 { echo '$(ME): found use of Texinfo @acronym{}' 1>&2; \
575 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
577 sc_prohibit_cvs_keyword:
578 @re='\$$($(cvs_keywords))\$$' \
579 msg='do not use CVS keyword expansion' \
582 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
583 # This is a bit of a kludge, since it prevents use of the string
584 # even in comments, but for now it does the job with no false positives.
585 sc_prohibit_stat_st_blocks:
586 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
589 # Make sure we don't define any S_IS* macros in src/*.c files.
590 # They're already defined via gnulib's sys/stat.h replacement.
591 sc_prohibit_S_IS_definition:
592 @re='^ *# *define *S_IS' \
593 msg='do not define S_IS* macros; include <sys/stat.h>' \
596 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
597 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
598 # Using test's -a and -o operators is not portable.
599 sc_prohibit_test_minus_ao:
600 @re='\<test .+ -[ao] ' \
601 msg='$(_ptm1); $(_ptm2)' \
604 # Each program that uses proper_name_utf8 must link with one of the
605 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
606 # The perl -0777 invocation below extracts the possibly-multi-line
607 # definition of LDADD from the appropriate Makefile.am and exits 0
608 # when it contains "ICONV".
609 sc_proper_name_utf8_requires_ICONV:
610 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
611 if test "x$$progs" != x; then \
613 for p in $$progs; do \
614 dir=$$(dirname "$$p"); \
616 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
617 $$dir/Makefile.am && continue; \
618 base=$$(basename "$$p" .c); \
619 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
620 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
623 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
627 # Warn about "c0nst struct Foo const foo[]",
628 # but not about "char const *const foo" or "#define const const".
630 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
631 msg='redundant "const" in declarations' \
634 sc_const_long_option:
635 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
636 | grep -Ev 'const struct option|struct option const' && { \
637 echo 1>&2 '$(ME): add "const" to the above declarations'; \
641 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
644 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
648 # Ensure that we don't accidentally insert an entry into an old NEWS block.
650 @if test -f $(srcdir)/NEWS; then \
651 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
652 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
655 # Update the hash stored above. Do this after each release and
656 # for any corrections to old entries.
657 update-NEWS-hash: NEWS
658 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
661 # Ensure that we use only the standard $(VAR) notation,
662 # not @...@ in Makefile.am, now that we can rely on automake
663 # to emit a definition for each substituted variable.
664 # We use perl rather than "grep -nE ..." to exempt a single
665 # use of an @...@-delimited variable name in src/Makefile.am.
666 # Allow the package to add exceptions via a hook in cfg.mk;
667 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
668 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
669 _makefile_at_at_check_exceptions ?=
670 sc_makefile_at_at_check:
671 @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
672 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
673 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
674 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
677 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
681 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
685 sc_makefile_TAB_only_indentation:
686 @grep -nE '^ [ ]{8}' \
687 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
688 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
692 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
693 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
694 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
698 'you have changed the set of files with translatable diagnostics;\n\
699 apply the above patch\n'
701 # Verify that all source files using _() are listed in po/POTFILES.in.
702 po_file = po/POTFILES.in
704 @if test -f $(po_file); then \
705 grep -E -v '^(#|$$)' $(po_file) \
706 | grep -v '^src/false\.c$$' | sort > $@-1; \
708 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
709 test -r $$file || continue; \
711 *.m4|*.mk) continue ;; \
717 base=`expr " $$file" : ' \(.*\)\..'`; \
718 { test -f $$base.l || test -f $$base.y; } && continue;; \
720 files="$$files $$file"; \
722 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
724 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
725 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
729 # Sometimes it is useful to change the PATH environment variable
730 # in Makefiles. When doing so, it's better not to use the Unix-centric
731 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
732 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
733 sc_makefile_path_separator_check:
734 @grep -nE 'PATH[=].*:' \
735 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
736 && { echo $(msg) 1>&2; exit 1; } || :
738 # Check that `make alpha' will not fail at the end of the process.
740 if test -d $(release_archive_dir); then :; else \
741 for file in $(distdir).tar.gz \
742 $(release_archive_dir)/$(distdir).tar.gz; do \
743 test -e $$file || continue; \
745 || { echo ERROR: $$file is not writable; fail=1; }; \
747 test "$$fail" && exit 1 || : ; \
750 v_etc_file = lib/version-etc.c
751 sample-test = tests/sample-test
752 texi = doc/$(PACKAGE).texi
753 # Make sure that the copyright date in $(v_etc_file) is up to date.
754 # Do the same for the $(sample-test) and the main doc/.texi file.
756 @if test -f $(v_etc_file); then \
757 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
759 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
762 @if test -f $(sample-test); then \
763 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
765 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
768 @if test -f $(texi); then \
769 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
771 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
775 # #if HAVE_... will evaluate to false for any non numeric string.
776 # That would be flagged by using -Wundef, however gnulib currently
777 # tests many undefined macros, and so we can't enable that option.
778 # So at least preclude common boolean strings as macro values.
780 @test -e '$(CONFIG_INCLUDE)' && \
781 grep -Ei '^#define.*(yes|no|true|false)$$' '$(CONFIG_INCLUDE)' && \
782 { echo 'Use 0 or 1 for macro values' 1>&2; exit 1; } || :
784 sc_vulnerable_makefile_CVE-2009-4029:
785 @files=$$(find $(srcdir) -name Makefile.in); \
786 if test -n "$$files"; then \
788 'perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
790 { echo '$(ME): the above files are vulnerable; beware of' \
791 'running "make dist*" rules, and upgrade to fixed automake' \
792 'see http://bugzilla.redhat.com/542609 for details' \
793 1>&2; exit 1; } || :; \
798 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
799 if test -s vc-diffs; then \
801 echo "Some files are locally modified:" 1>&2; \
807 rel-files = $(DIST_ARCHIVES)
809 gnulib_dir ?= $(srcdir)/gnulib
810 gnulib-version = $$(cd $(gnulib_dir) && git describe)
811 bootstrap-tools ?= autoconf,automake,gnulib
813 # If it's not already specified, derive the GPG key ID from
814 # the signed tag we've just applied to mark this release.
816 $$(git cat-file tag v$(VERSION) > .ann-sig \
817 && gpgv .ann-sig - < /dev/null 2>&1 \
818 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
820 announcement: NEWS ChangeLog $(rel-files)
821 @$(build_aux)/announce-gen \
822 --release-type=$(RELEASE_TYPE) \
823 --package=$(PACKAGE) \
824 --prev=$(PREV_VERSION) \
826 --gpg-key-id=$(gpg_key_ID) \
827 --news=$(srcdir)/NEWS \
828 --bootstrap-tools=$(bootstrap-tools) \
829 --gnulib-version=$(gnulib-version) \
830 --no-print-checksums \
831 $(addprefix --url-dir=, $(url_dir_list))
833 ## ---------------- ##
834 ## Updating files. ##
835 ## ---------------- ##
837 ftp-gnu = ftp://ftp.gnu.org/gnu
838 www-gnu = http://www.gnu.org
840 upload_dest_dir_ ?= $(PACKAGE)
841 emit_upload_commands:
842 @echo =====================================
843 @echo =====================================
844 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
845 @echo " --to $(gnu_rel_host):$(upload_dest_dir_) \\"
846 @echo " $(rel-files)"
847 @echo '# send the ~/announce-$(my_distdir) e-mail'
848 @echo =====================================
849 @echo =====================================
851 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
852 define emit-commit-log
853 printf '%s\n' 'post-release administrivia' '' \
854 '* NEWS: Add header line for next release.' \
855 '* .prev-version: Record previous version.' \
856 '* cfg.mk (old_NEWS_hash): Auto-update.'
859 .PHONY: no-submodule-changes
860 no-submodule-changes:
861 if test -d $(srcdir)/.git; then \
862 diff=$$(cd $(srcdir) && git submodule -q foreach \
863 git diff-index --name-only HEAD) \
865 case $$diff in '') ;; \
866 *) echo '$(ME): submodule files are locally modified:'; \
867 echo "$$diff"; exit 1;; esac; \
872 .PHONY: alpha beta stable
873 ALL_RECURSIVE_TARGETS += alpha beta stable
874 alpha beta stable: $(local-check) writable-files no-submodule-changes
876 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
877 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
879 $(MAKE) vc-diff-check
882 $(MAKE) dist XZ_OPT=-9ev
883 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
884 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
886 # Override this in cfg.mk if you follow different procedures.
887 release-prep-hook ?= release-prep
891 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
892 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
893 $(MAKE) -s announcement > ~/announce-$(my_distdir)
894 if test -d $(release_archive_dir); then \
895 ln $(rel-files) $(release_archive_dir); \
896 chmod a-w $(rel-files); \
898 echo $(VERSION) > $(prev_version_file)
899 $(MAKE) update-NEWS-hash
900 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
901 $(emit-commit-log) > .ci-msg
902 $(VC) commit -F .ci-msg -a
907 @test -z "$(manual_title)" \
908 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
909 @cd '$(srcdir)/doc'; \
910 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
911 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
912 "$(PACKAGE_NAME) - $(manual_title)"
913 @echo " *** Upload the doc/manual directory to web-cvs."
918 $(MAKE) $(AM_MAKEFLAGS) clean
919 lcov --directory . --zerocounters
921 COVERAGE_CCOPTS ?= "-g --coverage"
922 COVERAGE_OUT ?= doc/coverage
925 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
926 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
927 mkdir -p $(COVERAGE_OUT)
928 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
932 genhtml --output-directory $(COVERAGE_OUT) \
933 $(COVERAGE_OUT)/$(PACKAGE).info \
934 --highlight --frames --legend \
935 --title "$(PACKAGE_NAME)"
937 coverage: init-coverage build-coverage gen-coverage
939 # Update gettext files.
940 PACKAGE ?= $(shell basename $(PWD))
941 PO_DOMAIN ?= $(PACKAGE)
942 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
945 rm -f $(PODIR)/*.po && \
946 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
947 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
948 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
949 echo 'en@quot' >> $(PODIR)/LINGUAS && \
950 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
952 INDENT_SOURCES ?= $(C_SOURCES)
955 indent $(INDENT_SOURCES)
957 # If you want to set UPDATE_COPYRIGHT_* environment variables,
958 # put the assignments in this variable.
959 update-copyright-env ?=
961 # Run this rule once per year (usually early in January)
962 # to update all FSF copyright year lists in your project.
963 # If you have an additional project-specific rule,
964 # add it in cfg.mk along with a line 'update-copyright: prereq'.
965 # By default, exclude all variants of COPYING; you can also
966 # add exemptions (such as ChangeLog..* for rotated change logs)
967 # in the file .x-update-copyright.
968 .PHONY: update-copyright
970 grep -l -w Copyright \
971 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
972 | $(update-copyright-env) xargs $(build_aux)/$@