78
127
$(srcdir)/$(ME) $(_cfg_mk)))
79
128
.PHONY: $(syntax-check-rules)
81
local-checks-available = \
130
ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0)
131
local-checks-available += $(syntax-check-rules)
133
local-checks-available += no-vc-detected
135
@echo "No version control files detected; skipping syntax check"
83
137
.PHONY: $(local-checks-available)
85
139
# Arrange to print the name of each syntax-checking rule just before running it.
86
140
$(syntax-check-rules): %: %.m
87
$(patsubst %, %.m, $(syntax-check-rules)):
141
sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
142
.PHONY: $(sc_m_rules_)
88
144
@echo $(patsubst sc_%.m, %, $@)
90
local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
145
@date +%s.%N > .sc-start-$(basename $@)
147
# Compute and print the elapsed time for each syntax-check rule.
148
sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))
149
.PHONY: $(sc_z_rules_)
150
$(sc_z_rules_): %.z: %
151
@end=$$(date +%s.%N); \
152
start=$$(cat .sc-start-$*); \
153
rm -f .sc-start-$*; \
154
awk -v s=$$start -v e=$$end \
155
'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null
157
# The patsubst here is to replace each sc_% rule with its sc_%.z wrapper
158
# that computes and prints elapsed time.
160
$(patsubst sc_%, sc_%.z, \
161
$(filter-out $(local-checks-to-skip), $(local-checks-available)))
92
163
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; \
98
# grep -nE '^# *include <(string|stdlib)\.h>' \
99
# $(srcdir)/{lib,src}/*.[chy] && \
100
# { echo '$(ME): FIXME' 1>&2; \
102
# FIXME: don't allow `#include .strings\.h' anywhere
104
# By default, _prohibit_regexp does not ignore case.
167
# This macro searches for a given construct in the selected files and
168
# then takes some action.
170
# Parameters (shell variables):
174
# Regular expression (ERE) denoting either a forbidden construct
175
# or a required construct. Those arguments are exclusive.
177
# in_vc_files | in_files
179
# grep-E-style regexp denoting the files to check. If no files
180
# are specified the default are all the files that are under
183
# containing | non_containing
185
# Select the files (non) containing strings matching this regexp.
186
# If both arguments are specified then CONTAINING takes
191
# Extra options for grep.
199
# Message to display before to halting execution.
201
# Finally, you may exempt files based on an ERE matching file names.
202
# For example, to exempt from the sc_space_tab check all files with the
203
# .diff suffix, set this Make variable:
205
# exclude_file_name_regexp--sc_space_tab = \.diff$
207
# Note that while this functionality is mostly inherited via VC_LIST_EXCEPT,
208
# when filtering by name via in_files, we explicitly filter out matching
209
# names here as well.
211
# By default, _sc_search_regexp does not ignore case.
105
212
export ignore_case =
106
_ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
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; } || :
213
_ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :)
215
define _sc_say_and_exit
216
dummy=; : so we do not need a semicolon before each use; \
217
{ printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; };
220
# _sc_search_regexp used to be named _prohibit_regexp. However,
221
# upgrading to the new definition and leaving the old name undefined
222
# would usually convert each custom rule using $(_prohibit_regexp)
223
# (usually defined in cfg.mk) into a no-op. This definition ensures
224
# that people know right away if they're still using the old name.
225
# FIXME: remove in 2012.
227
$(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
229
define _sc_search_regexp
230
dummy=; : so we do not need a semicolon before each use; \
233
test -n "$$prohibit" && test -n "$$require" \
234
&& { msg='Cannot specify both prohibit and require' \
235
$(_sc_say_and_exit) } || :; \
236
test -z "$$prohibit" && test -z "$$require" \
237
&& { msg='Should specify either prohibit or require' \
238
$(_sc_say_and_exit) } || :; \
239
test -n "$$in_vc_files" && test -n "$$in_files" \
240
&& { msg='Cannot specify both in_vc_files and in_files' \
241
$(_sc_say_and_exit) } || :; \
242
test "x$$halt" != x \
243
|| { msg='halt not defined' $(_sc_say_and_exit) }; \
245
: Filter by file name; \
246
if test -n "$$in_files"; then \
247
files=$$(find $(srcdir) | grep -E "$$in_files" \
248
| grep -Ev '$(exclude_file_name_regexp--$@)'); \
250
files=$$($(VC_LIST_EXCEPT)); \
251
if test -n "$$in_vc_files"; then \
252
files=$$(echo "$$files" | grep -E "$$in_vc_files"); \
256
: Filter by content; \
257
test -n "$$files" && test -n "$$containing" \
258
&& { files=$$(grep -l "$$containing" $$files); } || :; \
259
test -n "$$files" && test -n "$$non_containing" \
260
&& { files=$$(grep -vl "$$non_containing" $$files); } || :; \
262
: Check for the construct; \
263
if test -n "$$files"; then \
264
if test -n "$$prohibit"; then \
265
grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
266
&& { msg="$$halt" $(_sc_say_and_exit) } || :; \
268
grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
270
&& { msg="$$halt" $(_sc_say_and_exit) } || :; \
119
276
sc_avoid_if_before_free:
126
283
sc_cast_of_argument_to_free:
127
@re='\<free *\( *\(' msg='don'\''t cast free argument' \
284
@prohibit='\<free *\( *\(' halt='don'\''t cast free argument' \
130
287
sc_cast_of_x_alloc_return_value:
131
@re='\*\) *x(m|c|re)alloc\>' \
132
msg='don'\''t cast x*alloc return value' \
288
@prohibit='\*\) *x(m|c|re)alloc\>' \
289
halt='don'\''t cast x*alloc return value' \
135
292
sc_cast_of_alloca_return_value:
136
@re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
293
@prohibit='\*\) *alloca\>' \
294
halt='don'\''t cast alloca return value' \
140
@re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
299
halt='found SPACE-TAB sequence; remove the SPACE' \
143
302
# Don't use *scanf or the old ato* functions in `real' code.
144
303
# They provide no error checking mechanism.
145
304
# Instead, use strto* functions.
146
305
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' \
306
@prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \
307
halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
151
310
# Use STREQ rather than comparing strcmp == 0, or != 0.
152
311
sc_prohibit_strcmp:
153
@grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
312
@grep -nE '! *str''cmp *\(|\<str''cmp *\(.+\) *[!=]=' \
154
313
$$($(VC_LIST_EXCEPT)) \
155
| grep -vE ':# *define STREQ\(' && \
156
{ echo '$(ME): use STREQ in place of the above uses of str''cmp' \
314
| grep -vE ':# *define STRN?EQ\(' && \
315
{ echo '$(ME): replace str''cmp calls above with STREQ/STRNEQ' \
157
316
1>&2; exit 1; } || :
318
# Pass EXIT_*, not number, to usage, exit, and error (when exiting)
319
# Convert all uses automatically, via these two commands:
320
# git grep -l '\<exit *(1)' \
321
# | grep -vEf .x-sc_prohibit_magic_number_exit \
322
# | xargs --no-run-if-empty \
323
# perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
324
# git grep -l '\<exit *(0)' \
325
# | grep -vEf .x-sc_prohibit_magic_number_exit \
326
# | xargs --no-run-if-empty \
327
# perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
328
sc_prohibit_magic_number_exit:
329
@prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
330
halt='use EXIT_* values rather than magic number' \
159
333
# Using EXIT_SUCCESS as the first argument to error is misleading,
160
334
# since when that parameter is 0, error does not exit. Use `0' instead.
161
335
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; } || :
336
@prohibit='error *\(EXIT_SUCCESS,' \
337
in_vc_files='\.[chly]$$' \
338
halt='found error (EXIT_SUCCESS' \
166
341
# `FATAL:' should be fully upper-cased in error messages
167
342
# `WARNING:' should be fully upper-cased, or fully lower-cased
168
343
sc_error_message_warn_fatal:
169
@grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
344
@grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
170
345
| grep -E '"Warning|"Fatal|"fatal' && \
171
346
{ echo '$(ME): use FATAL, WARNING or warning' 1>&2; \
174
349
# Error messages should not start with a capital letter
175
350
sc_error_message_uppercase:
176
@grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT)) \
351
@grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \
177
352
| grep -E '"[A-Z]' \
178
353
| grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
179
354
{ echo '$(ME): found capitalized error message' 1>&2; \
250
423
# Prohibit the inclusion of assert.h without an actual use of assert.
251
424
sc_prohibit_assert_without_use:
252
@h='<assert.h>' re='\<assert *\(' $(_header_without_use)
425
@h='assert.h' re='\<assert *\(' $(_sc_header_without_use)
427
# Prohibit the inclusion of close-stream.h without an actual use.
428
sc_prohibit_close_stream_without_use:
429
@h='close-stream.h' re='\<close_stream *\(' $(_sc_header_without_use)
254
431
# Prohibit the inclusion of getopt.h without an actual use.
255
432
sc_prohibit_getopt_without_use:
256
@h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
433
@h='getopt.h' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
258
435
# Don't include quotearg.h unless you use one of its functions.
259
436
sc_prohibit_quotearg_without_use:
260
@h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
437
@h='quotearg.h' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
262
439
# Don't include quote.h unless you use one of its functions.
263
440
sc_prohibit_quote_without_use:
264
@h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
441
@h='quote.h' re='\<quote(_n)? *\(' $(_sc_header_without_use)
266
443
# Don't include this header unless you use one of its functions.
267
444
sc_prohibit_long_options_without_use:
268
@h='"long-options.h"' re='\<parse_long_options *\(' \
269
$(_header_without_use)
445
@h='long-options.h' re='\<parse_long_options *\(' \
446
$(_sc_header_without_use)
271
448
# Don't include this header unless you use one of its functions.
272
449
sc_prohibit_inttostr_without_use:
273
@h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
274
$(_header_without_use)
450
@h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \
451
$(_sc_header_without_use)
453
# Don't include this header unless you use one of its functions.
454
sc_prohibit_ignore_value_without_use:
455
@h='ignore-value.h' re='\<ignore_(value|ptr) *\(' \
456
$(_sc_header_without_use)
276
458
# Don't include this header unless you use one of its functions.
277
459
sc_prohibit_error_without_use:
279
461
re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
280
$(_header_without_use)
462
$(_sc_header_without_use)
464
# Don't include xalloc.h unless you use one of its functions.
465
# Consider these symbols:
466
# perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
467
# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
468
# Divide into two sets on case, and filter each through this:
469
# | sort | perl -MRegexp::Assemble -le \
470
# 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
471
# Note this was produced by the above:
473
#x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
474
# But we can do better, in at least two ways:
475
# 1) take advantage of two "dup"-suffixed strings:
476
# x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
477
# 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
479
# x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
480
_xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
481
_xa2 = X([CZ]|N?M)ALLOC
482
sc_prohibit_xalloc_without_use:
484
re='\<($(_xa1)|$(_xa2)) *\('\
485
$(_sc_header_without_use)
487
# Extract function names:
488
# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
490
clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
491
_hash_fn = \<($(_hash_re)) *\(
492
_hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
493
sc_prohibit_hash_without_use:
495
re='$(_hash_fn)|$(_hash_struct)'\
496
$(_sc_header_without_use)
498
sc_prohibit_cloexec_without_use:
499
@h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \
500
$(_sc_header_without_use)
502
sc_prohibit_posixver_without_use:
503
@h='posixver.h' re='\<posix2_version *\(' $(_sc_header_without_use)
505
sc_prohibit_same_without_use:
506
@h='same.h' re='\<same_name *\(' $(_sc_header_without_use)
508
sc_prohibit_hash_pjw_without_use:
510
re='\<hash_pjw *\(' \
511
$(_sc_header_without_use)
282
513
sc_prohibit_safe_read_without_use:
283
@h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
284
$(_header_without_use)
514
@h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
515
$(_sc_header_without_use)
286
517
sc_prohibit_argmatch_without_use:
288
re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
289
$(_header_without_use)
519
re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \
520
$(_sc_header_without_use)
522
sc_prohibit_canonicalize_without_use:
523
@h='canonicalize.h' \
524
re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
525
$(_sc_header_without_use)
291
527
sc_prohibit_root_dev_ino_without_use:
292
@h='"root-dev-ino.h"' \
528
@h='root-dev-ino.h' \
293
529
re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
294
$(_header_without_use)
530
$(_sc_header_without_use)
532
sc_prohibit_openat_without_use:
534
re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
535
$(_sc_header_without_use)
296
537
# Prohibit the inclusion of c-ctype.h without an actual use.
297
538
ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
298
539
|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
299
540
sc_prohibit_c_ctype_without_use:
300
@h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
541
@h='c-ctype.h' re='\<c_($(ctype_re)) *\(' \
542
$(_sc_header_without_use)
303
545
_sp = $(_empty) $(_empty)
333
575
# Prohibit the inclusion of signal.h without an actual use.
334
576
sc_prohibit_signal_without_use:
336
578
re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
337
$(_header_without_use)
579
$(_sc_header_without_use)
581
# Don't include stdio--.h unless you use one of its functions.
582
sc_prohibit_stdio--_without_use:
583
@h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\(' \
584
$(_sc_header_without_use)
586
# Don't include stdio-safer.h unless you use one of its functions.
587
sc_prohibit_stdio-safer_without_use:
588
@h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\(' \
589
$(_sc_header_without_use)
591
# Prohibit the inclusion of strings.h without a sensible use.
592
# Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible.
593
sc_prohibit_strings_without_use:
595
re='\<(strn?casecmp|ffs(ll)?)\>' \
596
$(_sc_header_without_use)
598
# Get the list of symbol names with this:
599
# perl -lne '/^# *define ([A-Z]\w+)\(/ and print $1' lib/intprops.h|fmt
601
TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \
602
TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \
603
INT_BITS_STRLEN_BOUND INT_STRLEN_BOUND INT_BUFSIZE_BOUND \
604
INT_ADD_RANGE_OVERFLOW INT_SUBTRACT_RANGE_OVERFLOW \
605
INT_NEGATE_RANGE_OVERFLOW INT_MULTIPLY_RANGE_OVERFLOW \
606
INT_DIVIDE_RANGE_OVERFLOW INT_REMAINDER_RANGE_OVERFLOW \
607
INT_LEFT_SHIFT_RANGE_OVERFLOW INT_ADD_OVERFLOW INT_SUBTRACT_OVERFLOW \
608
INT_NEGATE_OVERFLOW INT_MULTIPLY_OVERFLOW INT_DIVIDE_OVERFLOW \
609
INT_REMAINDER_OVERFLOW INT_LEFT_SHIFT_OVERFLOW
610
_intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
611
# Prohibit the inclusion of intprops.h without an actual use.
612
sc_prohibit_intprops_without_use:
614
re='\<($(_intprops_syms_re)) *\(' \
615
$(_sc_header_without_use)
617
_stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t
618
# Prohibit the inclusion of stddef.h without an actual use.
619
sc_prohibit_stddef_without_use:
621
re='\<($(_stddef_syms_re)) *\(' \
622
$(_sc_header_without_use)
624
# Prohibit the inclusion of verify.h without an actual use.
625
sc_prohibit_verify_without_use:
627
re='\<(verify(true|expr)?|static_assert) *\(' \
628
$(_sc_header_without_use)
630
# Don't include xfreopen.h unless you use one of its functions.
631
sc_prohibit_xfreopen_without_use:
632
@h='xfreopen.h' re='\<xfreopen *\(' $(_sc_header_without_use)
339
634
sc_obsolete_symbols:
340
@re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
341
msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
635
@prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
636
halt='do not use HAVE''_FCNTL_H or O'_NDELAY \
344
639
# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
346
641
# Each nonempty ChangeLog line must start with a year number, or a TAB.
348
@if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
350
$$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') && \
351
{ echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
643
@prohibit='^[^12 ]' \
644
in_vc_files='^ChangeLog$$' \
645
halt='found unexpected prefix in a ChangeLog' \
355
648
# Ensure that each .c file containing a "main" function also
356
649
# calls set_program_name.
358
@if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \
359
files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
360
grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files \
362
{ echo '$(ME): the above files do not call set_program_name' \
363
1>&2; exit 1; } || :; \
651
@require='set_program_name *\(m?argv\[0\]\);' \
652
in_vc_files='\.c$$' \
653
containing='\<main *(' \
654
halt='the above files do not call set_program_name' \
657
# Ensure that each .c file containing a "main" function also
658
# calls bindtextdomain.
660
@require='bindtextdomain *\(' \
661
in_vc_files='\.c$$' \
662
containing='\<main *(' \
663
halt='the above files do not call bindtextdomain' \
367
666
# Require that the final line of each test-lib.sh-using test be this one:
383
682
exit 1; } || :; \
387
@re='\<the ''the\>' \
388
ignore_case=1 msg='found use of "the ''the";' \
391
685
sc_trailing_blank:
393
msg='found trailing blank(s)' \
687
halt='found trailing blank(s)' \
396
690
# Match lines like the following, but where there is only one space
397
691
# between the options and the description:
398
692
# -D, --all-repeated[=delimit-method] print all duplicate lines\n
399
693
longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
400
694
sc_two_space_separator_in_usage:
401
@grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
402
$$($(VC_LIST_EXCEPT)) && \
403
{ echo "$(ME): help2man requires at least two spaces between"; \
404
echo "$(ME): an option and its description"; \
695
@prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
696
halt='help2man requires at least two spaces between an option and its description'\
699
# A regexp matching function names like "error" that may be used
700
# to emit translatable messages.
701
_gl_translatable_diag_func_re ?= error
407
703
# Look for diagnostics that aren't marked for translation.
408
704
# This won't find any for which error's format string is on a separate line.
409
705
sc_unmarked_diagnostics:
411
'\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
412
| grep -v '_''(' && \
707
'\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \
708
$$($(VC_LIST_EXCEPT)) \
709
| grep -Ev '(_|ngettext ?)\(' && \
413
710
{ echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
416
713
# Avoid useless parentheses like those in this example:
417
714
# #if defined (SYMBOL) || defined (SYM2)
418
715
sc_useless_cpp_parens:
419
@grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
420
{ echo '$(ME): found useless parentheses in cpp directive' \
716
@prohibit='^# *if .*defined *\(' \
717
halt='found useless parentheses in cpp directive' \
720
# List headers for which HAVE_HEADER_H is always true, assuming you are
721
# using the appropriate gnulib module. CAUTION: for each "unnecessary"
722
# #if HAVE_HEADER_H that you remove, be sure that your project explicitly
723
# requires the gnulib module that guarantees the usability of that header.
724
gl_assured_headers_ = \
725
cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g'
727
# Convert the list of names to upper case, and replace each space with "|".
728
az_ = abcdefghijklmnopqrstuvwxyz
729
AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ
730
gl_header_upper_case_or_ = \
731
$$($(gl_assured_headers_) \
732
| tr $(az_)/.- $(AZ_)___ \
735
sc_prohibit_always_true_header_tests:
736
@or=$(gl_header_upper_case_or_); \
737
re="HAVE_($$or)_H"; \
738
prohibit='\<'"$$re"'\>' \
739
halt=$$(printf '%s\n' \
740
'do not test the above HAVE_<header>_H symbol(s);' \
741
' with the corresponding gnulib module, they are always true') \
744
# ==================================================================
745
gl_other_headers_ ?= \
750
# Perl -lne code to extract "significant" cpp-defined symbols from a
751
# gnulib header file, eliminating a few common false-positives.
752
gl_extract_significant_defines_ = \
753
/^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\
754
&& $$2 !~ /(?:rpl_|_used_without_)/\
755
&& $$1 !~ /^(?:NSIG)$$/\
756
&& $$1 !~ /^(?:SA_RESETHAND|SA_RESTART)$$/\
759
# Create a list of regular expressions matching the names
760
# of macros that are guaranteed to be defined by parts of gnulib.
762
gen_h=$(gl_generated_headers_); \
763
(cd $(gnulib_dir)/lib; \
764
for f in *.in.h $(gl_other_headers_); do \
765
perl -lne '$(gl_extract_significant_defines_)' $$f; \
768
| sed 's/^/^ *# *(define|undef) */;s/$$/\\>/'
771
# Don't define macros that we already get from gnulib header files.
772
sc_prohibit_always-defined_macros:
773
@if test -d $(gnulib_dir); then \
774
case $$(echo all: | grep -l -f - Makefile) in Makefile);; *) \
775
echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \
777
$(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT)) \
778
&& { echo '$(ME): define the above via some gnulib .h file' \
779
1>&2; exit 1; } || :; \
781
# ==================================================================
783
# Prohibit checked in backup files.
784
sc_prohibit_backup_files:
785
@$(VC_LIST) | grep '~$$' && \
786
{ echo '$(ME): found version controlled backup file' 1>&2; \
423
789
# Require the latest GPL.
425
@re='either ''version [^3]' msg='GPL vN, N!=3' \
791
@prohibit='either ''version [^3]' \
792
halt='GPL vN, N!=3' \
795
# Require the latest GFDL. Two regexp, since some .texi files end up
796
# line wrapping between 'Free Documentation License,' and 'Version'.
797
_GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
799
@prohibit='$(_GFDL_regexp)' \
800
halt='GFDL vN, N!=3' \
803
# Don't use Texinfo's @acronym{}.
804
# http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html
805
texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$
807
@prohibit='@acronym\{' \
808
in_vc_files='$(texinfo_suffix_re_)' \
809
halt='found use of Texinfo @acronym{}' \
429
813
Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
431
815
sc_prohibit_cvs_keyword:
432
@re='\$$($(cvs_keywords))\$$' \
433
msg='do not use CVS keyword expansion' \
816
@prohibit='\$$($(cvs_keywords))\$$' \
817
halt='do not use CVS keyword expansion' \
820
# This Perl code is slightly obfuscated. Not only is each "$" doubled
821
# because it's in a Makefile, but the $$c's are comments; we cannot
822
# use "#" due to the way the script ends up concatenated onto one line.
823
# It would be much more concise, and would produce better output (including
824
# counts) if written as:
825
# perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
826
# but that would be far less efficient, reading the entire contents
827
# of each file, rather than just the last two bytes of each.
828
# In addition, while the code below detects both blank lines and a missing
829
# newline at EOF, the above detects only the former.
831
# This is a perl script that is expected to be the single-quoted argument
832
# to a command-line "-le". The remaining arguments are file names.
833
# Print the name of each file that ends in exactly one newline byte.
834
# I.e., warn if there are blank lines (2 or more newlines), or if the
835
# last byte is not a newline. However, currently we don't complain
836
# about any file that contains exactly one byte.
837
# Exit nonzero if at least one such file is found, otherwise, exit 0.
838
# Warn about, but otherwise ignore open failure. Ignore seek/read failure.
840
# Use this if you want to remove trailing empty lines from selected files:
841
# perl -pi -0777 -e 's/\n\n+$/\n/' files...
843
require_exactly_one_NL_at_EOF_ = \
844
foreach my $$f (@ARGV) \
846
open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next; \
847
my $$p = sysseek (F, -2, 2); \
848
my $$c = "seek failure probably means file has < 2 bytes; ignore"; \
849
my $$last_two_bytes; \
850
defined $$p and $$p = sysread F, $$last_two_bytes, 2; \
852
$$c = "ignore read failure"; \
853
$$p && ($$last_two_bytes eq "\n\n" \
854
|| substr ($$last_two_bytes,1) ne "\n") \
855
and (print $$f), $$fail=1; \
857
END { exit defined $$fail }
858
sc_prohibit_empty_lines_at_EOF:
859
@perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \
860
|| { echo '$(ME): empty line(s) or no newline at EOF' \
436
863
# Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
437
864
# This is a bit of a kludge, since it prevents use of the string
438
865
# even in comments, but for now it does the job with no false positives.
439
866
sc_prohibit_stat_st_blocks:
440
@re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
867
@prohibit='[.>]st_blocks' \
868
halt='do not use st_blocks; use ST_NBLOCKS' \
443
871
# Make sure we don't define any S_IS* macros in src/*.c files.
444
872
# They're already defined via gnulib's sys/stat.h replacement.
445
873
sc_prohibit_S_IS_definition:
446
@re='^ *# *define *S_IS' \
447
msg='do not define S_IS* macros; include <sys/stat.h>' \
450
# Each program that uses proper_name_utf8 must link with
451
# one of the ICONV libraries.
874
@prohibit='^ *# *define *S_IS' \
875
halt='do not define S_IS* macros; include <sys/stat.h>' \
878
# Perl block to convert a match to FILE_NAME:LINENO:TEST,
879
# that is shared by two definitions below.
880
perl_filename_lineno_text_ = \
882
-e ' $$n = ($$` =~ tr/\n/\n/ + 1);' \
883
-e ' ($$v = $$&) =~ s/\n/\\n/g;' \
884
-e ' print "$$ARGV:$$n:$$v\n";' \
887
prohibit_doubled_word_RE_ ?= \
888
/\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims
889
prohibit_doubled_word_ = \
890
-e 'while ($(prohibit_doubled_word_RE_))' \
891
$(perl_filename_lineno_text_)
893
# Define this to a regular expression that matches
894
# any filename:dd:match lines you want to ignore.
895
# The default is to ignore no matches.
896
ignore_doubled_word_match_RE_ ?= ^$$
898
sc_prohibit_doubled_word:
899
@perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT)) \
900
| grep -vE '$(ignore_doubled_word_match_RE_)' \
901
| grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || :
903
# A regular expression matching undesirable combinations of words like
904
# "can not"; this matches them even when the two words appear on different
905
# lines, but not when there is an intervening delimiter like "#" or "*".
906
prohibit_undesirable_word_seq_RE_ ?= \
908
prohibit_undesirable_word_seq_ = \
909
-e 'while ($(prohibit_undesirable_word_seq_RE_))' \
910
$(perl_filename_lineno_text_)
911
# Define this to a regular expression that matches
912
# any filename:dd:match lines you want to ignore.
913
# The default is to ignore no matches.
914
ignore_undesirable_word_sequence_RE_ ?= ^$$
916
sc_prohibit_undesirable_word_seq:
917
@perl -n -0777 $(prohibit_undesirable_word_seq_) \
918
$$($(VC_LIST_EXCEPT)) \
919
| grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \
920
&& { echo '$(ME): undesirable word sequence' >&2; exit 1; } || :
922
_ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
923
_ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
924
# Using test's -a and -o operators is not portable.
925
# We prefer test over [, since the latter is spelled [[ in configure.ac.
926
sc_prohibit_test_minus_ao:
927
@prohibit='(\<test| \[+) .+ -[ao] ' \
928
halt='$(_ptm1); $(_ptm2)' \
931
# Avoid a test bashism.
932
sc_prohibit_test_double_equal:
933
@prohibit='(\<test| \[+) .+ == ' \
934
containing='#! */bin/[a-z]*sh' \
935
halt='use "test x = x", not "test x =''= x"' \
938
# Each program that uses proper_name_utf8 must link with one of the
939
# ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
940
# The perl -0777 invocation below extracts the possibly-multi-line
941
# definition of LDADD from the appropriate Makefile.am and exits 0
942
# when it contains "ICONV".
452
943
sc_proper_name_utf8_requires_ICONV:
453
944
@progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
454
945
if test "x$$progs" != x; then \
456
947
for p in $$progs; do \
457
948
dir=$$(dirname "$$p"); \
950
-ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
951
$$dir/Makefile.am && continue; \
458
952
base=$$(basename "$$p" .c); \
459
953
grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
460
954
|| { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
500
995
# Ensure that we use only the standard $(VAR) notation,
501
996
# not @...@ in Makefile.am, now that we can rely on automake
502
997
# to emit a definition for each substituted variable.
503
# We use perl rather than "grep -nE ..." to exempt a single
504
# use of an @...@-delimited variable name in src/Makefile.am.
506
@perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/' \
998
# However, there is still one case in which @VAR@ use is not just
999
# legitimate, but actually required: when augmenting an automake-defined
1000
# variable with a prefix. For example, gettext uses this:
1001
# MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@
1002
# otherwise, makeinfo would put German or French (current locale)
1003
# navigation hints in the otherwise-English documentation.
1005
# Allow the package to add exceptions via a hook in cfg.mk;
1006
# for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
1007
# setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
1008
_makefile_at_at_check_exceptions ?=
1009
sc_makefile_at_at_check:
1010
@perl -ne '/\@[A-Z_0-9]+\@/' \
1011
-e ' && !/([A-Z_0-9]+)\s+=.*\@\1\@$$/' \
1012
-e ''$(_makefile_at_at_check_exceptions) \
507
1013
-e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
508
$$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$') \
1014
$$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \
509
1015
&& { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
511
news-date-check: NEWS
512
today=`date +%Y-%m-%d`; \
513
if head $(srcdir)/NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
1018
if sed -n $(news-check-lines-spec)p $(srcdir)/NEWS \
1019
| grep -E $(news-check-regexp) >/dev/null; then \
517
echo "version or today's date is not in NEWS" 1>&2; \
1022
echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
521
1026
sc_makefile_TAB_only_indentation:
522
@grep -nE '^ [ ]{8}' \
523
$$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$') \
524
&& { echo '$(ME): found TAB-8-space indentation' 1>&2; \
1027
@prohibit='^ [ ]{8}' \
1028
in_vc_files='akefile|\.mk$$' \
1029
halt='found TAB-8-space indentation' \
1030
$(_sc_search_regexp)
527
1032
sc_m4_quote_check:
528
@grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
529
$$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
530
&& { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
1033
@prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
1034
in_vc_files='(^configure\.ac|\.m4)$$' \
1035
halt='quote the first arg to AC_DEF*' \
1036
$(_sc_search_regexp)
533
1038
fix_po_file_diag = \
534
1039
'you have changed the set of files with translatable diagnostics;\n\
535
1040
apply the above patch\n'
537
1042
# Verify that all source files using _() are listed in po/POTFILES.in.
538
po_file = po/POTFILES.in
1043
po_file ?= $(srcdir)/po/POTFILES.in
1044
generated_files ?= $(srcdir)/lib/*.[ch]
540
1046
@if test -f $(po_file); then \
541
1047
grep -E -v '^(#|$$)' $(po_file) \
542
1048
| grep -v '^src/false\.c$$' | sort > $@-1; \
544
for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do \
1050
for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do \
545
1051
test -r $$file || continue; \
546
1052
case $$file in \
547
1053
*.m4|*.mk) continue ;; \
583
1090
test "$$fail" && exit 1 || : ; \
586
v_etc_file = lib/version-etc.c
1093
v_etc_file = $(gnulib_dir)/lib/version-etc.c
587
1094
sample-test = tests/sample-test
588
1095
texi = doc/$(PACKAGE).texi
589
1096
# Make sure that the copyright date in $(v_etc_file) is up to date.
590
1097
# Do the same for the $(sample-test) and the main doc/.texi file.
591
1098
sc_copyright_check:
592
@if test -f $(v_etc_file); then \
593
grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
595
|| { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
598
@if test -f $(sample-test); then \
599
grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
601
|| { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
604
@if test -f $(texi); then \
605
grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
607
|| { echo 'out of date copyright in $(texi); update it' 1>&2; \
1099
@require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \
1100
in_files=$(v_etc_file) \
1101
halt='out of date copyright in $(v_etc_file); update it' \
1102
$(_sc_search_regexp)
1103
@require='# Copyright \(C\) '$$(date +%Y)' Free' \
1104
in_vc_files=$(sample-test) \
1105
halt='out of date copyright in $(sample-test); update it' \
1106
$(_sc_search_regexp)
1107
@require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \
1108
in_vc_files=$(texi) \
1109
halt='out of date copyright in $(texi); update it' \
1110
$(_sc_search_regexp)
1112
# If tests/help-version exists and seems to be new enough, assume that its
1113
# use of init.sh and path_prepend_ is correct, and ensure that every other
1114
# use of init.sh is identical.
1115
# This is useful because help-version cross-checks prog --version
1116
# with $(VERSION), which verifies that its path_prepend_ invocation
1117
# sets PATH correctly. This is an inexpensive way to ensure that
1118
# the other init.sh-using tests also get it right.
1119
_hv_file ?= $(srcdir)/tests/help-version
1120
_hv_regex_weak ?= ^ *\. .*/init\.sh"
1121
# Fix syntax-highlighters "
1122
_hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh"
1123
sc_cross_check_PATH_usage_in_tests:
1124
@if test -f $(_hv_file); then \
1125
grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \
1126
|| { echo "$@: skipped: no such file: $(_hv_file)" 1>&2; \
1128
grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null \
1129
|| { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \
1131
good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file)); \
1132
grep -LFx "$$good" \
1133
$$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT))) \
1135
{ echo "$(ME): the above files use path_prepend_ inconsistently" \
1136
1>&2; exit 1; } || :; \
1139
# #if HAVE_... will evaluate to false for any non numeric string.
1140
# That would be flagged by using -Wundef, however gnulib currently
1141
# tests many undefined macros, and so we can't enable that option.
1142
# So at least preclude common boolean strings as macro values.
1144
@prohibit='^#define.*(yes|no|true|false)$$' \
1145
in_files='$(CONFIG_INCLUDE)' \
1146
halt='Use 0 or 1 for macro values' \
1147
$(_sc_search_regexp)
1149
# Even if you use pathmax.h to guarantee that PATH_MAX is defined, it might
1150
# not be constant, or might overflow a stack. In general, use PATH_MAX as
1151
# a limit, not an array or alloca size.
1152
sc_prohibit_path_max_allocation:
1153
@prohibit='(\balloca *\([^)]*|\[[^]]*)PATH_MAX' \
1154
halt='Avoid stack allocations of size PATH_MAX' \
1155
$(_sc_search_regexp)
1157
sc_vulnerable_makefile_CVE-2009-4029:
1158
@prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
1159
in_files=$$(find $(srcdir) -name Makefile.in) \
1160
halt=$$(printf '%s\n' \
1161
'the above files are vulnerable; beware of running' \
1162
' "make dist*" rules, and upgrade to fixed automake' \
1163
' see http://bugzilla.redhat.com/542609 for details') \
1164
$(_sc_search_regexp)
612
1167
(unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
689
.PHONY: alpha beta major
690
ALL_RECURSIVE_TARGETS += alpha beta major
691
alpha beta major: $(local-check) writable-files no-submodule-changes
693
&& { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
1257
submodule-checks ?= no-submodule-changes public-submodule-commit
1259
# Ensure that each sub-module commit we're using is public.
1260
# Without this, it is too easy to tag and release code that
1261
# cannot be built from a fresh clone.
1262
.PHONY: public-submodule-commit
1263
public-submodule-commit:
1264
$(AM_V_GEN)if test -d $(srcdir)/.git; then \
1266
git submodule --quiet foreach test '$$(git rev-parse $$sha1)' \
1267
= '$$(git merge-base origin $$sha1)' \
1268
|| { echo '$(ME): found non-public submodule commit' >&2; \
1273
# This rule has a high enough utility/cost ratio that it should be a
1274
# dependent of "check" by default. However, some of us do occasionally
1275
# commit a temporary change that deliberately points to a non-public
1276
# submodule commit, and want to be able to use rules like "make check".
1277
# In that case, run e.g., "make check gl_public_submodule_commit="
1278
# to disable this test.
1279
gl_public_submodule_commit ?= public-submodule-commit
1280
check: $(gl_public_submodule_commit)
1282
.PHONY: alpha beta stable
1283
ALL_RECURSIVE_TARGETS += alpha beta stable
1284
alpha beta stable: $(local-check) writable-files $(submodule-checks)
1286
&& { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \
694
1287
|| { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
696
1289
$(MAKE) vc-diff-check
697
$(MAKE) news-date-check
698
1291
$(MAKE) distcheck
699
1292
$(MAKE) dist XZ_OPT=-9ev
700
$(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
1293
$(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1294
$(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1296
# Override this in cfg.mk if you follow different procedures.
1297
release-prep-hook ?= release-prep
1299
gl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?]
1300
.PHONY: release-prep
1302
case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1303
*) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1304
$(MAKE) --no-print-directory -s announcement > ~/announce-$(my_distdir)
701
1305
if test -d $(release_archive_dir); then \
702
1306
ln $(rel-files) $(release_archive_dir); \
703
1307
chmod a-w $(rel-files); \
705
$(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
706
1309
echo $(VERSION) > $(prev_version_file)
707
1310
$(MAKE) update-NEWS-hash
708
perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
1311
perl -pi -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' NEWS
709
1312
$(emit-commit-log) > .ci-msg
710
1313
$(VC) commit -F .ci-msg -a
1316
# Override this with e.g., -s $(srcdir)/some_other_name.texi
1317
# if the default $(PACKAGE)-derived name doesn't apply.
712
1320
.PHONY: web-manual
714
1322
@test -z "$(manual_title)" \
715
1323
&& { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
716
1324
@cd '$(srcdir)/doc'; \
717
$(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
1325
$(SHELL) ../build-aux/gendocs.sh $(gendocs_options_) \
1326
-o '$(abs_builddir)/doc/manual' \
718
1327
--email $(PACKAGE_BUGREPORT) $(PACKAGE) \
719
1328
"$(PACKAGE_NAME) - $(manual_title)"
720
1329
@echo " *** Upload the doc/manual directory to web-cvs."
777
1388
grep -l -w Copyright \
778
1389
$$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
779
1390
| $(update-copyright-env) xargs $(build_aux)/$@
1392
# This tight_scope test is skipped with a warning if $(_gl_TS_headers) is not
1393
# overridden and $(_gl_TS_dir)/Makefile.am does not mention noinst_HEADERS.
1395
# NOTE: to override any _gl_TS_* default value, you must
1396
# define the variable(s) using "export" in cfg.mk.
1399
ALL_RECURSIVE_TARGETS += sc_tight_scope
1400
sc_tight_scope: tight-scope.mk
1401
@if ! grep '^ *export _gl_TS_headers *=' $(srcdir)/cfg.mk \
1403
&& ! grep -w noinst_HEADERS $(srcdir)/$(_gl_TS_dir)/Makefile.am \
1404
> /dev/null 2>&1; then \
1405
echo '$(ME): skipping $@'; \
1407
$(MAKE) -s -C $(_gl_TS_dir) \
1409
-f $(abs_top_srcdir)/cfg.mk \
1410
-f $(abs_top_builddir)/$< \
1416
tight-scope.mk: $(ME)
1418
@perl -ne '/^# TS-start/.../^# TS-end/ and print' $(ME) > $@-t
1419
@chmod a=r $@-t && mv $@-t $@
1424
# Most functions should have static scope.
1425
# Any that don't must be marked with `extern', but `main'
1426
# and `usage' are exceptions: they're always extern, but
1427
# do not need to be marked. Symbols matching `__.*' are
1428
# reserved by the compiler, so are automatically excluded below.
1429
_gl_TS_unmarked_extern_functions ?= main usage
1430
_gl_TS_function_match ?= /^(?:$(_gl_TS_extern)) +.*?(\S+) *\(/
1432
# If your project uses a macro like "XTERN", then put
1433
# the following in cfg.mk to override this default:
1434
# export _gl_TS_extern = extern|XTERN
1435
_gl_TS_extern ?= extern
1437
# The second nm|grep checks for file-scope variables with `extern' scope.
1438
# Without gnulib's progname module, you might put program_name here.
1439
# Symbols matching `__.*' are reserved by the compiler,
1440
# so are automatically excluded below.
1441
_gl_TS_unmarked_extern_vars ?=
1443
# NOTE: the _match variables are perl expressions -- not mere regular
1444
# expressions -- so that you can extend them to match other patterns
1445
# and easily extract matched variable names.
1446
# For example, if your project declares some global variables via
1447
# a macro like this: GLOBAL(type, var_name, initializer), then you
1448
# can override this definition to automatically extract those names:
1449
# export _gl_TS_var_match = \
1450
# /^(?:$(_gl_TS_extern)) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/
1451
_gl_TS_var_match ?= /^(?:$(_gl_TS_extern)) .*?(\w+)(\[.*?\])?;/
1453
# The names of object files in (or relative to) $(_gl_TS_dir).
1454
_gl_TS_obj_files ?= *.$(OBJEXT)
1456
# Files in which to search for the one-line style extern declarations.
1457
# $(_gl_TS_dir)-relative.
1458
_gl_TS_headers ?= $(noinst_HEADERS)
1460
.PHONY: _gl_tight_scope
1461
_gl_tight_scope: $(bin_PROGRAMS)
1462
t=exceptions-$$$$; \
1463
trap 's=$$?; rm -f $$t; exit $$s' 0; \
1464
for sig in 1 2 3 13 15; do \
1465
eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \
1467
src=`for f in $(SOURCES); do \
1468
test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \
1469
hdr=`for f in $(_gl_TS_headers); do \
1470
test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \
1471
( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_functions); \
1472
grep -h -A1 '^extern .*[^;]$$' $$src \
1473
| grep -vE '^(extern |--)' | sed 's/ .*//'; \
1475
'$(_gl_TS_function_match) and print "^$$1\$$"' $$hdr; \
1476
) | sort -u > $$t; \
1477
nm -e $(_gl_TS_obj_files) | sed -n 's/.* T //p'|grep -Ev -f $$t \
1478
&& { echo the above functions should have static scope >&2; \
1480
( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_vars); \
1481
perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' $$hdr *.h \
1482
) | sort -u > $$t; \
1483
nm -e $(_gl_TS_obj_files) | sed -n 's/.* [BCDGRS] //p' \
1484
| sort -u | grep -Ev -f $$t \
1485
&& { echo the above variables should have static scope >&2; \
added
removed
maint.mk
