Update gnulib files.
[gnutls:gnutls.git] / maint.mk
1 # -*-Makefile-*-
2 # This Makefile fragment tries to be general-purpose enough to be
3 # used by many projects via the gnulib maintainer-makefile module.
4
5 ## Copyright (C) 2001-2009 Free Software Foundation, Inc.
6 ##
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.
11 ##
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.
16 ##
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/>.
19
20 # This is reported not to work with make-3.79.1
21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
22 ME := maint.mk
23
24 # Override this in cfg.mk if you use a non-standard build-aux directory.
25 build_aux ?= $(srcdir)/build-aux
26
27 # Do not save the original name or timestamp in the .tar.gz file.
28 # Use --rsyncable if available.
29 gzip_rsyncable := \
30   $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
31 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
32
33 # cfg.mk must define the gpg_key_ID used by this package.
34 GIT = git
35 VC = $(GIT)
36 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
37
38 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
39
40 VC_LIST_EXCEPT = \
41   $(VC_LIST) | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
42                else grep -Ev "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi
43
44 ifeq ($(origin prev_version_file), undefined)
45   prev_version_file = $(srcdir)/.prev-version
46 endif
47
48 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
49 VERSION_REGEXP = $(subst .,\.,$(VERSION))
50 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
51
52 ifeq ($(VC),$(GIT))
53 this-vc-tag = v$(VERSION)
54 this-vc-tag-regexp = v$(VERSION_REGEXP)
55 else
56 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
57 tag-this-version = $(subst .,_,$(VERSION))
58 this-vc-tag = $(tag-package)-$(tag-this-version)
59 this-vc-tag-regexp = $(this-vc-tag)
60 endif
61 my_distdir = $(PACKAGE)-$(VERSION)
62
63 # Old releases are stored here.
64 release_archive_dir ?= ../release
65
66 # Prevent programs like 'sort' from considering distinct strings to be equal.
67 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
68 export LC_ALL = C
69
70 ## --------------- ##
71 ## Sanity checks.  ##
72 ## --------------- ##
73
74 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
75
76 # Collect the names of rules starting with `sc_'.
77 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
78                         $(srcdir)/$(ME) $(_cfg_mk)))
79 .PHONY: $(syntax-check-rules)
80
81 local-checks-available = \
82   $(syntax-check-rules)
83 .PHONY: $(local-checks-available)
84
85 # Arrange to print the name of each syntax-checking rule just before running it.
86 $(syntax-check-rules): %: %.m
87 $(patsubst %, %.m, $(syntax-check-rules)):
88         @echo $(patsubst sc_%.m, %, $@)
89
90 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
91
92 syntax-check: $(local-check)
93 #       @grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'         \
94 #           $$(find -type f -name '*.[chly]') &&                        \
95 #         { echo '$(ME): found conditional include' 1>&2;               \
96 #           exit 1; } || :
97
98 #       grep -nE '^#  *include <(string|stdlib)\.h>'                    \
99 #           $(srcdir)/{lib,src}/*.[chy] &&                              \
100 #         { echo '$(ME): FIXME' 1>&2;                                   \
101 #           exit 1; } || :
102 # FIXME: don't allow `#include .strings\.h' anywhere
103
104 # By default, _prohibit_regexp does not ignore case.
105 export ignore_case =
106 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
107
108 # There are many rules below that prohibit constructs in this package.
109 # If the offending construct can be matched with a grep-E-style regexp,
110 # use this macro.  The shell variables "re" and "msg" must be defined.
111 define _prohibit_regexp
112   dummy=; : so we do not need a semicolon before each use;              \
113   test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; };  \
114   test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
115   grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) &&              \
116     { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
117 endef
118
119 sc_avoid_if_before_free:
120         @$(build_aux)/useless-if-before-free                            \
121                 $(useless_free_options)                                 \
122             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
123           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
124             exit 1; } || :
125
126 sc_cast_of_argument_to_free:
127         @re='\<free *\( *\(' msg='don'\''t cast free argument'          \
128           $(_prohibit_regexp)
129
130 sc_cast_of_x_alloc_return_value:
131         @re='\*\) *x(m|c|re)alloc\>'                                    \
132         msg='don'\''t cast x*alloc return value'                        \
133           $(_prohibit_regexp)
134
135 sc_cast_of_alloca_return_value:
136         @re='\*\) *alloca\>' msg='don'\''t cast alloca return value'    \
137           $(_prohibit_regexp)
138
139 sc_space_tab:
140         @re='[ ]        ' msg='found SPACE-TAB sequence; remove the SPACE' \
141           $(_prohibit_regexp)
142
143 # Don't use *scanf or the old ato* functions in `real' code.
144 # They provide no error checking mechanism.
145 # Instead, use strto* functions.
146 sc_prohibit_atoi_atof:
147         @re='\<([fs]?scanf|ato([filq]|ll)) *\('                         \
148         msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
149           $(_prohibit_regexp)
150
151 # Use STREQ rather than comparing strcmp == 0, or != 0.
152 sc_prohibit_strcmp:
153         @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *=='           \
154             $$($(VC_LIST_EXCEPT))                                       \
155           | grep -vE ':# *define STREQ\(' &&                            \
156           { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
157                 1>&2; exit 1; } || :
158
159 # Using EXIT_SUCCESS as the first argument to error is misleading,
160 # since when that parameter is 0, error does not exit.  Use `0' instead.
161 sc_error_exit_success:
162         @grep -nE 'error \(EXIT_SUCCESS,'                               \
163             $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') &&             \
164           { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
165
166 # `FATAL:' should be fully upper-cased in error messages
167 # `WARNING:' should be fully upper-cased, or fully lower-cased
168 sc_error_message_warn_fatal:
169         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
170             | grep -E '"Warning|"Fatal|"fatal' &&                       \
171           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
172             exit 1; } || :
173
174 # Error messages should not start with a capital letter
175 sc_error_message_uppercase:
176         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
177             | grep -E '"[A-Z]'                                          \
178             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
179           { echo '$(ME): found capitalized error message' 1>&2;         \
180             exit 1; } || :
181
182 # Error messages should not end with a period
183 sc_error_message_period:
184         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
185             | grep -E '[^."]\."' &&                                     \
186           { echo '$(ME): found error message ending in period' 1>&2;    \
187             exit 1; } || :
188
189 sc_file_system:
190         @re=file''system ignore_case=1                                  \
191         msg='found use of "file''system"; spell it "file system"'       \
192           $(_prohibit_regexp)
193
194 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
195 sc_prohibit_have_config_h:
196         @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) &&     \
197           { echo '$(ME): found use of HAVE''_CONFIG_H; remove'          \
198                 1>&2; exit 1; } || :
199
200 # Nearly all .c files must include <config.h>.  However, we also permit this
201 # via inclusion of a package-specific header, if cfg.mk specified one.
202 # config_h_header must be suitable for grep -E.
203 config_h_header ?= <config\.h>
204 sc_require_config_h:
205         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
206           grep -EL '^# *include $(config_h_header)'                     \
207                 $$($(VC_LIST_EXCEPT) | grep '\.c$$')                    \
208               | grep . &&                                               \
209           { echo '$(ME): the above files do not include <config.h>'     \
210                 1>&2; exit 1; } || :;                                   \
211         else :;                                                         \
212         fi
213
214 # You must include <config.h> before including any other header file.
215 # This can possibly be via a package-specific header, if given by cfg.mk.
216 sc_require_config_h_first:
217         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
218           fail=0;                                                       \
219           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
220             grep '^# *include\>' $$i | sed 1q                           \
221                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
222               || { echo $$i; fail=1; };                                 \
223           done;                                                         \
224           test $$fail = 1 &&                                            \
225             { echo '$(ME): the above files include some other header'   \
226                 'before <config.h>' 1>&2; exit 1; } || :;               \
227         else :;                                                         \
228         fi
229
230 sc_prohibit_HAVE_MBRTOWC:
231         @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
232           $(_prohibit_regexp)
233
234 # To use this "command" macro, you must first define two shell variables:
235 # h: the header, enclosed in <> or ""
236 # re: a regular expression that matches IFF something provided by $h is used.
237 define _header_without_use
238   dummy=; : so we do not need a semicolon before each use;              \
239   h_esc=`echo "$$h"|sed 's/\./\\\\./g'`;                                \
240   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
241     files=$$(grep -l '^# *include '"$$h_esc"                            \
242              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
243     grep -LE "$$re" $$files | grep . &&                                 \
244       { echo "$(ME): the above files include $$h but don't use it"      \
245         1>&2; exit 1; } || :;                                           \
246   else :;                                                               \
247   fi
248 endef
249
250 # Prohibit the inclusion of assert.h without an actual use of assert.
251 sc_prohibit_assert_without_use:
252         @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
253
254 # Prohibit the inclusion of getopt.h without an actual use.
255 sc_prohibit_getopt_without_use:
256         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
257
258 # Don't include quotearg.h unless you use one of its functions.
259 sc_prohibit_quotearg_without_use:
260         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
261
262 # Don't include quote.h unless you use one of its functions.
263 sc_prohibit_quote_without_use:
264         @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
265
266 # Don't include this header unless you use one of its functions.
267 sc_prohibit_long_options_without_use:
268         @h='"long-options.h"' re='\<parse_long_options *\(' \
269           $(_header_without_use)
270
271 # Don't include this header unless you use one of its functions.
272 sc_prohibit_inttostr_without_use:
273         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
274           $(_header_without_use)
275
276 # Don't include this header unless you use one of its functions.
277 sc_prohibit_error_without_use:
278         @h='"error.h"' \
279         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
280           $(_header_without_use)
281
282 sc_prohibit_safe_read_without_use:
283         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
284           $(_header_without_use)
285
286 sc_prohibit_argmatch_without_use:
287         @h='"argmatch.h"' \
288         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
289           $(_header_without_use)
290
291 sc_prohibit_root_dev_ino_without_use:
292         @h='"root-dev-ino.h"' \
293         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
294           $(_header_without_use)
295
296 sc_prohibit_openat_without_use:
297         @h='"openat.h"' \
298         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
299           $(_header_without_use)
300
301 # Prohibit the inclusion of c-ctype.h without an actual use.
302 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
303 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
304 sc_prohibit_c_ctype_without_use:
305         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
306
307 _empty =
308 _sp = $(_empty) $(_empty)
309 # The following list was generated by running:
310 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
311 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
312 _sig_functions = \
313   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
314   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
315   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
316   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
317 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
318 # The following were extracted from "man signal.h" manually.
319 _sig_types_and_consts =                                                 \
320   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
321   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
322   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
323   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
324   sigstack sigval stack_t ucontext_t
325 # generated via this:
326 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
327 _sig_names =                                                            \
328   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
329   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
330   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
331   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
332   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
333   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
334   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
335   SIGXCPU SIGXFSZ
336 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
337
338 # Prohibit the inclusion of signal.h without an actual use.
339 sc_prohibit_signal_without_use:
340         @h='<signal.h>'                                                 \
341         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
342           $(_header_without_use)
343
344 sc_obsolete_symbols:
345         @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                           \
346         msg='do not use HAVE''_FCNTL_H or O'_NDELAY                     \
347           $(_prohibit_regexp)
348
349 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
350
351 # Each nonempty ChangeLog line must start with a year number, or a TAB.
352 sc_changelog:
353         @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
354           grep -n '^[^12        ]'                                      \
355             $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') &&              \
356           { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
357             exit 1; } || :;                                             \
358         fi
359
360 # Ensure that each .c file containing a "main" function also
361 # calls set_program_name.
362 sc_program_name:
363         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
364           files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
365           grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files         \
366               | grep . &&                                               \
367           { echo '$(ME): the above files do not call set_program_name'  \
368                 1>&2; exit 1; } || :;                                   \
369         else :;                                                         \
370         fi
371
372 # Require that the final line of each test-lib.sh-using test be this one:
373 # Exit $fail
374 # Note: this test requires GNU grep's --label= option.
375 Exit_witness_file ?= tests/test-lib.sh
376 Exit_base := $(notdir $(Exit_witness_file))
377 sc_require_test_exit_idiom:
378         @if test -f $(srcdir)/$(Exit_witness_file); then                \
379           die=0;                                                        \
380           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
381                 $$($(VC_LIST) tests)); do                               \
382             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
383               && : || { die=1; echo $$i; }                              \
384           done;                                                         \
385           test $$die = 1 &&                                             \
386             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
387               echo 1>&2 'Exit something';                               \
388               exit 1; } || :;                                           \
389         fi
390
391 sc_the_the:
392         @re='\<the ''the\>'                                             \
393         ignore_case=1 msg='found use of "the ''the";'                   \
394           $(_prohibit_regexp)
395
396 sc_trailing_blank:
397         @re='[   ]$$'                                                   \
398         msg='found trailing blank(s)'                                   \
399           $(_prohibit_regexp)
400
401 # Match lines like the following, but where there is only one space
402 # between the options and the description:
403 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
404 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
405 sc_two_space_separator_in_usage:
406         @grep -nE '^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
407             $$($(VC_LIST_EXCEPT)) &&                                    \
408           { echo "$(ME): help2man requires at least two spaces between"; \
409             echo "$(ME): an option and its description";                \
410                 1>&2; exit 1; } || :
411
412 # Look for diagnostics that aren't marked for translation.
413 # This won't find any for which error's format string is on a separate line.
414 sc_unmarked_diagnostics:
415         @grep -nE                                                       \
416             '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))       \
417           | grep -v '_''(' &&                                           \
418           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
419             exit 1; } || :
420
421 # Avoid useless parentheses like those in this example:
422 # #if defined (SYMBOL) || defined (SYM2)
423 sc_useless_cpp_parens:
424         @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) &&         \
425           { echo '$(ME): found useless parentheses in cpp directive'    \
426                 1>&2; exit 1; } || :
427
428 # Require the latest GPL.
429 sc_GPL_version:
430         @re='either ''version [^3]' msg='GPL vN, N!=3'                  \
431           $(_prohibit_regexp)
432
433 cvs_keywords = \
434   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
435
436 sc_prohibit_cvs_keyword:
437         @re='\$$($(cvs_keywords))\$$'                                   \
438             msg='do not use CVS keyword expansion'                      \
439           $(_prohibit_regexp)
440
441 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
442 # This is a bit of a kludge, since it prevents use of the string
443 # even in comments, but for now it does the job with no false positives.
444 sc_prohibit_stat_st_blocks:
445         @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS'  \
446           $(_prohibit_regexp)
447
448 # Make sure we don't define any S_IS* macros in src/*.c files.
449 # They're already defined via gnulib's sys/stat.h replacement.
450 sc_prohibit_S_IS_definition:
451         @re='^ *# *define  *S_IS'                                       \
452         msg='do not define S_IS* macros; include <sys/stat.h>'          \
453           $(_prohibit_regexp)
454
455 # Each program that uses proper_name_utf8 must link with
456 # one of the ICONV libraries.
457 sc_proper_name_utf8_requires_ICONV:
458         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
459         if test "x$$progs" != x; then                                   \
460           fail=0;                                                       \
461           for p in $$progs; do                                          \
462             dir=$$(dirname "$$p");                                      \
463             base=$$(basename "$$p" .c);                                 \
464             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
465               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
466           done;                                                         \
467           test $$fail = 1 &&                                            \
468             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
469               exit 1; } || :;                                           \
470         fi
471
472 # Warn about "c0nst struct Foo const foo[]",
473 # but not about "char const *const foo" or "#define const const".
474 sc_redundant_const:
475         @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'                \
476         msg='redundant "const" in declarations'                         \
477           $(_prohibit_regexp)
478
479 sc_const_long_option:
480         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
481           | grep -Ev 'const struct option|struct option const' && {     \
482               echo 1>&2 '$(ME): add "const" to the above declarations'; \
483               exit 1; } || :
484
485 NEWS_hash =                                                             \
486   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
487        $(srcdir)/NEWS                                                   \
488      | grep -v '^Copyright .*Free Software'                             \
489      | md5sum -                                                         \
490      | sed 's/ .*//')
491
492 # Ensure that we don't accidentally insert an entry into an old NEWS block.
493 sc_immutable_NEWS:
494         @if test -f $(srcdir)/NEWS; then                                \
495           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
496             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
497         fi
498
499 # Update the hash stored above.  Do this after each release and
500 # for any corrections to old entries.
501 update-NEWS-hash: NEWS
502         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
503           $(srcdir)/cfg.mk
504
505 # Ensure that we use only the standard $(VAR) notation,
506 # not @...@ in Makefile.am, now that we can rely on automake
507 # to emit a definition for each substituted variable.
508 # We use perl rather than "grep -nE ..." to exempt a single
509 # use of an @...@-delimited variable name in src/Makefile.am.
510 sc_makefile_check:
511         @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/'        \
512           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
513             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
514           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
515
516 news-date-check: NEWS
517         today=`date +%Y-%m-%d`;                                         \
518         if head $(srcdir)/NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
519             >/dev/null; then                                            \
520           :;                                                            \
521         else                                                            \
522           echo "version or today's date is not in NEWS" 1>&2;           \
523           exit 1;                                                       \
524         fi
525
526 sc_makefile_TAB_only_indentation:
527         @grep -nE '^    [ ]{8}'                                         \
528             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
529           && { echo '$(ME): found TAB-8-space indentation' 1>&2;        \
530                exit 1; } || :
531
532 sc_m4_quote_check:
533         @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
534             $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$')   \
535           && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2;       \
536                exit 1; } || :
537
538 fix_po_file_diag = \
539 'you have changed the set of files with translatable diagnostics;\n\
540 apply the above patch\n'
541
542 # Verify that all source files using _() are listed in po/POTFILES.in.
543 po_file = po/POTFILES.in
544 sc_po_check:
545         @if test -f $(po_file); then                                    \
546           grep -E -v '^(#|$$)' $(po_file)                               \
547             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
548           files=;                                                       \
549           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
550             test -r $$file || continue;                                 \
551             case $$file in                                              \
552               *.m4|*.mk) continue ;;                                    \
553               *.?|*.??) ;;                                              \
554               *) continue;;                                             \
555             esac;                                                       \
556             case $$file in                                              \
557             *.[ch])                                                     \
558               base=`expr " $$file" : ' \(.*\)\..'`;                     \
559               { test -f $$base.l || test -f $$base.y; } && continue;;   \
560             esac;                                                       \
561             files="$$files $$file";                                     \
562           done;                                                         \
563           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
564             | sort -u > $@-2;                                           \
565           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
566             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
567           rm -f $@-1 $@-2;                                              \
568         fi
569
570 # Sometimes it is useful to change the PATH environment variable
571 # in Makefiles.  When doing so, it's better not to use the Unix-centric
572 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
573 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
574 sc_makefile_path_separator_check:
575         @grep -nE 'PATH[=].*:'                                          \
576             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
577           && { echo $(msg) 1>&2; exit 1; } || :
578
579 # Check that `make alpha' will not fail at the end of the process.
580 writable-files:
581         if test -d $(release_archive_dir); then :; else                 \
582           for file in $(distdir).tar.gz                                 \
583                       $(release_archive_dir)/$(distdir).tar.gz; do      \
584             test -e $$file || continue;                                 \
585             test -w $$file                                              \
586               || { echo ERROR: $$file is not writable; fail=1; };       \
587           done;                                                         \
588           test "$$fail" && exit 1 || : ;                                \
589         fi
590
591 v_etc_file = lib/version-etc.c
592 sample-test = tests/sample-test
593 texi = doc/$(PACKAGE).texi
594 # Make sure that the copyright date in $(v_etc_file) is up to date.
595 # Do the same for the $(sample-test) and the main doc/.texi file.
596 sc_copyright_check:
597         @if test -f $(v_etc_file); then                                 \
598           grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
599             >/dev/null                                                  \
600           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
601                exit 1; };                                               \
602         fi
603         @if test -f $(sample-test); then                                \
604           grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test)     \
605             >/dev/null                                                  \
606           || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
607                exit 1; };                                               \
608         fi
609         @if test -f $(texi); then                                       \
610           grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi)   \
611             >/dev/null                                                  \
612           || { echo 'out of date copyright in $(texi); update it' 1>&2; \
613                exit 1; };                                               \
614         fi
615
616 vc-diff-check:
617         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
618         if test -s vc-diffs; then                               \
619           cat vc-diffs;                                         \
620           echo "Some files are locally modified:" 1>&2;         \
621           exit 1;                                               \
622         else                                                    \
623           rm vc-diffs;                                          \
624         fi
625
626 # Use this to make sure we don't run these programs when building
627 # from a virgin tgz file, below.
628 null_AM_MAKEFLAGS = \
629   ACLOCAL=false \
630   AUTOCONF=false \
631   AUTOMAKE=false \
632   AUTOHEADER=false \
633   MAKEINFO=false
634
635 built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
636
637 rel-files = $(DIST_ARCHIVES)
638
639 gnulib_dir ?= $(srcdir)/gnulib
640 gnulib-version = $$(cd $(gnulib_dir) && git describe)
641 bootstrap-tools ?= autoconf,automake,gnulib
642
643 announcement: NEWS ChangeLog $(rel-files)
644         @$(build_aux)/announce-gen                                      \
645             --release-type=$(RELEASE_TYPE)                              \
646             --package=$(PACKAGE)                                        \
647             --prev=$(PREV_VERSION)                                      \
648             --curr=$(VERSION)                                           \
649             --gpg-key-id=$(gpg_key_ID)                                  \
650             --news=NEWS                                                 \
651             --bootstrap-tools=$(bootstrap-tools)                        \
652             --gnulib-version=$(gnulib-version)                          \
653             --no-print-checksums                                        \
654             $(addprefix --url-dir=, $(url_dir_list))
655
656 ## ---------------- ##
657 ## Updating files.  ##
658 ## ---------------- ##
659
660 ftp-gnu = ftp://ftp.gnu.org/gnu
661 www-gnu = http://www.gnu.org
662
663 emit_upload_commands:
664         @echo =====================================
665         @echo =====================================
666         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
667         @echo "    --to $(gnu_rel_host):$(PACKAGE) \\"
668         @echo "  $(rel-files)"
669         @echo '# send the /tmp/announcement e-mail'
670         @echo =====================================
671         @echo =====================================
672
673 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
674 define emit-commit-log
675   printf '%s\n' 'post-release administrivia' '' \
676     '* NEWS: Add header line for next release.' \
677     '* .prev-version: Record previous version.' \
678     '* cfg.mk (old_NEWS_hash): Auto-update.'
679 endef
680
681 .PHONY: no-submodule-changes
682 no-submodule-changes:
683         if test -d $(srcdir)/.git; then                                 \
684           diff=$$(cd $(srcdir) && git submodule -q foreach              \
685                   git diff-index --name-only HEAD)                      \
686             || exit 1;                                                  \
687           case $$diff in '') ;;                                         \
688             *) echo '$(ME): submodule files are locally modified:';     \
689                 echo "$$diff"; exit 1;; esac;                           \
690         else                                                            \
691           : ;                                                           \
692         fi
693
694 .PHONY: alpha beta major
695 ALL_RECURSIVE_TARGETS += alpha beta major
696 alpha beta major: $(local-check) writable-files no-submodule-changes
697         test $@ = major                                         \
698           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
699                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
700           || :
701         $(MAKE) vc-diff-check
702         $(MAKE) news-date-check
703         $(MAKE) distcheck
704         $(MAKE) dist XZ_OPT=-9ev
705         $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
706         if test -d $(release_archive_dir); then                 \
707           ln $(rel-files) $(release_archive_dir);               \
708           chmod a-w $(rel-files);                               \
709         fi
710         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
711         echo $(VERSION) > $(prev_version_file)
712         $(MAKE) update-NEWS-hash
713         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
714         $(emit-commit-log) > .ci-msg
715         $(VC) commit -F .ci-msg -a
716
717 .PHONY: web-manual
718 web-manual:
719         @test -z "$(manual_title)" \
720           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
721         @cd '$(srcdir)/doc'; \
722           $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
723              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
724             "$(PACKAGE_NAME) - $(manual_title)"
725         @echo " *** Upload the doc/manual directory to web-cvs."
726
727 # Code Coverage
728
729 init-coverage:
730         $(MAKE) $(AM_MAKEFLAGS) clean
731         lcov --directory . --zerocounters
732
733 COVERAGE_CCOPTS ?= "-g --coverage"
734 COVERAGE_OUT ?= doc/coverage
735
736 build-coverage:
737         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
738         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
739         mkdir -p $(COVERAGE_OUT)
740         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
741                 --capture
742
743 gen-coverage:
744         genhtml --output-directory $(COVERAGE_OUT) \
745                 $(COVERAGE_OUT)/$(PACKAGE).info \
746                 --highlight --frames --legend \
747                 --title "$(PACKAGE_NAME)"
748
749 coverage: init-coverage build-coverage gen-coverage
750
751 # Update gettext files.
752 PACKAGE ?= $(shell basename $(PWD))
753 PO_DOMAIN ?= $(PACKAGE)
754 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
755 PODIR ?= po
756 refresh-po:
757         rm -f $(PODIR)/*.po && \
758         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
759         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
760         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
761         echo 'en@quot' >> $(PODIR)/LINGUAS && \
762         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
763
764 INDENT_SOURCES ?= $(C_SOURCES)
765 .PHONY: indent
766 indent:
767         indent $(INDENT_SOURCES)
768
769 # If you want to set UPDATE_COPYRIGHT_* environment variables,
770 # put the assignments in this variable.
771 update-copyright-env ?=
772
773 # Run this rule once per year (usually early in January)
774 # to update all FSF copyright year lists in your project.
775 # If you have an additional project-specific rule,
776 # add it in cfg.mk along with a line 'update-copyright: prereq'.
777 # By default, exclude all variants of COPYING; you can also
778 # add exemptions (such as ChangeLog..* for rotated change logs)
779 # in the file .x-update-copyright.
780 .PHONY: update-copyright
781 update-copyright:
782         grep -l -w Copyright                                             \
783           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
784           | $(update-copyright-env) xargs $(build_aux)/$@