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 ?= ^$$
44 $(VC_LIST) | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
45 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
46 | grep -Ev -e '$(VC_LIST_ALWAYS_EXCLUDE_REGEX)'
48 ifeq ($(origin prev_version_file), undefined)
49 prev_version_file = $(srcdir)/.prev-version
52 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
53 VERSION_REGEXP = $(subst .,\.,$(VERSION))
54 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
57 this-vc-tag = v$(VERSION)
58 this-vc-tag-regexp = v$(VERSION_REGEXP)
60 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
61 tag-this-version = $(subst .,_,$(VERSION))
62 this-vc-tag = $(tag-package)-$(tag-this-version)
63 this-vc-tag-regexp = $(this-vc-tag)
65 my_distdir = $(PACKAGE)-$(VERSION)
67 # Old releases are stored here.
68 release_archive_dir ?= ../release
70 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
71 # Use alpha.gnu.org for alpha and beta releases.
72 # Use ftp.gnu.org for stable releases.
73 gnu_ftp_host-alpha = alpha.gnu.org
74 gnu_ftp_host-beta = alpha.gnu.org
75 gnu_ftp_host-stable = ftp.gnu.org
76 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
78 ifeq ($(gnu_rel_host),ftp.gnu.org)
79 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
81 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
84 # Override this in cfg.mk if you are using a different format in your
86 today = $(shell date +%Y-%m-%d)
87 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
89 # Prevent programs like 'sort' from considering distinct strings to be equal.
90 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
97 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
99 # Collect the names of rules starting with `sc_'.
100 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
101 $(srcdir)/$(ME) $(_cfg_mk)))
102 .PHONY: $(syntax-check-rules)
104 local-checks-available = \
105 $(syntax-check-rules)
106 .PHONY: $(local-checks-available)
108 # Arrange to print the name of each syntax-checking rule just before running it.
109 $(syntax-check-rules): %: %.m
110 $(patsubst %, %.m, $(syntax-check-rules)):
111 @echo $(patsubst sc_%.m, %, $@)
113 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
115 syntax-check: $(local-check)
116 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
117 # $$(find -type f -name '*.[chly]') && \
118 # { echo '$(ME): found conditional include' 1>&2; \
121 # grep -nE '^# *include <(string|stdlib)\.h>' \
122 # $(srcdir)/{lib,src}/*.[chy] && \
123 # { echo '$(ME): FIXME' 1>&2; \
125 # FIXME: don't allow `#include .strings\.h' anywhere
127 # By default, _prohibit_regexp does not ignore case.
129 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
131 # There are many rules below that prohibit constructs in this package.
132 # If the offending construct can be matched with a grep-E-style regexp,
133 # use this macro. The shell variables "re" and "msg" must be defined.
134 define _prohibit_regexp
135 dummy=; : so we do not need a semicolon before each use; \
136 test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
137 test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
138 grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
139 { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
142 sc_avoid_if_before_free:
143 @$(build_aux)/useless-if-before-free \
144 $(useless_free_options) \
145 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
146 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
149 sc_cast_of_argument_to_free:
150 @re='\<free *\( *\(' msg='don'\''t cast free argument' \
153 sc_cast_of_x_alloc_return_value:
154 @re='\*\) *x(m|c|re)alloc\>' \
155 msg='don'\''t cast x*alloc return value' \
158 sc_cast_of_alloca_return_value:
159 @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
163 @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
166 # Don't use *scanf or the old ato* functions in `real' code.
167 # They provide no error checking mechanism.
168 # Instead, use strto* functions.
169 sc_prohibit_atoi_atof:
170 @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
171 msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
174 # Use STREQ rather than comparing strcmp == 0, or != 0.
176 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
177 $$($(VC_LIST_EXCEPT)) \
178 | grep -vE ':# *define STREQ\(' && \
179 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
182 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
183 # Convert all uses automatically, via these two commands:
184 # git grep -l '\<exit *(1)' \
185 # | grep -vEf .x-sc_prohibit_magic_number_exit \
186 # | xargs --no-run-if-empty \
187 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
188 # git grep -l '\<exit *(0)' \
189 # | grep -vEf .x-sc_prohibit_magic_number_exit \
190 # | xargs --no-run-if-empty \
191 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
192 sc_prohibit_magic_number_exit:
193 @re='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
194 msg='use EXIT_* values rather than magic number' \
197 # Using EXIT_SUCCESS as the first argument to error is misleading,
198 # since when that parameter is 0, error does not exit. Use `0' instead.
199 sc_error_exit_success:
200 @grep -nE 'error \(EXIT_SUCCESS,' \
201 $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
202 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
204 # `FATAL:' should be fully upper-cased in error messages
205 # `WARNING:' should be fully upper-cased, or fully lower-cased
206 sc_error_message_warn_fatal:
207 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
208 | grep -E '"Warning|"Fatal|"fatal' && \
209 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
212 # Error messages should not start with a capital letter
213 sc_error_message_uppercase:
214 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
216 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
217 { echo '$(ME): found capitalized error message' 1>&2; \
220 # Error messages should not end with a period
221 sc_error_message_period:
222 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
223 | grep -E '[^."]\."' && \
224 { echo '$(ME): found error message ending in period' 1>&2; \
228 @re=file''system ignore_case=1 \
229 msg='found use of "file''system"; spell it "file system"' \
232 # Don't use cpp tests of this symbol. All code assumes config.h is included.
233 sc_prohibit_have_config_h:
234 @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
235 { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
238 # Nearly all .c files must include <config.h>. However, we also permit this
239 # via inclusion of a package-specific header, if cfg.mk specified one.
240 # config_h_header must be suitable for grep -E.
241 config_h_header ?= <config\.h>
243 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
244 grep -EL '^# *include $(config_h_header)' \
245 $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
247 { echo '$(ME): the above files do not include <config.h>' \
248 1>&2; exit 1; } || :; \
252 # You must include <config.h> before including any other header file.
253 # This can possibly be via a package-specific header, if given by cfg.mk.
254 sc_require_config_h_first:
255 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
257 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
258 grep '^# *include\>' $$i | sed 1q \
259 | grep -E '^# *include $(config_h_header)' > /dev/null \
260 || { echo $$i; fail=1; }; \
263 { echo '$(ME): the above files include some other header' \
264 'before <config.h>' 1>&2; exit 1; } || :; \
268 sc_prohibit_HAVE_MBRTOWC:
269 @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
272 # To use this "command" macro, you must first define two shell variables:
273 # h: the header, enclosed in <> or ""
274 # re: a regular expression that matches IFF something provided by $h is used.
275 define _header_without_use
276 dummy=; : so we do not need a semicolon before each use; \
277 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
278 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
279 files=$$(grep -l '^# *include '"$$h_esc" \
280 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
281 grep -LE "$$re" $$files | grep . && \
282 { echo "$(ME): the above files include $$h but don't use it" \
283 1>&2; exit 1; } || :; \
288 # Prohibit the inclusion of assert.h without an actual use of assert.
289 sc_prohibit_assert_without_use:
290 @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
292 # Prohibit the inclusion of close-stream.h without an actual use.
293 sc_prohibit_close_stream_without_use:
294 @h='"close-stream.h"' re='\<close_stream *\(' $(_header_without_use)
296 # Prohibit the inclusion of getopt.h without an actual use.
297 sc_prohibit_getopt_without_use:
298 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
300 # Don't include quotearg.h unless you use one of its functions.
301 sc_prohibit_quotearg_without_use:
302 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
304 # Don't include quote.h unless you use one of its functions.
305 sc_prohibit_quote_without_use:
306 @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
308 # Don't include this header unless you use one of its functions.
309 sc_prohibit_long_options_without_use:
310 @h='"long-options.h"' re='\<parse_long_options *\(' \
311 $(_header_without_use)
313 # Don't include this header unless you use one of its functions.
314 sc_prohibit_inttostr_without_use:
315 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
316 $(_header_without_use)
318 # Don't include this header unless you use one of its functions.
319 sc_prohibit_error_without_use:
321 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
322 $(_header_without_use)
324 # Don't include xalloc.h unless you use one of its functions.
325 # Consider these symbols:
326 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
327 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
328 # Divide into two sets on case, and filter each through this:
329 # | sort | perl -MRegexp::Assemble -le \
330 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
331 # Note this was produced by the above:
333 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
334 # But we can do better, in at least two ways:
335 # 1) take advantage of two "dup"-suffixed strings:
336 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
337 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
339 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
340 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
341 _xa2 = X([CZ]|N?M)ALLOC
342 sc_prohibit_xalloc_without_use:
344 re='\<($(_xa1)|$(_xa2)) *\('\
345 $(_header_without_use)
347 sc_prohibit_safe_read_without_use:
348 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
349 $(_header_without_use)
351 sc_prohibit_argmatch_without_use:
353 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
354 $(_header_without_use)
356 sc_prohibit_canonicalize_without_use:
357 @h='"canonicalize.h"' \
358 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
359 $(_header_without_use)
361 sc_prohibit_root_dev_ino_without_use:
362 @h='"root-dev-ino.h"' \
363 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
364 $(_header_without_use)
366 sc_prohibit_openat_without_use:
368 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
369 $(_header_without_use)
371 # Prohibit the inclusion of c-ctype.h without an actual use.
372 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
373 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
374 sc_prohibit_c_ctype_without_use:
375 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
378 _sp = $(_empty) $(_empty)
379 # The following list was generated by running:
380 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
381 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
383 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
384 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
385 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
386 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
387 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
388 # The following were extracted from "man signal.h" manually.
389 _sig_types_and_consts = \
390 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
391 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
392 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
393 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
394 sigstack sigval stack_t ucontext_t
395 # generated via this:
396 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
398 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
399 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
400 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
401 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
402 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
403 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
404 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
406 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
408 # Prohibit the inclusion of signal.h without an actual use.
409 sc_prohibit_signal_without_use:
411 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
412 $(_header_without_use)
415 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
416 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
419 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
421 # Each nonempty ChangeLog line must start with a year number, or a TAB.
423 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
425 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
426 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
430 # Ensure that each .c file containing a "main" function also
431 # calls set_program_name.
433 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
434 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
435 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
437 { echo '$(ME): the above files do not call set_program_name' \
438 1>&2; exit 1; } || :; \
442 # Require that the final line of each test-lib.sh-using test be this one:
444 # Note: this test requires GNU grep's --label= option.
445 Exit_witness_file ?= tests/test-lib.sh
446 Exit_base := $(notdir $(Exit_witness_file))
447 sc_require_test_exit_idiom:
448 @if test -f $(srcdir)/$(Exit_witness_file); then \
450 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
451 $$($(VC_LIST) tests)); do \
452 tail -n1 $$i | grep '^Exit .' > /dev/null \
453 && : || { die=1; echo $$i; } \
456 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
457 echo 1>&2 'Exit something'; \
462 @re='\<the ''the\>' \
463 ignore_case=1 msg='found use of "the ''the";' \
468 msg='found trailing blank(s)' \
471 # Match lines like the following, but where there is only one space
472 # between the options and the description:
473 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
474 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
475 sc_two_space_separator_in_usage:
476 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
477 $$($(VC_LIST_EXCEPT)) && \
478 { echo "$(ME): help2man requires at least two spaces between"; \
479 echo "$(ME): an option and its description"; \
482 # Look for diagnostics that aren't marked for translation.
483 # This won't find any for which error's format string is on a separate line.
484 sc_unmarked_diagnostics:
486 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
487 | grep -v '_''(' && \
488 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
491 # Avoid useless parentheses like those in this example:
492 # #if defined (SYMBOL) || defined (SYM2)
493 sc_useless_cpp_parens:
494 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
495 { echo '$(ME): found useless parentheses in cpp directive' \
498 # Require the latest GPL.
500 @re='either ''version [^3]' msg='GPL vN, N!=3' \
503 # Require the latest GFDL. Two regexp, since some .texi files end up
504 # line wrapping between 'Free Documentation License,' and 'Version'.
505 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
507 @re='$(_GFDL_regexp)' msg='GFDL vN, N!=3' \
511 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
513 sc_prohibit_cvs_keyword:
514 @re='\$$($(cvs_keywords))\$$' \
515 msg='do not use CVS keyword expansion' \
518 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
519 # This is a bit of a kludge, since it prevents use of the string
520 # even in comments, but for now it does the job with no false positives.
521 sc_prohibit_stat_st_blocks:
522 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
525 # Make sure we don't define any S_IS* macros in src/*.c files.
526 # They're already defined via gnulib's sys/stat.h replacement.
527 sc_prohibit_S_IS_definition:
528 @re='^ *# *define *S_IS' \
529 msg='do not define S_IS* macros; include <sys/stat.h>' \
532 # Each program that uses proper_name_utf8 must link with one of the
533 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
534 # The perl -0777 invocation below extracts the possibly-multi-line
535 # definition of LDADD from the appropriate Makefile.am and exits 0
536 # when it contains "ICONV".
537 sc_proper_name_utf8_requires_ICONV:
538 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
539 if test "x$$progs" != x; then \
541 for p in $$progs; do \
542 dir=$$(dirname "$$p"); \
544 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
545 $$dir/Makefile.am && continue; \
546 base=$$(basename "$$p" .c); \
547 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
548 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
551 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
555 # Warn about "c0nst struct Foo const foo[]",
556 # but not about "char const *const foo" or "#define const const".
558 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
559 msg='redundant "const" in declarations' \
562 sc_const_long_option:
563 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
564 | grep -Ev 'const struct option|struct option const' && { \
565 echo 1>&2 '$(ME): add "const" to the above declarations'; \
569 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
572 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
576 # Ensure that we don't accidentally insert an entry into an old NEWS block.
578 @if test -f $(srcdir)/NEWS; then \
579 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
580 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
583 # Update the hash stored above. Do this after each release and
584 # for any corrections to old entries.
585 update-NEWS-hash: NEWS
586 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
589 # Ensure that we use only the standard $(VAR) notation,
590 # not @...@ in Makefile.am, now that we can rely on automake
591 # to emit a definition for each substituted variable.
592 # We use perl rather than "grep -nE ..." to exempt a single
593 # use of an @...@-delimited variable name in src/Makefile.am.
594 # Allow the package to add exceptions via a hook in cfg.mk;
595 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
596 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
597 _makefile_at_at_check_exceptions ?=
598 sc_makefile_at_at_check:
599 @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
600 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
601 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
602 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
605 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
609 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
613 sc_makefile_TAB_only_indentation:
614 @grep -nE '^ [ ]{8}' \
615 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
616 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
620 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
621 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
622 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
626 'you have changed the set of files with translatable diagnostics;\n\
627 apply the above patch\n'
629 # Verify that all source files using _() are listed in po/POTFILES.in.
630 po_file = po/POTFILES.in
632 @if test -f $(po_file); then \
633 grep -E -v '^(#|$$)' $(po_file) \
634 | grep -v '^src/false\.c$$' | sort > $@-1; \
636 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
637 test -r $$file || continue; \
639 *.m4|*.mk) continue ;; \
645 base=`expr " $$file" : ' \(.*\)\..'`; \
646 { test -f $$base.l || test -f $$base.y; } && continue;; \
648 files="$$files $$file"; \
650 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
652 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
653 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
657 # Sometimes it is useful to change the PATH environment variable
658 # in Makefiles. When doing so, it's better not to use the Unix-centric
659 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
660 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
661 sc_makefile_path_separator_check:
662 @grep -nE 'PATH[=].*:' \
663 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
664 && { echo $(msg) 1>&2; exit 1; } || :
666 # Check that `make alpha' will not fail at the end of the process.
668 if test -d $(release_archive_dir); then :; else \
669 for file in $(distdir).tar.gz \
670 $(release_archive_dir)/$(distdir).tar.gz; do \
671 test -e $$file || continue; \
673 || { echo ERROR: $$file is not writable; fail=1; }; \
675 test "$$fail" && exit 1 || : ; \
678 v_etc_file = lib/version-etc.c
679 sample-test = tests/sample-test
680 texi = doc/$(PACKAGE).texi
681 # Make sure that the copyright date in $(v_etc_file) is up to date.
682 # Do the same for the $(sample-test) and the main doc/.texi file.
684 @if test -f $(v_etc_file); then \
685 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
687 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
690 @if test -f $(sample-test); then \
691 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
693 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
696 @if test -f $(texi); then \
697 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
699 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
704 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
705 if test -s vc-diffs; then \
707 echo "Some files are locally modified:" 1>&2; \
713 rel-files = $(DIST_ARCHIVES)
715 gnulib_dir ?= $(srcdir)/gnulib
716 gnulib-version = $$(cd $(gnulib_dir) && git describe)
717 bootstrap-tools ?= autoconf,automake,gnulib
719 # If it's not already specified, derive the GPG key ID from
720 # the signed tag we've just applied to mark this release.
722 $$(git cat-file tag v$(VERSION) > .ann-sig \
723 && gpgv .ann-sig - < /dev/null 2>&1 \
724 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
726 announcement: NEWS ChangeLog $(rel-files)
727 @$(build_aux)/announce-gen \
728 --release-type=$(RELEASE_TYPE) \
729 --package=$(PACKAGE) \
730 --prev=$(PREV_VERSION) \
732 --gpg-key-id=$(gpg_key_ID) \
733 --news=$(srcdir)/NEWS \
734 --bootstrap-tools=$(bootstrap-tools) \
735 --gnulib-version=$(gnulib-version) \
736 --no-print-checksums \
737 $(addprefix --url-dir=, $(url_dir_list))
739 ## ---------------- ##
740 ## Updating files. ##
741 ## ---------------- ##
743 ftp-gnu = ftp://ftp.gnu.org/gnu
744 www-gnu = http://www.gnu.org
746 emit_upload_commands:
747 @echo =====================================
748 @echo =====================================
749 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
750 @echo " --to $(gnu_rel_host):$(PACKAGE) \\"
751 @echo " $(rel-files)"
752 @echo '# send the ~/announce-$(my_distdir) e-mail'
753 @echo =====================================
754 @echo =====================================
756 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
757 define emit-commit-log
758 printf '%s\n' 'post-release administrivia' '' \
759 '* NEWS: Add header line for next release.' \
760 '* .prev-version: Record previous version.' \
761 '* cfg.mk (old_NEWS_hash): Auto-update.'
764 .PHONY: no-submodule-changes
765 no-submodule-changes:
766 if test -d $(srcdir)/.git; then \
767 diff=$$(cd $(srcdir) && git submodule -q foreach \
768 git diff-index --name-only HEAD) \
770 case $$diff in '') ;; \
771 *) echo '$(ME): submodule files are locally modified:'; \
772 echo "$$diff"; exit 1;; esac; \
777 .PHONY: alpha beta stable
778 ALL_RECURSIVE_TARGETS += alpha beta stable
779 alpha beta stable: $(local-check) writable-files no-submodule-changes
781 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
782 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
784 $(MAKE) vc-diff-check
787 $(MAKE) dist XZ_OPT=-9ev
788 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
789 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
791 # Override this in cfg.mk if you follow different procedures.
792 release-prep-hook ?= release-prep
796 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
797 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
798 $(MAKE) -s announcement > ~/announce-$(my_distdir)
799 if test -d $(release_archive_dir); then \
800 ln $(rel-files) $(release_archive_dir); \
801 chmod a-w $(rel-files); \
803 echo $(VERSION) > $(prev_version_file)
804 $(MAKE) update-NEWS-hash
805 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
806 $(emit-commit-log) > .ci-msg
807 $(VC) commit -F .ci-msg -a
812 @test -z "$(manual_title)" \
813 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
814 @cd '$(srcdir)/doc'; \
815 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
816 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
817 "$(PACKAGE_NAME) - $(manual_title)"
818 @echo " *** Upload the doc/manual directory to web-cvs."
823 $(MAKE) $(AM_MAKEFLAGS) clean
824 lcov --directory . --zerocounters
826 COVERAGE_CCOPTS ?= "-g --coverage"
827 COVERAGE_OUT ?= doc/coverage
830 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
831 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
832 mkdir -p $(COVERAGE_OUT)
833 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
837 genhtml --output-directory $(COVERAGE_OUT) \
838 $(COVERAGE_OUT)/$(PACKAGE).info \
839 --highlight --frames --legend \
840 --title "$(PACKAGE_NAME)"
842 coverage: init-coverage build-coverage gen-coverage
844 # Update gettext files.
845 PACKAGE ?= $(shell basename $(PWD))
846 PO_DOMAIN ?= $(PACKAGE)
847 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
850 rm -f $(PODIR)/*.po && \
851 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
852 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
853 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
854 echo 'en@quot' >> $(PODIR)/LINGUAS && \
855 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
857 INDENT_SOURCES ?= $(C_SOURCES)
860 indent $(INDENT_SOURCES)
862 # If you want to set UPDATE_COPYRIGHT_* environment variables,
863 # put the assignments in this variable.
864 update-copyright-env ?=
866 # Run this rule once per year (usually early in January)
867 # to update all FSF copyright year lists in your project.
868 # If you have an additional project-specific rule,
869 # add it in cfg.mk along with a line 'update-copyright: prereq'.
870 # By default, exclude all variants of COPYING; you can also
871 # add exemptions (such as ChangeLog..* for rotated change logs)
872 # in the file .x-update-copyright.
873 .PHONY: update-copyright
875 grep -l -w Copyright \
876 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
877 | $(update-copyright-env) xargs $(build_aux)/$@