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