2 # This Makefile fragment tries to be general-purpose enough to be
3 # used by many projects via the gnulib maintainer-makefile module.
5 ## Copyright (C) 2001-2010 Free Software Foundation, Inc.
7 ## This program is free software: you can redistribute it and/or modify
8 ## it under the terms of the GNU General Public License as published by
9 ## the Free Software Foundation, either version 3 of the License, or
10 ## (at your option) any later version.
12 ## This program is distributed in the hope that it will be useful,
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ## GNU General Public License for more details.
17 ## You should have received a copy of the GNU General Public License
18 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
20 # This is reported not to work with make-3.79.1
21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
24 # Override this in cfg.mk if you use a non-standard build-aux directory.
25 build_aux ?
= $(srcdir)/build-aux
27 # Do not save the original name or timestamp in the .tar.gz file.
28 # Use --rsyncable if available.
30 $(shell gzip
--help
2>/dev
/null|grep rsyncable
>/dev
/null
&& echo
--rsyncable
)
31 GZIP_ENV
= '--no-name --best $(gzip_rsyncable)'
35 VC-tag
= git tag
-s
-m
'$(VERSION)' -u
'$(gpg_key_ID)'
37 VC_LIST
= $(build_aux
)/vc-list-files
-C
$(srcdir)
39 # You can override this variable in cfg.mk to set your own regexp
40 # matching files to ignore.
41 VC_LIST_ALWAYS_EXCLUDE_REGEX ?
= ^
$$
43 # This is to preprocess robustly the output of $(VC_LIST), so that even
44 # when $(srcdir) is a pathological name like "....", the leading sed command
45 # removes only the intended prefix.
46 _dot_escaped_srcdir
= $(subst .
,\.
,$(srcdir))
48 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only
49 # when $(srcdir) is not ".".
51 _prepend_srcdir_prefix
=
53 _prepend_srcdir_prefix
= | sed
's|^|$(srcdir)/|'
56 # In order to be able to consistently filter "."-relative names,
57 # (i.e., with no $(srcdir) prefix), this definition is careful to
58 # remove any $(srcdir) prefix, and to restore what it removes.
60 $(VC_LIST
) | sed
's|^$(_dot_escaped_srcdir)/||' \
61 | if
test -f
$(srcdir)/.x-
$@
; then grep
-vEf
$(srcdir)/.x-
$@
; \
62 else grep
-Ev
-e
"$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
63 | grep
-Ev
-e
'$(VC_LIST_ALWAYS_EXCLUDE_REGEX)' \
64 $(_prepend_srcdir_prefix
)
66 ifeq ($(origin prev_version_file
), undefined
)
67 prev_version_file
= $(srcdir)/.prev-version
70 PREV_VERSION
:= $(shell cat
$(prev_version_file
) 2>/dev
/null
)
71 VERSION_REGEXP
= $(subst .
,\.
,$(VERSION
))
72 PREV_VERSION_REGEXP
= $(subst .
,\.
,$(PREV_VERSION
))
75 this-vc-tag
= v
$(VERSION
)
76 this-vc-tag-regexp
= v
$(VERSION_REGEXP
)
78 tag-package
= $(shell echo
"$(PACKAGE)" | tr
'[:lower:]' '[:upper:]')
79 tag-this-version
= $(subst .
,_
,$(VERSION
))
80 this-vc-tag
= $(tag-package
)-$(tag-this-version
)
81 this-vc-tag-regexp
= $(this-vc-tag
)
83 my_distdir
= $(PACKAGE
)-$(VERSION
)
85 # Old releases are stored here.
86 release_archive_dir ?
= ..
/release
88 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
89 # Use alpha.gnu.org for alpha and beta releases.
90 # Use ftp.gnu.org for stable releases.
91 gnu_ftp_host-alpha
= alpha.gnu.org
92 gnu_ftp_host-beta
= alpha.gnu.org
93 gnu_ftp_host-stable
= ftp.gnu.org
94 gnu_rel_host ?
= $(gnu_ftp_host-
$(RELEASE_TYPE
))
96 ifeq ($(gnu_rel_host
),ftp.gnu.org
)
97 url_dir_list ?
= http
://ftpmirror.gnu.org
/$(PACKAGE
)
99 url_dir_list ?
= ftp
://$(gnu_rel_host
)/gnu
/$(PACKAGE
)
102 # Override this in cfg.mk if you are using a different format in your
104 today
= $(shell date
+%Y-
%m-
%d
)
105 news-check-regexp ?
= '^\*.* $(VERSION_REGEXP) \($(today)\)'
107 # Prevent programs like 'sort' from considering distinct strings to be equal.
108 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
111 ## --------------- ##
113 ## --------------- ##
115 _cfg_mk
:= $(shell test -f
$(srcdir)/cfg.mk
&& echo
'$(srcdir)/cfg.mk')
117 # Collect the names of rules starting with `sc_'.
118 syntax-check-rules
:= $(sort $(shell sed
-n
's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
119 $(srcdir)/$(ME
) $(_cfg_mk
)))
120 .PHONY
: $(syntax-check-rules
)
122 local-checks-available
= \
123 $(syntax-check-rules
)
124 .PHONY
: $(local-checks-available
)
126 # Arrange to print the name of each syntax-checking rule just before running it.
127 $(syntax-check-rules
): %: %.m
128 $(patsubst %, %.m
, $(syntax-check-rules
)):
129 @echo
$(patsubst sc_
%.m
, %, $@
)
131 local-check
:= $(filter-out $(local-checks-to-skip
), $(local-checks-available
))
133 syntax-check
: $(local-check
)
134 # @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
135 # $$(find -type f -name '*.[chly]') && \
136 # { echo '$(ME): found conditional include' 1>&2; \
139 # grep -nE '^# *include <(string|stdlib)\.h>' \
140 # $(srcdir)/{lib,src}/*.[chy] && \
141 # { echo '$(ME): FIXME' 1>&2; \
143 # FIXME: don't allow `#include .strings\.h' anywhere
145 # By default, _prohibit_regexp does not ignore case.
147 _ignore_case
= $$(test -n
"$$ignore_case" && echo
-i ||
:)
149 # There are many rules below that prohibit constructs in this package.
150 # If the offending construct can be matched with a grep-E-style regexp,
151 # use this macro. The shell variables "re" and "msg" must be defined.
152 define _prohibit_regexp
153 dummy
=; : so we do not need a semicolon before each use
; \
154 test "x$$re" != x ||
{ echo
'$(ME): re not defined' 1>&2; exit
1; }; \
155 test "x$$msg" != x ||
{ echo
'$(ME): msg not defined' 1>&2; exit
1; };\
156 grep
$(_ignore_case
) -nE
"$$re" $$($(VC_LIST_EXCEPT
)) && \
157 { echo
'$(ME): '"$$msg" 1>&2; exit
1; } ||
:
160 sc_avoid_if_before_free
:
161 @
$(build_aux
)/useless-if-before-free \
162 $(useless_free_options
) \
163 $$($(VC_LIST_EXCEPT
) | grep
-v useless-if-before-free
) && \
164 { echo
'$(ME): found useless "if" before "free" above' 1>&2; \
167 sc_cast_of_argument_to_free
:
168 @re
='\<free *\( *\(' msg
='don'\''t cast free argument' \
171 sc_cast_of_x_alloc_return_value
:
172 @re
='\*\) *x(m|c|re)alloc\>' \
173 msg
='don'\''t cast x*alloc return value' \
176 sc_cast_of_alloca_return_value
:
177 @re
='\*\) *alloca\>' msg
='don'\''t cast alloca return value' \
181 @re
='[ ] ' msg
='found SPACE-TAB sequence; remove the SPACE' \
184 # Don't use *scanf or the old ato* functions in `real' code.
185 # They provide no error checking mechanism.
186 # Instead, use strto* functions.
187 sc_prohibit_atoi_atof
:
188 @re
='\<([fs]?scanf|ato([filq]|ll)) *\(' \
189 msg
='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
192 # Use STREQ rather than comparing strcmp == 0, or != 0.
194 @grep
-nE
'! *str''cmp *\(|\<str''cmp *\([^)]+\) *==' \
195 $$($(VC_LIST_EXCEPT
)) \
196 | grep
-vE
':# *define STREQ\(' && \
197 { echo
'$(ME): use STREQ in place of the above uses of str''cmp' \
200 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
201 # Convert all uses automatically, via these two commands:
202 # git grep -l '\<exit *(1)' \
203 # | grep -vEf .x-sc_prohibit_magic_number_exit \
204 # | xargs --no-run-if-empty \
205 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
206 # git grep -l '\<exit *(0)' \
207 # | grep -vEf .x-sc_prohibit_magic_number_exit \
208 # | xargs --no-run-if-empty \
209 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
210 sc_prohibit_magic_number_exit
:
211 @re
='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \
212 msg
='use EXIT_* values rather than magic number' \
215 # Using EXIT_SUCCESS as the first argument to error is misleading,
216 # since when that parameter is 0, error does not exit. Use `0' instead.
217 sc_error_exit_success
:
218 @grep
-nE
'error \(EXIT_SUCCESS,' \
219 $$($(VC_LIST_EXCEPT
) | grep
-E
'\.[chly]$$') && \
220 { echo
'$(ME): found error (EXIT_SUCCESS' 1>&2; exit
1; } ||
:
222 # `FATAL:' should be fully upper-cased in error messages
223 # `WARNING:' should be fully upper-cased, or fully lower-cased
224 sc_error_message_warn_fatal
:
225 @grep
-nEA2
'[^rp]error \(' $$($(VC_LIST_EXCEPT
)) \
226 | grep
-E
'"Warning|"Fatal|"fatal' && \
227 { echo
'$(ME): use FATAL, WARNING or warning' 1>&2; \
230 # Error messages should not start with a capital letter
231 sc_error_message_uppercase
:
232 @grep
-nEA2
'[^rp]error \(' $$($(VC_LIST_EXCEPT
)) \
234 | grep
-vE
'"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \
235 { echo
'$(ME): found capitalized error message' 1>&2; \
238 # Error messages should not end with a period
239 sc_error_message_period
:
240 @grep
-nEA2
'[^rp]error \(' $$($(VC_LIST_EXCEPT
)) \
241 | grep
-E
'[^."]\."' && \
242 { echo
'$(ME): found error message ending in period' 1>&2; \
246 @re
=file
''system ignore_case
=1 \
247 msg
='found use of "file''system"; spell it "file system"' \
250 # Don't use cpp tests of this symbol. All code assumes config.h is included.
251 sc_prohibit_have_config_h
:
252 @grep
-n
'^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT
)) && \
253 { echo
'$(ME): found use of HAVE''_CONFIG_H; remove' \
256 # Nearly all .c files must include <config.h>. However, we also permit this
257 # via inclusion of a package-specific header, if cfg.mk specified one.
258 # config_h_header must be suitable for grep -E.
259 config_h_header ?
= <config\.h
>
261 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.c$$' > /dev
/null
; then \
262 grep
-EL
'^# *include $(config_h_header)' \
263 $$($(VC_LIST_EXCEPT
) | grep
'\.c$$') \
265 { echo
'$(ME): the above files do not include <config.h>' \
266 1>&2; exit
1; } ||
:; \
270 # You must include <config.h> before including any other header file.
271 # This can possibly be via a package-specific header, if given by cfg.mk.
272 sc_require_config_h_first
:
273 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.c$$' > /dev
/null
; then \
275 for i in
$$($(VC_LIST_EXCEPT
) | grep
'\.c$$'); do \
276 grep
'^# *include\>' $$i | sed
1q \
277 | grep
-E
'^# *include $(config_h_header)' > /dev
/null \
278 ||
{ echo
$$i; fail
=1; }; \
281 { echo
'$(ME): the above files include some other header' \
282 'before <config.h>' 1>&2; exit
1; } ||
:; \
286 sc_prohibit_HAVE_MBRTOWC
:
287 @re
='\bHAVE_MBRTOWC\b' msg
="do not use $$re; it is always defined" \
290 # To use this "command" macro, you must first define two shell variables:
291 # h: the header, enclosed in <> or ""
292 # re: a regular expression that matches IFF something provided by $h is used.
293 define _header_without_use
294 dummy
=; : so we do not need a semicolon before each use
; \
295 h_esc
=`echo "$$h"|sed 's/\./\\\\./g'`; \
296 if
$(VC_LIST_EXCEPT
) | grep
-l
'\.c$$' > /dev
/null
; then \
297 files
=$$(grep
-l
'^# *include '"$$h_esc" \
298 $$($(VC_LIST_EXCEPT
) | grep
'\.c$$')) && \
299 grep
-LE
"$$re" $$files | grep .
&& \
300 { echo
"$(ME): the above files include $$h but don't use it" \
301 1>&2; exit
1; } ||
:; \
306 # Prohibit the inclusion of assert.h without an actual use of assert.
307 sc_prohibit_assert_without_use
:
308 @h
='<assert.h>' re
='\<assert *\(' $(_header_without_use
)
310 # Prohibit the inclusion of close-stream.h without an actual use.
311 sc_prohibit_close_stream_without_use
:
312 @h
='"close-stream.h"' re
='\<close_stream *\(' $(_header_without_use
)
314 # Prohibit the inclusion of getopt.h without an actual use.
315 sc_prohibit_getopt_without_use
:
316 @h
='<getopt.h>' re
='\<getopt(_long)? *\(' $(_header_without_use
)
318 # Don't include quotearg.h unless you use one of its functions.
319 sc_prohibit_quotearg_without_use
:
320 @h
='"quotearg.h"' re
='\<quotearg(_[^ ]+)? *\(' $(_header_without_use
)
322 # Don't include quote.h unless you use one of its functions.
323 sc_prohibit_quote_without_use
:
324 @h
='"quote.h"' re
='\<quote(_n)? *\(' $(_header_without_use
)
326 # Don't include this header unless you use one of its functions.
327 sc_prohibit_long_options_without_use
:
328 @h
='"long-options.h"' re
='\<parse_long_options *\(' \
329 $(_header_without_use
)
331 # Don't include this header unless you use one of its functions.
332 sc_prohibit_inttostr_without_use
:
333 @h
='"inttostr.h"' re
='\<(off|[iu]max|uint)tostr *\(' \
334 $(_header_without_use
)
336 # Don't include this header unless you use one of its functions.
337 sc_prohibit_ignore_value_without_use
:
338 @h
='"ignore-value.h"' re
='\<ignore_(value|ptr) *\(' \
339 $(_header_without_use
)
341 # Don't include this header unless you use one of its functions.
342 sc_prohibit_error_without_use
:
344 re
='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
345 $(_header_without_use
)
347 # Don't include xalloc.h unless you use one of its functions.
348 # Consider these symbols:
349 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
350 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
351 # Divide into two sets on case, and filter each through this:
352 # | sort | perl -MRegexp::Assemble -le \
353 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
354 # Note this was produced by the above:
356 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
357 # But we can do better, in at least two ways:
358 # 1) take advantage of two "dup"-suffixed strings:
359 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
360 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
362 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
363 _xa1
= x
(((2n?
)?re|char|n
(re|m
)|
[cmz
])alloc|alloc_
(oversized|die
)|
(mem|str
)dup
)
364 _xa2
= X
([CZ
]|N?M
)ALLOC
365 sc_prohibit_xalloc_without_use
:
367 re
='\<($(_xa1)|$(_xa2)) *\('\
368 $(_header_without_use
)
370 sc_prohibit_safe_read_without_use
:
371 @h
='"safe-read.h"' re
='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
372 $(_header_without_use
)
374 sc_prohibit_argmatch_without_use
:
376 re
='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
377 $(_header_without_use
)
379 sc_prohibit_canonicalize_without_use
:
380 @h
='"canonicalize.h"' \
381 re
='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
382 $(_header_without_use
)
384 sc_prohibit_root_dev_ino_without_use
:
385 @h
='"root-dev-ino.h"' \
386 re
='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
387 $(_header_without_use
)
389 sc_prohibit_openat_without_use
:
391 re
='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
392 $(_header_without_use
)
394 # Prohibit the inclusion of c-ctype.h without an actual use.
395 ctype_re
= isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
396 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
397 sc_prohibit_c_ctype_without_use
:
398 @h
='[<"]c-ctype.h[">]' re
='\<c_($(ctype_re)) *\(' $(_header_without_use
)
401 _sp
= $(_empty
) $(_empty
)
402 # The following list was generated by running:
403 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
404 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
406 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
407 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
408 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
409 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
410 _sig_function_re
= $(subst $(_sp
),|
,$(strip $(_sig_functions
)))
411 # The following were extracted from "man signal.h" manually.
412 _sig_types_and_consts
= \
413 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \
414 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \
415 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \
416 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \
417 sigstack sigval stack_t ucontext_t
418 # generated via this:
419 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
421 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \
422 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \
423 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \
424 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \
425 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \
426 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \
427 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \
429 _sig_syms_re
= $(subst $(_sp
),|
,$(strip $(_sig_names
) $(_sig_types_and_consts
)))
431 # Prohibit the inclusion of signal.h without an actual use.
432 sc_prohibit_signal_without_use
:
434 re
='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \
435 $(_header_without_use
)
438 @re
='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
439 msg
='do not use HAVE''_FCNTL_H or O'_NDELAY \
442 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
444 # Each nonempty ChangeLog line must start with a year number, or a TAB.
446 @if
$(VC_LIST_EXCEPT
) | grep
-l
'^ChangeLog$$' >/dev
/null
; then \
448 $$($(VC_LIST_EXCEPT
) | grep
'^ChangeLog$$') && \
449 { echo
'$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
453 # Ensure that each .c file containing a "main" function also
454 # calls set_program_name.
456 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.c$$' > /dev
/null
; then \
457 files
=$$(grep
-l
'^main *(' $$($(VC_LIST_EXCEPT
) | grep
'\.c$$')); \
458 grep
-LE
'set_program_name *\(m?argv\[0\]\);' $$files \
460 { echo
'$(ME): the above files do not call set_program_name' \
461 1>&2; exit
1; } ||
:; \
465 # Require that the final line of each test-lib.sh-using test be this one:
467 # Note: this test requires GNU grep's --label= option.
468 Exit_witness_file ?
= tests
/test-lib.sh
469 Exit_base
:= $(notdir $(Exit_witness_file
))
470 sc_require_test_exit_idiom
:
471 @if
test -f
$(srcdir)/$(Exit_witness_file
); then \
473 for i in
$$(grep
-l
-F
'srcdir/$(Exit_base)' \
474 $$($(VC_LIST
) tests
)); do \
475 tail
-n1
$$i | grep
'^Exit .' > /dev
/null \
476 && : ||
{ die
=1; echo
$$i; } \
479 { echo
1>&2 '$(ME): the final line in each of the above is not:'; \
480 echo
1>&2 'Exit something'; \
485 @re
='\<the ''the\>' \
486 ignore_case
=1 msg
='found use of "the ''the";' \
491 msg
='found trailing blank(s)' \
494 # Match lines like the following, but where there is only one space
495 # between the options and the description:
496 # -D, --all-repeated[=delimit-method] print all duplicate lines\n
497 longopt_re
= --[a-z
][0-9A-Za-z-
]*(\
[?
=[0-9A-Za-z-
]*\
]?
)?
498 sc_two_space_separator_in_usage
:
499 @grep
-nE
'^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
500 $$($(VC_LIST_EXCEPT
)) && \
501 { echo
"$(ME): help2man requires at least two spaces between"; \
502 echo
"$(ME): an option and its description"; \
505 # Look for diagnostics that aren't marked for translation.
506 # This won't find any for which error's format string is on a separate line.
507 sc_unmarked_diagnostics
:
509 '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT
)) \
510 | grep
-v
'_''(' && \
511 { echo
'$(ME): found unmarked diagnostic(s)' 1>&2; \
514 # Avoid useless parentheses like those in this example:
515 # #if defined (SYMBOL) || defined (SYM2)
516 sc_useless_cpp_parens
:
517 @grep
-n
'^# *if .*defined *(' $$($(VC_LIST_EXCEPT
)) && \
518 { echo
'$(ME): found useless parentheses in cpp directive' \
521 # Require the latest GPL.
523 @re
='either ''version [^3]' msg
='GPL vN, N!=3' \
526 # Require the latest GFDL. Two regexp, since some .texi files end up
527 # line wrapping between 'Free Documentation License,' and 'Version'.
528 _GFDL_regexp
= (Free
''Documentation.
*Version
1\.
[^
3]|Version
1\.
[^
3] or any
)
530 @re
='$(_GFDL_regexp)' msg
='GFDL vN, N!=3' \
534 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
536 sc_prohibit_cvs_keyword
:
537 @re
='\$$($(cvs_keywords))\$$' \
538 msg
='do not use CVS keyword expansion' \
541 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
542 # This is a bit of a kludge, since it prevents use of the string
543 # even in comments, but for now it does the job with no false positives.
544 sc_prohibit_stat_st_blocks
:
545 @re
='[.>]st_blocks' msg
='do not use st_blocks; use ST_NBLOCKS' \
548 # Make sure we don't define any S_IS* macros in src/*.c files.
549 # They're already defined via gnulib's sys/stat.h replacement.
550 sc_prohibit_S_IS_definition
:
551 @re
='^ *# *define *S_IS' \
552 msg
='do not define S_IS* macros; include <sys/stat.h>' \
555 # Each program that uses proper_name_utf8 must link with one of the
556 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD.
557 # The perl -0777 invocation below extracts the possibly-multi-line
558 # definition of LDADD from the appropriate Makefile.am and exits 0
559 # when it contains "ICONV".
560 sc_proper_name_utf8_requires_ICONV
:
561 @progs
=$$(grep
-l
'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT
)));\
562 if
test "x$$progs" != x
; then \
564 for p in
$$progs; do \
565 dir=$$(dirname
"$$p"); \
567 -ne
'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \
568 $$dir/Makefile.am
&& continue
; \
569 base
=$$(basename "$$p" .c
); \
570 grep
"$${base}_LDADD.*ICONV)" $$dir/Makefile.am
> /dev
/null \
571 ||
{ fail
=1; echo
1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
574 { echo
1>&2 '$(ME): the above do not link with any ICONV library'; \
578 # Warn about "c0nst struct Foo const foo[]",
579 # but not about "char const *const foo" or "#define const const".
581 @re
='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
582 msg
='redundant "const" in declarations' \
585 sc_const_long_option
:
586 @grep
'^ *static.*struct option ' $$($(VC_LIST_EXCEPT
)) \
587 | grep
-Ev
'const struct option|struct option const' && { \
588 echo
1>&2 '$(ME): add "const" to the above declarations'; \
592 $$(sed
-n
'/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
595 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \
599 # Ensure that we don't accidentally insert an entry into an old NEWS block.
601 @if
test -f
$(srcdir)/NEWS
; then \
602 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
603 { echo
'$(ME): you have modified old NEWS' 1>&2; exit
1; }; \
606 # Update the hash stored above. Do this after each release and
607 # for any corrections to old entries.
608 update-NEWS-hash
: NEWS
609 perl
-pi
-e
's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
612 # Ensure that we use only the standard $(VAR) notation,
613 # not @...@ in Makefile.am, now that we can rely on automake
614 # to emit a definition for each substituted variable.
615 # We use perl rather than "grep -nE ..." to exempt a single
616 # use of an @...@-delimited variable name in src/Makefile.am.
617 # Allow the package to add exceptions via a hook in cfg.mk;
618 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
619 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
620 _makefile_at_at_check_exceptions ?
=
621 sc_makefile_at_at_check
:
622 @perl
-ne
'/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions
) \
623 -e
'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \
624 $$($(VC_LIST_EXCEPT
) | grep
-E
'(^|/)Makefile\.am$$') \
625 && { echo
'$(ME): use $$(...), not @...@' 1>&2; exit
1; } ||
:
628 if head
$(srcdir)/NEWS | grep
-E
$(news-check-regexp
) \
632 echo
'NEWS: $$(news-check-regexp) failed to match' 1>&2; \
636 sc_makefile_TAB_only_indentation
:
637 @grep
-nE
'^ [ ]{8}' \
638 $$($(VC_LIST_EXCEPT
) | grep
-E
'akefile|\.mk$$') \
639 && { echo
'$(ME): found TAB-8-space indentation' 1>&2; \
643 @grep
-nE
'(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
644 $$($(VC_LIST_EXCEPT
) | grep
-E
'(^configure\.ac|\.m4)$$') \
645 && { echo
'$(ME): quote the first arg to AC_DEF*' 1>&2; \
649 'you have changed the set of files with translatable diagnostics;\n\
650 apply the above patch\n'
652 # Verify that all source files using _() are listed in po/POTFILES.in.
653 po_file
= po
/POTFILES.in
655 @if
test -f
$(po_file
); then \
656 grep
-E
-v
'^(#|$$)' $(po_file
) \
657 | grep
-v
'^src/false\.c$$' |
sort > $@
-1; \
659 for file in
$$($(VC_LIST_EXCEPT
)) lib
/*.
[ch
]; do \
660 test -r
$$file || continue
; \
662 *.m4|
*.mk
) continue
;; \
668 base
=`expr " $$file" : ' \(.*\)\..'`; \
669 { test -f
$$base.l ||
test -f
$$base.y
; } && continue
;; \
671 files
="$$files $$file"; \
673 grep
-E
-l
'\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
675 diff
-u
-L
$(po_file
) -L
$(po_file
) $@
-1 $@
-2 \
676 ||
{ printf
'$(ME): '$(fix_po_file_diag
) 1>&2; exit
1; }; \
680 # Sometimes it is useful to change the PATH environment variable
681 # in Makefiles. When doing so, it's better not to use the Unix-centric
682 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
683 msg
= '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
684 sc_makefile_path_separator_check
:
685 @grep
-nE
'PATH[=].*:' \
686 $$($(VC_LIST_EXCEPT
) | grep
-E
'akefile|\.mk$$') \
687 && { echo
$(msg
) 1>&2; exit
1; } ||
:
689 # Check that `make alpha' will not fail at the end of the process.
691 if
test -d
$(release_archive_dir
); then
:; else \
692 for file in
$(distdir
).
tar.gz \
693 $(release_archive_dir
)/$(distdir
).
tar.gz
; do \
694 test -e
$$file || continue
; \
696 ||
{ echo ERROR
: $$file is not writable
; fail
=1; }; \
698 test "$$fail" && exit
1 ||
: ; \
701 v_etc_file
= lib
/version-etc.c
702 sample-test
= tests
/sample-test
703 texi
= doc
/$(PACKAGE
).texi
704 # Make sure that the copyright date in $(v_etc_file) is up to date.
705 # Do the same for the $(sample-test) and the main doc/.texi file.
707 @if
test -f
$(v_etc_file
); then \
708 grep
'enum { COPYRIGHT_YEAR = '$$(date
+%Y
)' };' $(v_etc_file
) \
710 ||
{ echo
'out of date copyright in $(v_etc_file); update it' 1>&2; \
713 @if
test -f
$(sample-test
); then \
714 grep
'# Copyright (C) '$$(date
+%Y
)' Free' $(sample-test
) \
716 ||
{ echo
'out of date copyright in $(sample-test); update it' 1>&2; \
719 @if
test -f
$(texi
); then \
720 grep
'Copyright @copyright{} .*'$$(date
+%Y
)' Free' $(texi
) \
722 ||
{ echo
'out of date copyright in $(texi); update it' 1>&2; \
726 # #if HAVE_... will evaluate to false for any non numeric string.
727 # That would be flagged by using -Wundef, however gnulib currently
728 # tests many undefined macros, and so we can't enable that option.
729 # So at least preclude common boolean strings as macro values.
731 @grep
-Ei
'^#define.*(yes|no|true|false)$$' '$(CONFIG_INCLUDE)' && \
732 { echo
'Use 0 or 1 for macro values' 1>&2; exit
1; } ||
:
734 sc_vulnerable_makefile_CVE-2009-4029
:
735 @files
=$$(find
$(srcdir) -name Makefile.in
); \
736 if
test -n
"$$files"; then \
738 'perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
740 { echo
'$(ME): the above files are vulnerable; beware of' \
741 'running "make dist*" rules, and upgrade to fixed automake' \
742 'see http://bugzilla.redhat.com/542609 for details' \
743 1>&2; exit
1; } ||
:; \
748 (unset CDPATH
; cd
$(srcdir) && $(VC
) diff
) > vc-diffs ||
:
749 if
test -s vc-diffs
; then \
751 echo
"Some files are locally modified:" 1>&2; \
757 rel-files
= $(DIST_ARCHIVES
)
759 gnulib_dir ?
= $(srcdir)/gnulib
760 gnulib-version
= $$(cd
$(gnulib_dir
) && git describe
)
761 bootstrap-tools ?
= autoconf
,automake
,gnulib
763 # If it's not already specified, derive the GPG key ID from
764 # the signed tag we've just applied to mark this release.
766 $$(git cat-file tag v
$(VERSION
) > .ann-sig \
767 && gpgv .ann-sig
- < /dev
/null
2>&1 \
768 | sed
-n
'/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig
)
770 announcement
: NEWS ChangeLog
$(rel-files
)
771 @
$(build_aux
)/announce-gen \
772 --release-type
=$(RELEASE_TYPE
) \
773 --package
=$(PACKAGE
) \
774 --prev
=$(PREV_VERSION
) \
776 --gpg-key-id
=$(gpg_key_ID
) \
777 --news
=$(srcdir)/NEWS \
778 --bootstrap-tools
=$(bootstrap-tools
) \
779 --gnulib-version
=$(gnulib-version
) \
780 --no-print-checksums \
781 $(addprefix --url-dir
=, $(url_dir_list
))
783 ## ---------------- ##
784 ## Updating files. ##
785 ## ---------------- ##
787 ftp-gnu
= ftp
://ftp.gnu.org
/gnu
788 www-gnu
= http
://www.gnu.org
790 emit_upload_commands
:
791 @echo
=====================================
792 @echo
=====================================
793 @echo
"$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
794 @echo
" --to $(gnu_rel_host):$(PACKAGE) \\"
795 @echo
" $(rel-files)"
796 @echo
'# send the ~/announce-$(my_distdir) e-mail'
797 @echo
=====================================
798 @echo
=====================================
800 noteworthy
= * Noteworthy changes in release ?.?
(????
-??
-??
) [?
]
801 define emit-commit-log
802 printf
'%s\n' 'post-release administrivia' '' \
803 '* NEWS: Add header line for next release.' \
804 '* .prev-version: Record previous version.' \
805 '* cfg.mk (old_NEWS_hash): Auto-update.'
808 .PHONY
: no-submodule-changes
809 no-submodule-changes
:
810 if
test -d
$(srcdir)/.git
; then \
811 diff
=$$(cd
$(srcdir) && git submodule
-q
foreach \
812 git diff-index
--name-only HEAD
) \
814 case
$$diff in
'') ;; \
815 *) echo
'$(ME): submodule files are locally modified:'; \
816 echo
"$$diff"; exit
1;; esac
; \
821 .PHONY
: alpha beta stable
822 ALL_RECURSIVE_TARGETS
+= alpha beta stable
823 alpha beta stable
: $(local-check
) writable-files no-submodule-changes
825 && { echo
$(VERSION
) | grep
-E
'^[0-9]+(\.[0-9]+)+$$' \
826 ||
{ echo
"invalid version string: $(VERSION)" 1>&2; exit
1;};}\
828 $(MAKE
) vc-diff-check
831 $(MAKE
) dist XZ_OPT
=-9ev
832 $(MAKE
) $(release-prep-hook
) RELEASE_TYPE
=$@
833 $(MAKE
) -s emit_upload_commands RELEASE_TYPE
=$@
835 # Override this in cfg.mk if you follow different procedures.
836 release-prep-hook ?
= release-prep
840 case
$$RELEASE_TYPE in alpha|beta|stable
) ;; \
841 *) echo
"invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit
1;; esac
842 $(MAKE
) -s announcement
> ~
/announce-
$(my_distdir
)
843 if
test -d
$(release_archive_dir
); then \
844 ln
$(rel-files
) $(release_archive_dir
); \
845 chmod a-w
$(rel-files
); \
847 echo
$(VERSION
) > $(prev_version_file
)
848 $(MAKE
) update-NEWS-hash
849 perl
-pi
-e
'$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
850 $(emit-commit-log
) > .ci-msg
851 $(VC
) commit
-F .ci-msg
-a
856 @
test -z
"$(manual_title)" \
857 && { echo
define manual_title in cfg.mk
1>&2; exit
1; } ||
:
858 @cd
'$(srcdir)/doc'; \
859 $(SHELL
) ..
/build-aux
/gendocs.sh
-o
'$(abs_builddir)/doc/manual' \
860 --email
$(PACKAGE_BUGREPORT
) $(PACKAGE
) \
861 "$(PACKAGE_NAME) - $(manual_title)"
862 @echo
" *** Upload the doc/manual directory to web-cvs."
867 $(MAKE
) $(AM_MAKEFLAGS
) clean
868 lcov
--directory .
--zerocounters
870 COVERAGE_CCOPTS ?
= "-g --coverage"
871 COVERAGE_OUT ?
= doc
/coverage
874 $(MAKE
) $(AM_MAKEFLAGS
) CFLAGS
=$(COVERAGE_CCOPTS
) CXXFLAGS
=$(COVERAGE_CCOPTS
)
875 $(MAKE
) $(AM_MAKEFLAGS
) CFLAGS
=$(COVERAGE_CCOPTS
) CXXFLAGS
=$(COVERAGE_CCOPTS
) check
876 mkdir
-p
$(COVERAGE_OUT
)
877 lcov
--directory .
--output-file
$(COVERAGE_OUT
)/$(PACKAGE
).
info \
881 genhtml
--output-directory
$(COVERAGE_OUT
) \
882 $(COVERAGE_OUT
)/$(PACKAGE
).
info \
883 --highlight
--frames
--legend \
884 --title
"$(PACKAGE_NAME)"
886 coverage
: init-coverage build-coverage gen-coverage
888 # Update gettext files.
889 PACKAGE ?
= $(shell basename $(PWD
))
890 PO_DOMAIN ?
= $(PACKAGE
)
891 POURL
= http
://translationproject.org
/latest
/$(PO_DOMAIN
)/
894 rm -f
$(PODIR
)/*.po
&& \
895 echo
"$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
896 wget
--no-verbose
--directory-prefix
$(PODIR
) --no-directories
--recursive
--level
1 --accept .po
--accept .po
.1 $(POURL
) && \
897 echo
'en@boldquot' > $(PODIR
)/LINGUAS
&& \
898 echo
'en@quot' >> $(PODIR
)/LINGUAS
&& \
899 ls
$(PODIR
)/*.po | sed
's/\.po//' | sed
's,$(PODIR)/,,' |
sort >> $(PODIR
)/LINGUAS
901 INDENT_SOURCES ?
= $(C_SOURCES
)
904 indent
$(INDENT_SOURCES
)
906 # If you want to set UPDATE_COPYRIGHT_* environment variables,
907 # put the assignments in this variable.
908 update-copyright-env ?
=
910 # Run this rule once per year (usually early in January)
911 # to update all FSF copyright year lists in your project.
912 # If you have an additional project-specific rule,
913 # add it in cfg.mk along with a line 'update-copyright: prereq'.
914 # By default, exclude all variants of COPYING; you can also
915 # add exemptions (such as ChangeLog..* for rotated change logs)
916 # in the file .x-update-copyright.
917 .PHONY
: update-copyright
919 grep
-l
-w Copyright \
920 $$(export VC_LIST_EXCEPT_DEFAULT
=COPYING
&& $(VC_LIST_EXCEPT
)) \
921 |
$(update-copyright-env
) xargs
$(build_aux
)/$@