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
149 # This macro searches for a given construct in the selected files and
150 # then takes some action.
152 # Parameters (shell variables):
156 # Regular expression (ERE) denoting either a forbidden construct
157 # or a required construct. Those arguments are exclusive.
159 # in_vc_files | in_files
161 # grep-E-style regexp denoting the files to check. If no files
162 # are specified the default are all the files that are under
165 # containing | non_containing
167 # Select the files (non) containing strings matching this regexp.
168 # If both arguments are specified then CONTAINING takes
173 # Extra options for grep.
181 # Message to display before to halting execution.
183 # By default, _sc_search_regexp does not ignore case.
185 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
187 define _sc_say_and_exit
188 dummy=; : so we do not need a semicolon before each use; \
189 { echo -e "$(ME): $$msg" 1>&2; exit 1; };
192 define _sc_search_regexp
193 dummy=; : so we do not need a semicolon before each use; \
196 test -n "$$prohibit" && test -n "$$require" \
197 && { msg='Cannot specify both prohibit and require' \
198 $(_sc_say_and_exit) } || :; \
199 test -z "$$prohibit" && test -z "$$require" \
200 && { msg='Should specify either prohibit or require' \
201 $(_sc_say_and_exit) } || :; \
202 test -n "$$in_vc_files" && test -n "$$in_files" \
203 && { msg='Cannot specify both in_vc_files and in_files' \
204 $(_sc_say_and_exit) } || :; \
205 test "x$$halt" != x \
206 || { msg='halt not defined' $(_sc_say_and_exit) }; \
208 : Filter by file name; \
209 if test -n "$$in_files"; then \
210 files=$$(find $(srcdir) | grep -E "$$in_files"); \
212 files=$$($(VC_LIST_EXCEPT)); \
213 if test -n "$$in_vc_files"; then \
214 files=$$(echo "$$files" | grep -E "$$in_vc_files"); \
218 : Filter by content; \
219 test -n "$$files" && test -n "$$containing" \
220 && { files=$$(grep -l "$$containing" $$files); } || :; \
221 test -n "$$files" && test -n "$$non_containing" \
222 && { files=$$(grep -vl "$$non_containing" $$files); } || :; \
224 : Check for the construct; \
225 if test -n "$$files"; then \
226 if test -n "$$prohibit"; then \
227 grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
228 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
230 grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
232 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
238 sc_avoid_if_before_free:
239 @$(build_aux)/useless-if-before-free \
240 $(useless_free_options) \
241 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
242 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
245 sc_cast_of_argument_to_free:
246 @prohibit='\<free *\( *\(' halt='don'\''t cast free argument' \
249 sc_cast_of_x_alloc_return_value:
250 @prohibit='\*\) *x(m|c|re)alloc\>' \
251 halt='don'\''t cast x*alloc return value' \
254 sc_cast_of_alloca_return_value:
255 @prohibit='\*\) *alloca\>' \
256 halt='don'\''t cast alloca return value' \
261 halt='found SPACE-TAB sequence; remove the SPACE' \
264 # Don't use *scanf or the old ato* functions in `real' code.
265 # They provide no error checking mechanism.
266 # Instead, use strto* functions.
267 sc_prohibit_atoi_atof:
268 @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \
269 halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
272 # Use STREQ rather than comparing strcmp == 0, or != 0.
274 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
275 $$($(VC_LIST_EXCEPT)) \
276 | grep -vE ':# *define STREQ\(' && \
277 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
280 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
281 # Convert all uses automatically, via these two commands:
282 # git grep -l '\<exit *(1)' \
283 # | grep -vEf .x-sc_prohibit_magic_number_exit \
284 # | xargs --no-run-if-empty \
285 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
286 # git grep -l '\<exit *(0)' \
287 # | grep -vEf .x-sc_prohibit_magic_number_exit \
288 # | xargs --no-run-if-empty \
289 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
290 sc_prohibit_magic_number_exit:
291 @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
292 halt='use EXIT_* values rather than magic number' \
295 # Using EXIT_SUCCESS as the first argument to error is misleading,
296 # since when that parameter is 0, error does not exit. Use `0' instead.
297 sc_error_exit_success:
298 @prohibit='error *\(EXIT_SUCCESS,' \
299 in_vc_files='\.[chly]$$' \
300 halt='found error (EXIT_SUCCESS' \
303 # `FATAL:' should be fully upper-cased in error messages
304 # `WARNING:' should be fully upper-cased, or fully lower-cased
305 sc_error_message_warn_fatal:
306 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
307 | grep -E '"Warning|"Fatal|"fatal' && \
308 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
311 # Error messages should not start with a capital letter
312 sc_error_message_uppercase:
313 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
315 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
316 { echo '$(ME): found capitalized error message' 1>&2; \
319 # Error messages should not end with a period
320 sc_error_message_period:
321 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
322 | grep -E '[^."]\."' && \
323 { echo '$(ME): found error message ending in period' 1>&2; \
327 @prohibit=file''system \
329 halt='found use of "file''system"; spell it "file system"' \
332 # Don't use cpp tests of this symbol. All code assumes config.h is included.
333 sc_prohibit_have_config_h:
334 @prohibit='^# *if.*HAVE''_CONFIG_H' \
335 halt='found use of HAVE''_CONFIG_H; remove' \
338 # Nearly all .c files must include <config.h>. However, we also permit this
339 # via inclusion of a package-specific header, if cfg.mk specified one.
340 # config_h_header must be suitable for grep -E.
341 config_h_header ?= <config\.h>
343 @require='^# *include $(config_h_header)' \
344 in_vc_files='\.c$$' \
345 halt='the above files do not include <config.h>' \
348 # You must include <config.h> before including any other header file.
349 # This can possibly be via a package-specific header, if given by cfg.mk.
350 sc_require_config_h_first:
351 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
353 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
354 grep '^# *include\>' $$i | sed 1q \
355 | grep -E '^# *include $(config_h_header)' > /dev/null \
356 || { echo $$i; fail=1; }; \
359 { echo '$(ME): the above files include some other header' \
360 'before <config.h>' 1>&2; exit 1; } || :; \
364 sc_prohibit_HAVE_MBRTOWC:
365 @prohibit='\bHAVE_MBRTOWC\b' \
366 halt="do not use $$re; it is always defined" \
369 # To use this "command" macro, you must first define two shell variables:
370 # h: the header, enclosed in <> or ""
371 # re: a regular expression that matches IFF something provided by $h is used.
372 define _sc_header_without_use
373 dummy=; : so we do not need a semicolon before each use; \
374 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
375 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
376 files=$$(grep -l '^# *include '"$$h_esc" \
377 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
378 grep -LE "$$re" $$files | grep . && \
379 { echo "$(ME): the above files include $$h but don't use it" \
380 1>&2; exit 1; } || :; \
385 # Prohibit the inclusion of assert.h without an actual use of assert.
386 sc_prohibit_assert_without_use:
387 @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
389 # Prohibit the inclusion of close-stream.h without an actual use.
390 sc_prohibit_close_stream_without_use:
391 @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
393 # Prohibit the inclusion of getopt.h without an actual use.
394 sc_prohibit_getopt_without_use:
395 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
397 # Don't include quotearg.h unless you use one of its functions.
398 sc_prohibit_quotearg_without_use:
399 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
401 # Don't include quote.h unless you use one of its functions.
402 sc_prohibit_quote_without_use:
403 @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
405 # Don't include this header unless you use one of its functions.
406 sc_prohibit_long_options_without_use:
407 @h='"long-options.h"' re='\<parse_long_options *\(' \
408 $(_sc_header_without_use)
410 # Don't include this header unless you use one of its functions.
411 sc_prohibit_inttostr_without_use:
412 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
413 $(_sc_header_without_use)
415 # Don't include this header unless you use one of its functions.
416 sc_prohibit_ignore_value_without_use:
417 @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
418 $(_sc_header_without_use)
420 # Don't include this header unless you use one of its functions.
421 sc_prohibit_error_without_use:
423 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
424 $(_sc_header_without_use)
426 # Don't include xalloc.h unless you use one of its functions.
427 # Consider these symbols:
428 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
429 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
430 # Divide into two sets on case, and filter each through this:
431 # | sort | perl -MRegexp::Assemble -le \
432 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
433 # Note this was produced by the above:
435 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
436 # But we can do better, in at least two ways:
437 # 1) take advantage of two "dup"-suffixed strings:
438 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
439 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
441 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
442 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
443 _xa2 = X([CZ]|N?M)ALLOC
444 sc_prohibit_xalloc_without_use:
446 re='\<($(_xa1)|$(_xa2)) *\('\
447 $(_sc_header_without_use)
449 # Extract function names:
450 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
452 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
453 _hash_fn = \<($(_hash_re)) *\(
454 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
455 sc_prohibit_hash_without_use:
457 re='$(_hash_fn)|$(_hash_struct)'\
458 $(_sc_header_without_use)
460 sc_prohibit_hash_pjw_without_use:
462 re='\<hash_pjw *\(' \
463 $(_sc_header_without_use)
465 sc_prohibit_safe_read_without_use:
466 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
467 $(_sc_header_without_use)
469 sc_prohibit_argmatch_without_use:
471 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
472 $(_sc_header_without_use)
474 sc_prohibit_canonicalize_without_use:
475 @h='"canonicalize.h"' \
476 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
477 $(_sc_header_without_use)
479 sc_prohibit_root_dev_ino_without_use:
480 @h='"root-dev-ino.h"' \
481 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
482 $(_sc_header_without_use)
484 sc_prohibit_openat_without_use:
486 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
487 $(_sc_header_without_use)
489 # Prohibit the inclusion of c-ctype.h without an actual use.
490 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
491 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
492 sc_prohibit_c_ctype_without_use:
493 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' \
494 $(_sc_header_without_use)
497 _sp = $(_empty) $(_empty)
498 # The following list was generated by running:
499 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
500 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
502 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
503 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
504 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
505 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
506 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
507 # The following were extracted from "man signal.h" manually.
508 _sig_types_and_consts = \
509 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
510 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
511 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
512 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
513 sigstack sigval stack_t ucontext_t
514 # generated via this:
515 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
517 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
518 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
519 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
520 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
521 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
522 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
523 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
525 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
527 # Prohibit the inclusion of signal.h without an actual use.
528 sc_prohibit_signal_without_use:
530 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
531 $(_sc_header_without_use)
533 # Get the list of symbol names with this:
534 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
536 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \
537 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \
538 INT_STRLEN_BOUND INT_BUFSIZE_BOUND
539 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
540 # Prohibit the inclusion of intprops.h without an actual use.
541 sc_prohibit_intprops_without_use:
543 re='\<($(_intprops_syms_re)) *\(' \
544 $(_sc_header_without_use)
547 @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
548 halt='do not use HAVE''_FCNTL_H or O'_NDELAY \
551 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
553 # Each nonempty ChangeLog line must start with a year number, or a TAB.
555 @prohibit='^[^12 ]' \
556 in_vc_files='^ChangeLog$$' \
557 halt='found unexpected prefix in a ChangeLog' \
560 # Ensure that each .c file containing a "main" function also
561 # calls set_program_name.
563 @require='set_program_name *\(m?argv\[0\]\);' \
564 in_vc_files='\.c$$' \
565 containing='^main *(' \
566 halt='the above files do not call set_program_name' \
569 # Require that the final line of each test-lib.sh-using test be this one:
571 # Note: this test requires GNU grep's --label= option.
572 Exit_witness_file ?= tests/test-lib.sh
573 Exit_base := $(notdir $(Exit_witness_file))
574 sc_require_test_exit_idiom:
575 @if test -f $(srcdir)/$(Exit_witness_file); then \
577 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
578 $$($(VC_LIST) tests)); do \
579 tail -n1 $$i | grep '^Exit .' > /dev/null \
580 && : || { die=1; echo $$i; } \
583 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
584 echo 1>&2 'Exit something'; \
589 @prohibit='\<the ''the\>' \
591 halt='found use of "the ''the";' \
596 halt='found trailing blank(s)' \
599 # Match lines like the following, but where there is only one space
600 # between the options and the description:
601 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
602 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
603 sc_two_space_separator_in_usage:
604 @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
605 halt='help2man requires at least two spaces between an option and its description'\
608 # Look for diagnostics that aren't marked for translation.
609 # This won't find any for which error's format string is on a separate line.
610 sc_unmarked_diagnostics:
612 '\<error *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
613 | grep -v '_''(' && \
614 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
617 # Avoid useless parentheses like those in this example:
618 # #if defined (SYMBOL) || defined (SYM2)
619 sc_useless_cpp_parens:
620 @prohibit='^# *if .*defined *\(' \
621 halt='found useless parentheses in cpp directive' \
624 # Require the latest GPL.
626 @prohibit='either ''version [^3]' \
627 halt='GPL vN, N!=3' \
630 # Require the latest GFDL. Two regexp, since some .texi files end up
631 # line wrapping between 'Free Documentation License,' and 'Version'.
632 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
634 @prohibit='$(_GFDL_regexp)' \
635 halt='GFDL vN, N!=3' \
638 # Don't use Texinfo @acronym{} as it is not a good idea.
640 @prohibit='@acronym{' \
641 in_vc_files='\.texi$$' \
642 halt='found use of Texinfo @acronym{}' \
646 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
648 sc_prohibit_cvs_keyword:
649 @prohibit='\$$($(cvs_keywords))\$$' \
650 halt='do not use CVS keyword expansion' \
653 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
654 # This is a bit of a kludge, since it prevents use of the string
655 # even in comments, but for now it does the job with no false positives.
656 sc_prohibit_stat_st_blocks:
657 @prohibit='[.>]st_blocks' \
658 halt='do not use st_blocks; use ST_NBLOCKS' \
661 # Make sure we don't define any S_IS* macros in src/*.c files.
662 # They're already defined via gnulib's sys/stat.h replacement.
663 sc_prohibit_S_IS_definition:
664 @prohibit='^ *# *define *S_IS' \
665 halt='do not define S_IS* macros; include <sys/stat.h>' \
668 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
669 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
670 # Using test's -a and -o operators is not portable.
671 # We prefer test over [, since the latter is spelled [[ in configure.ac.
672 sc_prohibit_test_minus_ao:
673 @re='(\<test| \[+) .+ -[ao] ' \
674 msg='$(_ptm1); $(_ptm2)' \
677 # Each program that uses proper_name_utf8 must link with one of the
678 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
679 # The perl -0777 invocation below extracts the possibly-multi-line
680 # definition of LDADD from the appropriate Makefile.am and exits 0
681 # when it contains "ICONV".
682 sc_proper_name_utf8_requires_ICONV:
683 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
684 if test "x$$progs" != x; then \
686 for p in $$progs; do \
687 dir=$$(dirname "$$p"); \
689 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
690 $$dir/Makefile.am && continue; \
691 base=$$(basename "$$p" .c); \
692 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
693 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
696 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
700 # Warn about "c0nst struct Foo const foo[]",
701 # but not about "char const *const foo" or "#define const const".
703 @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
704 halt='redundant "const" in declarations' \
707 sc_const_long_option:
708 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
709 | grep -Ev 'const struct option|struct option const' && { \
710 echo 1>&2 '$(ME): add "const" to the above declarations'; \
714 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
717 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
721 # Ensure that we don't accidentally insert an entry into an old NEWS block.
723 @if test -f $(srcdir)/NEWS; then \
724 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
725 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
728 # Update the hash stored above. Do this after each release and
729 # for any corrections to old entries.
730 update-NEWS-hash: NEWS
731 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
734 # Ensure that we use only the standard $(VAR) notation,
735 # not @...@ in Makefile.am, now that we can rely on automake
736 # to emit a definition for each substituted variable.
737 # We use perl rather than "grep -nE ..." to exempt a single
738 # use of an @...@-delimited variable name in src/Makefile.am.
739 # Allow the package to add exceptions via a hook in cfg.mk;
740 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
741 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
742 _makefile_at_at_check_exceptions ?=
743 sc_makefile_at_at_check:
744 @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
745 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
746 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
747 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
750 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
754 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
758 sc_makefile_TAB_only_indentation:
759 @prohibit='^ [ ]{8}' \
760 in_vc_files='akefile|\.mk$$' \
761 halt='found TAB-8-space indentation' \
765 @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
766 in_vc_files='(^configure\.ac|\.m4)$$' \
767 halt='quote the first arg to AC_DEF*' \
771 'you have changed the set of files with translatable diagnostics;\n\
772 apply the above patch\n'
774 # Verify that all source files using _() are listed in po/POTFILES.in.
775 po_file = po/POTFILES.in
777 @if test -f $(po_file); then \
778 grep -E -v '^(#|$$)' $(po_file) \
779 | grep -v '^src/false\.c$$' | sort > $@-1; \
781 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
782 test -r $$file || continue; \
784 *.m4|*.mk) continue ;; \
790 base=`expr " $$file" : ' \(.*\)\..'`; \
791 { test -f $$base.l || test -f $$base.y; } && continue;; \
793 files="$$files $$file"; \
795 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
797 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
798 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
802 # Sometimes it is useful to change the PATH environment variable
803 # in Makefiles. When doing so, it's better not to use the Unix-centric
804 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
805 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
806 sc_makefile_path_separator_check:
807 @prohibit='PATH[=].*:' \
808 in_vc_files='akefile|\.mk$$' \
812 # Check that `make alpha' will not fail at the end of the process.
814 if test -d $(release_archive_dir); then :; else \
815 for file in $(distdir).tar.gz \
816 $(release_archive_dir)/$(distdir).tar.gz; do \
817 test -e $$file || continue; \
819 || { echo ERROR: $$file is not writable; fail=1; }; \
821 test "$$fail" && exit 1 || : ; \
824 v_etc_file = lib/version-etc.c
825 sample-test = tests/sample-test
826 texi = doc/$(PACKAGE).texi
827 # Make sure that the copyright date in $(v_etc_file) is up to date.
828 # Do the same for the $(sample-test) and the main doc/.texi file.
830 @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \
831 in_files=$(v_etc_file) \
832 halt='out of date copyright in $(v_etc_file); update it' \
834 @require='# Copyright \(C\) '$$(date +%Y)' Free' \
835 in_vc_files=$(sample-test) \
836 halt='out of date copyright in $(sample-test); update it' \
838 @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \
839 in_vc_files=$(texi) \
840 halt='out of date copyright in $(texi); update it' \
843 # #if HAVE_... will evaluate to false for any non numeric string.
844 # That would be flagged by using -Wundef, however gnulib currently
845 # tests many undefined macros, and so we can't enable that option.
846 # So at least preclude common boolean strings as macro values.
848 @prohibit='^#define.*(yes|no|true|false)$$' \
849 in_files='$(CONFIG_INCLUDE)' \
850 halt='Use 0 or 1 for macro values' \
853 sc_vulnerable_makefile_CVE-2009-4029:
854 @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
855 in_files=$$(find $(srcdir) -name Makefile.in) \
856 halt='the above files are vulnerable; beware of running\n'\
857 '"make dist*" rules, and upgrade to fixed automake\n'\
858 'see http://bugzilla.redhat.com/542609 for details' \
862 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
863 if test -s vc-diffs; then \
865 echo "Some files are locally modified:" 1>&2; \
871 rel-files = $(DIST_ARCHIVES)
873 gnulib_dir ?= $(srcdir)/gnulib
874 gnulib-version = $$(cd $(gnulib_dir) && git describe)
875 bootstrap-tools ?= autoconf,automake,gnulib
877 # If it's not already specified, derive the GPG key ID from
878 # the signed tag we've just applied to mark this release.
880 $$(git cat-file tag v$(VERSION) > .ann-sig \
881 && gpgv .ann-sig - < /dev/null 2>&1 \
882 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
884 announcement: NEWS ChangeLog $(rel-files)
885 @$(build_aux)/announce-gen \
886 --release-type=$(RELEASE_TYPE) \
887 --package=$(PACKAGE) \
888 --prev=$(PREV_VERSION) \
890 --gpg-key-id=$(gpg_key_ID) \
891 --news=$(srcdir)/NEWS \
892 --bootstrap-tools=$(bootstrap-tools) \
893 --gnulib-version=$(gnulib-version) \
894 --no-print-checksums \
895 $(addprefix --url-dir=, $(url_dir_list))
897 ## ---------------- ##
898 ## Updating files. ##
899 ## ---------------- ##
901 ftp-gnu = ftp://ftp.gnu.org/gnu
902 www-gnu = http://www.gnu.org
904 upload_dest_dir_ ?= $(PACKAGE)
905 emit_upload_commands:
906 @echo =====================================
907 @echo =====================================
908 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
909 @echo " --to $(gnu_rel_host):$(upload_dest_dir_) \\"
910 @echo " $(rel-files)"
911 @echo '# send the ~/announce-$(my_distdir) e-mail'
912 @echo =====================================
913 @echo =====================================
915 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
916 define emit-commit-log
917 printf '%s\n' 'post-release administrivia' '' \
918 '* NEWS: Add header line for next release.' \
919 '* .prev-version: Record previous version.' \
920 '* cfg.mk (old_NEWS_hash): Auto-update.'
923 .PHONY: no-submodule-changes
924 no-submodule-changes:
925 if test -d $(srcdir)/.git; then \
926 diff=$$(cd $(srcdir) && git submodule -q foreach \
927 git diff-index --name-only HEAD) \
929 case $$diff in '') ;; \
930 *) echo '$(ME): submodule files are locally modified:'; \
931 echo "$$diff"; exit 1;; esac; \
936 .PHONY: alpha beta stable
937 ALL_RECURSIVE_TARGETS += alpha beta stable
938 alpha beta stable: $(local-check) writable-files no-submodule-changes
940 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
941 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
943 $(MAKE) vc-diff-check
946 $(MAKE) dist XZ_OPT=-9ev
947 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
948 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
950 # Override this in cfg.mk if you follow different procedures.
951 release-prep-hook ?= release-prep
955 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
956 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
957 $(MAKE) -s announcement > ~/announce-$(my_distdir)
958 if test -d $(release_archive_dir); then \
959 ln $(rel-files) $(release_archive_dir); \
960 chmod a-w $(rel-files); \
962 echo $(VERSION) > $(prev_version_file)
963 $(MAKE) update-NEWS-hash
964 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
965 $(emit-commit-log) > .ci-msg
966 $(VC) commit -F .ci-msg -a
971 @test -z "$(manual_title)" \
972 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
973 @cd '$(srcdir)/doc'; \
974 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
975 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
976 "$(PACKAGE_NAME) - $(manual_title)"
977 @echo " *** Upload the doc/manual directory to web-cvs."
982 $(MAKE) $(AM_MAKEFLAGS) clean
983 lcov --directory . --zerocounters
985 COVERAGE_CCOPTS ?= "-g --coverage"
986 COVERAGE_OUT ?= doc/coverage
989 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
990 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
991 mkdir -p $(COVERAGE_OUT)
992 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
996 genhtml --output-directory $(COVERAGE_OUT) \
997 $(COVERAGE_OUT)/$(PACKAGE).info \
998 --highlight --frames --legend \
999 --title "$(PACKAGE_NAME)"
1001 coverage: init-coverage build-coverage gen-coverage
1003 # Update gettext files.
1004 PACKAGE ?= $(shell basename $(PWD))
1005 PO_DOMAIN ?= $(PACKAGE)
1006 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1009 rm -f $(PODIR)/*.po && \
1010 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1011 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1012 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1013 echo 'en@quot' >> $(PODIR)/LINGUAS && \
1014 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1016 INDENT_SOURCES ?= $(C_SOURCES)
1019 indent $(INDENT_SOURCES)
1021 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1022 # put the assignments in this variable.
1023 update-copyright-env ?=
1025 # Run this rule once per year (usually early in January)
1026 # to update all FSF copyright year lists in your project.
1027 # If you have an additional project-specific rule,
1028 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1029 # By default, exclude all variants of COPYING; you can also
1030 # add exemptions (such as ChangeLog..* for rotated change logs)
1031 # in the file .x-update-copyright.
1032 .PHONY: update-copyright
1034 grep -l -w Copyright \
1035 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1036 | $(update-copyright-env) xargs $(build_aux)/$@