2008-01-29 20:42:39 +03:00
# Customize Makefile.maint. -*- makefile -*-
2010-01-15 13:09:01 +03:00
# Copyright (C) 2003-2010 Free Software Foundation, Inc.
2008-01-29 20:42:39 +03:00
# 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 = \
2009-01-29 15:11:49 +03:00
changelog-check \
check-AUTHORS \
2008-01-29 20:42:39 +03:00
makefile-check \
2009-01-29 15:11:49 +03:00
makefile_path_separator_check \
patch-check \
2008-01-29 20:42:39 +03:00
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 \
2009-01-29 15:11:49 +03:00
sc_immutable_NEWS \
sc_makefile_path_separator_check \
2008-01-29 20:42:39 +03:00
sc_obsolete_symbols \
2009-01-29 15:11:49 +03:00
sc_prohibit_S_IS_definition \
2008-01-29 20:42:39 +03:00
sc_prohibit_atoi_atof \
2010-02-23 19:54:32 +03:00
sc_prohibit_hash_without_use \
2008-01-29 20:42:39 +03:00
sc_prohibit_jm_in_m4 \
sc_prohibit_quote_without_use \
sc_prohibit_quotearg_without_use \
2009-01-29 15:11:49 +03:00
sc_prohibit_stat_st_blocks \
2008-01-29 20:42:39 +03:00
sc_root_tests \
sc_space_tab \
sc_sun_os_names \
sc_system_h_headers \
2009-01-29 15:11:49 +03:00
sc_tight_scope \
2008-01-29 20:42:39 +03:00
sc_two_space_separator_in_usage \
2009-07-06 21:17:06 +04:00
sc_error_message_uppercase \
sc_program_name \
sc_require_test_exit_idiom \
sc_makefile_check \
2009-01-29 15:11:49 +03:00
sc_useless_cpp_parens
2008-02-07 19:49:29 +03:00
useless_free_options = \
--name= sexpr_free \
2009-02-03 16:08:07 +03:00
--name= VIR_FREE \
2008-04-29 19:06:14 +04:00
--name= xmlFree \
2008-02-07 19:49:29 +03:00
--name= xmlXPathFreeContext \
--name= xmlXPathFreeObject
Prepare to use maint.mk from gnulib
Since Makefile.maint will soon come from gnulib's maint.mk,
sync Makefile.maint to have the same contents (modulo minor
things). In syncing it, we have to remove some libvirt-specific
rules. Since we want to keep them (of course), put those in cfg.mk.
* Makefile.maint: Merge from gnulib's maint.mk.
* cfg.mk (sc_avoid_write): New rule. From Makefile.cfg.
(sc_prohibit_strcmp_and_strncmp): Likewise, and rename.
(sc_prohibit_asprintf, sc_prohibit_VIR_ERR_NO_MEMORY): Likewise.
(sc_prohibit_nonreentrant): Likewise.
(sc_prohibit_ctype_h): Likewise.
(sc_TAB_in_indentation, sc_avoid_ctype_macros): Likewise.
(sc_prohibit_virBufferAdd_with_string_literal): Likewise.
(sc_prohibit_gethostby): Likewise.
(sc_libvirt_unmarked_diagnostics): Likewise. Also, rename the
rule, inserting "_libvirt", since this rule is a specialization of
the one in gnulib.
* GNUmakefile: Include cfg.mk, not Makefile.cfg
* .x-sc_prohibit_strcmp_and_strncmp: New file.
* Makefile.am (EXTRA_DIST): Add .x-sc_prohibit_strcmp_and_strncmp
2009-07-06 20:28:10 +04:00
# 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 :
2009-10-23 14:10:38 +04:00
@re= 'strn?cmp *\(' \
msg = 'use STREQ() in place of the above uses of str[n]cmp' \
$( _prohibit_regexp)
Prepare to use maint.mk from gnulib
Since Makefile.maint will soon come from gnulib's maint.mk,
sync Makefile.maint to have the same contents (modulo minor
things). In syncing it, we have to remove some libvirt-specific
rules. Since we want to keep them (of course), put those in cfg.mk.
* Makefile.maint: Merge from gnulib's maint.mk.
* cfg.mk (sc_avoid_write): New rule. From Makefile.cfg.
(sc_prohibit_strcmp_and_strncmp): Likewise, and rename.
(sc_prohibit_asprintf, sc_prohibit_VIR_ERR_NO_MEMORY): Likewise.
(sc_prohibit_nonreentrant): Likewise.
(sc_prohibit_ctype_h): Likewise.
(sc_TAB_in_indentation, sc_avoid_ctype_macros): Likewise.
(sc_prohibit_virBufferAdd_with_string_literal): Likewise.
(sc_prohibit_gethostby): Likewise.
(sc_libvirt_unmarked_diagnostics): Likewise. Also, rename the
rule, inserting "_libvirt", since this rule is a specialization of
the one in gnulib.
* GNUmakefile: Include cfg.mk, not Makefile.cfg
* .x-sc_prohibit_strcmp_and_strncmp: New file.
* Makefile.am (EXTRA_DIST): Add .x-sc_prohibit_strcmp_and_strncmp
2009-07-06 20:28:10 +04:00
# 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)
2009-08-03 16:37:44 +04:00
sc_prohibit_strncpy :
2009-09-23 16:58:13 +04:00
@re= 'strncpy *\(' \
msg = 'use virStrncpy, not strncpy' \
$( _prohibit_regexp)
2009-08-03 16:37:44 +04:00
2009-12-21 22:14:46 +03:00
sc_prohibit_readlink :
@re= 'readlink *\(' \
msg = 'use virFileResolveLink, not readlink' \
$( _prohibit_regexp)
2009-10-23 14:13:20 +04:00
sc_prohibit_gethostname :
@re= 'gethostname *\(' \
msg = 'use virGetHostname, not gethostname' \
$( _prohibit_regexp)
2010-03-18 16:05:44 +03:00
sc_prohibit_gettext_noop :
@re= 'gettext_noop *\(' \
2010-03-18 17:39:59 +03:00
msg = 'use N_, not gettext_noop' \
2010-03-18 16:05:44 +03:00
$( _prohibit_regexp)
Prepare to use maint.mk from gnulib
Since Makefile.maint will soon come from gnulib's maint.mk,
sync Makefile.maint to have the same contents (modulo minor
things). In syncing it, we have to remove some libvirt-specific
rules. Since we want to keep them (of course), put those in cfg.mk.
* Makefile.maint: Merge from gnulib's maint.mk.
* cfg.mk (sc_avoid_write): New rule. From Makefile.cfg.
(sc_prohibit_strcmp_and_strncmp): Likewise, and rename.
(sc_prohibit_asprintf, sc_prohibit_VIR_ERR_NO_MEMORY): Likewise.
(sc_prohibit_nonreentrant): Likewise.
(sc_prohibit_ctype_h): Likewise.
(sc_TAB_in_indentation, sc_avoid_ctype_macros): Likewise.
(sc_prohibit_virBufferAdd_with_string_literal): Likewise.
(sc_prohibit_gethostby): Likewise.
(sc_libvirt_unmarked_diagnostics): Likewise. Also, rename the
rule, inserting "_libvirt", since this rule is a specialization of
the one in gnulib.
* GNUmakefile: Include cfg.mk, not Makefile.cfg
* .x-sc_prohibit_strcmp_and_strncmp: New file.
* Makefile.am (EXTRA_DIST): Add .x-sc_prohibit_strcmp_and_strncmp
2009-07-06 20:28:10 +04:00
sc_prohibit_VIR_ERR_NO_MEMORY :
@re= '\<V' 'IR_ERR_NO_MEMORY\>' \
msg = 'use virReportOOMError, not V' IR_ERR_NO_MEMORY \
$( _prohibit_regexp)
2009-10-01 18:55:09 +04:00
i n c l u d e $( srcdir ) / M a k e f i l e . n o n r e e n t r a n t
Prepare to use maint.mk from gnulib
Since Makefile.maint will soon come from gnulib's maint.mk,
sync Makefile.maint to have the same contents (modulo minor
things). In syncing it, we have to remove some libvirt-specific
rules. Since we want to keep them (of course), put those in cfg.mk.
* Makefile.maint: Merge from gnulib's maint.mk.
* cfg.mk (sc_avoid_write): New rule. From Makefile.cfg.
(sc_prohibit_strcmp_and_strncmp): Likewise, and rename.
(sc_prohibit_asprintf, sc_prohibit_VIR_ERR_NO_MEMORY): Likewise.
(sc_prohibit_nonreentrant): Likewise.
(sc_prohibit_ctype_h): Likewise.
(sc_TAB_in_indentation, sc_avoid_ctype_macros): Likewise.
(sc_prohibit_virBufferAdd_with_string_literal): Likewise.
(sc_prohibit_gethostby): Likewise.
(sc_libvirt_unmarked_diagnostics): Likewise. Also, rename the
rule, inserting "_libvirt", since this rule is a specialization of
the one in gnulib.
* GNUmakefile: Include cfg.mk, not Makefile.cfg
* .x-sc_prohibit_strcmp_and_strncmp: New file.
* Makefile.am (EXTRA_DIST): Add .x-sc_prohibit_strcmp_and_strncmp
2009-07-06 20:28:10 +04:00
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) \
2010-03-01 22:05:06 +03:00
| grep -E '\.(rng|[ch](\.in)?)$$' \
Prepare to use maint.mk from gnulib
Since Makefile.maint will soon come from gnulib's maint.mk,
sync Makefile.maint to have the same contents (modulo minor
things). In syncing it, we have to remove some libvirt-specific
rules. Since we want to keep them (of course), put those in cfg.mk.
* Makefile.maint: Merge from gnulib's maint.mk.
* cfg.mk (sc_avoid_write): New rule. From Makefile.cfg.
(sc_prohibit_strcmp_and_strncmp): Likewise, and rename.
(sc_prohibit_asprintf, sc_prohibit_VIR_ERR_NO_MEMORY): Likewise.
(sc_prohibit_nonreentrant): Likewise.
(sc_prohibit_ctype_h): Likewise.
(sc_TAB_in_indentation, sc_avoid_ctype_macros): Likewise.
(sc_prohibit_virBufferAdd_with_string_literal): Likewise.
(sc_prohibit_gethostby): Likewise.
(sc_libvirt_unmarked_diagnostics): Likewise. Also, rename the
rule, inserting "_libvirt", since this rule is a specialization of
the one in gnulib.
* GNUmakefile: Include cfg.mk, not Makefile.cfg
* .x-sc_prohibit_strcmp_and_strncmp: New file.
* Makefile.am (EXTRA_DIST): Add .x-sc_prohibit_strcmp_and_strncmp
2009-07-06 20:28:10 +04:00
| 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\
| i s p r i n t | i s p u n c t | i s s p a c e | i s u p p e r | i s x d i g i t | t o l o w e r | t o u p p e r
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; } || :
2009-07-07 20:08:45 +04:00
2009-07-16 11:06:58 +04:00
# Disallow trailing blank lines.
sc_prohibit_trailing_blank_lines :
@$( VC_LIST_EXCEPT) | xargs perl -ln -0777 -e \
'/\n\n+$$/ and print $$ARGV' > $@ -t
@found= 0; test -s $@ -t && { found = 1; cat $@ -t 1>& 2; \
echo '$(ME): found trailing blank line(s)' 1>& 2; } ; \
rm -f $@ -t; \
test $$ found = 0
2010-03-10 00:22:14 +03:00
# Regex for grep -E that exempts generated files from style rules.
preprocessor_exempt = ( remote_( driver| protocol) \. h) $$
# Enforce recommended preprocessor indentation style.
sc_preprocessor_indentation :
@if ( cppi --version >/dev/null 2>& 1) ; then \
$( VC_LIST_EXCEPT) | grep '\.[ch]$$' \
| grep -vE '$(preprocessor_exempt)' | xargs cppi -a -c \
|| { echo '$(ME): incorrect preprocessor indentation' 1>& 2; \
exit 1; } ; \
else \
echo '$(ME): skipping test $@: cppi not installed' 1>& 2; \
fi
2010-03-18 20:25:01 +03:00
sc_copyright_format :
@$( VC_LIST_EXCEPT) | xargs grep -ni 'copyright .*Red ' Hat \
| grep -v Inc \
&& { echo '$(ME): Red Hat copyright is missing Inc' 1>& 2; \
exit 1; } || :
@$( VC_LIST_EXCEPT) | xargs grep -ni 'copyright [^(].*Red ' Hat \
&& { echo '$(ME): consistently use (C) in Red Hat copyright' 1>& 2; \
exit 1; } || :
2009-07-07 20:08:45 +04:00
# We don't use this feature of maint.mk.
prev_version_file = /dev/null
2009-07-10 12:01:04 +04:00
i f e q ( 0 , $( MAKELEVEL ) )
_curr_status = .git-module-status
2009-07-15 11:54:26 +04:00
# The sed filter accommodates those who check out on a commit from which
# no tag is reachable. In that case, git submodule status prints a "-"
# in column 1 and does not print a "git describe"-style string after the
# submodule name. Contrast these:
# -b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib
# b653eda3ac4864de205419d9f41eec267cb89eeb .gnulib (v0.0-2286-gb653eda)
2010-02-24 14:01:09 +03:00
# $ cat .git-module-status
# b653eda3ac4864de205419d9f41eec267cb89eeb
_submodule_hash = sed 's/^[ +-]//;s/ .*//'
2009-07-15 11:54:26 +04:00
_update_required := $( shell \
2010-03-10 20:03:29 +03:00
actual = $$ ( git submodule status | $( _submodule_hash) ; \
git hash-object bootstrap.conf) ; \
2009-07-15 11:54:26 +04:00
stamp = " $$ ( $( _submodule_hash) $( _curr_status) 2>/dev/null) " ; \
test " $$ stamp " = " $$ actual " ; echo $$ ?)
2009-07-10 12:01:04 +04:00
ifeq ( 1,$( _update_required) )
$( error gnulib update required; run ./autogen.sh first)
endif
e n d i f
2010-01-15 13:09:01 +03:00
# Exempt @...@ uses of these symbols.
_makefile_at_at_check_exceptions = ' && !/(SCHEMA|SYSCONF)DIR/'