mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-07-11 12:25:52 +00:00
360194bfb5
* cfg.mk (local-checks-to-skip): Add these: sc_error_message_uppercase, sc_program_name, sc_require_test_exit_idiom, sc_makefile_check.
230 lines
8.0 KiB
Makefile
230 lines
8.0 KiB
Makefile
# Customize Makefile.maint. -*- makefile -*-
|
|
# Copyright (C) 2003-2009 Free Software Foundation, Inc.
|
|
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
# Use alpha.gnu.org for alpha and beta releases.
|
|
# Use ftp.gnu.org for major releases.
|
|
gnu_ftp_host-alpha = alpha.gnu.org
|
|
gnu_ftp_host-beta = alpha.gnu.org
|
|
gnu_ftp_host-major = ftp.gnu.org
|
|
gnu_rel_host = $(gnu_ftp_host-$(RELEASE_TYPE))
|
|
|
|
url_dir_list = \
|
|
ftp://$(gnu_rel_host)/gnu/coreutils
|
|
|
|
# Tests not to run as part of "make distcheck".
|
|
local-checks-to-skip = \
|
|
changelog-check \
|
|
check-AUTHORS \
|
|
makefile-check \
|
|
makefile_path_separator_check \
|
|
patch-check \
|
|
sc_GPL_version \
|
|
sc_always_defined_macros \
|
|
sc_cast_of_alloca_return_value \
|
|
sc_dd_max_sym_length \
|
|
sc_error_exit_success \
|
|
sc_file_system \
|
|
sc_immutable_NEWS \
|
|
sc_makefile_path_separator_check \
|
|
sc_obsolete_symbols \
|
|
sc_prohibit_S_IS_definition \
|
|
sc_prohibit_atoi_atof \
|
|
sc_prohibit_jm_in_m4 \
|
|
sc_prohibit_quote_without_use \
|
|
sc_prohibit_quotearg_without_use \
|
|
sc_prohibit_stat_st_blocks \
|
|
sc_root_tests \
|
|
sc_space_tab \
|
|
sc_sun_os_names \
|
|
sc_system_h_headers \
|
|
sc_tight_scope \
|
|
sc_two_space_separator_in_usage \
|
|
sc_error_message_uppercase \
|
|
sc_program_name \
|
|
sc_require_test_exit_idiom \
|
|
sc_makefile_check \
|
|
sc_useless_cpp_parens
|
|
|
|
useless_free_options = \
|
|
--name=sexpr_free \
|
|
--name=VIR_FREE \
|
|
--name=xmlFree \
|
|
--name=xmlXPathFreeContext \
|
|
--name=xmlXPathFreeObject
|
|
|
|
# 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
|
|
|
|
# Use STREQ rather than comparing strcmp == 0, or != 0.
|
|
# Similarly, use STREQLEN or STRPREFIX rather than strncmp.
|
|
sc_prohibit_strcmp_and_strncmp:
|
|
@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)
|
|
|
|
include Makefile.nonreentrant
|
|
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
|
|
|
|
# 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; } || :
|
|
|
|
# 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; } || :
|
|
|
|
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)
|
|
|
|
# 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 += oneError
|
|
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_libvirt_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; } || :
|