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-2011 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 \
31 && printf %s --rsyncable)
32 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
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 $(if $(exclude_file_name_regexp--$@),$(exclude_file_name_regexp--$@),^$$)
62 $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
63 | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
64 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
65 | grep -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \
66 $(_prepend_srcdir_prefix)
68 ifeq ($(origin prev_version_file), undefined)
69 prev_version_file = $(srcdir)/.prev-version
72 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
73 VERSION_REGEXP = $(subst .,\.,$(VERSION))
74 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
77 this-vc-tag = v$(VERSION)
78 this-vc-tag-regexp = v$(VERSION_REGEXP)
80 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
81 tag-this-version = $(subst .,_,$(VERSION))
82 this-vc-tag = $(tag-package)-$(tag-this-version)
83 this-vc-tag-regexp = $(this-vc-tag)
85 my_distdir = $(PACKAGE)-$(VERSION)
87 # Old releases are stored here.
88 release_archive_dir ?= ../release
90 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
91 # Use alpha.gnu.org for alpha and beta releases.
92 # Use ftp.gnu.org for stable releases.
93 gnu_ftp_host-alpha = alpha.gnu.org
94 gnu_ftp_host-beta = alpha.gnu.org
95 gnu_ftp_host-stable = ftp.gnu.org
96 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
98 ifeq ($(gnu_rel_host),ftp.gnu.org)
99 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
101 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
104 # Override this in cfg.mk if you are using a different format in your
106 today = $(shell date +%Y-%m-%d)
108 # Select which lines of NEWS are searched for $(news-check-regexp).
109 # This is a sed line number spec. The default says that we search
110 # lines 1..10 of NEWS for $(news-check-regexp).
111 # If you want to search only line 3 or only lines 20-22, use "3" or "20,22".
112 news-check-lines-spec ?= 1,10
113 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
115 # Prevent programs like 'sort' from considering distinct strings to be equal.
116 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
119 ## --------------- ##
121 ## --------------- ##
123 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
125 # Collect the names of rules starting with `sc_'.
126 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
127 $(srcdir)/$(ME) $(_cfg_mk)))
128 .PHONY: $(syntax-check-rules)
130 ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0)
131 local-checks-available += $(syntax-check-rules)
133 local-checks-available += no-vc-detected
135 @echo "No version control files detected; skipping syntax check"
137 .PHONY: $(local-checks-available)
139 # Arrange to print the name of each syntax-checking rule just before running it.
140 $(syntax-check-rules): %: %.m
141 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
142 .PHONY: $(sc_m_rules_)
144 @echo $(patsubst sc_%.m, %, $@)
145 @date +%s.%N > .sc-start-$(basename $@)
147 # Compute and print the elapsed time for each syntax-check rule.
148 sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))
149 .PHONY: $(sc_z_rules_)
150 $(sc_z_rules_): %.z: %
151 @end=$$(date +%s.%N); \
152 start=$$(cat .sc-start-$*); \
153 rm -f .sc-start-$*; \
154 awk -v s=$$start -v e=$$end \
155 'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null
157 # The patsubst here is to replace each sc_% rule with its sc_%.z wrapper
158 # that computes and prints elapsed time.
160 $(patsubst sc_%, sc_%.z, \
161 $(filter-out $(local-checks-to-skip), $(local-checks-available)))
163 syntax-check: $(local-check)
167 # This macro searches for a given construct in the selected files and
168 # then takes some action.
170 # Parameters (shell variables):
174 # Regular expression (ERE) denoting either a forbidden construct
175 # or a required construct. Those arguments are exclusive.
177 # in_vc_files | in_files
179 # grep-E-style regexp denoting the files to check. If no files
180 # are specified the default are all the files that are under
183 # containing | non_containing
185 # Select the files (non) containing strings matching this regexp.
186 # If both arguments are specified then CONTAINING takes
191 # Extra options for grep.
199 # Message to display before to halting execution.
201 # Finally, you may exempt files based on an ERE matching file names.
202 # For example, to exempt from the sc_space_tab check all files with the
203 # .diff suffix, set this Make variable:
205 # exclude_file_name_regexp--sc_space_tab = \.diff$
207 # Note that while this functionality is mostly inherited via VC_LIST_EXCEPT,
208 # when filtering by name via in_files, we explicitly filter out matching
209 # names here as well.
211 # By default, _sc_search_regexp does not ignore case.
213 _ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :)
215 define _sc_say_and_exit
216 dummy=; : so we do not need a semicolon before each use; \
217 { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; };
220 # _sc_search_regexp used to be named _prohibit_regexp. However,
221 # upgrading to the new definition and leaving the old name undefined
222 # would usually convert each custom rule using $(_prohibit_regexp)
223 # (usually defined in cfg.mk) into a no-op. This definition ensures
224 # that people know right away if they're still using the old name.
225 # FIXME: remove in 2012.
227 $(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
229 define _sc_search_regexp
230 dummy=; : so we do not need a semicolon before each use; \
233 test -n "$$prohibit" && test -n "$$require" \
234 && { msg='Cannot specify both prohibit and require' \
235 $(_sc_say_and_exit) } || :; \
236 test -z "$$prohibit" && test -z "$$require" \
237 && { msg='Should specify either prohibit or require' \
238 $(_sc_say_and_exit) } || :; \
239 test -n "$$in_vc_files" && test -n "$$in_files" \
240 && { msg='Cannot specify both in_vc_files and in_files' \
241 $(_sc_say_and_exit) } || :; \
242 test "x$$halt" != x \
243 || { msg='halt not defined' $(_sc_say_and_exit) }; \
245 : Filter by file name; \
246 if test -n "$$in_files"; then \
247 files=$$(find $(srcdir) | grep -E "$$in_files" \
248 | grep -Ev '$(exclude_file_name_regexp--$@)'); \
250 files=$$($(VC_LIST_EXCEPT)); \
251 if test -n "$$in_vc_files"; then \
252 files=$$(echo "$$files" | grep -E "$$in_vc_files"); \
256 : Filter by content; \
257 test -n "$$files" && test -n "$$containing" \
258 && { files=$$(grep -l "$$containing" $$files); } || :; \
259 test -n "$$files" && test -n "$$non_containing" \
260 && { files=$$(grep -vl "$$non_containing" $$files); } || :; \
262 : Check for the construct; \
263 if test -n "$$files"; then \
264 if test -n "$$prohibit"; then \
265 grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
266 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
268 grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
270 && { msg="$$halt" $(_sc_say_and_exit) } || :; \
276 sc_avoid_if_before_free:
277 @$(build_aux)/useless-if-before-free \
278 $(useless_free_options) \
279 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
280 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
283 sc_cast_of_argument_to_free:
284 @prohibit='\<free *\( *\(' halt='don'\''t cast free argument' \
287 sc_cast_of_x_alloc_return_value:
288 @prohibit='\*\) *x(m|c|re)alloc\>' \
289 halt='don'\''t cast x*alloc return value' \
292 sc_cast_of_alloca_return_value:
293 @prohibit='\*\) *alloca\>' \
294 halt='don'\''t cast alloca return value' \
299 halt='found SPACE-TAB sequence; remove the SPACE' \
302 # Don't use *scanf or the old ato* functions in `real' code.
303 # They provide no error checking mechanism.
304 # Instead, use strto* functions.
305 sc_prohibit_atoi_atof:
306 @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \
307 halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
310 # Use STREQ rather than comparing strcmp == 0, or != 0.
312 @grep -nE '! *str''cmp *\(|\<str''cmp *\(.+\) *[!=]=' \
313 $$($(VC_LIST_EXCEPT)) \
314 | grep -vE ':# *define STRN?EQ\(' && \
315 { echo '$(ME): replace str''cmp calls above with STREQ/STRNEQ' \
318 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
319 # Convert all uses automatically, via these two commands:
320 # git grep -l '\<exit *(1)' \
321 # | grep -vEf .x-sc_prohibit_magic_number_exit \
322 # | xargs --no-run-if-empty \
323 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
324 # git grep -l '\<exit *(0)' \
325 # | grep -vEf .x-sc_prohibit_magic_number_exit \
326 # | xargs --no-run-if-empty \
327 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
328 sc_prohibit_magic_number_exit:
329 @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
330 halt='use EXIT_* values rather than magic number' \
333 # Using EXIT_SUCCESS as the first argument to error is misleading,
334 # since when that parameter is 0, error does not exit. Use `0' instead.
335 sc_error_exit_success:
336 @prohibit='error *\(EXIT_SUCCESS,' \
337 in_vc_files='\.[chly]$$' \
338 halt='found error (EXIT_SUCCESS' \
341 # `FATAL:' should be fully upper-cased in error messages
342 # `WARNING:' should be fully upper-cased, or fully lower-cased
343 sc_error_message_warn_fatal:
344 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
345 | grep -E '"Warning|"Fatal|"fatal' && \
346 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
349 # Error messages should not start with a capital letter
350 sc_error_message_uppercase:
351 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
353 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
354 { echo '$(ME): found capitalized error message' 1>&2; \
357 # Error messages should not end with a period
358 sc_error_message_period:
359 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
360 | grep -E '[^."]\."' && \
361 { echo '$(ME): found error message ending in period' 1>&2; \
365 @prohibit=file''system \
367 halt='found use of "file''system"; spell it "file system"' \
370 # Don't use cpp tests of this symbol. All code assumes config.h is included.
371 sc_prohibit_have_config_h:
372 @prohibit='^# *if.*HAVE''_CONFIG_H' \
373 halt='found use of HAVE''_CONFIG_H; remove' \
376 # Nearly all .c files must include <config.h>. However, we also permit this
377 # via inclusion of a package-specific header, if cfg.mk specified one.
378 # config_h_header must be suitable for grep -E.
379 config_h_header ?= <config\.h>
381 @require='^# *include $(config_h_header)' \
382 in_vc_files='\.c$$' \
383 halt='the above files do not include <config.h>' \
386 # You must include <config.h> before including any other header file.
387 # This can possibly be via a package-specific header, if given by cfg.mk.
388 sc_require_config_h_first:
389 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
391 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
392 grep '^# *include\>' $$i | sed 1q \
393 | grep -E '^# *include $(config_h_header)' > /dev/null \
394 || { echo $$i; fail=1; }; \
397 { echo '$(ME): the above files include some other header' \
398 'before <config.h>' 1>&2; exit 1; } || :; \
402 sc_prohibit_HAVE_MBRTOWC:
403 @prohibit='\bHAVE_MBRTOWC\b' \
404 halt="do not use $$prohibit; it is always defined" \
407 # To use this "command" macro, you must first define two shell variables:
408 # h: the header, enclosed in <> or ""
409 # re: a regular expression that matches IFF something provided by $h is used.
410 define _sc_header_without_use
411 dummy=; : so we do not need a semicolon before each use; \
412 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
413 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
414 files=$$(grep -l '^# *include '"$$h_esc" \
415 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
416 grep -LE "$$re" $$files | grep . && \
417 { echo "$(ME): the above files include $$h but don't use it" \
418 1>&2; exit 1; } || :; \
423 # Prohibit the inclusion of assert.h without an actual use of assert.
424 sc_prohibit_assert_without_use:
425 @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
427 # Prohibit the inclusion of close-stream.h without an actual use.
428 sc_prohibit_close_stream_without_use:
429 @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
431 # Prohibit the inclusion of getopt.h without an actual use.
432 sc_prohibit_getopt_without_use:
433 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
435 # Don't include quotearg.h unless you use one of its functions.
436 sc_prohibit_quotearg_without_use:
437 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
439 # Don't include quote.h unless you use one of its functions.
440 sc_prohibit_quote_without_use:
441 @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
443 # Don't include this header unless you use one of its functions.
444 sc_prohibit_long_options_without_use:
445 @h='"long-options.h"' re='\<parse_long_options *\(' \
446 $(_sc_header_without_use)
448 # Don't include this header unless you use one of its functions.
449 sc_prohibit_inttostr_without_use:
450 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
451 $(_sc_header_without_use)
453 # Don't include this header unless you use one of its functions.
454 sc_prohibit_ignore_value_without_use:
455 @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
456 $(_sc_header_without_use)
458 # Don't include this header unless you use one of its functions.
459 sc_prohibit_error_without_use:
461 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
462 $(_sc_header_without_use)
464 # Don't include xalloc.h unless you use one of its functions.
465 # Consider these symbols:
466 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
467 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
468 # Divide into two sets on case, and filter each through this:
469 # | sort | perl -MRegexp::Assemble -le \
470 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
471 # Note this was produced by the above:
473 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
474 # But we can do better, in at least two ways:
475 # 1) take advantage of two "dup"-suffixed strings:
476 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
477 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
479 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
480 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
481 _xa2 = X([CZ]|N?M)ALLOC
482 sc_prohibit_xalloc_without_use:
484 re='\<($(_xa1)|$(_xa2)) *\('\
485 $(_sc_header_without_use)
487 # Extract function names:
488 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
490 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
491 _hash_fn = \<($(_hash_re)) *\(
492 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
493 sc_prohibit_hash_without_use:
495 re='$(_hash_fn)|$(_hash_struct)'\
496 $(_sc_header_without_use)
498 sc_prohibit_hash_pjw_without_use:
500 re='\<hash_pjw *\(' \
501 $(_sc_header_without_use)
503 sc_prohibit_safe_read_without_use:
504 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
505 $(_sc_header_without_use)
507 sc_prohibit_argmatch_without_use:
509 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
510 $(_sc_header_without_use)
512 sc_prohibit_canonicalize_without_use:
513 @h='"canonicalize.h"' \
514 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
515 $(_sc_header_without_use)
517 sc_prohibit_root_dev_ino_without_use:
518 @h='"root-dev-ino.h"' \
519 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
520 $(_sc_header_without_use)
522 sc_prohibit_openat_without_use:
524 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
525 $(_sc_header_without_use)
527 # Prohibit the inclusion of c-ctype.h without an actual use.
528 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
529 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
530 sc_prohibit_c_ctype_without_use:
531 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' \
532 $(_sc_header_without_use)
535 _sp = $(_empty) $(_empty)
536 # The following list was generated by running:
537 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
538 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
540 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
541 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
542 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
543 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
544 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
545 # The following were extracted from "man signal.h" manually.
546 _sig_types_and_consts = \
547 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
548 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
549 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
550 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
551 sigstack sigval stack_t ucontext_t
552 # generated via this:
553 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
555 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
556 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
557 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
558 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
559 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
560 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
561 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
563 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
565 # Prohibit the inclusion of signal.h without an actual use.
566 sc_prohibit_signal_without_use:
568 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
569 $(_sc_header_without_use)
571 # Prohibit the inclusion of strings.h without a sensible use.
572 # Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible.
573 sc_prohibit_strings_without_use:
575 re='\<(strn?casecmp|ffs(ll)?)\>' \
576 $(_sc_header_without_use)
578 # Get the list of symbol names with this:
579 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
581 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \
582 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \
583 INT_STRLEN_BOUND INT_BUFSIZE_BOUND
584 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
585 # Prohibit the inclusion of intprops.h without an actual use.
586 sc_prohibit_intprops_without_use:
588 re='\<($(_intprops_syms_re)) *\(' \
589 $(_sc_header_without_use)
591 _stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t
592 # Prohibit the inclusion of stddef.h without an actual use.
593 sc_prohibit_stddef_without_use:
595 re='\<($(_stddef_syms_re)) *\(' \
596 $(_sc_header_without_use)
599 @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
600 halt='do not use HAVE''_FCNTL_H or O'_NDELAY \
603 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
605 # Each nonempty ChangeLog line must start with a year number, or a TAB.
607 @prohibit='^[^12 ]' \
608 in_vc_files='^ChangeLog$$' \
609 halt='found unexpected prefix in a ChangeLog' \
612 # Ensure that each .c file containing a "main" function also
613 # calls set_program_name.
615 @require='set_program_name *\(m?argv\[0\]\);' \
616 in_vc_files='\.c$$' \
617 containing='\<main *(' \
618 halt='the above files do not call set_program_name' \
621 # Ensure that each .c file containing a "main" function also
622 # calls bindtextdomain.
624 @require='bindtextdomain *\(' \
625 in_vc_files='\.c$$' \
626 containing='\<main *(' \
627 halt='the above files do not call bindtextdomain' \
630 # Require that the final line of each test-lib.sh-using test be this one:
632 # Note: this test requires GNU grep's --label= option.
633 Exit_witness_file ?= tests/test-lib.sh
634 Exit_base := $(notdir $(Exit_witness_file))
635 sc_require_test_exit_idiom:
636 @if test -f $(srcdir)/$(Exit_witness_file); then \
638 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
639 $$($(VC_LIST) tests)); do \
640 tail -n1 $$i | grep '^Exit .' > /dev/null \
641 && : || { die=1; echo $$i; } \
644 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
645 echo 1>&2 'Exit something'; \
650 @prohibit='\<the ''the\>' \
652 halt='found use of "the ''the";' \
657 halt='found trailing blank(s)' \
660 # Match lines like the following, but where there is only one space
661 # between the options and the description:
662 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
663 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
664 sc_two_space_separator_in_usage:
665 @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
666 halt='help2man requires at least two spaces between an option and its description'\
669 # Look for diagnostics that aren't marked for translation.
670 # This won't find any for which error's format string is on a separate line.
671 sc_unmarked_diagnostics:
673 '\<error *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
674 | grep -Ev '(_|ngettext ?)\(' && \
675 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
678 # Avoid useless parentheses like those in this example:
679 # #if defined (SYMBOL) || defined (SYM2)
680 sc_useless_cpp_parens:
681 @prohibit='^# *if .*defined *\(' \
682 halt='found useless parentheses in cpp directive' \
685 # List headers for which HAVE_HEADER_H is always true, assuming you are
686 # using the appropriate gnulib module. CAUTION: for each "unnecessary"
687 # #if HAVE_HEADER_H that you remove, be sure that your project explicitly
688 # requires the gnulib module that guarantees the usability of that header.
689 gl_assured_headers_ = \
690 cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g'
692 # Convert the list of names to upper case, and replace each space with "|".
693 az_ = abcdefghijklmnopqrstuvwxyz
694 AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ
695 gl_header_upper_case_or_ = \
696 $$($(gl_assured_headers_) \
697 | tr $(az_)/.- $(AZ_)___ \
700 sc_prohibit_always_true_header_tests:
701 @or=$(gl_header_upper_case_or_); \
702 re="HAVE_($$or)_H"; \
703 prohibit='\<'"$$re"'\>' \
704 halt=$$(printf '%s\n' \
705 'do not test the above HAVE_<header>_H symbol(s);' \
706 ' with the corresponding gnulib module, they are always true') \
709 # ==================================================================
710 gl_other_headers_ ?= \
715 # Perl -lne code to extract "significant" cpp-defined symbols from a
716 # gnulib header file, eliminating a few common false-positives.
717 gl_extract_significant_defines_ = \
718 /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\
719 && $$2 !~ /(?:rpl_|_used_without_)/\
720 && $$1 !~ /^(?:NSIG|ATTRIBUTE_NORETURN)$$/\
723 # Create a list of regular expressions matching the names
724 # of macros that are guaranteed to be defined by parts of gnulib.
726 gen_h=$(gl_generated_headers_); \
727 (cd $(gnulib_dir)/lib; \
728 for f in *.in.h $(gl_other_headers_); do \
729 perl -lne '$(gl_extract_significant_defines_)' $$f; \
732 | grep -Ev '^ATTRIBUTE_NORETURN' \
733 | sed 's/^/^ *# *(define|undef) */;s/$$/\\>/'
736 # Don't define macros that we already get from gnulib header files.
737 sc_prohibit_always-defined_macros:
738 @if test -d $(gnulib_dir); then \
739 case $$(echo all: | grep -l -f - Makefile) in Makefile);; *) \
740 echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \
742 $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT)) \
743 && { echo '$(ME): define the above via some gnulib .h file' \
744 1>&2; exit 1; } || :; \
746 # ==================================================================
748 # Prohibit checked in backup files.
749 sc_prohibit_backup_files:
750 @$(VC_LIST) | grep '~$$' && \
751 { echo '$(ME): found version controlled backup file' 1>&2; \
754 # Require the latest GPL.
756 @prohibit='either ''version [^3]' \
757 halt='GPL vN, N!=3' \
760 # Require the latest GFDL. Two regexp, since some .texi files end up
761 # line wrapping between 'Free Documentation License,' and 'Version'.
762 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
764 @prohibit='$(_GFDL_regexp)' \
765 halt='GFDL vN, N!=3' \
768 # Don't use Texinfo's @acronym{}.
769 # http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html
770 texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$
772 @prohibit='@acronym\{' \
773 in_vc_files='$(texinfo_suffix_re_)' \
774 halt='found use of Texinfo @acronym{}' \
778 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
780 sc_prohibit_cvs_keyword:
781 @prohibit='\$$($(cvs_keywords))\$$' \
782 halt='do not use CVS keyword expansion' \
785 # This Perl code is slightly obfuscated. Not only is each "$" doubled
786 # because it's in a Makefile, but the $$c's are comments; we cannot
787 # use "#" due to the way the script ends up concatenated onto one line.
788 # It would be much more concise, and would produce better output (including
789 # counts) if written as:
790 # perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
791 # but that would be far less efficient, reading the entire contents
792 # of each file, rather than just the last two bytes of each.
793 # In addition, while the code below detects both blank lines and a missing
794 # newline at EOF, the above detects only the former.
796 # This is a perl script that is expected to be the single-quoted argument
797 # to a command-line "-le". The remaining arguments are file names.
798 # Print the name of each file that ends in exactly one newline byte.
799 # I.e., warn if there are blank lines (2 or more newlines), or if the
800 # last byte is not a newline. However, currently we don't complain
801 # about any file that contains exactly one byte.
802 # Exit nonzero if at least one such file is found, otherwise, exit 0.
803 # Warn about, but otherwise ignore open failure. Ignore seek/read failure.
805 # Use this if you want to remove trailing empty lines from selected files:
806 # perl -pi -0777 -e 's/\n\n+$/\n/' files...
808 require_exactly_one_NL_at_EOF_ = \
809 foreach my $$f (@ARGV) \
811 open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next; \
812 my $$p = sysseek (F, -2, 2); \
813 my $$c = "seek failure probably means file has < 2 bytes; ignore"; \
814 my $$last_two_bytes; \
815 defined $$p and $$p = sysread F, $$last_two_bytes, 2; \
817 $$c = "ignore read failure"; \
818 $$p && ($$last_two_bytes eq "\n\n" \
819 || substr ($$last_two_bytes,1) ne "\n") \
820 and (print $$f), $$fail=1; \
822 END { exit defined $$fail }
823 sc_prohibit_empty_lines_at_EOF:
824 @perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \
825 || { echo '$(ME): empty line(s) or no newline at EOF' \
828 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
829 # This is a bit of a kludge, since it prevents use of the string
830 # even in comments, but for now it does the job with no false positives.
831 sc_prohibit_stat_st_blocks:
832 @prohibit='[.>]st_blocks' \
833 halt='do not use st_blocks; use ST_NBLOCKS' \
836 # Make sure we don't define any S_IS* macros in src/*.c files.
837 # They're already defined via gnulib's sys/stat.h replacement.
838 sc_prohibit_S_IS_definition:
839 @prohibit='^ *# *define *S_IS' \
840 halt='do not define S_IS* macros; include <sys/stat.h>' \
843 # Perl block to convert a match to FILE_NAME:LINENO:TEST,
844 # that is shared by two definitions below.
845 perl_filename_lineno_text_ = \
847 -e ' $$n = ($$` =~ tr/\n/\n/ + 1);' \
848 -e ' ($$v = $$&) =~ s/\n/\\n/g;' \
849 -e ' print "$$ARGV:$$n:$$v\n";' \
852 prohibit_doubled_word_RE_ ?= \
853 /\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims
854 prohibit_doubled_word_ = \
855 -e 'while ($(prohibit_doubled_word_RE_))' \
856 $(perl_filename_lineno_text_)
858 # Define this to a regular expression that matches
859 # any filename:dd:match lines you want to ignore.
860 # The default is to ignore no matches.
861 ignore_doubled_word_match_RE_ ?= ^$$
863 sc_prohibit_doubled_word:
864 @perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT)) \
865 | grep -vE '$(ignore_doubled_word_match_RE_)' \
866 | grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || :
868 # A regular expression matching undesirable combinations of words like
869 # "can not"; this matches them even when the two words appear on different
870 # lines, but not when there is an intervening delimiter like "#" or "*".
871 prohibit_undesirable_word_seq_RE_ ?= \
873 prohibit_undesirable_word_seq_ = \
874 -e 'while ($(prohibit_undesirable_word_seq_RE_))' \
875 $(perl_filename_lineno_text_)
876 # Define this to a regular expression that matches
877 # any filename:dd:match lines you want to ignore.
878 # The default is to ignore no matches.
879 ignore_undesirable_word_sequence_RE_ ?= ^$$
881 sc_prohibit_undesirable_word_seq:
882 @perl -n -0777 $(prohibit_undesirable_word_seq_) \
883 $$($(VC_LIST_EXCEPT)) \
884 | grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \
885 && { echo '$(ME): undesirable word sequence' >&2; exit 1; } || :
887 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
888 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
889 # Using test's -a and -o operators is not portable.
890 # We prefer test over [, since the latter is spelled [[ in configure.ac.
891 sc_prohibit_test_minus_ao:
892 @prohibit='(\<test| \[+) .+ -[ao] ' \
893 halt='$(_ptm1); $(_ptm2)' \
896 # Avoid a test bashism.
897 sc_prohibit_test_double_equal:
898 @prohibit='(\<test| \[+) .+ == ' \
899 containing='#! */bin/[a-z]*sh' \
900 halt='use "test x = x", not "test x =''= x"' \
903 # Each program that uses proper_name_utf8 must link with one of the
904 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
905 # The perl -0777 invocation below extracts the possibly-multi-line
906 # definition of LDADD from the appropriate Makefile.am and exits 0
907 # when it contains "ICONV".
908 sc_proper_name_utf8_requires_ICONV:
909 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
910 if test "x$$progs" != x; then \
912 for p in $$progs; do \
913 dir=$$(dirname "$$p"); \
915 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
916 $$dir/Makefile.am && continue; \
917 base=$$(basename "$$p" .c); \
918 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
919 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
922 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
926 # Warn about "c0nst struct Foo const foo[]",
927 # but not about "char const *const foo" or "#define const const".
929 @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
930 halt='redundant "const" in declarations' \
933 sc_const_long_option:
934 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
935 | grep -Ev 'const struct option|struct option const' && { \
936 echo 1>&2 '$(ME): add "const" to the above declarations'; \
940 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
943 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
947 # Ensure that we don't accidentally insert an entry into an old NEWS block.
949 @if test -f $(srcdir)/NEWS; then \
950 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
951 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
954 # Update the hash stored above. Do this after each release and
955 # for any corrections to old entries.
956 update-NEWS-hash: NEWS
957 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
960 # Ensure that we use only the standard $(VAR) notation,
961 # not @...@ in Makefile.am, now that we can rely on automake
962 # to emit a definition for each substituted variable.
963 # However, there is still one case in which @VAR@ use is not just
964 # legitimate, but actually required: when augmenting an automake-defined
965 # variable with a prefix. For example, gettext uses this:
966 # MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@
967 # otherwise, makeinfo would put German or French (current locale)
968 # navigation hints in the otherwise-English documentation.
970 # Allow the package to add exceptions via a hook in cfg.mk;
971 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
972 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
973 _makefile_at_at_check_exceptions ?=
974 sc_makefile_at_at_check:
975 @perl -ne '/\@[A-Z_0-9]+\@/' \
976 -e ' && !/([A-Z_0-9]+)\s+=.*\@\1\@$$/' \
977 -e ''$(_makefile_at_at_check_exceptions) \
978 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
979 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \
980 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
983 if sed -n $(news-check-lines-spec)p $(srcdir)/NEWS \
984 | grep -E $(news-check-regexp) >/dev/null; then \
987 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
991 sc_makefile_TAB_only_indentation:
992 @prohibit='^ [ ]{8}' \
993 in_vc_files='akefile|\.mk$$' \
994 halt='found TAB-8-space indentation' \
998 @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
999 in_vc_files='(^configure\.ac|\.m4)$$' \
1000 halt='quote the first arg to AC_DEF*' \
1001 $(_sc_search_regexp)
1003 fix_po_file_diag = \
1004 'you have changed the set of files with translatable diagnostics;\n\
1005 apply the above patch\n'
1007 # Verify that all source files using _() are listed in po/POTFILES.in.
1008 po_file ?= $(srcdir)/po/POTFILES.in
1009 generated_files ?= $(srcdir)/lib/*.[ch]
1011 @if test -f $(po_file); then \
1012 grep -E -v '^(#|$$)' $(po_file) \
1013 | grep -v '^src/false\.c$$' | sort > $@-1; \
1015 for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do \
1016 test -r $$file || continue; \
1018 *.m4|*.mk) continue ;; \
1024 base=`expr " $$file" : ' \(.*\)\..'`; \
1025 { test -f $$base.l || test -f $$base.y; } && continue;; \
1027 files="$$files $$file"; \
1029 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
1030 | sed 's|^$(_dot_escaped_srcdir)/||' | sort -u > $@-2; \
1031 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
1032 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
1036 # Sometimes it is useful to change the PATH environment variable
1037 # in Makefiles. When doing so, it's better not to use the Unix-centric
1038 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
1039 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
1040 sc_makefile_path_separator_check:
1041 @prohibit='PATH[=].*:' \
1042 in_vc_files='akefile|\.mk$$' \
1044 $(_sc_search_regexp)
1046 # Check that `make alpha' will not fail at the end of the process.
1048 if test -d $(release_archive_dir); then :; else \
1049 for file in $(distdir).tar.gz \
1050 $(release_archive_dir)/$(distdir).tar.gz; do \
1051 test -e $$file || continue; \
1053 || { echo ERROR: $$file is not writable; fail=1; }; \
1055 test "$$fail" && exit 1 || : ; \
1058 v_etc_file = $(gnulib_dir)/lib/version-etc.c
1059 sample-test = tests/sample-test
1060 texi = doc/$(PACKAGE).texi
1061 # Make sure that the copyright date in $(v_etc_file) is up to date.
1062 # Do the same for the $(sample-test) and the main doc/.texi file.
1064 @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \
1065 in_files=$(v_etc_file) \
1066 halt='out of date copyright in $(v_etc_file); update it' \
1067 $(_sc_search_regexp)
1068 @require='# Copyright \(C\) '$$(date +%Y)' Free' \
1069 in_vc_files=$(sample-test) \
1070 halt='out of date copyright in $(sample-test); update it' \
1071 $(_sc_search_regexp)
1072 @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \
1073 in_vc_files=$(texi) \
1074 halt='out of date copyright in $(texi); update it' \
1075 $(_sc_search_regexp)
1077 # If tests/help-version exists and seems to be new enough, assume that its
1078 # use of init.sh and path_prepend_ is correct, and ensure that every other
1079 # use of init.sh is identical.
1080 # This is useful because help-version cross-checks prog --version
1081 # with $(VERSION), which verifies that its path_prepend_ invocation
1082 # sets PATH correctly. This is an inexpensive way to ensure that
1083 # the other init.sh-using tests also get it right.
1084 _hv_file ?= $(srcdir)/tests/help-version
1085 _hv_regex_weak ?= ^ *\. .*/init\.sh"
1086 _hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh"
1087 sc_cross_check_PATH_usage_in_tests:
1088 @if test -f $(_hv_file); then \
1089 grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \
1090 || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2; \
1092 grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null \
1093 || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \
1095 good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file)); \
1096 grep -LFx "$$good" \
1097 $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT))) \
1099 { echo "$(ME): the above files use path_prepend_ inconsistently" \
1100 1>&2; exit 1; } || :; \
1103 # #if HAVE_... will evaluate to false for any non numeric string.
1104 # That would be flagged by using -Wundef, however gnulib currently
1105 # tests many undefined macros, and so we can't enable that option.
1106 # So at least preclude common boolean strings as macro values.
1108 @prohibit='^#define.*(yes|no|true|false)$$' \
1109 in_files='$(CONFIG_INCLUDE)' \
1110 halt='Use 0 or 1 for macro values' \
1111 $(_sc_search_regexp)
1113 sc_vulnerable_makefile_CVE-2009-4029:
1114 @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
1115 in_files=$$(find $(srcdir) -name Makefile.in) \
1116 halt=$$(printf '%s\n' \
1117 'the above files are vulnerable; beware of running' \
1118 ' "make dist*" rules, and upgrade to fixed automake' \
1119 ' see http://bugzilla.redhat.com/542609 for details') \
1120 $(_sc_search_regexp)
1123 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
1124 if test -s vc-diffs; then \
1126 echo "Some files are locally modified:" 1>&2; \
1132 rel-files = $(DIST_ARCHIVES)
1134 gnulib_dir ?= $(srcdir)/gnulib
1135 gnulib-version = $$(cd $(gnulib_dir) && git describe)
1136 bootstrap-tools ?= autoconf,automake,gnulib
1138 # If it's not already specified, derive the GPG key ID from
1139 # the signed tag we've just applied to mark this release.
1141 $$(git cat-file tag v$(VERSION) > .ann-sig \
1142 && gpgv .ann-sig - < /dev/null 2>&1 \
1143 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
1145 translation_project_ ?= coordinator@translationproject.org
1147 # Make info-gnu the default only for a stable release.
1148 ifeq ($(RELEASE_TYPE),stable)
1149 announcement_Cc_ ?= $(translation_project_), $(PACKAGE_BUGREPORT)
1150 announcement_mail_headers_ ?= \
1151 To: info-gnu@gnu.org \
1152 Cc: $(announcement_Cc_) \
1153 Mail-Followup-To: $(PACKAGE_BUGREPORT)
1155 announcement_Cc_ ?= $(translation_project_)
1156 announcement_mail_headers_ ?= \
1157 To: $(PACKAGE_BUGREPORT) \
1158 Cc: $(announcement_Cc_)
1161 announcement: NEWS ChangeLog $(rel-files)
1162 @$(build_aux)/announce-gen \
1163 --mail-headers='$(announcement_mail_headers_)' \
1164 --release-type=$(RELEASE_TYPE) \
1165 --package=$(PACKAGE) \
1166 --prev=$(PREV_VERSION) \
1168 --gpg-key-id=$(gpg_key_ID) \
1169 --news=$(srcdir)/NEWS \
1170 --bootstrap-tools=$(bootstrap-tools) \
1171 --gnulib-version=$(gnulib-version) \
1172 --no-print-checksums \
1173 $(addprefix --url-dir=, $(url_dir_list))
1175 ## ---------------- ##
1176 ## Updating files. ##
1177 ## ---------------- ##
1179 ftp-gnu = ftp://ftp.gnu.org/gnu
1180 www-gnu = http://www.gnu.org
1182 upload_dest_dir_ ?= $(PACKAGE)
1183 emit_upload_commands:
1184 @echo =====================================
1185 @echo =====================================
1186 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
1187 @echo " --to $(gnu_rel_host):$(upload_dest_dir_) \\"
1188 @echo " $(rel-files)"
1189 @echo '# send the ~/announce-$(my_distdir) e-mail'
1190 @echo =====================================
1191 @echo =====================================
1193 define emit-commit-log
1194 printf '%s\n' 'post-release administrivia' '' \
1195 '* NEWS: Add header line for next release.' \
1196 '* .prev-version: Record previous version.' \
1197 '* cfg.mk (old_NEWS_hash): Auto-update.'
1200 .PHONY: no-submodule-changes
1201 no-submodule-changes:
1202 if test -d $(srcdir)/.git; then \
1203 diff=$$(cd $(srcdir) && git submodule -q foreach \
1204 git diff-index --name-only HEAD) \
1206 case $$diff in '') ;; \
1207 *) echo '$(ME): submodule files are locally modified:'; \
1208 echo "$$diff"; exit 1;; esac; \
1213 submodule-checks ?= no-submodule-changes public-submodule-commit
1215 # Ensure that each sub-module commit we're using is public.
1216 # Without this, it is too easy to tag and release code that
1217 # cannot be built from a fresh clone.
1218 .PHONY: public-submodule-commit
1219 public-submodule-commit:
1220 $(AM_V_GEN)if test -d $(srcdir)/.git; then \
1222 git submodule --quiet foreach test '$$(git rev-parse $$sha1)' \
1223 = '$$(git merge-base origin $$sha1)' \
1224 || { echo '$(ME): found non-public submodule commit' >&2; \
1229 # This rule has a high enough utility/cost ratio that it should be a
1230 # dependent of "check" by default. However, some of us do occasionally
1231 # commit a temporary change that deliberately points to a non-public
1232 # submodule commit, and want to be able to use rules like "make check".
1233 # In that case, run e.g., "make check gl_public_submodule_commit="
1234 # to disable this test.
1235 gl_public_submodule_commit ?= public-submodule-commit
1236 check: $(gl_public_submodule_commit)
1238 .PHONY: alpha beta stable
1239 ALL_RECURSIVE_TARGETS += alpha beta stable
1240 alpha beta stable: $(local-check) writable-files $(submodule-checks)
1242 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
1243 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
1245 $(MAKE) vc-diff-check
1248 $(MAKE) dist XZ_OPT=-9ev
1249 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1250 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1252 # Override this in cfg.mk if you follow different procedures.
1253 release-prep-hook ?= release-prep
1255 gl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?]
1256 .PHONY: release-prep
1258 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1259 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1260 $(MAKE) --no-print-directory -s announcement > ~/announce-$(my_distdir)
1261 if test -d $(release_archive_dir); then \
1262 ln $(rel-files) $(release_archive_dir); \
1263 chmod a-w $(rel-files); \
1265 echo $(VERSION) > $(prev_version_file)
1266 $(MAKE) update-NEWS-hash
1267 perl -pi -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' NEWS
1268 $(emit-commit-log) > .ci-msg
1269 $(VC) commit -F .ci-msg -a
1272 # Override this with e.g., -s $(srcdir)/some_other_name.texi
1273 # if the default $(PACKAGE)-derived name doesn't apply.
1278 @test -z "$(manual_title)" \
1279 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
1280 @cd '$(srcdir)/doc'; \
1281 $(SHELL) ../build-aux/gendocs.sh $(gendocs_options_) \
1282 -o '$(abs_builddir)/doc/manual' \
1283 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
1284 "$(PACKAGE_NAME) - $(manual_title)"
1285 @echo " *** Upload the doc/manual directory to web-cvs."
1290 $(MAKE) $(AM_MAKEFLAGS) clean
1291 lcov --directory . --zerocounters
1293 COVERAGE_CCOPTS ?= "-g --coverage"
1294 COVERAGE_OUT ?= doc/coverage
1297 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
1298 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
1299 mkdir -p $(COVERAGE_OUT)
1300 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
1304 genhtml --output-directory $(COVERAGE_OUT) \
1305 $(COVERAGE_OUT)/$(PACKAGE).info \
1306 --highlight --frames --legend \
1307 --title "$(PACKAGE_NAME)"
1309 coverage: init-coverage build-coverage gen-coverage
1311 # Update gettext files.
1312 PACKAGE ?= $(shell basename $(PWD))
1313 PO_DOMAIN ?= $(PACKAGE)
1314 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1317 rm -f $(PODIR)/*.po && \
1318 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1319 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1320 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1321 echo 'en@quot' >> $(PODIR)/LINGUAS && \
1322 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1324 # Running indent once is not idempotent, but running it twice is.
1325 INDENT_SOURCES ?= $(C_SOURCES)
1328 indent $(INDENT_SOURCES)
1329 indent $(INDENT_SOURCES)
1331 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1332 # put the assignments in this variable.
1333 update-copyright-env ?=
1335 # Run this rule once per year (usually early in January)
1336 # to update all FSF copyright year lists in your project.
1337 # If you have an additional project-specific rule,
1338 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1339 # By default, exclude all variants of COPYING; you can also
1340 # add exemptions (such as ChangeLog..* for rotated change logs)
1341 # in the file .x-update-copyright.
1342 .PHONY: update-copyright
1344 grep -l -w Copyright \
1345 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1346 | $(update-copyright-env) xargs $(build_aux)/$@
1348 # NOTE: This test is silently skipped if $(_gl_TS_dir)/Makefile.am
1349 # does not mention noinst_HEADERS.
1350 # NOTE: to override these _gl_TS_* default values, you must
1351 # define the variable(s) using "export" in cfg.mk.
1353 ALL_RECURSIVE_TARGETS += sc_tight_scope
1354 sc_tight_scope: tight-scope.mk
1355 @grep noinst_HEADERS $(_gl_TS_dir)/Makefile.am > /dev/null 2>&1 \
1356 && $(MAKE) -s -C $(_gl_TS_dir) -f Makefile \
1357 -f '$(abs_srcdir)/tight-scope.mk' _gl_tight_scope \
1361 tight-scope.mk: $(ME)
1363 @perl -ne '/^# TS-start/.../^# TS-end/ and print' $(ME) > $@-t
1364 @chmod a=r $@-t && mv $@-t $@
1368 # Most functions should have static scope.
1369 # Any that don't must be marked with `extern', but `main'
1370 # and `usage' are exceptions: they're always extern, but
1371 # do not need to be marked.
1372 _gl_TS_unmarked_extern_functions ?= main usage
1373 _gl_TS_function_match ?= \
1374 /^(?:extern|XTERN) +(?:void|(?:struct |const |enum )?\S+) +\**(\S+) +\(/
1376 # The second nm|grep checks for file-scope variables with `extern' scope.
1377 # Without gnulib's progname module, you might put program_name here.
1378 _gl_TS_unmarked_extern_vars ?=
1380 # NOTE: the _match variables are perl expressions -- not mere regular
1381 # expressions -- so that you can extend them to match other patterns
1382 # and easily extract matched variable names.
1383 # For example, if your project declares some global variables via
1384 # a macro like this: GLOBAL(type, var_name, initializer), then you
1385 # can override this definition to automatically extract those names:
1386 # export _gl_TS_var_match = \
1387 # /^(?:extern|XTERN) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/
1388 _gl_TS_var_match ?= /^(?:extern|XTERN) .*?\**(\w+)(\[.*?\])?;/
1389 .PHONY: _gl_tight_scope
1390 _gl_tight_scope: $(bin_PROGRAMS)
1391 t=exceptions-$$$$; \
1392 trap 's=$$?; rm -f $$t; exit $$s' 0; \
1393 for sig in 1 2 3 13 15; do \
1394 eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \
1396 src=`for f in $(SOURCES); do \
1397 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \
1398 hdr=`for f in $(noinst_HEADERS); do \
1399 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \
1400 ( printf '^%s$$\n' $(_gl_TS_unmarked_extern_functions); \
1401 grep -h -A1 '^extern .*[^;]$$' $$src \
1402 | grep -vE '^(extern |--)' | sed 's/ .*//'; \
1403 perl -lne '$(_gl_TS_function_match)' \
1404 -e 'and print $$1' $$hdr; \
1405 ) | sort -u | sed 's/^/^/;s/$$/$$/' > $$t; \
1406 nm -e *.$(OBJEXT) | sed -n 's/.* T //p' | grep -Ev -f $$t \
1407 && { echo the above functions should have static scope >&2; \
1409 ( printf '^%s$$\n' $(_gl_TS_unmarked_extern_vars); \
1410 perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' \
1411 $$hdr *.h ) | sort -u > $$t; \
1412 nm -e *.$(OBJEXT) | sed -n 's/.* [BCDGRS] //p' \
1413 | sort -u | grep -Ev -f $$t \
1414 && { echo the above variables should have static scope >&2; \