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-2010 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 \
31     && printf %s --rsyncable)
32 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
33
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 # You can override this variable in cfg.mk to set your own regexp
41 # matching files to ignore.
42 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$
43
44 # This is to preprocess robustly the output of $(VC_LIST), so that even
45 # when $(srcdir) is a pathological name like "....", the leading sed command
46 # removes only the intended prefix.
47 _dot_escaped_srcdir = $(subst .,\.,$(srcdir))
48
49 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only
50 # when $(srcdir) is not ".".
51 ifeq ($(srcdir),.)
52 _prepend_srcdir_prefix =
53 else
54 _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|'
55 endif
56
57 # In order to be able to consistently filter "."-relative names,
58 # (i.e., with no $(srcdir) prefix), this definition is careful to
59 # remove any $(srcdir) prefix, and to restore what it removes.
60 VC_LIST_EXCEPT = \
61   $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
62         | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
63           else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
64         | grep -Ev -e '$(VC_LIST_ALWAYS_EXCLUDE_REGEX)' \
65         $(_prepend_srcdir_prefix)
66
67 ifeq ($(origin prev_version_file), undefined)
68   prev_version_file = $(srcdir)/.prev-version
69 endif
70
71 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
72 VERSION_REGEXP = $(subst .,\.,$(VERSION))
73 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
74
75 ifeq ($(VC),$(GIT))
76 this-vc-tag = v$(VERSION)
77 this-vc-tag-regexp = v$(VERSION_REGEXP)
78 else
79 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
80 tag-this-version = $(subst .,_,$(VERSION))
81 this-vc-tag = $(tag-package)-$(tag-this-version)
82 this-vc-tag-regexp = $(this-vc-tag)
83 endif
84 my_distdir = $(PACKAGE)-$(VERSION)
85
86 # Old releases are stored here.
87 release_archive_dir ?= ../release
88
89 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
90 # Use alpha.gnu.org for alpha and beta releases.
91 # Use ftp.gnu.org for stable releases.
92 gnu_ftp_host-alpha = alpha.gnu.org
93 gnu_ftp_host-beta = alpha.gnu.org
94 gnu_ftp_host-stable = ftp.gnu.org
95 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
96
97 ifeq ($(gnu_rel_host),ftp.gnu.org)
98 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
99 else
100 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
101 endif
102
103 # Override this in cfg.mk if you are using a different format in your
104 # NEWS file.
105 today = $(shell date +%Y-%m-%d)
106
107 # Select which lines of NEWS are searched for $(news-check-regexp).
108 # This is a sed line number spec.  The default says that we search
109 # lines 1..10 of NEWS for $(news-check-regexp).
110 # If you want to search only line 3 or only lines 20-22, use "3" or "20,22".
111 news-check-lines-spec ?= 1,10
112 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
113
114 # Prevent programs like 'sort' from considering distinct strings to be equal.
115 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
116 export LC_ALL = C
117
118 ## --------------- ##
119 ## Sanity checks.  ##
120 ## --------------- ##
121
122 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
123
124 # Collect the names of rules starting with `sc_'.
125 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
126                         $(srcdir)/$(ME) $(_cfg_mk)))
127 .PHONY: $(syntax-check-rules)
128
129 local-checks-available = \
130   $(syntax-check-rules)
131 .PHONY: $(local-checks-available)
132
133 # Arrange to print the name of each syntax-checking rule just before running it.
134 $(syntax-check-rules): %: %.m
135 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
136 .PHONY: $(sc_m_rules_)
137 $(sc_m_rules_):
138         @echo $(patsubst sc_%.m, %, $@)
139         @date +%s.%N > .sc-start-$(basename $@)
140
141 # Compute and print the elapsed time for each syntax-check rule.
142 sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))
143 .PHONY: $(sc_z_rules_)
144 $(sc_z_rules_): %.z: %
145         @end=$$(date +%s.%N);                                           \
146         start=$$(cat .sc-start-$*);                                     \
147         rm -f .sc-start-$*;                                             \
148         awk -v s=$$start -v e=$$end                                     \
149           'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null
150
151 # The patsubst here is to replace each sc_% rule with its sc_%.z wrapper
152 # that computes and prints elapsed time.
153 local-check :=                                                          \
154   $(patsubst sc_%, sc_%.z,                                              \
155     $(filter-out $(local-checks-to-skip), $(local-checks-available)))
156
157 syntax-check: $(local-check)
158
159 # _sc_search_regexp
160 #
161 # This macro searches for a given construct in the selected files and
162 # then takes some action.
163 #
164 # Parameters (shell variables):
165 #
166 #  prohibit | require
167 #
168 #     Regular expression (ERE) denoting either a forbidden construct
169 #     or a required construct.  Those arguments are exclusive.
170 #
171 #  in_vc_files | in_files
172 #
173 #     grep-E-style regexp denoting the files to check.  If no files
174 #     are specified the default are all the files that are under
175 #     version control.
176 #
177 #  containing | non_containing
178 #
179 #     Select the files (non) containing strings matching this regexp.
180 #     If both arguments are specified then CONTAINING takes
181 #     precedence.
182 #
183 #  with_grep_options
184 #
185 #     Extra options for grep.
186 #
187 #  ignore_case
188 #
189 #     Ignore case.
190 #
191 #  halt
192 #
193 #     Message to display before to halting execution.
194
195 # By default, _sc_search_regexp does not ignore case.
196 export ignore_case =
197 _ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :)
198
199 define _sc_say_and_exit
200    dummy=; : so we do not need a semicolon before each use;             \
201    { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; };
202 endef
203
204 # _sc_search_regexp used to be named _prohibit_regexp.  However,
205 # upgrading to the new definition and leaving the old name undefined
206 # would usually convert each custom rule using $(_prohibit_regexp)
207 # (usually defined in cfg.mk) into a no-op.  This definition ensures
208 # that people know right away if they're still using the old name.
209 # FIXME: remove in 2012.
210 _prohibit_regexp = \
211   $(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
212
213 define _sc_search_regexp
214    dummy=; : so we do not need a semicolon before each use;             \
215                                                                         \
216    : Check arguments;                                                   \
217    test -n "$$prohibit" && test -n "$$require"                          \
218      && { msg='Cannot specify both prohibit and require'                \
219           $(_sc_say_and_exit) } || :;                                   \
220    test -z "$$prohibit" && test -z "$$require"                          \
221      && { msg='Should specify either prohibit or require'               \
222           $(_sc_say_and_exit) } || :;                                   \
223    test -n "$$in_vc_files" && test -n "$$in_files"                      \
224      && { msg='Cannot specify both in_vc_files and in_files'            \
225           $(_sc_say_and_exit) } || :;                                   \
226    test "x$$halt" != x                                                  \
227      || { msg='halt not defined' $(_sc_say_and_exit) };                 \
228                                                                         \
229    : Filter by file name;                                               \
230    if test -n "$$in_files"; then                                        \
231      files=$$(find $(srcdir) | grep -E "$$in_files");                   \
232    else                                                                 \
233      files=$$($(VC_LIST_EXCEPT));                                       \
234      if test -n "$$in_vc_files"; then                                   \
235        files=$$(echo "$$files" | grep -E "$$in_vc_files");              \
236      fi;                                                                \
237    fi;                                                                  \
238                                                                         \
239    : Filter by content;                                                 \
240    test -n "$$files" && test -n "$$containing"                          \
241      && { files=$$(grep -l "$$containing" $$files); } || :;             \
242    test -n "$$files" && test -n "$$non_containing"                      \
243      && { files=$$(grep -vl "$$non_containing" $$files); } || :;        \
244                                                                         \
245    : Check for the construct;                                           \
246    if test -n "$$files"; then                                           \
247      if test -n "$$prohibit"; then                                      \
248        grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
249          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
250      else                                                               \
251        grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
252            | grep .                                                     \
253          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
254      fi                                                                 \
255    else :;                                                              \
256    fi || :;
257 endef
258
259 sc_avoid_if_before_free:
260         @$(build_aux)/useless-if-before-free                            \
261                 $(useless_free_options)                                 \
262             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
263           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
264             exit 1; } || :
265
266 sc_cast_of_argument_to_free:
267         @prohibit='\<free *\( *\(' halt='don'\''t cast free argument'   \
268           $(_sc_search_regexp)
269
270 sc_cast_of_x_alloc_return_value:
271         @prohibit='\*\) *x(m|c|re)alloc\>'                              \
272         halt='don'\''t cast x*alloc return value'                       \
273           $(_sc_search_regexp)
274
275 sc_cast_of_alloca_return_value:
276         @prohibit='\*\) *alloca\>'                                      \
277         halt='don'\''t cast alloca return value'                        \
278           $(_sc_search_regexp)
279
280 sc_space_tab:
281         @prohibit='[ ]  '                                               \
282         halt='found SPACE-TAB sequence; remove the SPACE'               \
283           $(_sc_search_regexp)
284
285 # Don't use *scanf or the old ato* functions in `real' code.
286 # They provide no error checking mechanism.
287 # Instead, use strto* functions.
288 sc_prohibit_atoi_atof:
289         @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\('                           \
290         halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q'   \
291           $(_sc_search_regexp)
292
293 # Use STREQ rather than comparing strcmp == 0, or != 0.
294 sc_prohibit_strcmp:
295         @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *=='           \
296             $$($(VC_LIST_EXCEPT))                                       \
297           | grep -vE ':# *define STREQ\(' &&                            \
298           { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
299                 1>&2; exit 1; } || :
300
301 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
302 # Convert all uses automatically, via these two commands:
303 # git grep -l '\<exit *(1)' \
304 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
305 #  | xargs --no-run-if-empty \
306 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
307 # git grep -l '\<exit *(0)' \
308 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
309 #  | xargs --no-run-if-empty \
310 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
311 sc_prohibit_magic_number_exit:
312         @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'     \
313         halt='use EXIT_* values rather than magic number'                       \
314           $(_sc_search_regexp)
315
316 # Using EXIT_SUCCESS as the first argument to error is misleading,
317 # since when that parameter is 0, error does not exit.  Use `0' instead.
318 sc_error_exit_success:
319         @prohibit='error *\(EXIT_SUCCESS,'                              \
320         in_vc_files='\.[chly]$$'                                        \
321         halt='found error (EXIT_SUCCESS'                                \
322          $(_sc_search_regexp)
323
324 # `FATAL:' should be fully upper-cased in error messages
325 # `WARNING:' should be fully upper-cased, or fully lower-cased
326 sc_error_message_warn_fatal:
327         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
328             | grep -E '"Warning|"Fatal|"fatal' &&                       \
329           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
330             exit 1; } || :
331
332 # Error messages should not start with a capital letter
333 sc_error_message_uppercase:
334         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
335             | grep -E '"[A-Z]'                                          \
336             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
337           { echo '$(ME): found capitalized error message' 1>&2;         \
338             exit 1; } || :
339
340 # Error messages should not end with a period
341 sc_error_message_period:
342         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
343             | grep -E '[^."]\."' &&                                     \
344           { echo '$(ME): found error message ending in period' 1>&2;    \
345             exit 1; } || :
346
347 sc_file_system:
348         @prohibit=file''system                                          \
349         ignore_case=1                                                   \
350         halt='found use of "file''system"; spell it "file system"'      \
351           $(_sc_search_regexp)
352
353 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
354 sc_prohibit_have_config_h:
355         @prohibit='^# *if.*HAVE''_CONFIG_H'                             \
356         halt='found use of HAVE''_CONFIG_H; remove'                     \
357           $(_sc_search_regexp)
358
359 # Nearly all .c files must include <config.h>.  However, we also permit this
360 # via inclusion of a package-specific header, if cfg.mk specified one.
361 # config_h_header must be suitable for grep -E.
362 config_h_header ?= <config\.h>
363 sc_require_config_h:
364         @require='^# *include $(config_h_header)'                       \
365         in_vc_files='\.c$$'                                             \
366         halt='the above files do not include <config.h>'                \
367           $(_sc_search_regexp)
368
369 # You must include <config.h> before including any other header file.
370 # This can possibly be via a package-specific header, if given by cfg.mk.
371 sc_require_config_h_first:
372         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
373           fail=0;                                                       \
374           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
375             grep '^# *include\>' $$i | sed 1q                           \
376                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
377               || { echo $$i; fail=1; };                                 \
378           done;                                                         \
379           test $$fail = 1 &&                                            \
380             { echo '$(ME): the above files include some other header'   \
381                 'before <config.h>' 1>&2; exit 1; } || :;               \
382         else :;                                                         \
383         fi
384
385 sc_prohibit_HAVE_MBRTOWC:
386         @prohibit='\bHAVE_MBRTOWC\b'                                    \
387         halt="do not use $$prohibit; it is always defined"              \
388           $(_sc_search_regexp)
389
390 # To use this "command" macro, you must first define two shell variables:
391 # h: the header, enclosed in <> or ""
392 # re: a regular expression that matches IFF something provided by $h is used.
393 define _sc_header_without_use
394   dummy=; : so we do not need a semicolon before each use;              \
395   h_esc=`echo "$$h"|sed 's/\./\\\\./g'`;                                \
396   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
397     files=$$(grep -l '^# *include '"$$h_esc"                            \
398              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
399     grep -LE "$$re" $$files | grep . &&                                 \
400       { echo "$(ME): the above files include $$h but don't use it"      \
401         1>&2; exit 1; } || :;                                           \
402   else :;                                                               \
403   fi
404 endef
405
406 # Prohibit the inclusion of assert.h without an actual use of assert.
407 sc_prohibit_assert_without_use:
408         @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
409
410 # Prohibit the inclusion of close-stream.h without an actual use.
411 sc_prohibit_close_stream_without_use:
412         @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
413
414 # Prohibit the inclusion of getopt.h without an actual use.
415 sc_prohibit_getopt_without_use:
416         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
417
418 # Don't include quotearg.h unless you use one of its functions.
419 sc_prohibit_quotearg_without_use:
420         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
421
422 # Don't include quote.h unless you use one of its functions.
423 sc_prohibit_quote_without_use:
424         @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
425
426 # Don't include this header unless you use one of its functions.
427 sc_prohibit_long_options_without_use:
428         @h='"long-options.h"' re='\<parse_long_options *\(' \
429           $(_sc_header_without_use)
430
431 # Don't include this header unless you use one of its functions.
432 sc_prohibit_inttostr_without_use:
433         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
434           $(_sc_header_without_use)
435
436 # Don't include this header unless you use one of its functions.
437 sc_prohibit_ignore_value_without_use:
438         @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
439           $(_sc_header_without_use)
440
441 # Don't include this header unless you use one of its functions.
442 sc_prohibit_error_without_use:
443         @h='"error.h"' \
444         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
445           $(_sc_header_without_use)
446
447 # Don't include xalloc.h unless you use one of its functions.
448 # Consider these symbols:
449 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
450 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
451 # Divide into two sets on case, and filter each through this:
452 # | sort | perl -MRegexp::Assemble -le \
453 #  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
454 # Note this was produced by the above:
455 # _xa1 = \
456 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
457 # But we can do better, in at least two ways:
458 # 1) take advantage of two "dup"-suffixed strings:
459 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
460 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
461 # "char|[cmz]"
462 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
463 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
464 _xa2 = X([CZ]|N?M)ALLOC
465 sc_prohibit_xalloc_without_use:
466         @h='"xalloc.h"' \
467         re='\<($(_xa1)|$(_xa2)) *\('\
468           $(_sc_header_without_use)
469
470 # Extract function names:
471 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
472 _hash_re = \
473 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
474 _hash_fn = \<($(_hash_re)) *\(
475 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
476 sc_prohibit_hash_without_use:
477         @h='"hash.h"' \
478         re='$(_hash_fn)|$(_hash_struct)'\
479           $(_sc_header_without_use)
480
481 sc_prohibit_hash_pjw_without_use:
482         @h='"hash-pjw.h"' \
483         re='\<hash_pjw *\(' \
484           $(_sc_header_without_use)
485
486 sc_prohibit_safe_read_without_use:
487         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
488           $(_sc_header_without_use)
489
490 sc_prohibit_argmatch_without_use:
491         @h='"argmatch.h"' \
492         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
493           $(_sc_header_without_use)
494
495 sc_prohibit_canonicalize_without_use:
496         @h='"canonicalize.h"' \
497         re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
498           $(_sc_header_without_use)
499
500 sc_prohibit_root_dev_ino_without_use:
501         @h='"root-dev-ino.h"' \
502         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
503           $(_sc_header_without_use)
504
505 sc_prohibit_openat_without_use:
506         @h='"openat.h"' \
507         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
508           $(_sc_header_without_use)
509
510 # Prohibit the inclusion of c-ctype.h without an actual use.
511 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
512 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
513 sc_prohibit_c_ctype_without_use:
514         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' \
515           $(_sc_header_without_use)
516
517 _empty =
518 _sp = $(_empty) $(_empty)
519 # The following list was generated by running:
520 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
521 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
522 _sig_functions = \
523   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
524   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
525   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
526   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
527 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
528 # The following were extracted from "man signal.h" manually.
529 _sig_types_and_consts =                                                 \
530   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
531   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
532   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
533   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
534   sigstack sigval stack_t ucontext_t
535 # generated via this:
536 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
537 _sig_names =                                                            \
538   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
539   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
540   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
541   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
542   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
543   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
544   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
545   SIGXCPU SIGXFSZ
546 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
547
548 # Prohibit the inclusion of signal.h without an actual use.
549 sc_prohibit_signal_without_use:
550         @h='<signal.h>'                                                 \
551         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
552           $(_sc_header_without_use)
553
554 # Prohibit the inclusion of strings.h without a sensible use.
555 # Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible.
556 sc_prohibit_strings_without_use:
557         @h='<strings.h>'                                                \
558         re='\<(strn?casecmp|ffs(ll)?)\>'                                \
559           $(_sc_header_without_use)
560
561 # Get the list of symbol names with this:
562 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
563 _intprops_names =                                                       \
564   TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT             \
565   TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM           \
566   INT_STRLEN_BOUND INT_BUFSIZE_BOUND
567 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
568 # Prohibit the inclusion of intprops.h without an actual use.
569 sc_prohibit_intprops_without_use:
570         @h='"intprops.h"'                                               \
571         re='\<($(_intprops_syms_re)) *\('                               \
572           $(_sc_header_without_use)
573
574 sc_obsolete_symbols:
575         @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                     \
576         halt='do not use HAVE''_FCNTL_H or O'_NDELAY                    \
577           $(_sc_search_regexp)
578
579 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
580
581 # Each nonempty ChangeLog line must start with a year number, or a TAB.
582 sc_changelog:
583         @prohibit='^[^12        ]'                                      \
584         in_vc_files='^ChangeLog$$'                                      \
585         halt='found unexpected prefix in a ChangeLog'                   \
586           $(_sc_search_regexp)
587
588 # Ensure that each .c file containing a "main" function also
589 # calls set_program_name.
590 sc_program_name:
591         @require='set_program_name *\(m?argv\[0\]\);'                   \
592         in_vc_files='\.c$$'                                             \
593         containing='^main *('                                           \
594         halt='the above files do not call set_program_name'             \
595           $(_sc_search_regexp)
596
597 # Require that the final line of each test-lib.sh-using test be this one:
598 # Exit $fail
599 # Note: this test requires GNU grep's --label= option.
600 Exit_witness_file ?= tests/test-lib.sh
601 Exit_base := $(notdir $(Exit_witness_file))
602 sc_require_test_exit_idiom:
603         @if test -f $(srcdir)/$(Exit_witness_file); then                \
604           die=0;                                                        \
605           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
606                 $$($(VC_LIST) tests)); do                               \
607             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
608               && : || { die=1; echo $$i; }                              \
609           done;                                                         \
610           test $$die = 1 &&                                             \
611             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
612               echo 1>&2 'Exit something';                               \
613               exit 1; } || :;                                           \
614         fi
615
616 sc_the_the:
617         @prohibit='\<the ''the\>'                                       \
618         ignore_case=1                                                   \
619         halt='found use of "the ''the";'                                \
620           $(_sc_search_regexp)
621
622 sc_trailing_blank:
623         @prohibit='[     ]$$'                                           \
624         halt='found trailing blank(s)'                                  \
625           $(_sc_search_regexp)
626
627 # Match lines like the following, but where there is only one space
628 # between the options and the description:
629 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
630 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
631 sc_two_space_separator_in_usage:
632         @prohibit='^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
633         halt='help2man requires at least two spaces between an option and its description'\
634           $(_sc_search_regexp)
635
636 # Look for diagnostics that aren't marked for translation.
637 # This won't find any for which error's format string is on a separate line.
638 sc_unmarked_diagnostics:
639         @grep -nE                                                       \
640             '\<error *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))      \
641           | grep -v '_''(' &&                                           \
642           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
643             exit 1; } || :
644
645 # Avoid useless parentheses like those in this example:
646 # #if defined (SYMBOL) || defined (SYM2)
647 sc_useless_cpp_parens:
648         @prohibit='^# *if .*defined *\('                                \
649         halt='found useless parentheses in cpp directive'               \
650           $(_sc_search_regexp)
651
652 # List headers for which HAVE_HEADER_H is always true, assuming you are
653 # using the appropriate gnulib module.  CAUTION: for each "unnecessary"
654 # #if HAVE_HEADER_H that you remove, be sure that your project explicitly
655 # requires the gnulib module that guarantees the usability of that header.
656 gl_assured_headers_ = \
657   cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g'
658
659 # Convert the list of names to upper case, and replace each space with "|".
660 az_ = abcdefghijklmnopqrstuvwxyz
661 AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ
662 gl_header_upper_case_or_ =                                              \
663   $$($(gl_assured_headers_)                                             \
664     | tr $(az_)/.- $(AZ_)___                                            \
665     | tr -s ' ' '|'                                                     \
666     )
667 sc_prohibit_always_true_header_tests:
668         @or=$(gl_header_upper_case_or_);                                \
669         re="HAVE_($$or)_H";                                             \
670         prohibit='\<'"$$re"'\>'                                         \
671         halt=$$(printf '%s\n'                                           \
672         'do not test the above HAVE_<header>_H symbol(s);'              \
673         '  with the corresponding gnulib module, they are always true') \
674           $(_sc_search_regexp)
675
676 # ==================================================================
677 gl_other_headers_ ?= \
678   intprops.h    \
679   openat.h      \
680   stat-macros.h
681
682 # Perl -lne code to extract "significant" cpp-defined symbols from a
683 # gnulib header file, eliminating a few common false-positives.
684 gl_extract_significant_defines_ = \
685   /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\
686     && $$2 !~ /(?:rpl_|_used_without_)/\
687     && $$1 !~ /^(?:NSIG|ATTRIBUTE_NORETURN)$$/\
688     and print $$1
689
690 # Create a list of regular expressions matching the names
691 # of macros that are guaranteed to be defined by parts of gnulib.
692 define def_sym_regex
693         gen_h=$(gl_generated_headers_);                                 \
694         (cd $(gnulib_dir)/lib;                                          \
695           for f in *.in.h $(gl_other_headers_); do                      \
696             perl -lne '$(gl_extract_significant_defines_)' $$f;         \
697           done;                                                         \
698         ) | sort -u                                                     \
699           | grep -Ev '^ATTRIBUTE_NORETURN'                              \
700           | sed 's/^/^ *# *(define|undef)  */;s/$$/\\>/'
701 endef
702
703 # Don't define macros that we already get from gnulib header files.
704 sc_prohibit_always-defined_macros:
705         @if test -d $(gnulib_dir); then                                 \
706           case $$(echo all: | grep -l -f - Makefile) in Makefile);; *)  \
707             echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \
708           esac;                                                         \
709           $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT))         \
710             && { echo '$(ME): define the above via some gnulib .h file' \
711                   1>&2;  exit 1; } || :;                                \
712         fi
713 # ==================================================================
714
715 # Prohibit checked in backup files.
716 sc_prohibit_backup_files:
717         @$(VC_LIST) | grep '~$$' &&                             \
718           { echo '$(ME): found version controlled backup file' 1>&2;    \
719             exit 1; } || :
720
721 # Require the latest GPL.
722 sc_GPL_version:
723         @prohibit='either ''version [^3]'                               \
724         halt='GPL vN, N!=3'                                             \
725           $(_sc_search_regexp)
726
727 # Require the latest GFDL.  Two regexp, since some .texi files end up
728 # line wrapping between 'Free Documentation License,' and 'Version'.
729 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
730 sc_GFDL_version:
731         @prohibit='$(_GFDL_regexp)'                                     \
732         halt='GFDL vN, N!=3'                                            \
733           $(_sc_search_regexp)
734
735 # Don't use Texinfo @acronym{} as it is not a good idea.
736 texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$
737 sc_texinfo_acronym:
738         @prohibit='@acronym\{'                                          \
739         in_vc_files='$(texinfo_suffix_re_)'                             \
740         halt='found use of Texinfo @acronym{}'                          \
741           $(_sc_search_regexp)
742
743 cvs_keywords = \
744   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
745
746 sc_prohibit_cvs_keyword:
747         @prohibit='\$$($(cvs_keywords))\$$'                             \
748         halt='do not use CVS keyword expansion'                         \
749           $(_sc_search_regexp)
750
751 # This Perl code is slightly obfuscated.  Not only is each "$" doubled
752 # because it's in a Makefile, but the $$c's are comments;  we cannot
753 # use "#" due to the way the script ends up concatenated onto one line.
754 # It would be much more concise, and would produce better output (including
755 # counts) if written as:
756 #   perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
757 # but that would be far less efficient, reading the entire contents
758 # of each file, rather than just the last two bytes of each.
759 #
760 # This is a perl script that is expected to be the single-quoted argument
761 # to a command-line "-le".  The remaining arguments are file names.
762 # Print the name of each file that ends in two or more newline bytes.
763 # Exit nonzero if at least one such file is found, otherwise, exit 0.
764 # Warn about, but otherwise ignore open failure.  Ignore seek/read failure.
765 #
766 # Use this if you want to remove trailing empty lines from selected files:
767 #   perl -pi -0777 -e 's/\n\n+$/\n/' files...
768 #
769 detect_empty_lines_at_EOF_ =                                            \
770   foreach my $$f (@ARGV)                                                \
771     {                                                                   \
772       open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next;     \
773       my $$p = sysseek (F, -2, 2);                                      \
774       my $$c = "seek failure probably means file has < 2 bytes; ignore"; \
775       my $$last_two_bytes;                                              \
776       defined $$p and $$p = sysread F, $$last_two_bytes, 2;             \
777       close F;                                                          \
778       $$c = "ignore read failure";                                      \
779       $$p && $$last_two_bytes eq "\n\n" and (print $$f), $$fail=1;      \
780     }                                                                   \
781   END { exit defined $$fail }
782 sc_prohibit_empty_lines_at_EOF:
783         @perl -le '$(detect_empty_lines_at_EOF_)' $$($(VC_LIST_EXCEPT)) \
784           || { echo '$(ME): the above files end with empty line(s)'     \
785                 1>&2; exit 1; } || :;                                   \
786
787 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
788 # This is a bit of a kludge, since it prevents use of the string
789 # even in comments, but for now it does the job with no false positives.
790 sc_prohibit_stat_st_blocks:
791         @prohibit='[.>]st_blocks'                                       \
792         halt='do not use st_blocks; use ST_NBLOCKS'                     \
793           $(_sc_search_regexp)
794
795 # Make sure we don't define any S_IS* macros in src/*.c files.
796 # They're already defined via gnulib's sys/stat.h replacement.
797 sc_prohibit_S_IS_definition:
798         @prohibit='^ *# *define  *S_IS'                                 \
799         halt='do not define S_IS* macros; include <sys/stat.h>'         \
800           $(_sc_search_regexp)
801
802 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
803 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
804 # Using test's -a and -o operators is not portable.
805 # We prefer test over [, since the latter is spelled [[ in configure.ac.
806 sc_prohibit_test_minus_ao:
807         @prohibit='(\<test| \[+) .+ -[ao] '                             \
808         halt='$(_ptm1); $(_ptm2)'                                       \
809           $(_sc_search_regexp)
810
811 # Each program that uses proper_name_utf8 must link with one of the
812 # ICONV libraries.  Otherwise, some ICONV library must appear in LDADD.
813 # The perl -0777 invocation below extracts the possibly-multi-line
814 # definition of LDADD from the appropriate Makefile.am and exits 0
815 # when it contains "ICONV".
816 sc_proper_name_utf8_requires_ICONV:
817         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
818         if test "x$$progs" != x; then                                   \
819           fail=0;                                                       \
820           for p in $$progs; do                                          \
821             dir=$$(dirname "$$p");                                      \
822             perl -0777                                                  \
823               -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)'  \
824               $$dir/Makefile.am && continue;                            \
825             base=$$(basename "$$p" .c);                                 \
826             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
827               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
828           done;                                                         \
829           test $$fail = 1 &&                                            \
830             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
831               exit 1; } || :;                                           \
832         fi
833
834 # Warn about "c0nst struct Foo const foo[]",
835 # but not about "char const *const foo" or "#define const const".
836 sc_redundant_const:
837         @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'          \
838         halt='redundant "const" in declarations'                        \
839           $(_sc_search_regexp)
840
841 sc_const_long_option:
842         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
843           | grep -Ev 'const struct option|struct option const' && {     \
844               echo 1>&2 '$(ME): add "const" to the above declarations'; \
845               exit 1; } || :
846
847 NEWS_hash =                                                             \
848   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
849        $(srcdir)/NEWS                                                   \
850      | perl -0777 -pe                                                   \
851         's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms'       \
852      | md5sum -                                                         \
853      | sed 's/ .*//')
854
855 # Ensure that we don't accidentally insert an entry into an old NEWS block.
856 sc_immutable_NEWS:
857         @if test -f $(srcdir)/NEWS; then                                \
858           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
859             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
860         fi
861
862 # Update the hash stored above.  Do this after each release and
863 # for any corrections to old entries.
864 update-NEWS-hash: NEWS
865         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
866           $(srcdir)/cfg.mk
867
868 # Ensure that we use only the standard $(VAR) notation,
869 # not @...@ in Makefile.am, now that we can rely on automake
870 # to emit a definition for each substituted variable.
871 # We use perl rather than "grep -nE ..." to exempt a single
872 # use of an @...@-delimited variable name in src/Makefile.am.
873 # Allow the package to add exceptions via a hook in cfg.mk;
874 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
875 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
876 _makefile_at_at_check_exceptions ?=
877 sc_makefile_at_at_check:
878         @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
879           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
880             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
881           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
882
883 news-check: NEWS
884         if sed -n $(news-check-lines-spec)p $(srcdir)/NEWS              \
885             | grep -E $(news-check-regexp) >/dev/null; then             \
886           :;                                                            \
887         else                                                            \
888           echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2;      \
889           exit 1;                                                       \
890         fi
891
892 sc_makefile_TAB_only_indentation:
893         @prohibit='^    [ ]{8}'                                         \
894         in_vc_files='akefile|\.mk$$'                                    \
895         halt='found TAB-8-space indentation'                            \
896           $(_sc_search_regexp)
897
898 sc_m4_quote_check:
899         @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
900         in_vc_files='(^configure\.ac|\.m4)$$'                           \
901         halt='quote the first arg to AC_DEF*'                           \
902           $(_sc_search_regexp)
903
904 fix_po_file_diag = \
905 'you have changed the set of files with translatable diagnostics;\n\
906 apply the above patch\n'
907
908 # Verify that all source files using _() are listed in po/POTFILES.in.
909 po_file = po/POTFILES.in
910 sc_po_check:
911         @if test -f $(po_file); then                                    \
912           grep -E -v '^(#|$$)' $(po_file)                               \
913             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
914           files=;                                                       \
915           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
916             test -r $$file || continue;                                 \
917             case $$file in                                              \
918               *.m4|*.mk) continue ;;                                    \
919               *.?|*.??) ;;                                              \
920               *) continue;;                                             \
921             esac;                                                       \
922             case $$file in                                              \
923             *.[ch])                                                     \
924               base=`expr " $$file" : ' \(.*\)\..'`;                     \
925               { test -f $$base.l || test -f $$base.y; } && continue;;   \
926             esac;                                                       \
927             files="$$files $$file";                                     \
928           done;                                                         \
929           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
930             | sort -u > $@-2;                                           \
931           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
932             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
933           rm -f $@-1 $@-2;                                              \
934         fi
935
936 # Sometimes it is useful to change the PATH environment variable
937 # in Makefiles.  When doing so, it's better not to use the Unix-centric
938 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
939 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
940 sc_makefile_path_separator_check:
941         @prohibit='PATH[=].*:'                                          \
942         in_vc_files='akefile|\.mk$$'                                    \
943         halt=$(msg)                                                     \
944           $(_sc_search_regexp)
945
946 # Check that `make alpha' will not fail at the end of the process.
947 writable-files:
948         if test -d $(release_archive_dir); then :; else                 \
949           for file in $(distdir).tar.gz                                 \
950                       $(release_archive_dir)/$(distdir).tar.gz; do      \
951             test -e $$file || continue;                                 \
952             test -w $$file                                              \
953               || { echo ERROR: $$file is not writable; fail=1; };       \
954           done;                                                         \
955           test "$$fail" && exit 1 || : ;                                \
956         fi
957
958 v_etc_file = $(gnulib_dir)/lib/version-etc.c
959 sample-test = tests/sample-test
960 texi = doc/$(PACKAGE).texi
961 # Make sure that the copyright date in $(v_etc_file) is up to date.
962 # Do the same for the $(sample-test) and the main doc/.texi file.
963 sc_copyright_check:
964         @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };'            \
965         in_files=$(v_etc_file)                                          \
966         halt='out of date copyright in $(v_etc_file); update it'        \
967           $(_sc_search_regexp)
968         @require='# Copyright \(C\) '$$(date +%Y)' Free'                \
969         in_vc_files=$(sample-test)                                      \
970         halt='out of date copyright in $(sample-test); update it'       \
971           $(_sc_search_regexp)
972         @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free'       \
973         in_vc_files=$(texi)                                             \
974         halt='out of date copyright in $(texi); update it'              \
975           $(_sc_search_regexp)
976
977 # If tests/help-version exists and seems to be new enough, assume that its
978 # use of init.sh and path_prepend_ is correct, and ensure that every other
979 # use of init.sh is identical.
980 # This is useful because help-version cross-checks prog --version
981 # with $(VERSION), which verifies that its path_prepend_ invocation
982 # sets PATH correctly.  This is an inexpensive way to ensure that
983 # the other init.sh-using tests also get it right.
984 _hv_file ?= $(srcdir)/tests/help-version
985 _hv_regex_weak ?= ^ *\. .*/init\.sh"
986 _hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh"
987 sc_cross_check_PATH_usage_in_tests:
988         @if test -f $(_hv_file); then                                   \
989           grep -l 'VERSION mismatch' $(_hv_file) >/dev/null             \
990             || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2;    \
991                  exit 0; };                                             \
992           grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null         \
993             || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \
994                  exit 1; };                                             \
995           good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file));           \
996           grep -LFx "$$good"                                            \
997                 $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT)))  \
998               | grep . &&                                               \
999             { echo "$(ME): the above files use path_prepend_ inconsistently" \
1000                 1>&2; exit 1; } || :;                                   \
1001         fi
1002
1003 # #if HAVE_... will evaluate to false for any non numeric string.
1004 # That would be flagged by using -Wundef, however gnulib currently
1005 # tests many undefined macros, and so we can't enable that option.
1006 # So at least preclude common boolean strings as macro values.
1007 sc_Wundef_boolean:
1008         @prohibit='^#define.*(yes|no|true|false)$$'                     \
1009         in_files='$(CONFIG_INCLUDE)'                                    \
1010         halt='Use 0 or 1 for macro values'                              \
1011           $(_sc_search_regexp)
1012
1013 sc_vulnerable_makefile_CVE-2009-4029:
1014         @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
1015         in_files=$$(find $(srcdir) -name Makefile.in)                   \
1016         halt=$$(printf '%s\n'                                           \
1017           'the above files are vulnerable; beware of running'           \
1018           '  "make dist*" rules, and upgrade to fixed automake'         \
1019           '  see http://bugzilla.redhat.com/542609 for details')        \
1020           $(_sc_search_regexp)
1021
1022 vc-diff-check:
1023         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
1024         if test -s vc-diffs; then                               \
1025           cat vc-diffs;                                         \
1026           echo "Some files are locally modified:" 1>&2;         \
1027           exit 1;                                               \
1028         else                                                    \
1029           rm vc-diffs;                                          \
1030         fi
1031
1032 rel-files = $(DIST_ARCHIVES)
1033
1034 gnulib_dir ?= $(srcdir)/gnulib
1035 gnulib-version = $$(cd $(gnulib_dir) && git describe)
1036 bootstrap-tools ?= autoconf,automake,gnulib
1037
1038 # If it's not already specified, derive the GPG key ID from
1039 # the signed tag we've just applied to mark this release.
1040 gpg_key_ID ?= \
1041   $$(git cat-file tag v$(VERSION) > .ann-sig \
1042      && gpgv .ann-sig - < /dev/null 2>&1 \
1043           | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
1044
1045 translation_project_ ?= coordinator@translationproject.org
1046 announcement_Cc_ ?= $(translation_project_), $(PACKAGE_BUGREPORT)
1047 announcement_mail_headers_ ?=                                           \
1048 To: info-gnu@gnu.org                                                    \
1049 Cc: $(announcement_Cc_)                                                 \
1050 Mail-Followup-To: $(PACKAGE_BUGREPORT)
1051
1052 announcement: NEWS ChangeLog $(rel-files)
1053         @$(build_aux)/announce-gen                                      \
1054             --mail-headers='$(announcement_mail_headers_)'              \
1055             --release-type=$(RELEASE_TYPE)                              \
1056             --package=$(PACKAGE)                                        \
1057             --prev=$(PREV_VERSION)                                      \
1058             --curr=$(VERSION)                                           \
1059             --gpg-key-id=$(gpg_key_ID)                                  \
1060             --news=$(srcdir)/NEWS                                       \
1061             --bootstrap-tools=$(bootstrap-tools)                        \
1062             --gnulib-version=$(gnulib-version)                          \
1063             --no-print-checksums                                        \
1064             $(addprefix --url-dir=, $(url_dir_list))
1065
1066 ## ---------------- ##
1067 ## Updating files.  ##
1068 ## ---------------- ##
1069
1070 ftp-gnu = ftp://ftp.gnu.org/gnu
1071 www-gnu = http://www.gnu.org
1072
1073 upload_dest_dir_ ?= $(PACKAGE)
1074 emit_upload_commands:
1075         @echo =====================================
1076         @echo =====================================
1077         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
1078         @echo "    --to $(gnu_rel_host):$(upload_dest_dir_) \\"
1079         @echo "  $(rel-files)"
1080         @echo '# send the ~/announce-$(my_distdir) e-mail'
1081         @echo =====================================
1082         @echo =====================================
1083
1084 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
1085 define emit-commit-log
1086   printf '%s\n' 'post-release administrivia' '' \
1087     '* NEWS: Add header line for next release.' \
1088     '* .prev-version: Record previous version.' \
1089     '* cfg.mk (old_NEWS_hash): Auto-update.'
1090 endef
1091
1092 .PHONY: no-submodule-changes
1093 no-submodule-changes:
1094         if test -d $(srcdir)/.git; then                                 \
1095           diff=$$(cd $(srcdir) && git submodule -q foreach              \
1096                   git diff-index --name-only HEAD)                      \
1097             || exit 1;                                                  \
1098           case $$diff in '') ;;                                         \
1099             *) echo '$(ME): submodule files are locally modified:';     \
1100                 echo "$$diff"; exit 1;; esac;                           \
1101         else                                                            \
1102           : ;                                                           \
1103         fi
1104
1105 .PHONY: alpha beta stable
1106 ALL_RECURSIVE_TARGETS += alpha beta stable
1107 alpha beta stable: $(local-check) writable-files no-submodule-changes
1108         test $@ = stable                                                \
1109           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$'         \
1110                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
1111           || :
1112         $(MAKE) vc-diff-check
1113         $(MAKE) news-check
1114         $(MAKE) distcheck
1115         $(MAKE) dist XZ_OPT=-9ev
1116         $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1117         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1118
1119 # Override this in cfg.mk if you follow different procedures.
1120 release-prep-hook ?= release-prep
1121
1122 .PHONY: release-prep
1123 release-prep:
1124         case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1125           *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1126         $(MAKE) -s announcement > ~/announce-$(my_distdir)
1127         if test -d $(release_archive_dir); then                 \
1128           ln $(rel-files) $(release_archive_dir);               \
1129           chmod a-w $(rel-files);                               \
1130         fi
1131         echo $(VERSION) > $(prev_version_file)
1132         $(MAKE) update-NEWS-hash
1133         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
1134         $(emit-commit-log) > .ci-msg
1135         $(VC) commit -F .ci-msg -a
1136         rm .ci-msg
1137
1138 # Override this with e.g., -s $(srcdir)/some_other_name.texi
1139 # if the default $(PACKAGE)-derived name doesn't apply.
1140 gendocs_options_ ?=
1141
1142 .PHONY: web-manual
1143 web-manual:
1144         @test -z "$(manual_title)" \
1145           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
1146         @cd '$(srcdir)/doc'; \
1147           $(SHELL) ../build-aux/gendocs.sh $(gendocs_options_) \
1148              -o '$(abs_builddir)/doc/manual' \
1149              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
1150             "$(PACKAGE_NAME) - $(manual_title)"
1151         @echo " *** Upload the doc/manual directory to web-cvs."
1152
1153 # Code Coverage
1154
1155 init-coverage:
1156         $(MAKE) $(AM_MAKEFLAGS) clean
1157         lcov --directory . --zerocounters
1158
1159 COVERAGE_CCOPTS ?= "-g --coverage"
1160 COVERAGE_OUT ?= doc/coverage
1161
1162 build-coverage:
1163         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
1164         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
1165         mkdir -p $(COVERAGE_OUT)
1166         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
1167                 --capture
1168
1169 gen-coverage:
1170         genhtml --output-directory $(COVERAGE_OUT) \
1171                 $(COVERAGE_OUT)/$(PACKAGE).info \
1172                 --highlight --frames --legend \
1173                 --title "$(PACKAGE_NAME)"
1174
1175 coverage: init-coverage build-coverage gen-coverage
1176
1177 # Update gettext files.
1178 PACKAGE ?= $(shell basename $(PWD))
1179 PO_DOMAIN ?= $(PACKAGE)
1180 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1181 PODIR ?= po
1182 refresh-po:
1183         rm -f $(PODIR)/*.po && \
1184         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1185         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1186         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1187         echo 'en@quot' >> $(PODIR)/LINGUAS && \
1188         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1189
1190  # Running indent once is not idempotent, but running it twice is.
1191 INDENT_SOURCES ?= $(C_SOURCES)
1192 .PHONY: indent
1193 indent:
1194         indent $(INDENT_SOURCES)
1195         indent $(INDENT_SOURCES)
1196         indent $(INDENT_SOURCES) # Ident is not idempotent!
1197
1198 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1199 # put the assignments in this variable.
1200 update-copyright-env ?=
1201
1202 # Run this rule once per year (usually early in January)
1203 # to update all FSF copyright year lists in your project.
1204 # If you have an additional project-specific rule,
1205 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1206 # By default, exclude all variants of COPYING; you can also
1207 # add exemptions (such as ChangeLog..* for rotated change logs)
1208 # in the file .x-update-copyright.
1209 .PHONY: update-copyright
1210 update-copyright:
1211         grep -l -w Copyright                                             \
1212           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1213           | $(update-copyright-env) xargs $(build_aux)/$@