2 # This Makefile fragment tries to be general-purpose enough to be
3 # used by many projects via the gnulib maintainer-makefile module.
5 ## Copyright (C) 2001-2010 Free Software Foundation, Inc.
7 ## This program is free software: you can redistribute it and/or modify
8 ## it under the terms of the GNU General Public License as published by
9 ## the Free Software Foundation, either version 3 of the License, or
10 ## (at your option) any later version.
12 ## This program is distributed in the hope that it will be useful,
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ## GNU General Public License for more details.
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
20 # This is reported not to work with make-3.79.1
21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
24 # Override this in cfg.mk if you use a non-standard build-aux directory.
25 build_aux ?= $(srcdir)/build-aux
27 # Do not save the original name or timestamp in the .tar.gz file.
28 # Use --rsyncable if available.
30 $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
31 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
35 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
37 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
39 # You can override this variable in cfg.mk to set your own regexp
40 # matching files to ignore.
41 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$
43 # This is to preprocess robustly the output of $(VC_LIST), so that even
44 # when $(srcdir) is a pathological name like "....", the leading sed command
45 # removes only the intended prefix.
46 _dot_escaped_srcdir = $(subst .,\.,$(srcdir))
49 $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
50 | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
51 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
52 | grep -Ev -e '$(VC_LIST_ALWAYS_EXCLUDE_REGEX)' \
53 | sed 's|^|$(srcdir)/|'
55 ifeq ($(origin prev_version_file), undefined)
56 prev_version_file = $(srcdir)/.prev-version
59 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
60 VERSION_REGEXP = $(subst .,\.,$(VERSION))
61 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
64 this-vc-tag = v$(VERSION)
65 this-vc-tag-regexp = v$(VERSION_REGEXP)
67 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
68 tag-this-version = $(subst .,_,$(VERSION))
69 this-vc-tag = $(tag-package)-$(tag-this-version)
70 this-vc-tag-regexp = $(this-vc-tag)
72 my_distdir = $(PACKAGE)-$(VERSION)
74 # Old releases are stored here.
75 release_archive_dir ?= ../release
77 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
78 # Use alpha.gnu.org for alpha and beta releases.
79 # Use ftp.gnu.org for stable releases.
80 gnu_ftp_host-alpha = alpha.gnu.org
81 gnu_ftp_host-beta = alpha.gnu.org
82 gnu_ftp_host-stable = ftp.gnu.org
83 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
85 ifeq ($(gnu_rel_host),ftp.gnu.org)
86 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
88 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
91 # Override this in cfg.mk if you are using a different format in your
93 today = $(shell date +%Y-%m-%d)
94 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
96 # Prevent programs like 'sort' from considering distinct strings to be equal.
97 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
100 ## --------------- ##
102 ## --------------- ##
104 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
106 # Collect the names of rules starting with `sc_'.
107 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
108 $(srcdir)/$(ME) $(_cfg_mk)))
109 .PHONY: $(syntax-check-rules)
111 local-checks-available = \
112 $(syntax-check-rules)
113 .PHONY: $(local-checks-available)
115 # Arrange to print the name of each syntax-checking rule just before running it.
116 $(syntax-check-rules): %: %.m
117 $(patsubst %, %.m, $(syntax-check-rules)):
118 @echo $(patsubst sc_%.m, %, $@)
120 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
122 syntax-check: $(local-check)
123 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
124 # $$(find -type f -name '*.[chly]') && \
125 # { echo '$(ME): found conditional include' 1>&2; \
128 # grep -nE '^# *include <(string|stdlib)\.h>' \
129 # $(srcdir)/{lib,src}/*.[chy] && \
130 # { echo '$(ME): FIXME' 1>&2; \
132 # FIXME: don't allow `#include .strings\.h' anywhere
134 # By default, _prohibit_regexp does not ignore case.
136 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
138 # There are many rules below that prohibit constructs in this package.
139 # If the offending construct can be matched with a grep-E-style regexp,
140 # use this macro. The shell variables "re" and "msg" must be defined.
141 define _prohibit_regexp
142 dummy=; : so we do not need a semicolon before each use; \
143 test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
144 test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
145 grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
146 { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
149 sc_avoid_if_before_free:
150 @$(build_aux)/useless-if-before-free \
151 $(useless_free_options) \
152 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \
153 { echo '$(ME): found useless "if" before "free" above' 1>&2; \
156 sc_cast_of_argument_to_free:
157 @re='\<free *\( *\(' msg='don'\''t cast free argument' \
160 sc_cast_of_x_alloc_return_value:
161 @re='\*\) *x(m|c|re)alloc\>' \
162 msg='don'\''t cast x*alloc return value' \
165 sc_cast_of_alloca_return_value:
166 @re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
170 @re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
173 # Don't use *scanf or the old ato* functions in `real' code.
174 # They provide no error checking mechanism.
175 # Instead, use strto* functions.
176 sc_prohibit_atoi_atof:
177 @re='\<([fs]?scanf|ato([filq]|ll)) *\(' \
178 msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
181 # Use STREQ rather than comparing strcmp == 0, or != 0.
183 @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
184 $$($(VC_LIST_EXCEPT)) \
185 | grep -vE ':# *define STREQ\(' && \
186 { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
189 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
190 # Convert all uses automatically, via these two commands:
191 # git grep -l '\<exit *(1)' \
192 # | grep -vEf .x-sc_prohibit_magic_number_exit \
193 # | xargs --no-run-if-empty \
194 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
195 # git grep -l '\<exit *(0)' \
196 # | grep -vEf .x-sc_prohibit_magic_number_exit \
197 # | xargs --no-run-if-empty \
198 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
199 sc_prohibit_magic_number_exit:
200 @re='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
201 msg='use EXIT_* values rather than magic number' \
204 # Using EXIT_SUCCESS as the first argument to error is misleading,
205 # since when that parameter is 0, error does not exit. Use `0' instead.
206 sc_error_exit_success:
207 @grep -nE 'error \(EXIT_SUCCESS,' \
208 $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') && \
209 { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
211 # `FATAL:' should be fully upper-cased in error messages
212 # `WARNING:' should be fully upper-cased, or fully lower-cased
213 sc_error_message_warn_fatal:
214 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
215 | grep -E '"Warning|"Fatal|"fatal' && \
216 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
219 # Error messages should not start with a capital letter
220 sc_error_message_uppercase:
221 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
223 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
224 { echo '$(ME): found capitalized error message' 1>&2; \
227 # Error messages should not end with a period
228 sc_error_message_period:
229 @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
230 | grep -E '[^."]\."' && \
231 { echo '$(ME): found error message ending in period' 1>&2; \
235 @re=file''system ignore_case=1 \
236 msg='found use of "file''system"; spell it "file system"' \
239 # Don't use cpp tests of this symbol. All code assumes config.h is included.
240 sc_prohibit_have_config_h:
241 @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
242 { echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
245 # Nearly all .c files must include <config.h>. However, we also permit this
246 # via inclusion of a package-specific header, if cfg.mk specified one.
247 # config_h_header must be suitable for grep -E.
248 config_h_header ?= <config\.h>
250 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
251 grep -EL '^# *include $(config_h_header)' \
252 $$($(VC_LIST_EXCEPT) | grep '\.c$$') \
254 { echo '$(ME): the above files do not include <config.h>' \
255 1>&2; exit 1; } || :; \
259 # You must include <config.h> before including any other header file.
260 # This can possibly be via a package-specific header, if given by cfg.mk.
261 sc_require_config_h_first:
262 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
264 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
265 grep '^# *include\>' $$i | sed 1q \
266 | grep -E '^# *include $(config_h_header)' > /dev/null \
267 || { echo $$i; fail=1; }; \
270 { echo '$(ME): the above files include some other header' \
271 'before <config.h>' 1>&2; exit 1; } || :; \
275 sc_prohibit_HAVE_MBRTOWC:
276 @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
279 # To use this "command" macro, you must first define two shell variables:
280 # h: the header, enclosed in <> or ""
281 # re: a regular expression that matches IFF something provided by $h is used.
282 define _header_without_use
283 dummy=; : so we do not need a semicolon before each use; \
284 h_esc=`echo "$$h"|sed 's/\./\\\\./g'`; \
285 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
286 files=$$(grep -l '^# *include '"$$h_esc" \
287 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
288 grep -LE "$$re" $$files | grep . && \
289 { echo "$(ME): the above files include $$h but don't use it" \
290 1>&2; exit 1; } || :; \
295 # Prohibit the inclusion of assert.h without an actual use of assert.
296 sc_prohibit_assert_without_use:
297 @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
299 # Prohibit the inclusion of close-stream.h without an actual use.
300 sc_prohibit_close_stream_without_use:
301 @h='"close-stream.h"' re='\<close_stream *\(' $(_header_without_use)
303 # Prohibit the inclusion of getopt.h without an actual use.
304 sc_prohibit_getopt_without_use:
305 @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
307 # Don't include quotearg.h unless you use one of its functions.
308 sc_prohibit_quotearg_without_use:
309 @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
311 # Don't include quote.h unless you use one of its functions.
312 sc_prohibit_quote_without_use:
313 @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
315 # Don't include this header unless you use one of its functions.
316 sc_prohibit_long_options_without_use:
317 @h='"long-options.h"' re='\<parse_long_options *\(' \
318 $(_header_without_use)
320 # Don't include this header unless you use one of its functions.
321 sc_prohibit_inttostr_without_use:
322 @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
323 $(_header_without_use)
325 # Don't include this header unless you use one of its functions.
326 sc_prohibit_error_without_use:
328 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
329 $(_header_without_use)
331 # Don't include xalloc.h unless you use one of its functions.
332 # Consider these symbols:
333 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
334 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
335 # Divide into two sets on case, and filter each through this:
336 # | sort | perl -MRegexp::Assemble -le \
337 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
338 # Note this was produced by the above:
340 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
341 # But we can do better, in at least two ways:
342 # 1) take advantage of two "dup"-suffixed strings:
343 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
344 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
346 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
347 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
348 _xa2 = X([CZ]|N?M)ALLOC
349 sc_prohibit_xalloc_without_use:
351 re='\<($(_xa1)|$(_xa2)) *\('\
352 $(_header_without_use)
354 sc_prohibit_safe_read_without_use:
355 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
356 $(_header_without_use)
358 sc_prohibit_argmatch_without_use:
360 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
361 $(_header_without_use)
363 sc_prohibit_canonicalize_without_use:
364 @h='"canonicalize.h"' \
365 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
366 $(_header_without_use)
368 sc_prohibit_root_dev_ino_without_use:
369 @h='"root-dev-ino.h"' \
370 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
371 $(_header_without_use)
373 sc_prohibit_openat_without_use:
375 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
376 $(_header_without_use)
378 # Prohibit the inclusion of c-ctype.h without an actual use.
379 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
380 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
381 sc_prohibit_c_ctype_without_use:
382 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
385 _sp = $(_empty) $(_empty)
386 # The following list was generated by running:
387 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
388 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
390 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
391 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
392 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
393 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
394 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
395 # The following were extracted from "man signal.h" manually.
396 _sig_types_and_consts = \
397 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
398 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
399 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
400 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
401 sigstack sigval stack_t ucontext_t
402 # generated via this:
403 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
405 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
406 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
407 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
408 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
409 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
410 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
411 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
413 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
415 # Prohibit the inclusion of signal.h without an actual use.
416 sc_prohibit_signal_without_use:
418 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
419 $(_header_without_use)
422 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
423 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
426 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
428 # Each nonempty ChangeLog line must start with a year number, or a TAB.
430 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
432 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
433 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
437 # Ensure that each .c file containing a "main" function also
438 # calls set_program_name.
440 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
441 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
442 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
444 { echo '$(ME): the above files do not call set_program_name' \
445 1>&2; exit 1; } || :; \
449 # Require that the final line of each test-lib.sh-using test be this one:
451 # Note: this test requires GNU grep's --label= option.
452 Exit_witness_file ?= tests/test-lib.sh
453 Exit_base := $(notdir $(Exit_witness_file))
454 sc_require_test_exit_idiom:
455 @if test -f $(srcdir)/$(Exit_witness_file); then \
457 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
458 $$($(VC_LIST) tests)); do \
459 tail -n1 $$i | grep '^Exit .' > /dev/null \
460 && : || { die=1; echo $$i; } \
463 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
464 echo 1>&2 'Exit something'; \
469 @re='\<the ''the\>' \
470 ignore_case=1 msg='found use of "the ''the";' \
475 msg='found trailing blank(s)' \
478 # Match lines like the following, but where there is only one space
479 # between the options and the description:
480 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
481 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
482 sc_two_space_separator_in_usage:
483 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
484 $$($(VC_LIST_EXCEPT)) && \
485 { echo "$(ME): help2man requires at least two spaces between"; \
486 echo "$(ME): an option and its description"; \
489 # Look for diagnostics that aren't marked for translation.
490 # This won't find any for which error's format string is on a separate line.
491 sc_unmarked_diagnostics:
493 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
494 | grep -v '_''(' && \
495 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
498 # Avoid useless parentheses like those in this example:
499 # #if defined (SYMBOL) || defined (SYM2)
500 sc_useless_cpp_parens:
501 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
502 { echo '$(ME): found useless parentheses in cpp directive' \
505 # Require the latest GPL.
507 @re='either ''version [^3]' msg='GPL vN, N!=3' \
510 # Require the latest GFDL. Two regexp, since some .texi files end up
511 # line wrapping between 'Free Documentation License,' and 'Version'.
512 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
514 @re='$(_GFDL_regexp)' msg='GFDL vN, N!=3' \
518 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
520 sc_prohibit_cvs_keyword:
521 @re='\$$($(cvs_keywords))\$$' \
522 msg='do not use CVS keyword expansion' \
525 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
526 # This is a bit of a kludge, since it prevents use of the string
527 # even in comments, but for now it does the job with no false positives.
528 sc_prohibit_stat_st_blocks:
529 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
532 # Make sure we don't define any S_IS* macros in src/*.c files.
533 # They're already defined via gnulib's sys/stat.h replacement.
534 sc_prohibit_S_IS_definition:
535 @re='^ *# *define *S_IS' \
536 msg='do not define S_IS* macros; include <sys/stat.h>' \
539 # Each program that uses proper_name_utf8 must link with one of the
540 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
541 # The perl -0777 invocation below extracts the possibly-multi-line
542 # definition of LDADD from the appropriate Makefile.am and exits 0
543 # when it contains "ICONV".
544 sc_proper_name_utf8_requires_ICONV:
545 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
546 if test "x$$progs" != x; then \
548 for p in $$progs; do \
549 dir=$$(dirname "$$p"); \
551 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
552 $$dir/Makefile.am && continue; \
553 base=$$(basename "$$p" .c); \
554 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
555 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
558 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
562 # Warn about "c0nst struct Foo const foo[]",
563 # but not about "char const *const foo" or "#define const const".
565 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
566 msg='redundant "const" in declarations' \
569 sc_const_long_option:
570 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
571 | grep -Ev 'const struct option|struct option const' && { \
572 echo 1>&2 '$(ME): add "const" to the above declarations'; \
576 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
579 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
583 # Ensure that we don't accidentally insert an entry into an old NEWS block.
585 @if test -f $(srcdir)/NEWS; then \
586 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
587 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
590 # Update the hash stored above. Do this after each release and
591 # for any corrections to old entries.
592 update-NEWS-hash: NEWS
593 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
596 # Ensure that we use only the standard $(VAR) notation,
597 # not @...@ in Makefile.am, now that we can rely on automake
598 # to emit a definition for each substituted variable.
599 # We use perl rather than "grep -nE ..." to exempt a single
600 # use of an @...@-delimited variable name in src/Makefile.am.
601 # Allow the package to add exceptions via a hook in cfg.mk;
602 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
603 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
604 _makefile_at_at_check_exceptions ?=
605 sc_makefile_at_at_check:
606 @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
607 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
608 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
609 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
612 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
616 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
620 sc_makefile_TAB_only_indentation:
621 @grep -nE '^ [ ]{8}' \
622 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
623 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
627 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
628 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
629 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
633 'you have changed the set of files with translatable diagnostics;\n\
634 apply the above patch\n'
636 # Verify that all source files using _() are listed in po/POTFILES.in.
637 po_file = po/POTFILES.in
639 @if test -f $(po_file); then \
640 grep -E -v '^(#|$$)' $(po_file) \
641 | grep -v '^src/false\.c$$' | sort > $@-1; \
643 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
644 test -r $$file || continue; \
646 *.m4|*.mk) continue ;; \
652 base=`expr " $$file" : ' \(.*\)\..'`; \
653 { test -f $$base.l || test -f $$base.y; } && continue;; \
655 files="$$files $$file"; \
657 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
659 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
660 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
664 # Sometimes it is useful to change the PATH environment variable
665 # in Makefiles. When doing so, it's better not to use the Unix-centric
666 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
667 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
668 sc_makefile_path_separator_check:
669 @grep -nE 'PATH[=].*:' \
670 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
671 && { echo $(msg) 1>&2; exit 1; } || :
673 # Check that `make alpha' will not fail at the end of the process.
675 if test -d $(release_archive_dir); then :; else \
676 for file in $(distdir).tar.gz \
677 $(release_archive_dir)/$(distdir).tar.gz; do \
678 test -e $$file || continue; \
680 || { echo ERROR: $$file is not writable; fail=1; }; \
682 test "$$fail" && exit 1 || : ; \
685 v_etc_file = lib/version-etc.c
686 sample-test = tests/sample-test
687 texi = doc/$(PACKAGE).texi
688 # Make sure that the copyright date in $(v_etc_file) is up to date.
689 # Do the same for the $(sample-test) and the main doc/.texi file.
691 @if test -f $(v_etc_file); then \
692 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
694 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
697 @if test -f $(sample-test); then \
698 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
700 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
703 @if test -f $(texi); then \
704 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
706 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
711 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
712 if test -s vc-diffs; then \
714 echo "Some files are locally modified:" 1>&2; \
720 rel-files = $(DIST_ARCHIVES)
722 gnulib_dir ?= $(srcdir)/gnulib
723 gnulib-version = $$(cd $(gnulib_dir) && git describe)
724 bootstrap-tools ?= autoconf,automake,gnulib
726 # If it's not already specified, derive the GPG key ID from
727 # the signed tag we've just applied to mark this release.
729 $$(git cat-file tag v$(VERSION) > .ann-sig \
730 && gpgv .ann-sig - < /dev/null 2>&1 \
731 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
733 announcement: NEWS ChangeLog $(rel-files)
734 @$(build_aux)/announce-gen \
735 --release-type=$(RELEASE_TYPE) \
736 --package=$(PACKAGE) \
737 --prev=$(PREV_VERSION) \
739 --gpg-key-id=$(gpg_key_ID) \
740 --news=$(srcdir)/NEWS \
741 --bootstrap-tools=$(bootstrap-tools) \
742 --gnulib-version=$(gnulib-version) \
743 --no-print-checksums \
744 $(addprefix --url-dir=, $(url_dir_list))
746 ## ---------------- ##
747 ## Updating files. ##
748 ## ---------------- ##
750 ftp-gnu = ftp://ftp.gnu.org/gnu
751 www-gnu = http://www.gnu.org
753 emit_upload_commands:
754 @echo =====================================
755 @echo =====================================
756 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
757 @echo " --to $(gnu_rel_host):$(PACKAGE) \\"
758 @echo " $(rel-files)"
759 @echo '# send the ~/announce-$(my_distdir) e-mail'
760 @echo =====================================
761 @echo =====================================
763 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
764 define emit-commit-log
765 printf '%s\n' 'post-release administrivia' '' \
766 '* NEWS: Add header line for next release.' \
767 '* .prev-version: Record previous version.' \
768 '* cfg.mk (old_NEWS_hash): Auto-update.'
771 .PHONY: no-submodule-changes
772 no-submodule-changes:
773 if test -d $(srcdir)/.git; then \
774 diff=$$(cd $(srcdir) && git submodule -q foreach \
775 git diff-index --name-only HEAD) \
777 case $$diff in '') ;; \
778 *) echo '$(ME): submodule files are locally modified:'; \
779 echo "$$diff"; exit 1;; esac; \
784 .PHONY: alpha beta stable
785 ALL_RECURSIVE_TARGETS += alpha beta stable
786 alpha beta stable: $(local-check) writable-files no-submodule-changes
788 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
789 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
791 $(MAKE) vc-diff-check
794 $(MAKE) dist XZ_OPT=-9ev
795 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
796 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
798 # Override this in cfg.mk if you follow different procedures.
799 release-prep-hook ?= release-prep
803 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
804 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
805 $(MAKE) -s announcement > ~/announce-$(my_distdir)
806 if test -d $(release_archive_dir); then \
807 ln $(rel-files) $(release_archive_dir); \
808 chmod a-w $(rel-files); \
810 echo $(VERSION) > $(prev_version_file)
811 $(MAKE) update-NEWS-hash
812 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
813 $(emit-commit-log) > .ci-msg
814 $(VC) commit -F .ci-msg -a
819 @test -z "$(manual_title)" \
820 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
821 @cd '$(srcdir)/doc'; \
822 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
823 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
824 "$(PACKAGE_NAME) - $(manual_title)"
825 @echo " *** Upload the doc/manual directory to web-cvs."
830 $(MAKE) $(AM_MAKEFLAGS) clean
831 lcov --directory . --zerocounters
833 COVERAGE_CCOPTS ?= "-g --coverage"
834 COVERAGE_OUT ?= doc/coverage
837 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
838 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
839 mkdir -p $(COVERAGE_OUT)
840 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
844 genhtml --output-directory $(COVERAGE_OUT) \
845 $(COVERAGE_OUT)/$(PACKAGE).info \
846 --highlight --frames --legend \
847 --title "$(PACKAGE_NAME)"
849 coverage: init-coverage build-coverage gen-coverage
851 # Update gettext files.
852 PACKAGE ?= $(shell basename $(PWD))
853 PO_DOMAIN ?= $(PACKAGE)
854 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
857 rm -f $(PODIR)/*.po && \
858 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
859 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
860 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
861 echo 'en@quot' >> $(PODIR)/LINGUAS && \
862 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
864 INDENT_SOURCES ?= $(C_SOURCES)
867 indent $(INDENT_SOURCES)
869 # If you want to set UPDATE_COPYRIGHT_* environment variables,
870 # put the assignments in this variable.
871 update-copyright-env ?=
873 # Run this rule once per year (usually early in January)
874 # to update all FSF copyright year lists in your project.
875 # If you have an additional project-specific rule,
876 # add it in cfg.mk along with a line 'update-copyright: prereq'.
877 # By default, exclude all variants of COPYING; you can also
878 # add exemptions (such as ChangeLog..* for rotated change logs)
879 # in the file .x-update-copyright.
880 .PHONY: update-copyright
882 grep -l -w Copyright \
883 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
884 | $(update-copyright-env) xargs $(build_aux)/$@