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:
327 # _xa1 = x(alloc_(oversized|die)|([cz]|2?re)alloc|m(alloc|emdup)|strdup)
328 # But we can do better:
329 _xa1 = x(alloc_(oversized|die)|([cmz]|2?re)alloc|(mem|str)dup)
330 _xa2 = X([CZ]|N?M)ALLOC
331 sc_prohibit_xalloc_without_use:
333 re='\<($(_xa1)|$(_xa2)) *\('\
334 $(_header_without_use)
336 sc_prohibit_safe_read_without_use:
337 @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
338 $(_header_without_use)
340 sc_prohibit_argmatch_without_use:
342 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
343 $(_header_without_use)
345 sc_prohibit_canonicalize_without_use:
346 @h='"canonicalize.h"' \
347 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
348 $(_header_without_use)
350 sc_prohibit_root_dev_ino_without_use:
351 @h='"root-dev-ino.h"' \
352 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
353 $(_header_without_use)
355 sc_prohibit_openat_without_use:
357 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
358 $(_header_without_use)
360 # Prohibit the inclusion of c-ctype.h without an actual use.
361 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
362 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
363 sc_prohibit_c_ctype_without_use:
364 @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
367 _sp = $(_empty) $(_empty)
368 # The following list was generated by running:
369 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
370 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
372 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
373 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
374 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
375 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
376 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
377 # The following were extracted from "man signal.h" manually.
378 _sig_types_and_consts = \
379 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
380 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
381 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
382 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
383 sigstack sigval stack_t ucontext_t
384 # generated via this:
385 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
387 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
388 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
389 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
390 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
391 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
392 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
393 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
395 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
397 # Prohibit the inclusion of signal.h without an actual use.
398 sc_prohibit_signal_without_use:
400 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
401 $(_header_without_use)
404 @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
405 msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
408 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
410 # Each nonempty ChangeLog line must start with a year number, or a TAB.
412 @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
414 $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
415 { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
419 # Ensure that each .c file containing a "main" function also
420 # calls set_program_name.
422 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
423 files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
424 grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
426 { echo '$(ME): the above files do not call set_program_name' \
427 1>&2; exit 1; } || :; \
431 # Require that the final line of each test-lib.sh-using test be this one:
433 # Note: this test requires GNU grep's --label= option.
434 Exit_witness_file ?= tests/test-lib.sh
435 Exit_base := $(notdir $(Exit_witness_file))
436 sc_require_test_exit_idiom:
437 @if test -f $(srcdir)/$(Exit_witness_file); then \
439 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \
440 $$($(VC_LIST) tests)); do \
441 tail -n1 $$i | grep '^Exit .' > /dev/null \
442 && : || { die=1; echo $$i; } \
445 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
446 echo 1>&2 'Exit something'; \
451 @re='\<the ''the\>' \
452 ignore_case=1 msg='found use of "the ''the";' \
457 msg='found trailing blank(s)' \
460 # Match lines like the following, but where there is only one space
461 # between the options and the description:
462 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
463 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
464 sc_two_space_separator_in_usage:
465 @grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
466 $$($(VC_LIST_EXCEPT)) && \
467 { echo "$(ME): help2man requires at least two spaces between"; \
468 echo "$(ME): an option and its description"; \
471 # Look for diagnostics that aren't marked for translation.
472 # This won't find any for which error's format string is on a separate line.
473 sc_unmarked_diagnostics:
475 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
476 | grep -v '_''(' && \
477 { echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
480 # Avoid useless parentheses like those in this example:
481 # #if defined (SYMBOL) || defined (SYM2)
482 sc_useless_cpp_parens:
483 @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
484 { echo '$(ME): found useless parentheses in cpp directive' \
487 # Require the latest GPL.
489 @re='either ''version [^3]' msg='GPL vN, N!=3' \
493 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
495 sc_prohibit_cvs_keyword:
496 @re='\$$($(cvs_keywords))\$$' \
497 msg='do not use CVS keyword expansion' \
500 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
501 # This is a bit of a kludge, since it prevents use of the string
502 # even in comments, but for now it does the job with no false positives.
503 sc_prohibit_stat_st_blocks:
504 @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
507 # Make sure we don't define any S_IS* macros in src/*.c files.
508 # They're already defined via gnulib's sys/stat.h replacement.
509 sc_prohibit_S_IS_definition:
510 @re='^ *# *define *S_IS' \
511 msg='do not define S_IS* macros; include <sys/stat.h>' \
514 # Each program that uses proper_name_utf8 must link with
515 # one of the ICONV libraries.
516 sc_proper_name_utf8_requires_ICONV:
517 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
518 if test "x$$progs" != x; then \
520 for p in $$progs; do \
521 dir=$$(dirname "$$p"); \
522 base=$$(basename "$$p" .c); \
523 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
524 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
527 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
531 # Warn about "c0nst struct Foo const foo[]",
532 # but not about "char const *const foo" or "#define const const".
534 @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
535 msg='redundant "const" in declarations' \
538 sc_const_long_option:
539 @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
540 | grep -Ev 'const struct option|struct option const' && { \
541 echo 1>&2 '$(ME): add "const" to the above declarations'; \
545 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
547 | grep -v '^Copyright .*Free Software' \
551 # Ensure that we don't accidentally insert an entry into an old NEWS block.
553 @if test -f $(srcdir)/NEWS; then \
554 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
555 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
558 # Update the hash stored above. Do this after each release and
559 # for any corrections to old entries.
560 update-NEWS-hash: NEWS
561 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
564 # Ensure that we use only the standard $(VAR) notation,
565 # not @...@ in Makefile.am, now that we can rely on automake
566 # to emit a definition for each substituted variable.
567 # We use perl rather than "grep -nE ..." to exempt a single
568 # use of an @...@-delimited variable name in src/Makefile.am.
570 @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/' \
571 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
572 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
573 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
576 if head $(srcdir)/NEWS | grep -E $(news-check-regexp) \
580 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
584 sc_makefile_TAB_only_indentation:
585 @grep -nE '^ [ ]{8}' \
586 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
587 && { echo '$(ME): found TAB-8-space indentation' 1>&2; \
591 @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
592 $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
593 && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
597 'you have changed the set of files with translatable diagnostics;\n\
598 apply the above patch\n'
600 # Verify that all source files using _() are listed in po/POTFILES.in.
601 po_file = po/POTFILES.in
603 @if test -f $(po_file); then \
604 grep -E -v '^(#|$$)' $(po_file) \
605 | grep -v '^src/false\.c$$' | sort > $@-1; \
607 for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
608 test -r $$file || continue; \
610 *.m4|*.mk) continue ;; \
616 base=`expr " $$file" : ' \(.*\)\..'`; \
617 { test -f $$base.l || test -f $$base.y; } && continue;; \
619 files="$$files $$file"; \
621 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
623 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
624 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
628 # Sometimes it is useful to change the PATH environment variable
629 # in Makefiles. When doing so, it's better not to use the Unix-centric
630 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
631 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
632 sc_makefile_path_separator_check:
633 @grep -nE 'PATH[=].*:' \
634 $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
635 && { echo $(msg) 1>&2; exit 1; } || :
637 # Check that `make alpha' will not fail at the end of the process.
639 if test -d $(release_archive_dir); then :; else \
640 for file in $(distdir).tar.gz \
641 $(release_archive_dir)/$(distdir).tar.gz; do \
642 test -e $$file || continue; \
644 || { echo ERROR: $$file is not writable; fail=1; }; \
646 test "$$fail" && exit 1 || : ; \
649 v_etc_file = lib/version-etc.c
650 sample-test = tests/sample-test
651 texi = doc/$(PACKAGE).texi
652 # Make sure that the copyright date in $(v_etc_file) is up to date.
653 # Do the same for the $(sample-test) and the main doc/.texi file.
655 @if test -f $(v_etc_file); then \
656 grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
658 || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
661 @if test -f $(sample-test); then \
662 grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
664 || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
667 @if test -f $(texi); then \
668 grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
670 || { echo 'out of date copyright in $(texi); update it' 1>&2; \
675 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
676 if test -s vc-diffs; then \
678 echo "Some files are locally modified:" 1>&2; \
684 rel-files = $(DIST_ARCHIVES)
686 gnulib_dir ?= $(srcdir)/gnulib
687 gnulib-version = $$(cd $(gnulib_dir) && git describe)
688 bootstrap-tools ?= autoconf,automake,gnulib
690 # If it's not already specified, derive the GPG key ID from
691 # the signed tag we've just applied to mark this release.
693 $$(git cat-file tag v$(VERSION) > .ann-sig \
694 && gpgv .ann-sig - < /dev/null 2>&1 \
695 | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
697 announcement: NEWS ChangeLog $(rel-files)
698 @$(build_aux)/announce-gen \
699 --release-type=$(RELEASE_TYPE) \
700 --package=$(PACKAGE) \
701 --prev=$(PREV_VERSION) \
703 --gpg-key-id=$(gpg_key_ID) \
705 --bootstrap-tools=$(bootstrap-tools) \
706 --gnulib-version=$(gnulib-version) \
707 --no-print-checksums \
708 $(addprefix --url-dir=, $(url_dir_list))
710 ## ---------------- ##
711 ## Updating files. ##
712 ## ---------------- ##
714 ftp-gnu = ftp://ftp.gnu.org/gnu
715 www-gnu = http://www.gnu.org
717 emit_upload_commands:
718 @echo =====================================
719 @echo =====================================
720 @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
721 @echo " --to $(gnu_rel_host):$(PACKAGE) \\"
722 @echo " $(rel-files)"
723 @echo '# send the ~/announce-$(my_distdir) e-mail'
724 @echo =====================================
725 @echo =====================================
727 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
728 define emit-commit-log
729 printf '%s\n' 'post-release administrivia' '' \
730 '* NEWS: Add header line for next release.' \
731 '* .prev-version: Record previous version.' \
732 '* cfg.mk (old_NEWS_hash): Auto-update.'
735 .PHONY: no-submodule-changes
736 no-submodule-changes:
737 if test -d $(srcdir)/.git; then \
738 diff=$$(cd $(srcdir) && git submodule -q foreach \
739 git diff-index --name-only HEAD) \
741 case $$diff in '') ;; \
742 *) echo '$(ME): submodule files are locally modified:'; \
743 echo "$$diff"; exit 1;; esac; \
748 .PHONY: alpha beta stable
749 ALL_RECURSIVE_TARGETS += alpha beta stable
750 alpha beta stable: $(local-check) writable-files no-submodule-changes
752 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
753 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
755 $(MAKE) vc-diff-check
758 $(MAKE) dist XZ_OPT=-9ev
759 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
760 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
762 # Override this in cfg.mk if you follow different procedures.
763 release-prep-hook ?= release-prep
767 case $$RELEASE_TYPE in alpha|beta|stable) ;; \
768 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
769 $(MAKE) -s announcement > ~/announce-$(my_distdir)
770 if test -d $(release_archive_dir); then \
771 ln $(rel-files) $(release_archive_dir); \
772 chmod a-w $(rel-files); \
774 echo $(VERSION) > $(prev_version_file)
775 $(MAKE) update-NEWS-hash
776 perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
777 $(emit-commit-log) > .ci-msg
778 $(VC) commit -F .ci-msg -a
783 @test -z "$(manual_title)" \
784 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
785 @cd '$(srcdir)/doc'; \
786 $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
787 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
788 "$(PACKAGE_NAME) - $(manual_title)"
789 @echo " *** Upload the doc/manual directory to web-cvs."
794 $(MAKE) $(AM_MAKEFLAGS) clean
795 lcov --directory . --zerocounters
797 COVERAGE_CCOPTS ?= "-g --coverage"
798 COVERAGE_OUT ?= doc/coverage
801 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
802 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
803 mkdir -p $(COVERAGE_OUT)
804 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
808 genhtml --output-directory $(COVERAGE_OUT) \
809 $(COVERAGE_OUT)/$(PACKAGE).info \
810 --highlight --frames --legend \
811 --title "$(PACKAGE_NAME)"
813 coverage: init-coverage build-coverage gen-coverage
815 # Update gettext files.
816 PACKAGE ?= $(shell basename $(PWD))
817 PO_DOMAIN ?= $(PACKAGE)
818 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
821 rm -f $(PODIR)/*.po && \
822 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
823 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
824 echo 'en@boldquot' > $(PODIR)/LINGUAS && \
825 echo 'en@quot' >> $(PODIR)/LINGUAS && \
826 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
828 INDENT_SOURCES ?= $(C_SOURCES)
831 indent $(INDENT_SOURCES)
833 # If you want to set UPDATE_COPYRIGHT_* environment variables,
834 # put the assignments in this variable.
835 update-copyright-env ?=
837 # Run this rule once per year (usually early in January)
838 # to update all FSF copyright year lists in your project.
839 # If you have an additional project-specific rule,
840 # add it in cfg.mk along with a line 'update-copyright: prereq'.
841 # By default, exclude all variants of COPYING; you can also
842 # add exemptions (such as ChangeLog..* for rotated change logs)
843 # in the file .x-update-copyright.
844 .PHONY: update-copyright
846 grep -l -w Copyright \
847 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
848 | $(update-copyright-env) xargs $(build_aux)/$@