mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-07-11 12:25:52 +00:00
828 lines
29 KiB
Makefile
828 lines
29 KiB
Makefile
# This is reported not to work with make-3.79.1
|
|
# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
|
|
ME := Makefile.maint
|
|
|
|
# Do not save the original name or timestamp in the .tar.gz file.
|
|
# Use --rsyncable if available.
|
|
gzip_rsyncable := \
|
|
$(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
|
|
GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
|
|
|
|
VC_LIST = $(srcdir)/build-aux/vc-list-files
|
|
|
|
VC_LIST_EXCEPT = \
|
|
$(VC_LIST) | if test -f .x-$@; then grep -vEf .x-$@; else grep -v ChangeLog; fi
|
|
|
|
include Makefile.nonreentrant
|
|
|
|
# Prevent programs like 'sort' from considering distinct strings to be equal.
|
|
# Doing it here saves us from having to set LC_ALL elsewhere in this file.
|
|
export LC_ALL = C
|
|
|
|
# Collect the names of rules starting with `sc_'.
|
|
syntax-check-rules := $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
|
|
$(srcdir)/$(ME))
|
|
.PHONY: $(syntax-check-rules)
|
|
|
|
local-checks-available = \
|
|
patch-check $(syntax-check-rules) \
|
|
makefile-check check-AUTHORS
|
|
.PHONY: $(local-checks-available)
|
|
|
|
# Arrange to print the name of each syntax-checking rule just before running it.
|
|
$(syntax-check-rules): %: %.m
|
|
$(patsubst %, %.m, $(syntax-check-rules)):
|
|
@echo "CHECK:" $(patsubst sc_%.m, %, $@)
|
|
|
|
local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
|
|
|
|
syntax-check: $(local-check)
|
|
# @grep -nE '# *include <(limits|std(def|arg|bool))\.h>' \
|
|
# $$(find -type f -name '*.[chly]') && \
|
|
# { echo '$(ME): found conditional include' 1>&2; \
|
|
# exit 1; } || :
|
|
|
|
# grep -nE '^# *include <(string|stdlib)\.h>' \
|
|
# $(srcdir)/{lib,src}/*.[chy] && \
|
|
# { echo '$(ME): FIXME' 1>&2; \
|
|
# exit 1; } || :
|
|
# FIXME: don't allow `#include .strings\.h' anywhere
|
|
|
|
# By default, _prohibit_regexp does not ignore case.
|
|
export ignore_case =
|
|
_ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
|
|
|
|
# There are many rules below that prohibit constructs in this package.
|
|
# If the offending construct can be matched with a grep-E-style regexp,
|
|
# use this macro. The shell variables "re" and "msg" must be defined.
|
|
define _prohibit_regexp
|
|
dummy=; : so we do not need a semicolon before each use \
|
|
test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; }; \
|
|
test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
|
|
grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) && \
|
|
{ echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
|
|
endef
|
|
|
|
sc_avoid_if_before_free:
|
|
@$(srcdir)/build-aux/useless-if-before-free \
|
|
$(useless_free_options) \
|
|
$$($(VC_LIST_EXCEPT)) && \
|
|
{ echo '$(ME): found useless "if" before "free" above' 1>&2; \
|
|
exit 1; } || :
|
|
|
|
# Avoid uses of write(2). Either switch to streams (fwrite), or use
|
|
# the safewrite wrapper.
|
|
sc_avoid_write:
|
|
@if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \
|
|
grep '\<write *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$') && \
|
|
{ echo "$(ME): the above files use write;" \
|
|
" consider using the safewrite wrapper instead" \
|
|
1>&2; exit 1; } || :; \
|
|
else :; \
|
|
fi
|
|
|
|
sc_cast_of_argument_to_free:
|
|
@re='\<free *\( *\(' msg='don'\''t cast free argument' \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_cast_of_x_alloc_return_value:
|
|
@re='\*\) *x(m|c|re)alloc\>' \
|
|
msg='don'\''t cast x*alloc return value' \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_cast_of_alloca_return_value:
|
|
@re='\*\) *alloca\>' msg='don'\''t cast alloca return value' \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_space_tab:
|
|
@re='[ ] ' msg='found SPACE-TAB sequence; remove the SPACE' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Don't use *scanf or the old ato* functions in `real' code.
|
|
# They provide no error checking mechanism.
|
|
# Instead, use strto* functions.
|
|
sc_prohibit_atoi_atof:
|
|
@re='\<([fs]?scanf|ato([filq]|ll))\>' \
|
|
msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Use STREQ rather than comparing strcmp == 0, or != 0.
|
|
# Similarly, use STREQLEN or STRPREFIX rather than strncmp.
|
|
sc_prohibit_strcmp:
|
|
@grep -nE '! *strn?cmp *\(|\<strn?cmp *\([^)]+\) *==' \
|
|
$$($(VC_LIST_EXCEPT)) \
|
|
| grep -vE ':# *define STREQ(LEN)?\(' && \
|
|
{ echo '$(ME): use STREQ(LEN) in place of the above uses of strcmp(strncmp)' \
|
|
1>&2; exit 1; } || :
|
|
|
|
# Use virAsprintf rather than a'sprintf since *strp is undefined on error.
|
|
sc_prohibit_asprintf:
|
|
@re='\<[a]sprintf\>' \
|
|
msg='use virAsprintf, not a'sprintf \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_prohibit_VIR_ERR_NO_MEMORY:
|
|
@re='\<V''IR_ERR_NO_MEMORY\>' \
|
|
msg='use virReportOOMError, not V'IR_ERR_NO_MEMORY \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_prohibit_nonreentrant:
|
|
@fail=0 ; \
|
|
for i in $(NON_REENTRANT) ; \
|
|
do \
|
|
grep --before 2 --after 1 -nE "\<$$i\>[:space:]*\(" $$($(VC_LIST_EXCEPT)) && \
|
|
fail=1 && echo "$(ME): use $${i}_r, not $${i}" || : ; \
|
|
done ; \
|
|
exit $$fail
|
|
|
|
# Using EXIT_SUCCESS as the first argument to error is misleading,
|
|
# since when that parameter is 0, error does not exit. Use `0' instead.
|
|
sc_error_exit_success:
|
|
@grep -nF 'error (EXIT_SUCCESS,' \
|
|
$$(find -type f -name '*.[chly]') && \
|
|
{ echo '$(ME): found error (EXIT_SUCCESS' 1>&2; \
|
|
exit 1; } || :
|
|
|
|
sc_file_system:
|
|
@re=file''system ignore_case=1 \
|
|
msg='found use of "file''system"; spell it "file system"' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Don't use cpp tests of this symbol. All code assumes config.h is included.
|
|
sc_prohibit_have_config_h:
|
|
@grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) && \
|
|
{ echo '$(ME): found use of HAVE''_CONFIG_H; remove' \
|
|
1>&2; exit 1; } || :
|
|
|
|
# Nearly all .c files must include <config.h>.
|
|
sc_require_config_h:
|
|
@if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \
|
|
grep -L '^# *include <config\.h>' \
|
|
$$($(VC_LIST_EXCEPT) | grep '\.c$$') \
|
|
| grep . && \
|
|
{ echo '$(ME): the above files do not include <config.h>' \
|
|
1>&2; exit 1; } || :; \
|
|
else :; \
|
|
fi
|
|
|
|
# You must include <config.h> before including any other header file.
|
|
sc_require_config_h_first:
|
|
@if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \
|
|
fail=0; \
|
|
for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \
|
|
grep '^# *include\>' $$i | sed 1q \
|
|
| grep '^# *include <config\.h>' > /dev/null \
|
|
|| { echo $$i; fail=1; }; \
|
|
done; \
|
|
test $$fail = 1 && \
|
|
{ echo '$(ME): the above files include some other header' \
|
|
'before <config.h>' 1>&2; exit 1; } || :; \
|
|
else :; \
|
|
fi
|
|
|
|
sc_prohibit_HAVE_MBRTOWC:
|
|
@re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
|
|
$(_prohibit_regexp)
|
|
|
|
# To use this "command" macro, you must first define two shell variables:
|
|
# h: the header, enclosed in <> or ""
|
|
# re: a regular expression that matches IFF something provided by $h is used.
|
|
define _header_without_use
|
|
h_esc=`echo "$$h"|sed 's/\./\\./'`; \
|
|
if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \
|
|
files=$$(grep -l '^# *include '"$$h_esc" \
|
|
$$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \
|
|
grep -LE "$$re" $$files | grep . && \
|
|
{ echo "$(ME): the above files include $$h but don't use it" \
|
|
1>&2; exit 1; } || :; \
|
|
else :; \
|
|
fi
|
|
endef
|
|
|
|
# Prohibit the inclusion of assert.h without an actual use of assert.
|
|
sc_prohibit_assert_without_use:
|
|
@h='<assert.h>' re='\<assert *\(' $(_header_without_use)
|
|
|
|
# Prohibit the inclusion of getopt.h without an actual use.
|
|
sc_prohibit_getopt_without_use:
|
|
@h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
|
|
|
|
# Don't include quotearg.h unless you use one of its functions.
|
|
sc_prohibit_quotearg_without_use:
|
|
@h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
|
|
|
|
# Don't include quote.h unless you use one of its functions.
|
|
sc_prohibit_quote_without_use:
|
|
@h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
|
|
|
|
# Don't include this header unless you use one of its functions.
|
|
sc_prohibit_long_options_without_use:
|
|
@h='"long-options.h"' re='\<parse_long_options *\(' \
|
|
$(_header_without_use)
|
|
|
|
# Don't include this header unless you use one of its functions.
|
|
sc_prohibit_inttostr_without_use:
|
|
@h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
|
|
$(_header_without_use)
|
|
|
|
# Don't include this header unless you use one of its functions.
|
|
sc_prohibit_error_without_use:
|
|
@h='"error.h"' \
|
|
re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
|
|
$(_header_without_use)
|
|
|
|
sc_prohibit_safe_read_without_use:
|
|
@h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
|
|
$(_header_without_use)
|
|
|
|
sc_prohibit_argmatch_without_use:
|
|
@h='"argmatch.h"' \
|
|
re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
|
|
$(_header_without_use)
|
|
|
|
sc_prohibit_root_dev_ino_without_use:
|
|
@h='"root-dev-ino.h"' \
|
|
re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
|
|
$(_header_without_use)
|
|
|
|
# Prohibit the inclusion of c-ctype.h without an actual use.
|
|
sc_prohibit_c_ctype_without_use:
|
|
@h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
|
|
|
|
# Prohibit the inclusion of <ctype.h>.
|
|
sc_prohibit_ctype_h:
|
|
@grep -E '^# *include *<ctype\.h>' $$($(VC_LIST_EXCEPT)) && \
|
|
{ echo "$(ME): don't use ctype.h; instead, use c-ctype.h" \
|
|
1>&2; exit 1; } || :
|
|
|
|
sc_obsolete_symbols:
|
|
@re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \
|
|
msg='do not use HAVE''_FCNTL_H or O'_NDELAY \
|
|
$(_prohibit_regexp)
|
|
|
|
# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
|
|
|
|
# Each nonempty line must start with a year number, or a TAB.
|
|
# Or day-of-week+space.
|
|
changelog_entry_header_regexp = \
|
|
([12][0-9][0-9][0-9]| .|(Mon|Tue|Wed|Thu|Fri|Sat|Sun) )
|
|
sc_changelog:
|
|
@grep -Evn '(^$$|^$(changelog_entry_header_regexp))' \
|
|
$$(find . -maxdepth 2 -name ChangeLog) && \
|
|
{ echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2; \
|
|
exit 1; } || :
|
|
|
|
sc_the_the:
|
|
@re='\<the ''the\>' \
|
|
ignore_case=1 msg='found use of "the ''the";' \
|
|
$(_prohibit_regexp)
|
|
|
|
sc_trailing_blank:
|
|
@re='[ ]$$' \
|
|
ignore_case=1 msg='found trailing blank(s)' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Ensure that no C source file uses TABs for indentation.
|
|
# Also match *.h.in files, to get libvirt.h.in.
|
|
# Exclude files in gnulib, since they're imported.
|
|
sc_TAB_in_indentation:
|
|
@grep -lE '^ * ' /dev/null \
|
|
$$($(VC_LIST_EXCEPT) \
|
|
| grep -E '\.[ch](\.in)?$$' \
|
|
| grep -v '^gnulib/') && \
|
|
{ echo '$(ME): found TAB(s) used for indentation in C sources;'\
|
|
'use spaces' 1>&2; exit 1; } || :
|
|
|
|
ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
|
|
|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
|
|
|
|
sc_avoid_ctype_macros:
|
|
@grep -E '\b($(ctype_re)) *\(' /dev/null \
|
|
$$($(VC_LIST_EXCEPT)) && \
|
|
{ echo "$(ME): don't use ctype macros (use c-ctype.h)" \
|
|
1>&2; exit 1; } || :
|
|
|
|
# Match lines like the following, but where there is only one space
|
|
# between the options and the description:
|
|
# -D, --all-repeated[=delimit-method] print all duplicate lines\n
|
|
longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
|
|
sc_two_space_separator_in_usage:
|
|
@grep -nE '^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \
|
|
$$($(VC_LIST_EXCEPT)) && \
|
|
{ echo "$(ME): help2man requires at least two spaces between"; \
|
|
echo "$(ME): an option and its description"; \
|
|
1>&2; exit 1; } || :
|
|
|
|
# Many of the function names below came from this filter:
|
|
# git grep -B2 '\<_('|grep -E '\.c- *[[:alpha:]_][[:alnum:]_]* ?\(.*[,;]$' \
|
|
# |sed 's/.*\.c- *//'|perl -pe 's/ ?\(.*//'|sort -u \
|
|
# |grep -vE '^(qsort|if|close|assert|fputc|free|N_|vir.*GetName|.*Unlock|virNodeListDevices|virHashRemoveEntry|freeaddrinfo|.*[fF]ree|xdrmem_create|xmlXPathFreeObject|virUUIDFormat|openvzSetProgramSentinal|polkit_action_unref)$'
|
|
|
|
msg_gen_function =
|
|
msg_gen_function += DEBUG0
|
|
msg_gen_function += DISABLE_fprintf
|
|
msg_gen_function += ERROR
|
|
msg_gen_function += ERROR0
|
|
msg_gen_function += REMOTE_DEBUG
|
|
msg_gen_function += ReportError
|
|
msg_gen_function += VIR_FREE
|
|
msg_gen_function += VIR_INFO
|
|
msg_gen_function += VIR_USE_CPU
|
|
msg_gen_function += errorf
|
|
msg_gen_function += lxcError
|
|
msg_gen_function += networkLog
|
|
msg_gen_function += networkReportError
|
|
msg_gen_function += openvzError
|
|
msg_gen_function += openvzLog
|
|
msg_gen_function += qemudDispatchClientFailure
|
|
msg_gen_function += qemudLog
|
|
msg_gen_function += qemudReportError
|
|
msg_gen_function += regerror
|
|
msg_gen_function += remoteDispatchFormatError
|
|
msg_gen_function += umlLog
|
|
msg_gen_function += umlReportError
|
|
msg_gen_function += virConfError
|
|
msg_gen_function += virDomainReportError
|
|
msg_gen_function += virSecurityReportError
|
|
msg_gen_function += virHashError
|
|
msg_gen_function += virLibConnError
|
|
msg_gen_function += virLibDomainError
|
|
msg_gen_function += virLog
|
|
msg_gen_function += virNetworkReportError
|
|
msg_gen_function += virNodeDeviceReportError
|
|
msg_gen_function += virProxyError
|
|
msg_gen_function += virRaiseError
|
|
msg_gen_function += virReportErrorHelper
|
|
msg_gen_function += virReportSystemError
|
|
msg_gen_function += virSexprError
|
|
msg_gen_function += virStorageLog
|
|
msg_gen_function += virStorageReportError
|
|
msg_gen_function += virXMLError
|
|
msg_gen_function += virXenInotifyError
|
|
msg_gen_function += virXenStoreError
|
|
msg_gen_function += virXendError
|
|
msg_gen_function += vshCloseLogFile
|
|
msg_gen_function += xenUnifiedError
|
|
msg_gen_function += xenXMError
|
|
|
|
# Uncomment the following and run "make syntax-check" to see diagnostics
|
|
# that are not yet marked for translation, but that need to be rewritten
|
|
# so that they are translatable.
|
|
# msg_gen_function += error
|
|
# msg_gen_function += fprintf
|
|
# msg_gen_function += testError
|
|
# msg_gen_function += virXenError
|
|
# msg_gen_function += vshPrint
|
|
# msg_gen_function += vshError
|
|
|
|
func_or := $(shell printf '$(msg_gen_function)'|tr -s '[[:space:]]' '|')
|
|
func_re := ($(func_or))
|
|
|
|
# Look for diagnostics that aren't marked for translation.
|
|
# This won't find any for which error's format string is on a separate line.
|
|
# The sed filters eliminate false-positives like these:
|
|
# _("...: "
|
|
# "%s", _("no storage vol w..."
|
|
sc_unmarked_diagnostics:
|
|
@grep -nE \
|
|
'\<$(func_re) \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT)) \
|
|
| grep -v '_''(' && \
|
|
{ echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
|
|
exit 1; } || :
|
|
@{ grep -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT)); \
|
|
grep -A1 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
|
|
| sed 's/_("[^"][^"]*"//;s/[ ]"%s"//' \
|
|
| grep '[ ]"' && \
|
|
{ echo '$(ME): found unmarked diagnostic(s)' 1>&2; \
|
|
exit 1; } || :
|
|
|
|
sc_prohibit_virBufferAdd_with_string_literal:
|
|
@re='\<virBufferAdd *\([^,]+, *"[^"]' \
|
|
msg='use virBufferAddLit, not virBufferAdd, with a string literal' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Not only do they fail to deal well with ipv6, but the gethostby*
|
|
# functions are also not thread-safe.
|
|
sc_prohibit_gethostby:
|
|
@re='\<gethostby(addr|name2?) *\(' \
|
|
msg='use getaddrinfo, not gethostby*' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Avoid useless parentheses like those in this example:
|
|
# #if defined (SYMBOL) || defined (SYM2)
|
|
sc_useless_cpp_parens:
|
|
@grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) && \
|
|
{ echo '$(ME): found useless parentheses in cpp directive' \
|
|
1>&2; exit 1; } || :
|
|
|
|
# Require the latest GPL.
|
|
sc_GPL_version:
|
|
@re='either ''version [^3]' msg='GPL vN, N!=3' \
|
|
$(_prohibit_regexp)
|
|
|
|
cvs_keywords = \
|
|
Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
|
|
|
|
sc_prohibit_cvs_keyword:
|
|
@re='\$$($(cvs_keywords))\$$' \
|
|
msg='do not use CVS keyword expansion' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Make sure we don't use st_blocks. Use ST_NBLOCKS instead.
|
|
# This is a bit of a kludge, since it prevents use of the string
|
|
# even in comments, but for now it does the job with no false positives.
|
|
sc_prohibit_stat_st_blocks:
|
|
@re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Make sure we don't define any S_IS* macros in src/*.c files.
|
|
# They're already defined via gnulib's sys/stat.h replacement.
|
|
sc_prohibit_S_IS_definition:
|
|
@re='^ *# *define *S_IS' \
|
|
msg='do not define S_IS* macros; include <sys/stat.h>' \
|
|
$(_prohibit_regexp)
|
|
|
|
# Each program that uses proper_name_utf8 must link with
|
|
# one of the ICONV libraries.
|
|
sc_proper_name_utf8_requires_ICONV:
|
|
@progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
|
|
if test "x$$progs" != x; then \
|
|
fail=0; \
|
|
for p in $$progs; do \
|
|
dir=$$(dirname "$$p"); \
|
|
base=$$(basename "$$p" .c); \
|
|
grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
|
|
|| { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
|
|
done; \
|
|
test $$fail = 1 && \
|
|
{ echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
|
|
exit 1; } || :; \
|
|
fi
|
|
|
|
# Warn about "c0nst struct Foo const foo[]",
|
|
# but not about "char const *const foo" or "#define const const".
|
|
sc_redundant_const:
|
|
@grep -E '\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \
|
|
$$($(VC_LIST_EXCEPT)) && \
|
|
{ echo 1>&2 '$(ME): redundant "const" in declarations'; \
|
|
exit 1; } || :
|
|
|
|
sc_const_long_option:
|
|
@grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT)) \
|
|
| grep -Ev 'const struct option|struct option const' && { \
|
|
echo 1>&2 '$(ME): add "const" to the above declarations'; \
|
|
exit 1; } || :
|
|
|
|
NEWS_hash = \
|
|
$$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \
|
|
$(srcdir)/NEWS | md5sum -)
|
|
|
|
# Ensure that we don't accidentally insert an entry into an old NEWS block.
|
|
sc_immutable_NEWS:
|
|
@if test -f $(srcdir)/NEWS; then \
|
|
test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \
|
|
{ echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
|
|
fi
|
|
|
|
# Update the hash stored above. Do this after each release and
|
|
# for any corrections to old entries.
|
|
update-NEWS-hash: NEWS
|
|
perl -pi -e 's/^(old_NEWS_hash = ).*/$${1}'"$(NEWS_hash)/" \
|
|
$(srcdir)/cfg.mk
|
|
|
|
epoch_date = 1970-01-01 00:00:00.000000000 +0000
|
|
# Ensure that the c99-to-c89 patch applies cleanly.
|
|
patch-check:
|
|
rm -rf src-c89 $@.1 $@.2
|
|
cp -a $(srcdir)/src src-c89
|
|
if test "x$(srcdir)" != x.; then \
|
|
cp -a src/* src-c89; \
|
|
dotfiles=`ls src/.[!.]* 2>/dev/null`; \
|
|
test -z "$$dotfiles" || cp -a src/.[!.]* src-c89; \
|
|
fi
|
|
(cd src-c89; patch -p1 -V never --fuzz=0) < $(srcdir)/src/c99-to-c89.diff \
|
|
> $@.1 2>&1
|
|
if test "$(REGEN_PATCH)" = yes; then \
|
|
diff -upr $(srcdir)/src src-c89 | sed 's,$(srcdir)/src-c89/,src/,' \
|
|
| grep -vE '^(Only in|File )' \
|
|
| perl -pe 's/^((?:\+\+\+|---) \S+\t).*/$${1}$(epoch_date)/;' \
|
|
-e 's/^ $$//' \
|
|
> new-diff || : ; fi
|
|
grep -v '^patching file ' $@.1 > $@.2 || :
|
|
msg=ok; test -s $@.2 && msg='fuzzy patch' || : ; \
|
|
rm -f src-c89/*.o || msg='rm failed'; \
|
|
$(MAKE) -C src-c89 CFLAGS='-Wdeclaration-after-statement -Werror' \
|
|
|| msg='compile failure with extra options'; \
|
|
test "$$msg" = ok && rm -rf src-c89 $@.1 $@.2 || echo "$$msg" 1>&2; \
|
|
test "$$msg" = ok
|
|
|
|
check-AUTHORS:
|
|
$(MAKE) -C src $@
|
|
|
|
# Ensure that we use only the standard $(VAR) notation,
|
|
# not @...@ in Makefile.am, now that we can rely on automake
|
|
# to emit a definition for each substituted variable.
|
|
makefile-check:
|
|
grep -nE '@[A-Z_0-9]+@' `find . -name Makefile.am` \
|
|
&& { echo 'Makefile.maint: use $$(...), not @...@' 1>&2; exit 1; } || :
|
|
|
|
news-date-check: NEWS
|
|
today=`date +%Y-%m-%d`; \
|
|
if head NEWS | grep '^\*.* $(VERSION_REGEXP) ('$$today')' \
|
|
>/dev/null; then \
|
|
:; \
|
|
else \
|
|
echo "version or today's date is not in NEWS" 1>&2; \
|
|
exit 1; \
|
|
fi
|
|
|
|
changelog-check:
|
|
if head ChangeLog | grep 'Version $(VERSION_REGEXP)\.$$' \
|
|
>/dev/null; then \
|
|
:; \
|
|
else \
|
|
echo "$(VERSION) not in ChangeLog" 1>&2; \
|
|
exit 1; \
|
|
fi
|
|
|
|
sc_m4_quote_check:
|
|
@grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \
|
|
$$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$') \
|
|
&& { echo '$(ME): quote the first arg to AC_DEF*' 1>&2; \
|
|
exit 1; } || :
|
|
|
|
fix_po_file_diag = \
|
|
'you have changed the set of files with translatable diagnostics;\n\
|
|
apply the above patch\n'
|
|
|
|
# Verify that all source files using _() are listed in po/POTFILES.in.
|
|
po_file = po/POTFILES.in
|
|
sc_po_check:
|
|
@if test -f $(po_file); then \
|
|
grep -E -v '^(#|$$)' $(po_file) \
|
|
| grep -v '^src/false\.c$$' | sort > $@-1; \
|
|
files=; \
|
|
for file in $$($(VC_LIST_EXCEPT)); do \
|
|
case $$file in \
|
|
*.m4) continue;; \
|
|
*.?|*.??) ;; \
|
|
*) continue;; \
|
|
esac; \
|
|
case $$file in \
|
|
*.[ch]) \
|
|
base=`expr " $$file" : ' \(.*\)\..'`; \
|
|
{ test -f $$base.l || test -f $$base.y; } && continue;; \
|
|
esac; \
|
|
files="$$files $$file"; \
|
|
done; \
|
|
grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \
|
|
| sort -u > $@-2; \
|
|
diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \
|
|
|| { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \
|
|
rm -f $@-1 $@-2; \
|
|
fi
|
|
|
|
# Sometimes it is useful to change the PATH environment variable
|
|
# in Makefiles. When doing so, it's better not to use the Unix-centric
|
|
# path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
|
|
# It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
|
|
# and there probably aren't many projects with so many Makefile.am files
|
|
# that we'd have to worry about limits on command line length.
|
|
msg = '$(ME): Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
|
|
sc_makefile_path_separator_check:
|
|
@grep -n 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
|
|
&& { echo $(msg) 1>&2; exit 1; } || :
|
|
|
|
# Check that `make alpha' will not fail at the end of the process.
|
|
writable-files:
|
|
if test -d $(release_archive_dir); then :; else \
|
|
for file in $(distdir).tar.gz \
|
|
$(release_archive_dir)/$(distdir).tar.gz; do \
|
|
test -e $$file || continue; \
|
|
test -w $$file \
|
|
|| { echo ERROR: $$file is not writable; fail=1; }; \
|
|
done; \
|
|
test "$$fail" && exit 1 || : ; \
|
|
fi
|
|
|
|
v_etc_file = lib/version-etc.c
|
|
sample-test = tests/sample-test
|
|
texi = doc/$(PACKAGE).texi
|
|
# Make sure that the copyright date in $(v_etc_file) is up to date.
|
|
# Do the same for the $(sample-test) and the main doc/.texi file.
|
|
sc_copyright_check:
|
|
@if test -f $(v_etc_file); then \
|
|
grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
|
|
>/dev/null \
|
|
|| { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
|
|
exit 1; }; \
|
|
fi
|
|
@if test -f $(sample-test); then \
|
|
grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test) \
|
|
>/dev/null \
|
|
|| { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
|
|
exit 1; }; \
|
|
fi
|
|
@if test -f $(texi); then \
|
|
grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi) \
|
|
>/dev/null \
|
|
|| { echo 'out of date copyright in $(texi); update it' 1>&2; \
|
|
exit 1; }; \
|
|
fi
|
|
|
|
vc-diff-check:
|
|
$(VC) diff > vc-diffs || :
|
|
if test -s vc-diffs; then \
|
|
cat vc-diffs; \
|
|
echo "Some files are locally modified:" 1>&2; \
|
|
exit 1; \
|
|
else \
|
|
rm vc-diffs; \
|
|
fi
|
|
|
|
cvs-check: vc-diff-check
|
|
|
|
maintainer-distcheck:
|
|
$(MAKE) distcheck
|
|
$(MAKE) my-distcheck
|
|
|
|
|
|
# Don't make a distribution if checks fail.
|
|
# Also, make sure the NEWS file is up-to-date.
|
|
vc-dist: $(local-check) cvs-check maintainer-distcheck
|
|
$(MAKE) dist
|
|
|
|
# Use this to make sure we don't run these programs when building
|
|
# from a virgin tgz file, below.
|
|
null_AM_MAKEFLAGS = \
|
|
ACLOCAL=false \
|
|
AUTOCONF=false \
|
|
AUTOMAKE=false \
|
|
AUTOHEADER=false \
|
|
MAKEINFO=false
|
|
|
|
built_programs = $$(cd src && MAKEFLAGS= $(MAKE) -s built_programs.list)
|
|
|
|
warn_cflags = -Dlint -O -Werror -Wall -Wformat -Wshadow -Wpointer-arith
|
|
bin=bin-$$$$
|
|
|
|
write_loser = printf '\#!%s\necho $$0: bad path 1>&2; exit 1\n' '$(SHELL)'
|
|
|
|
TMPDIR ?= /tmp
|
|
t=$(TMPDIR)/$(PACKAGE)/test
|
|
pfx=$(t)/i
|
|
|
|
# More than once, tainted build and source directory names would
|
|
# have caused at least one "make check" test to apply "chmod 700"
|
|
# to all directories under $HOME. Make sure it doesn't happen again.
|
|
tp := $(shell echo "$(TMPDIR)/$(PACKAGE)-$$$$")
|
|
t_prefix = $(tp)/a
|
|
t_taint = '$(t_prefix) b'
|
|
fake_home = $(tp)/home
|
|
|
|
# Ensure that tests run from tainted build and src dir names work,
|
|
# and don't affect anything in $HOME. Create witness files in $HOME,
|
|
# record their attributes, and build/test. Then ensure that the
|
|
# witnesses were not affected.
|
|
taint-distcheck: $(DIST_ARCHIVES)
|
|
test -d $(t_taint) && chmod -R 700 $(t_taint) || :
|
|
-rm -rf $(t_taint) $(fake_home)
|
|
mkdir -p $(t_prefix) $(t_taint) $(fake_home)
|
|
GZIP=$(GZIP_ENV) $(AMTAR) -C $(t_taint) -zxf $(distdir).tar.gz
|
|
mkfifo $(fake_home)/fifo
|
|
touch $(fake_home)/f
|
|
mkdir -p $(fake_home)/d/e
|
|
ls -lR $(fake_home) $(t_prefix) > $(tp)/.ls-before
|
|
cd $(t_taint)/$(distdir) \
|
|
&& ./configure \
|
|
&& $(MAKE) \
|
|
&& HOME=$(fake_home) $(MAKE) check \
|
|
&& ls -lR $(fake_home) $(t_prefix) > $(tp)/.ls-after \
|
|
&& diff $(tp)/.ls-before $(tp)/.ls-after \
|
|
&& test -d $(t_prefix)
|
|
rm -rf $(tp)
|
|
|
|
# Verify that a twisted use of --program-transform-name=PROGRAM works.
|
|
define install-transform-check
|
|
echo running install-transform-check \
|
|
&& rm -rf $(pfx) \
|
|
&& $(MAKE) program_transform_name='s/.*/zyx/' \
|
|
prefix=$(pfx) install \
|
|
&& test "$$(echo $(pfx)/bin/*)" = "$(pfx)/bin/zyx" \
|
|
&& test "$$(find $(pfx)/share/man -type f|sed 's,.*/,,;s,\..*,,')" = "zyx"
|
|
endef
|
|
|
|
# Install, then verify that all binaries and man pages are in place.
|
|
# Note that neither the binary, ginstall, nor the ].1 man page is installed.
|
|
define my-instcheck
|
|
$(MAKE) prefix=$(pfx) install \
|
|
&& test ! -f $(pfx)/bin/ginstall \
|
|
&& { fail=0; \
|
|
for i in $(built_programs); do \
|
|
test "$$i" = ginstall && i=install; \
|
|
for j in "$(pfx)/bin/$$i" \
|
|
"$(pfx)/share/man/man1/$$i.1"; do \
|
|
case $$j in *'[.1') continue;; esac; \
|
|
test -f "$$j" && : \
|
|
|| { echo "$$j not installed"; fail=1; }; \
|
|
done; \
|
|
done; \
|
|
test $$fail = 1 && exit 1 || :; \
|
|
}
|
|
endef
|
|
|
|
define coreutils-path-check
|
|
{ \
|
|
if test -f $(srcdir)/src/true.c; then \
|
|
fail=1; \
|
|
mkdir $(bin) \
|
|
&& ($(write_loser)) > $(bin)/loser \
|
|
&& chmod a+x $(bin)/loser \
|
|
&& for i in $(built_programs); do \
|
|
case $$i in \
|
|
rm|expr|basename|echo|sort|ls|tr);; \
|
|
cat|dirname|mv|wc);; \
|
|
*) ln $(bin)/loser $(bin)/$$i;; \
|
|
esac; \
|
|
done \
|
|
&& ln -sf ../src/true $(bin)/false \
|
|
&& PATH=`pwd`/$(bin):$$PATH $(MAKE) -C tests check \
|
|
&& { test -d gnulib-tests \
|
|
&& $(MAKE) -C gnulib-tests check \
|
|
|| :; } \
|
|
&& rm -rf $(bin) \
|
|
&& fail=0; \
|
|
else \
|
|
fail=0; \
|
|
fi; \
|
|
test $$fail = 1 && exit 1 || :; \
|
|
}
|
|
endef
|
|
|
|
# Use -Wformat -Werror to detect format-string/arg-list mismatches.
|
|
# Also, check for shadowing problems with -Wshadow, and for pointer
|
|
# arithmetic problems with -Wpointer-arith.
|
|
# These CFLAGS are pretty strict. If you build this target, you probably
|
|
# have to have a recent version of gcc and glibc headers.
|
|
# The hard-linking for-loop below ensures that there is a bin/ directory
|
|
# full of all of the programs under test (except the ones that are required
|
|
# for basic Makefile rules), all symlinked to the just-built "false" program.
|
|
# This is to ensure that if ever a test neglects to make PATH include
|
|
# the build srcdir, these always-failing programs will run.
|
|
# Otherwise, it is too easy to test the wrong programs.
|
|
# Note that "false" itself is a symlink to true, so it too will malfunction.
|
|
my-distcheck: $(DIST_ARCHIVES) $(local-check)
|
|
$(MAKE) syntax-check
|
|
$(MAKE) check
|
|
-rm -rf $(t)
|
|
mkdir -p $(t)
|
|
GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
|
|
cd $(t)/$(distdir) \
|
|
&& ./configure --disable-nls \
|
|
&& $(MAKE) CFLAGS='$(warn_cflags)' \
|
|
AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
|
|
&& $(MAKE) dvi \
|
|
&& $(install-transform-check) \
|
|
&& $(my-instcheck) \
|
|
&& $(coreutils-path-check) \
|
|
&& $(MAKE) distclean
|
|
(cd $(t) && mv $(distdir) $(distdir).old \
|
|
&& $(AMTAR) -zxf - ) < $(distdir).tar.gz
|
|
diff -ur $(t)/$(distdir).old $(t)/$(distdir)
|
|
-rm -rf $(t)
|
|
@echo "========================"; \
|
|
echo "$(distdir).tar.gz is ready for distribution"; \
|
|
echo "========================"
|
|
|
|
cvs-to-git = '\#!/usr/bin/perl\n\
|
|
use warnings;\n\
|
|
use strict;\n\
|
|
use File::Find;\n\
|
|
use File::Copy;\n\
|
|
\n\
|
|
find ({wanted =>\n\
|
|
sub {$$_ eq q/.cvsignore/ or return;\n\
|
|
my $$gi = q/.gitignore/;\n\
|
|
unlink $$gi;\n\
|
|
copy($$_, $$gi) or die qq/copy failed: $$_->$$gi: $$!\\n/;\n\
|
|
chmod 0444, $$gi;\n\
|
|
}},\n\
|
|
q!.!);\n'
|
|
|
|
.PHONY: sync-vcs-ignore-files
|
|
c2g = cvs-to-git
|
|
sync-vcs-ignore-files:
|
|
rm -f $(c2g)-t $(c2g)
|
|
printf $(cvs-to-git) > $(c2g)-t
|
|
chmod a+x-w $(c2g)-t
|
|
mv $(c2g)-t $(c2g)
|
|
perl $(c2g)
|
|
rm -f $(c2g)
|
|
echo "syntax: glob" > .hgignore
|
|
( for ignore in $$($(VC_LIST) \
|
|
| grep -E '(^|/)\.gitignore$$'); do \
|
|
dir=$$(dirname "$$ignore"); \
|
|
test "$$dir" = . && pfx= || pfx=$$dir/; \
|
|
sed "s!^!$$pfx!" "$$ignore"; \
|
|
done ) | sort -u >> .hgignore
|