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, %, $@)
132 @date +%s.%N > .sc-start-$(basename $@)
134 # Compute and print the elapsed time for each syntax-check rule.
135 sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))
136 .PHONY: $(sc_z_rules_)
137 $(sc_z_rules_): %.z: %
138 @end=$$(date +%s.%N); \
139 start=$$(cat .sc-start-$*); \
140 rm -f .sc-start-$*; \
141 awk -v s=$$start -v e=$$end \
142 'END {printf "%.2f: $* done\n", e - s}' < /dev/null
144 # The patsubst here is to replace each sc_% rule with its sc_%.z wrapper
145 # that computes and prints elapsed time.
147 $(patsubst sc_%, sc_%.z, \
148 $(filter-out $(local-checks-to-skip), $(local-checks-available)))
150 syntax-check: $(local-check)
151 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
152 # $$(find -type f -name '*.[chly]') && \
153 # { echo '$(ME): found conditional include' 1>&2; \
156 # grep -nE '^# *include <(string|stdlib)\.h>' \
157 # $(srcdir)/{lib,src}/*.[chy] && \
158 # { echo '$(ME): FIXME' 1>&2; \
160 # FIXME: don't allow `#include .strings\.h' anywhere
164 # This macro searches for a given construct in the selected files and
165 # then takes some action.
167 # Parameters (shell variables):
171 # Regular expression (ERE) denoting either a forbidden construct
172 # or a required construct. Those arguments are exclusive.
174 # in_vc_files | in_files
176 # grep-E-style regexp denoting the files to check. If no files
177 # are specified the default are all the files that are under
180 # containing | non_containing
182 # Select the files (non) containing strings matching this regexp.
183 # If both arguments are specified then CONTAINING takes
188 # Extra options for grep.
196 # Message to display before to halting execution.
198 # By default, _sc_search_regexp does not ignore case.
200 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
202 define _sc_say_and_exit
203 dummy=; : so we do not need a semicolon before each use; \
204 { echo -e "$(ME): $$msg" 1>&2; exit 1; };
207 # _sc_search_regexp used to be named _prohibit_regexp. However,
208 # upgrading to the new definition and leaving the old name undefined
209 # would usually convert each custom rule using $(_prohibit_regexp)
210 # (usually defined in cfg.mk) into a no-op. This definition ensures
211 # that people know right away if they're still using the old name.
212 # FIXME: remove in 2012.
214 $(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
216 define _sc_search_regexp
217 dummy=; : so we do not need a semicolon before each use; \
220 test -n "$$prohibit" && test -n "$$require" \
221 && { msg='Cannot specify both prohibit and require' \
222 $(_sc_say_and_exit) } || :; \
223 test -z "$$prohibit" && test -z "$$require" \
224 && { msg='Should specify either prohibit or require' \
225 $(_sc_say_and_exit) } || :; \
226 test -n "$$in_vc_files" && test -n "$$in_files" \
227 && { msg='Cannot specify both in_vc_files and in_files' \
228 $(_sc_say_and_exit) } || :; \
229 test "x$$halt" != x \
230 || { msg='halt not defined' $(_sc_say_and_exit) }; \
232 : Filter by file name; \
233 if test -n "$$in_files"; then \
234 files=$$(find $(srcdir) | grep -E "$$in_files"); \
236 files=$$($(VC_LIST_EXCEPT)); \
237 if test -n "$$in_vc_files"; then \
238 files=$$(echo "$$files" | grep -E "$$in_vc_files"); \
242 : Filter by content; \
243 test -n "$$files" && test -n "$$containing" \
244 && { files=$$(grep -l "$$containing" $$files); } || :; \
245 test -n "$$files" && test -n "$$non_containing" \
246 && { files=$$(grep -vl "$$non_containing" $$files); } || :; \
248 : Check for the construct; \
249 if test -n "$$files"; then \
250 if test -n "$$prohibit"; then \
251 grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
252 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
254 grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
256 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
262 sc_avoid_if_before_free:
263 @$(build_aux)/useless-if-before-free \
264 $(useless_free_options) \
265 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
266 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
269 sc_cast_of_argument_to_free:
270 @prohibit='\<free *\( *\(' halt='don'\''t cast free argument' \
273 sc_cast_of_x_alloc_return_value:
274 @prohibit='\*\) *x(m|c|re)alloc\>' \
275 halt='don'\''t cast x*alloc return value' \
278 sc_cast_of_alloca_return_value:
279 @prohibit='\*\) *alloca\>' \
280 halt='don'\''t cast alloca return value' \
285 halt='found SPACE-TAB sequence; remove the SPACE' \
288 # Don't use *scanf or the old ato* functions in `real' code.
289 # They provide no error checking mechanism.
290 # Instead, use strto* functions.
291 sc_prohibit_atoi_atof:
292 @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \
293 halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
296 # Use STREQ rather than comparing strcmp == 0, or != 0.
298 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
299 $$($(VC_LIST_EXCEPT)) \
300 | grep -vE ':# *define STREQ\(' && \
301 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
304 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
305 # Convert all uses automatically, via these two commands:
306 # git grep -l '\<exit *(1)' \
307 # | grep -vEf .x-sc_prohibit_magic_number_exit \
308 # | xargs --no-run-if-empty \
309 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
310 # git grep -l '\<exit *(0)' \
311 # | grep -vEf .x-sc_prohibit_magic_number_exit \
312 # | xargs --no-run-if-empty \
313 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
314 sc_prohibit_magic_number_exit:
315 @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
316 halt='use EXIT_* values rather than magic number' \
319 # Using EXIT_SUCCESS as the first argument to error is misleading,
320 # since when that parameter is 0, error does not exit. Use `0' instead.
321 sc_error_exit_success:
322 @prohibit='error *\(EXIT_SUCCESS,' \
323 in_vc_files='\.[chly]$$' \
324 halt='found error (EXIT_SUCCESS' \
327 # `FATAL:' should be fully upper-cased in error messages
328 # `WARNING:' should be fully upper-cased, or fully lower-cased
329 sc_error_message_warn_fatal:
330 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
331 | grep -E '"Warning|"Fatal|"fatal' && \
332 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
335 # Error messages should not start with a capital letter
336 sc_error_message_uppercase:
337 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
339 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
340 { echo '$(ME): found capitalized error message' 1>&2; \
343 # Error messages should not end with a period
344 sc_error_message_period:
345 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
346 | grep -E '[^."]\."' && \
347 { echo '$(ME): found error message ending in period' 1>&2; \
351 @prohibit=file''system \
353 halt='found use of "file''system"; spell it "file system"' \
356 # Don't use cpp tests of this symbol. All code assumes config.h is included.
357 sc_prohibit_have_config_h:
358 @prohibit='^# *if.*HAVE''_CONFIG_H' \
359 halt='found use of HAVE''_CONFIG_H; remove' \
362 # Nearly all .c files must include <config.h>. However, we also permit this
363 # via inclusion of a package-specific header, if cfg.mk specified one.
364 # config_h_header must be suitable for grep -E.
365 config_h_header ?= <config\.h>
367 @require='^# *include $(config_h_header)' \
368 in_vc_files='\.c$$' \
369 halt='the above files do not include <config.h>' \
372 # You must include <config.h> before including any other header file.
373 # This can possibly be via a package-specific header, if given by cfg.mk.
374 sc_require_config_h_first:
375 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
377 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
378 grep '^# *include\>' $$i | sed 1q \
379 | grep -E '^# *include $(config_h_header)' > /dev/null \
380 || { echo $$i; fail=1; }; \
383 { echo '$(ME): the above files include some other header' \
384 'before <config.h>' 1>&2; exit 1; } || :; \
388 sc_prohibit_HAVE_MBRTOWC:
389 @prohibit='\bHAVE_MBRTOWC\b' \
390 halt="do not use $$prohibit; it is always defined" \
393 # To use this "command" macro, you must first define two shell variables:
394 # h: the header, enclosed in <> or ""
395 # re: a regular expression that matches IFF something provided by $h is used.
396 define _sc_header_without_use
397 dummy=; : so we do not need a semicolon before each use; \
398 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
399 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
400 files=$$(grep -l '^# *include '"$$h_esc" \
401 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
402 grep -LE "$$re" $$files | grep . && \
403 { echo "$(ME): the above files include $$h but don't use it" \
404 1>&2; exit 1; } || :; \
409 # Prohibit the inclusion of assert.h without an actual use of assert.
410 sc_prohibit_assert_without_use:
411 @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
413 # Prohibit the inclusion of close-stream.h without an actual use.
414 sc_prohibit_close_stream_without_use:
415 @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
417 # Prohibit the inclusion of getopt.h without an actual use.
418 sc_prohibit_getopt_without_use:
419 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
421 # Don't include quotearg.h unless you use one of its functions.
422 sc_prohibit_quotearg_without_use:
423 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
425 # Don't include quote.h unless you use one of its functions.
426 sc_prohibit_quote_without_use:
427 @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
429 # Don't include this header unless you use one of its functions.
430 sc_prohibit_long_options_without_use:
431 @h='"long-options.h"' re='\<parse_long_options *\(' \
432 $(_sc_header_without_use)
434 # Don't include this header unless you use one of its functions.
435 sc_prohibit_inttostr_without_use:
436 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
437 $(_sc_header_without_use)
439 # Don't include this header unless you use one of its functions.
440 sc_prohibit_ignore_value_without_use:
441 @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
442 $(_sc_header_without_use)
444 # Don't include this header unless you use one of its functions.
445 sc_prohibit_error_without_use:
447 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
448 $(_sc_header_without_use)
450 # Don't include xalloc.h unless you use one of its functions.
451 # Consider these symbols:
452 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
453 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
454 # Divide into two sets on case, and filter each through this:
455 # | sort | perl -MRegexp::Assemble -le \
456 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
457 # Note this was produced by the above:
459 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
460 # But we can do better, in at least two ways:
461 # 1) take advantage of two "dup"-suffixed strings:
462 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
463 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
465 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
466 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
467 _xa2 = X([CZ]|N?M)ALLOC
468 sc_prohibit_xalloc_without_use:
470 re='\<($(_xa1)|$(_xa2)) *\('\
471 $(_sc_header_without_use)
473 # Extract function names:
474 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
476 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
477 _hash_fn = \<($(_hash_re)) *\(
478 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
479 sc_prohibit_hash_without_use:
481 re='$(_hash_fn)|$(_hash_struct)'\
482 $(_sc_header_without_use)
484 sc_prohibit_hash_pjw_without_use:
486 re='\<hash_pjw *\(' \
487 $(_sc_header_without_use)
489 sc_prohibit_safe_read_without_use:
490 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
491 $(_sc_header_without_use)
493 sc_prohibit_argmatch_without_use:
495 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
496 $(_sc_header_without_use)
498 sc_prohibit_canonicalize_without_use:
499 @h='"canonicalize.h"' \
500 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
501 $(_sc_header_without_use)
503 sc_prohibit_root_dev_ino_without_use:
504 @h='"root-dev-ino.h"' \
505 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
506 $(_sc_header_without_use)
508 sc_prohibit_openat_without_use:
510 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
511 $(_sc_header_without_use)
513 # Prohibit the inclusion of c-ctype.h without an actual use.
514 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
515 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
516 sc_prohibit_c_ctype_without_use:
517 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' \
518 $(_sc_header_without_use)
521 _sp = $(_empty) $(_empty)
522 # The following list was generated by running:
523 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
524 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
526 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
527 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
528 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
529 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
530 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
531 # The following were extracted from "man signal.h" manually.
532 _sig_types_and_consts = \
533 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
534 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
535 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
536 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
537 sigstack sigval stack_t ucontext_t
538 # generated via this:
539 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
541 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
542 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
543 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
544 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
545 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
546 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
547 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
549 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
551 # Prohibit the inclusion of signal.h without an actual use.
552 sc_prohibit_signal_without_use:
554 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
555 $(_sc_header_without_use)
557 # Get the list of symbol names with this:
558 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
560 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \
561 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \
562 INT_STRLEN_BOUND INT_BUFSIZE_BOUND
563 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
564 # Prohibit the inclusion of intprops.h without an actual use.
565 sc_prohibit_intprops_without_use:
567 re='\<($(_intprops_syms_re)) *\(' \
568 $(_sc_header_without_use)
571 @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
572 halt='do not use HAVE''_FCNTL_H or O'_NDELAY \
575 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
577 # Each nonempty ChangeLog line must start with a year number, or a TAB.
579 @prohibit='^[^12 ]' \
580 in_vc_files='^ChangeLog$$' \
581 halt='found unexpected prefix in a ChangeLog' \
584 # Ensure that each .c file containing a "main" function also
585 # calls set_program_name.
587 @require='set_program_name *\(m?argv\[0\]\);' \
588 in_vc_files='\.c$$' \
589 containing='^main *(' \
590 halt='the above files do not call set_program_name' \
593 # Require that the final line of each test-lib.sh-using test be this one:
595 # Note: this test requires GNU grep's --label= option.
596 Exit_witness_file ?= tests/test-lib.sh
597 Exit_base := $(notdir $(Exit_witness_file))
598 sc_require_test_exit_idiom:
599 @if test -f $(srcdir)/$(Exit_witness_file); then \
601 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
602 $$($(VC_LIST) tests)); do \
603 tail -n1 $$i | grep '^Exit .' > /dev/null \
604 && : || { die=1; echo $$i; } \
607 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
608 echo 1>&2 'Exit something'; \
613 @prohibit='\<the ''the\>' \
615 halt='found use of "the ''the";' \
620 halt='found trailing blank(s)' \
623 # Match lines like the following, but where there is only one space
624 # between the options and the description:
625 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
626 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
627 sc_two_space_separator_in_usage:
628 @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
629 halt='help2man requires at least two spaces between an option and its description'\
632 # Look for diagnostics that aren't marked for translation.
633 # This won't find any for which error's format string is on a separate line.
634 sc_unmarked_diagnostics:
636 '\<error *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
637 | grep -v '_''(' && \
638 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
641 # Avoid useless parentheses like those in this example:
642 # #if defined (SYMBOL) || defined (SYM2)
643 sc_useless_cpp_parens:
644 @prohibit='^# *if .*defined *\(' \
645 halt='found useless parentheses in cpp directive' \
648 # Require the latest GPL.
650 @prohibit='either ''version [^3]' \
651 halt='GPL vN, N!=3' \
654 # Require the latest GFDL. Two regexp, since some .texi files end up
655 # line wrapping between 'Free Documentation License,' and 'Version'.
656 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
658 @prohibit='$(_GFDL_regexp)' \
659 halt='GFDL vN, N!=3' \
662 # Don't use Texinfo @acronym{} as it is not a good idea.
664 @prohibit='@acronym{' \
665 in_vc_files='\.texi$$' \
666 halt='found use of Texinfo @acronym{}' \
670 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
672 sc_prohibit_cvs_keyword:
673 @prohibit='\$$($(cvs_keywords))\$$' \
674 halt='do not use CVS keyword expansion' \
677 # The following tail+perl pipeline would be more concise, and would
678 # produce slightly better output (including counts) if written as
679 # perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
680 # but that would be far less efficient, reading the entire contents
681 # of each file, rather than just the last few bytes of each.
683 # This is a perl script that operates on the output of
684 # tail -n1 TWO_OR_MORE_FILES
685 # Print the name of each file that ends in two or more newline bytes.
686 # Exit nonzero if at least one such file is found, otherwise, exit 0.
688 # Use this if you want to remove trailing empty lines from selected files:
689 # perl -pi -0777 -e 's/\n\n+$/\n/' files...
691 detect_empty_lines_at_EOF_ = \
692 /^==> ([^\n]+) <==\n\n\n/m and (print "$$1\n"), $$fail = 1; \
693 END { exit defined $$fail }
694 sc_prohibit_empty_lines_at_EOF:
695 @tail -n1 $$($(VC_LIST_EXCEPT)) /dev/null \
696 | perl -00 -ne '$(detect_empty_lines_at_EOF_)' \
697 || { echo '$(ME): the above files end with empty line(s)' \
698 1>&2; exit 1; } || :; \
700 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
701 # This is a bit of a kludge, since it prevents use of the string
702 # even in comments, but for now it does the job with no false positives.
703 sc_prohibit_stat_st_blocks:
704 @prohibit='[.>]st_blocks' \
705 halt='do not use st_blocks; use ST_NBLOCKS' \
708 # Make sure we don't define any S_IS* macros in src/*.c files.
709 # They're already defined via gnulib's sys/stat.h replacement.
710 sc_prohibit_S_IS_definition:
711 @prohibit='^ *# *define *S_IS' \
712 halt='do not define S_IS* macros; include <sys/stat.h>' \
715 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
716 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
717 # Using test's -a and -o operators is not portable.
718 # We prefer test over [, since the latter is spelled [[ in configure.ac.
719 sc_prohibit_test_minus_ao:
720 @prohibit='(\<test| \[+) .+ -[ao] ' \
721 halt='$(_ptm1); $(_ptm2)' \
724 # Each program that uses proper_name_utf8 must link with one of the
725 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
726 # The perl -0777 invocation below extracts the possibly-multi-line
727 # definition of LDADD from the appropriate Makefile.am and exits 0
728 # when it contains "ICONV".
729 sc_proper_name_utf8_requires_ICONV:
730 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
731 if test "x$$progs" != x; then \
733 for p in $$progs; do \
734 dir=$$(dirname "$$p"); \
736 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
737 $$dir/Makefile.am && continue; \
738 base=$$(basename "$$p" .c); \
739 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
740 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
743 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
747 # Warn about "c0nst struct Foo const foo[]",
748 # but not about "char const *const foo" or "#define const const".
750 @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
751 halt='redundant "const" in declarations' \
754 sc_const_long_option:
755 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
756 | grep -Ev 'const struct option|struct option const' && { \
757 echo 1>&2 '$(ME): add "const" to the above declarations'; \
761 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
764 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
768 # Ensure that we don't accidentally insert an entry into an old NEWS block.
770 @if test -f $(srcdir)/NEWS; then \
771 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
772 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
775 # Update the hash stored above. Do this after each release and
776 # for any corrections to old entries.
777 update-NEWS-hash: NEWS
778 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
781 # Ensure that we use only the standard $(VAR) notation,
782 # not @...@ in Makefile.am, now that we can rely on automake
783 # to emit a definition for each substituted variable.
784 # We use perl rather than "grep -nE ..." to exempt a single
785 # use of an @...@-delimited variable name in src/Makefile.am.
786 # Allow the package to add exceptions via a hook in cfg.mk;
787 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
788 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
789 _makefile_at_at_check_exceptions ?=
790 sc_makefile_at_at_check:
791 @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
792 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
793 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
794 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
797 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
801 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
805 sc_makefile_TAB_only_indentation:
806 @prohibit='^ [ ]{8}' \
807 in_vc_files='akefile|\.mk$$' \
808 halt='found TAB-8-space indentation' \
812 @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
813 in_vc_files='(^configure\.ac|\.m4)$$' \
814 halt='quote the first arg to AC_DEF*' \
818 'you have changed the set of files with translatable diagnostics;\n\
819 apply the above patch\n'
821 # Verify that all source files using _() are listed in po/POTFILES.in.
822 po_file = po/POTFILES.in
824 @if test -f $(po_file); then \
825 grep -E -v '^(#|$$)' $(po_file) \
826 | grep -v '^src/false\.c$$' | sort > $@-1; \
828 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
829 test -r $$file || continue; \
831 *.m4|*.mk) continue ;; \
837 base=`expr " $$file" : ' \(.*\)\..'`; \
838 { test -f $$base.l || test -f $$base.y; } && continue;; \
840 files="$$files $$file"; \
842 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
844 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
845 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
849 # Sometimes it is useful to change the PATH environment variable
850 # in Makefiles. When doing so, it's better not to use the Unix-centric
851 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
852 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
853 sc_makefile_path_separator_check:
854 @prohibit='PATH[=].*:' \
855 in_vc_files='akefile|\.mk$$' \
859 # Check that `make alpha' will not fail at the end of the process.
861 if test -d $(release_archive_dir); then :; else \
862 for file in $(distdir).tar.gz \
863 $(release_archive_dir)/$(distdir).tar.gz; do \
864 test -e $$file || continue; \
866 || { echo ERROR: $$file is not writable; fail=1; }; \
868 test "$$fail" && exit 1 || : ; \
871 v_etc_file = lib/version-etc.c
872 sample-test = tests/sample-test
873 texi = doc/$(PACKAGE).texi
874 # Make sure that the copyright date in $(v_etc_file) is up to date.
875 # Do the same for the $(sample-test) and the main doc/.texi file.
877 @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \
878 in_files=$(v_etc_file) \
879 halt='out of date copyright in $(v_etc_file); update it' \
881 @require='# Copyright \(C\) '$$(date +%Y)' Free' \
882 in_vc_files=$(sample-test) \
883 halt='out of date copyright in $(sample-test); update it' \
885 @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \
886 in_vc_files=$(texi) \
887 halt='out of date copyright in $(texi); update it' \
890 # If tests/help-version exists and seems to be new enough, assume that its
891 # use of init.sh and path_prepend_ is correct, and ensure that every other
892 # use of init.sh is identical.
893 # This is useful because help-version cross-checks prog --version
894 # with $(VERSION), which verifies that its path_prepend_ invocation
895 # sets PATH correctly. This is an inexpensive way to ensure that
896 # the other init.sh-using tests also get it right.
897 _hv_file ?= $(srcdir)/tests/help-version
898 _hv_regex ?= ^ *\. [^ ]*/init\.sh
899 sc_cross_check_PATH_usage_in_tests:
900 @if test -f $(_hv_file); then \
901 if grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \
902 && grep -lE '$(_hv_regex)' $(_hv_file) >/dev/null; then \
903 good=$$(grep -E '$(_hv_regex)' < $(_hv_file)); \
905 $$(grep -lE '$(_hv_regex)' $$($(VC_LIST_EXCEPT))) \
907 { echo "$(ME): the above files use path_prepend_ inconsistently" \
908 1>&2; exit 1; } || :; \
911 echo "$@: skipped: no such file: $(_hv_file)"; \
914 # #if HAVE_... will evaluate to false for any non numeric string.
915 # That would be flagged by using -Wundef, however gnulib currently
916 # tests many undefined macros, and so we can't enable that option.
917 # So at least preclude common boolean strings as macro values.
919 @prohibit='^#define.*(yes|no|true|false)$$' \
920 in_files='$(CONFIG_INCLUDE)' \
921 halt='Use 0 or 1 for macro values' \
924 sc_vulnerable_makefile_CVE-2009-4029:
925 @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
926 in_files=$$(find $(srcdir) -name Makefile.in) \
927 halt='the above files are vulnerable; beware of running\n'\
928 '"make dist*" rules, and upgrade to fixed automake\n'\
929 'see http://bugzilla.redhat.com/542609 for details' \
933 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
934 if test -s vc-diffs; then \
936 echo "Some files are locally modified:" 1>&2; \
942 rel-files = $(DIST_ARCHIVES)
944 gnulib_dir ?= $(srcdir)/gnulib
945 gnulib-version = $$(cd $(gnulib_dir) && git describe)
946 bootstrap-tools ?= autoconf,automake,gnulib
948 # If it's not already specified, derive the GPG key ID from
949 # the signed tag we've just applied to mark this release.
951 $$(git cat-file tag v$(VERSION) > .ann-sig \
952 && gpgv .ann-sig - < /dev/null 2>&1 \
953 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
955 announcement: NEWS ChangeLog $(rel-files)
956 @$(build_aux)/announce-gen \
957 --release-type=$(RELEASE_TYPE) \
958 --package=$(PACKAGE) \
959 --prev=$(PREV_VERSION) \
961 --gpg-key-id=$(gpg_key_ID) \
962 --news=$(srcdir)/NEWS \
963 --bootstrap-tools=$(bootstrap-tools) \
964 --gnulib-version=$(gnulib-version) \
965 --no-print-checksums \
966 $(addprefix --url-dir=, $(url_dir_list))
968 ## ---------------- ##
969 ## Updating files. ##
970 ## ---------------- ##
972 ftp-gnu = ftp://ftp.gnu.org/gnu
973 www-gnu = http://www.gnu.org
975 upload_dest_dir_ ?= $(PACKAGE)
976 emit_upload_commands:
977 @echo =====================================
978 @echo =====================================
979 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
980 @echo " --to $(gnu_rel_host):$(upload_dest_dir_) \\"
981 @echo " $(rel-files)"
982 @echo '# send the ~/announce-$(my_distdir) e-mail'
983 @echo =====================================
984 @echo =====================================
986 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
987 define emit-commit-log
988 printf '%s\n' 'post-release administrivia' '' \
989 '* NEWS: Add header line for next release.' \
990 '* .prev-version: Record previous version.' \
991 '* cfg.mk (old_NEWS_hash): Auto-update.'
994 .PHONY: no-submodule-changes
995 no-submodule-changes:
996 if test -d $(srcdir)/.git; then \
997 diff=$$(cd $(srcdir) && git submodule -q foreach \
998 git diff-index --name-only HEAD) \
1000 case $$diff in '') ;; \
1001 *) echo '$(ME): submodule files are locally modified:'; \
1002 echo "$$diff"; exit 1;; esac; \
1007 .PHONY: alpha beta stable
1008 ALL_RECURSIVE_TARGETS += alpha beta stable
1009 alpha beta stable: $(local-check) writable-files no-submodule-changes
1011 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
1012 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
1014 $(MAKE) vc-diff-check
1017 $(MAKE) dist XZ_OPT=-9ev
1018 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1019 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1021 # Override this in cfg.mk if you follow different procedures.
1022 release-prep-hook ?= release-prep
1024 .PHONY: release-prep
1026 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1027 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1028 $(MAKE) -s announcement > ~/announce-$(my_distdir)
1029 if test -d $(release_archive_dir); then \
1030 ln $(rel-files) $(release_archive_dir); \
1031 chmod a-w $(rel-files); \
1033 echo $(VERSION) > $(prev_version_file)
1034 $(MAKE) update-NEWS-hash
1035 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
1036 $(emit-commit-log) > .ci-msg
1037 $(VC) commit -F .ci-msg -a
1042 @test -z "$(manual_title)" \
1043 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
1044 @cd '$(srcdir)/doc'; \
1045 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
1046 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
1047 "$(PACKAGE_NAME) - $(manual_title)"
1048 @echo " *** Upload the doc/manual directory to web-cvs."
1053 $(MAKE) $(AM_MAKEFLAGS) clean
1054 lcov --directory . --zerocounters
1056 COVERAGE_CCOPTS ?= "-g --coverage"
1057 COVERAGE_OUT ?= doc/coverage
1060 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
1061 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
1062 mkdir -p $(COVERAGE_OUT)
1063 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
1067 genhtml --output-directory $(COVERAGE_OUT) \
1068 $(COVERAGE_OUT)/$(PACKAGE).info \
1069 --highlight --frames --legend \
1070 --title "$(PACKAGE_NAME)"
1072 coverage: init-coverage build-coverage gen-coverage
1074 # Update gettext files.
1075 PACKAGE ?= $(shell basename $(PWD))
1076 PO_DOMAIN ?= $(PACKAGE)
1077 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1080 rm -f $(PODIR)/*.po && \
1081 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1082 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1083 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1084 echo 'en@quot' >> $(PODIR)/LINGUAS && \
1085 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1087 INDENT_SOURCES ?= $(C_SOURCES)
1090 indent $(INDENT_SOURCES)
1092 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1093 # put the assignments in this variable.
1094 update-copyright-env ?=
1096 # Run this rule once per year (usually early in January)
1097 # to update all FSF copyright year lists in your project.
1098 # If you have an additional project-specific rule,
1099 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1100 # By default, exclude all variants of COPYING; you can also
1101 # add exemptions (such as ChangeLog..* for rotated change logs)
1102 # in the file .x-update-copyright.
1103 .PHONY: update-copyright
1105 grep -l -w Copyright \
1106 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1107 | $(update-copyright-env) xargs $(build_aux)/$@