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 := $(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   h_esc=`echo "$$h"|sed 's/\./\\./g'`;                                  \
239   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
240     files=$$(grep -l '^# *include '"$$h_esc"                            \
241              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
242     grep -LE "$$re" $$files | grep . &&                                 \
243       { echo "$(ME): the above files include $$h but don't use it"      \
244         1>&2; exit 1; } || :;                                           \
245   else :;                                                               \
246   fi
247 endef
248
249 # Prohibit the inclusion of assert.h without an actual use of assert.
250 sc_prohibit_assert_without_use:
251         @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
252
253 # Prohibit the inclusion of getopt.h without an actual use.
254 sc_prohibit_getopt_without_use:
255         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
256
257 # Don't include quotearg.h unless you use one of its functions.
258 sc_prohibit_quotearg_without_use:
259         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
260
261 # Don't include quote.h unless you use one of its functions.
262 sc_prohibit_quote_without_use:
263         @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
264
265 # Don't include this header unless you use one of its functions.
266 sc_prohibit_long_options_without_use:
267         @h='"long-options.h"' re='\<parse_long_options *\(' \
268           $(_header_without_use)
269
270 # Don't include this header unless you use one of its functions.
271 sc_prohibit_inttostr_without_use:
272         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
273           $(_header_without_use)
274
275 # Don't include this header unless you use one of its functions.
276 sc_prohibit_error_without_use:
277         @h='"error.h"' \
278         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
279           $(_header_without_use)
280
281 sc_prohibit_safe_read_without_use:
282         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
283           $(_header_without_use)
284
285 sc_prohibit_argmatch_without_use:
286         @h='"argmatch.h"' \
287         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
288           $(_header_without_use)
289
290 sc_prohibit_root_dev_ino_without_use:
291         @h='"root-dev-ino.h"' \
292         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
293           $(_header_without_use)
294
295 # Prohibit the inclusion of c-ctype.h without an actual use.
296 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
297 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
298 sc_prohibit_c_ctype_without_use:
299         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
300
301 _empty =
302 _sp = $(_empty) $(_empty)
303 # The following list was generated by running:
304 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
305 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
306 _sig_functions = \
307   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
308   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
309   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
310   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
311 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
312 # The following were extracted from "man signal.h" manually.
313 _sig_types_and_consts =                                                 \
314   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
315   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
316   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
317   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
318   sigstack sigval stack_t ucontext_t
319 # generated via this:
320 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
321 _sig_names =                                                            \
322   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
323   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
324   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
325   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
326   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
327   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
328   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
329   SIGXCPU SIGXFSZ
330 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
331
332 # Prohibit the inclusion of signal.h without an actual use.
333 sc_prohibit_signal_without_use:
334         @h='<signal.h>'                                                 \
335         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
336           $(_header_without_use)
337
338 sc_obsolete_symbols:
339         @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                           \
340         msg='do not use HAVE''_FCNTL_H or O'_NDELAY                     \
341           $(_prohibit_regexp)
342
343 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
344
345 # Each nonempty ChangeLog line must start with a year number, or a TAB.
346 sc_changelog:
347         @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
348           grep -n '^[^12        ]'                                      \
349             $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') &&              \
350           { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
351             exit 1; } || :;                                             \
352         fi
353
354 # Ensure that each .c file containing a "main" function also
355 # calls set_program_name.
356 sc_program_name:
357         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
358           files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
359           grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files         \
360               | grep . &&                                               \
361           { echo '$(ME): the above files do not call set_program_name'  \
362                 1>&2; exit 1; } || :;                                   \
363         else :;                                                         \
364         fi
365
366 # Require that the final line of each test-lib.sh-using test be this one:
367 # Exit $fail
368 # Note: this test requires GNU grep's --label= option.
369 Exit_witness_file ?= tests/test-lib.sh
370 Exit_base := $(notdir $(Exit_witness_file))
371 sc_require_test_exit_idiom:
372         @if test -f $(srcdir)/$(Exit_witness_file); then                \
373           die=0;                                                        \
374           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
375                 $$($(VC_LIST) tests)); do                               \
376             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
377               && : || { die=1; echo $$i; }                              \
378           done;                                                         \
379           test $$die = 1 &&                                             \
380             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
381               echo 1>&2 'Exit something';                               \
382               exit 1; } || :;                                           \
383         fi
384
385 sc_the_the:
386         @re='\<the ''the\>'                                             \
387         ignore_case=1 msg='found use of "the ''the";'                   \
388           $(_prohibit_regexp)
389
390 sc_trailing_blank:
391         @re='[   ]$$'                                                   \
392         msg='found trailing blank(s)'                                   \
393           $(_prohibit_regexp)
394
395 # Match lines like the following, but where there is only one space
396 # between the options and the description:
397 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
398 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
399 sc_two_space_separator_in_usage:
400         @grep -nE '^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
401             $$($(VC_LIST_EXCEPT)) &&                                    \
402           { echo "$(ME): help2man requires at least two spaces between"; \
403             echo "$(ME): an option and its description";                \
404                 1>&2; exit 1; } || :
405
406 # Look for diagnostics that aren't marked for translation.
407 # This won't find any for which error's format string is on a separate line.
408 sc_unmarked_diagnostics:
409         @grep -nE                                                       \
410             '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))       \
411           | grep -v '_''(' &&                                           \
412           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
413             exit 1; } || :
414
415 # Avoid useless parentheses like those in this example:
416 # #if defined (SYMBOL) || defined (SYM2)
417 sc_useless_cpp_parens:
418         @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) &&         \
419           { echo '$(ME): found useless parentheses in cpp directive'    \
420                 1>&2; exit 1; } || :
421
422 # Require the latest GPL.
423 sc_GPL_version:
424         @re='either ''version [^3]' msg='GPL vN, N!=3'                  \
425           $(_prohibit_regexp)
426
427 cvs_keywords = \
428   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
429
430 sc_prohibit_cvs_keyword:
431         @re='\$$($(cvs_keywords))\$$'                                   \
432             msg='do not use CVS keyword expansion'                      \
433           $(_prohibit_regexp)
434
435 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
436 # This is a bit of a kludge, since it prevents use of the string
437 # even in comments, but for now it does the job with no false positives.
438 sc_prohibit_stat_st_blocks:
439         @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS'  \
440           $(_prohibit_regexp)
441
442 # Make sure we don't define any S_IS* macros in src/*.c files.
443 # They're already defined via gnulib's sys/stat.h replacement.
444 sc_prohibit_S_IS_definition:
445         @re='^ *# *define  *S_IS'                                       \
446         msg='do not define S_IS* macros; include <sys/stat.h>'          \
447           $(_prohibit_regexp)
448
449 # Each program that uses proper_name_utf8 must link with
450 # one of the ICONV libraries.
451 sc_proper_name_utf8_requires_ICONV:
452         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
453         if test "x$$progs" != x; then                                   \
454           fail=0;                                                       \
455           for p in $$progs; do                                          \
456             dir=$$(dirname "$$p");                                      \
457             base=$$(basename "$$p" .c);                                 \
458             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
459               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
460           done;                                                         \
461           test $$fail = 1 &&                                            \
462             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
463               exit 1; } || :;                                           \
464         fi
465
466 # Warn about "c0nst struct Foo const foo[]",
467 # but not about "char const *const foo" or "#define const const".
468 sc_redundant_const:
469         @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'                \
470         msg='redundant "const" in declarations'                         \
471           $(_prohibit_regexp)
472
473 sc_const_long_option:
474         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
475           | grep -Ev 'const struct option|struct option const' && {     \
476               echo 1>&2 '$(ME): add "const" to the above declarations'; \
477               exit 1; } || :
478
479 NEWS_hash =                                                             \
480   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
481        $(srcdir)/NEWS                                                   \
482      | grep -v '^Copyright .*Free Software'                             \
483      | md5sum -                                                         \
484      | sed 's/ .*//')
485
486 # Ensure that we don't accidentally insert an entry into an old NEWS block.
487 sc_immutable_NEWS:
488         @if test -f $(srcdir)/NEWS; then                                \
489           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
490             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
491         fi
492
493 # Update the hash stored above.  Do this after each release and
494 # for any corrections to old entries.
495 update-NEWS-hash: NEWS
496         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
497           $(srcdir)/cfg.mk
498
499 # Ensure that we use only the standard $(VAR) notation,
500 # not @...@ in Makefile.am, now that we can rely on automake
501 # to emit a definition for each substituted variable.
502 # We use perl rather than "grep -nE ..." to exempt a single
503 # use of an @...@-delimited variable name in src/Makefile.am.
504 sc_makefile_check:
505         @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/'        \
506           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
507             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
508           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
509
510 news-date-check: NEWS
511         today=`date +%Y-%m-%d`;                                         \
512         if head $(srcdir)/NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
513             >/dev/null; then                                            \
514           :;                                                            \
515         else                                                            \
516           echo "version or today's date is not in NEWS" 1>&2;           \
517           exit 1;                                                       \
518         fi
519
520 sc_makefile_TAB_only_indentation:
521         @grep -nE '^    [ ]{8}'                                         \
522             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
523           && { echo '$(ME): found TAB-8-space indentation' 1>&2;        \
524                exit 1; } || :
525
526 sc_m4_quote_check:
527         @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
528             $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$')   \
529           && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2;       \
530                exit 1; } || :
531
532 fix_po_file_diag = \
533 'you have changed the set of files with translatable diagnostics;\n\
534 apply the above patch\n'
535
536 # Verify that all source files using _() are listed in po/POTFILES.in.
537 po_file = po/POTFILES.in
538 sc_po_check:
539         @if test -f $(po_file); then                                    \
540           grep -E -v '^(#|$$)' $(po_file)                               \
541             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
542           files=;                                                       \
543           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
544             test -r $$file || continue;                                 \
545             case $$file in                                              \
546               *.m4|*.mk) continue ;;                                    \
547               *.?|*.??) ;;                                              \
548               *) continue;;                                             \
549             esac;                                                       \
550             case $$file in                                              \
551             *.[ch])                                                     \
552               base=`expr " $$file" : ' \(.*\)\..'`;                     \
553               { test -f $$base.l || test -f $$base.y; } && continue;;   \
554             esac;                                                       \
555             files="$$files $$file";                                     \
556           done;                                                         \
557           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
558             | sort -u > $@-2;                                           \
559           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
560             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
561           rm -f $@-1 $@-2;                                              \
562         fi
563
564 # Sometimes it is useful to change the PATH environment variable
565 # in Makefiles.  When doing so, it's better not to use the Unix-centric
566 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
567 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
568 sc_makefile_path_separator_check:
569         @grep -nE 'PATH[=].*:'                                          \
570             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
571           && { echo $(msg) 1>&2; exit 1; } || :
572
573 # Check that `make alpha' will not fail at the end of the process.
574 writable-files:
575         if test -d $(release_archive_dir); then :; else                 \
576           for file in $(distdir).tar.gz                                 \
577                       $(release_archive_dir)/$(distdir).tar.gz; do      \
578             test -e $$file || continue;                                 \
579             test -w $$file                                              \
580               || { echo ERROR: $$file is not writable; fail=1; };       \
581           done;                                                         \
582           test "$$fail" && exit 1 || : ;                                \
583         fi
584
585 v_etc_file = lib/version-etc.c
586 sample-test = tests/sample-test
587 texi = doc/$(PACKAGE).texi
588 # Make sure that the copyright date in $(v_etc_file) is up to date.
589 # Do the same for the $(sample-test) and the main doc/.texi file.
590 sc_copyright_check:
591         @if test -f $(v_etc_file); then                                 \
592           grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
593             >/dev/null                                                  \
594           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
595                exit 1; };                                               \
596         fi
597         @if test -f $(sample-test); then                                \
598           grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test)     \
599             >/dev/null                                                  \
600           || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
601                exit 1; };                                               \
602         fi
603         @if test -f $(texi); then                                       \
604           grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi)   \
605             >/dev/null                                                  \
606           || { echo 'out of date copyright in $(texi); update it' 1>&2; \
607                exit 1; };                                               \
608         fi
609
610 vc-diff-check:
611         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
612         if test -s vc-diffs; then                               \
613           cat vc-diffs;                                         \
614           echo "Some files are locally modified:" 1>&2;         \
615           exit 1;                                               \
616         else                                                    \
617           rm vc-diffs;                                          \
618         fi
619
620 cvs-check: vc-diff-check
621
622 ALL_RECURSIVE_TARGETS += maintainer-distcheck
623 maintainer-distcheck:
624         $(MAKE) distcheck
625         $(MAKE) taint-distcheck
626         $(MAKE) my-distcheck
627
628
629 # Don't make a distribution if checks fail.
630 # Also, make sure the NEWS file is up-to-date.
631 ALL_RECURSIVE_TARGETS += vc-dist
632 vc-dist: $(local-check) cvs-check maintainer-distcheck
633         XZ_OPT=9ev $(MAKE) dist
634
635 # Use this to make sure we don't run these programs when building
636 # from a virgin tgz file, below.
637 null_AM_MAKEFLAGS = \
638   ACLOCAL=false \
639   AUTOCONF=false \
640   AUTOMAKE=false \
641   AUTOHEADER=false \
642   MAKEINFO=false
643
644 built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
645
646 rel-files = $(DIST_ARCHIVES)
647
648 gnulib_dir ?= $(srcdir)/gnulib
649 gnulib-version = $$(cd $(gnulib_dir) && git describe)
650 bootstrap-tools ?= autoconf,automake,gnulib
651
652 announcement: NEWS ChangeLog $(rel-files)
653         @$(build_aux)/announce-gen                                      \
654             --release-type=$(RELEASE_TYPE)                              \
655             --package=$(PACKAGE)                                        \
656             --prev=$(PREV_VERSION)                                      \
657             --curr=$(VERSION)                                           \
658             --gpg-key-id=$(gpg_key_ID)                                  \
659             --news=NEWS                                                 \
660             --bootstrap-tools=$(bootstrap-tools)                        \
661             --gnulib-version=$(gnulib-version)                          \
662             --no-print-checksums                                        \
663             $(addprefix --url-dir=, $(url_dir_list))
664
665 ## ---------------- ##
666 ## Updating files.  ##
667 ## ---------------- ##
668
669 ftp-gnu = ftp://ftp.gnu.org/gnu
670 www-gnu = http://www.gnu.org
671
672 emit_upload_commands:
673         @echo =====================================
674         @echo =====================================
675         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
676         @echo "    --to $(gnu_rel_host):$(PACKAGE) \\"
677         @echo "  $(rel-files)"
678         @echo '# send the /tmp/announcement e-mail'
679         @echo =====================================
680         @echo =====================================
681
682 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
683 define emit-commit-log
684   printf '%s\n' 'post-release administrivia' '' \
685     '* NEWS: Add header line for next release.' \
686     '* .prev-version: Record previous version.' \
687     '* cfg.mk (old_NEWS_hash): Auto-update.'
688 endef
689
690 .PHONY: no-submodule-changes
691 no-submodule-changes:
692         if test -d $(srcdir)/.git; then                                 \
693           diff=$$(cd $(srcdir) && git submodule -q foreach              \
694                   git diff-index --name-only HEAD)                      \
695             || exit 1;                                                  \
696           case $$diff in '') ;;                                         \
697             *) echo '$(ME): submodule files are locally modified:';     \
698                 echo "$$diff"; exit 1;; esac;                           \
699         else                                                            \
700           : ;                                                           \
701         fi
702
703 .PHONY: alpha beta major
704 ALL_RECURSIVE_TARGETS += alpha beta major
705 alpha beta major: $(local-check) writable-files no-submodule-changes
706         test $@ = major                                         \
707           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
708                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
709           || :
710         $(MAKE) vc-dist
711         $(MAKE) news-date-check
712         $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
713         if test -d $(release_archive_dir); then                 \
714           ln $(rel-files) $(release_archive_dir);               \
715           chmod a-w $(rel-files);                               \
716         fi
717         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
718         echo $(VERSION) > $(prev_version_file)
719         $(MAKE) update-NEWS-hash
720         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
721         $(emit-commit-log) > .ci-msg
722         $(VC) commit -F .ci-msg -a
723
724 .PHONY: web-manual
725 web-manual:
726         @test -z "$(manual_title)" \
727           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
728         @cd '$(srcdir)/doc'; \
729           $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
730              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
731             "$(PACKAGE_NAME) - $(manual_title)"
732         @echo " *** Upload the doc/manual directory to web-cvs."
733
734 # Code Coverage
735
736 init-coverage:
737         $(MAKE) $(AM_MAKEFLAGS) clean
738         lcov --directory . --zerocounters
739
740 COVERAGE_CCOPTS ?= "-g --coverage"
741 COVERAGE_OUT ?= doc/coverage
742
743 build-coverage:
744         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
745         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
746         mkdir -p $(COVERAGE_OUT)
747         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
748                 --capture
749
750 gen-coverage:
751         genhtml --output-directory $(COVERAGE_OUT) \
752                 $(COVERAGE_OUT)/$(PACKAGE).info \
753                 --highlight --frames --legend \
754                 --title "$(PACKAGE_NAME)"
755
756 coverage: init-coverage build-coverage gen-coverage
757
758 # Update gettext files.
759 PACKAGE ?= $(shell basename $(PWD))
760 PO_DOMAIN ?= $(PACKAGE)
761 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
762 PODIR ?= po
763 refresh-po:
764         rm -f $(PODIR)/*.po && \
765         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
766         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
767         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
768         echo 'en@quot' >> $(PODIR)/LINGUAS && \
769         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
770
771 INDENT_SOURCES ?= $(C_SOURCES)
772 .PHONY: indent
773 indent:
774         indent $(INDENT_SOURCES)
775
776 # If you want to set UPDATE_COPYRIGHT_* environment variables,
777 # put the assignments in this variable.
778 update-copyright-env ?=
779
780 # Run this rule once per year (usually early in January)
781 # to update all FSF copyright year lists in your project.
782 # If you have an additional project-specific rule,
783 # add it in cfg.mk along with a line 'update-copyright: prereq'.
784 # By default, exclude all variants of COPYING; you can also
785 # add exemptions (such as ChangeLog..* for rotated change logs)
786 # in the file .x-update-copyright.
787 .PHONY: update-copyright
788 update-copyright:
789         grep -l -w Copyright                                             \
790           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
791           | $(update-copyright-env) xargs $(build_aux)/$@