cfg.mk 29.1 KB
Newer Older
1
# Customize Makefile.maint.                           -*- makefile -*-
E
Eric Blake 已提交
2
# Copyright (C) 2008-2012 Red Hat, Inc.
3
# Copyright (C) 2003-2008 Free Software Foundation, Inc.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

# 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

28 29 30
# We use .gnulib, not gnulib.
gnulib_dir = $(srcdir)/.gnulib

E
Eric Blake 已提交
31 32 33
# List of additional files that we want to pick up in our POTFILES.in
# This is all gnulib files, as well as generated files for RPC code.
generated_files = \
E
Eric Blake 已提交
34
  $(srcdir)/daemon/*_dispatch.h \
E
Eric Blake 已提交
35 36 37 38
  $(srcdir)/src/remote/*_client_bodies.h \
  $(srcdir)/src/remote/*_protocol.[ch] \
  $(srcdir)/gnulib/lib/*.[ch]

E
Eric Blake 已提交
39 40 41
# We haven't converted all scripts to using gnulib's init.sh yet.
_test_script_regex = \<\(init\|test-lib\)\.sh\>

42 43
# Tests not to run as part of "make distcheck".
local-checks-to-skip =			\
44 45
  changelog-check			\
  check-AUTHORS				\
46
  makefile-check			\
47 48
  makefile_path_separator_check		\
  patch-check				\
49 50 51
  sc_GPL_version			\
  sc_always_defined_macros		\
  sc_cast_of_alloca_return_value	\
52
  sc_cross_check_PATH_usage_in_tests	\
53 54 55
  sc_dd_max_sym_length			\
  sc_error_exit_success			\
  sc_file_system			\
56 57
  sc_immutable_NEWS			\
  sc_makefile_path_separator_check	\
58
  sc_obsolete_symbols			\
59
  sc_prohibit_S_IS_definition		\
60
  sc_prohibit_atoi_atof			\
61
  sc_prohibit_hash_without_use		\
62 63 64
  sc_prohibit_jm_in_m4			\
  sc_prohibit_quote_without_use		\
  sc_prohibit_quotearg_without_use	\
65
  sc_prohibit_stat_st_blocks		\
66 67 68 69
  sc_root_tests				\
  sc_space_tab				\
  sc_sun_os_names			\
  sc_system_h_headers			\
E
Eric Blake 已提交
70
  sc_texinfo_acronym			\
71
  sc_tight_scope			\
72
  sc_two_space_separator_in_usage	\
J
Jim Meyering 已提交
73 74 75 76
  sc_error_message_uppercase		\
  sc_program_name			\
  sc_require_test_exit_idiom		\
  sc_makefile_check			\
77
  sc_useless_cpp_parens
78

79
# Files that should never cause syntax check failures.
80 81
VC_LIST_ALWAYS_EXCLUDE_REGEX = \
  (^(HACKING|docs/(news\.html\.in|.*\.patch))|\.po)$$
82 83

# Functions like free() that are no-ops on NULL arguments.
84 85
useless_free_options =				\
  --name=VIR_FREE				\
86
  --name=qemuCapsFree				\
87
  --name=qemuMigrationCookieFree                \
88
  --name=qemuMigrationCookieGraphicsFree        \
89
  --name=sexpr_free				\
90
  --name=virBandwidthDefFree			\
91
  --name=virBitmapFree                          \
92 93 94 95 96 97 98 99 100
  --name=virCPUDefFree				\
  --name=virCapabilitiesFree			\
  --name=virCapabilitiesFreeGuest		\
  --name=virCapabilitiesFreeGuestDomain		\
  --name=virCapabilitiesFreeGuestFeature	\
  --name=virCapabilitiesFreeGuestMachine	\
  --name=virCapabilitiesFreeHostNUMACell	\
  --name=virCapabilitiesFreeMachines		\
  --name=virCgroupFree				\
101
  --name=virCommandFree				\
102 103
  --name=virConfFreeList			\
  --name=virConfFreeValue			\
104
  --name=virDomainActualNetDefFree		\
105
  --name=virDomainChrDefFree			\
106
  --name=virDomainChrSourceDefFree		\
107 108 109 110 111 112 113
  --name=virDomainControllerDefFree		\
  --name=virDomainDefFree			\
  --name=virDomainDeviceDefFree			\
  --name=virDomainDiskDefFree			\
  --name=virDomainEventCallbackListFree		\
  --name=virDomainEventFree			\
  --name=virDomainEventQueueFree		\
114
  --name=virDomainEventStateFree		\
115 116 117 118 119 120
  --name=virDomainFSDefFree			\
  --name=virDomainGraphicsDefFree		\
  --name=virDomainHostdevDefFree		\
  --name=virDomainInputDefFree			\
  --name=virDomainNetDefFree			\
  --name=virDomainObjFree			\
E
Eric Blake 已提交
121
  --name=virDomainSmartcardDefFree		\
122 123 124 125 126
  --name=virDomainSnapshotDefFree		\
  --name=virDomainSnapshotObjFree		\
  --name=virDomainSoundDefFree			\
  --name=virDomainVideoDefFree			\
  --name=virDomainWatchdogDefFree		\
127
  --name=virFileDirectFdFree			\
128
  --name=virHashFree				\
129 130 131 132 133 134
  --name=virInterfaceDefFree			\
  --name=virInterfaceIpDefFree			\
  --name=virInterfaceObjFree			\
  --name=virInterfaceProtocolDefFree		\
  --name=virJSONValueFree			\
  --name=virLastErrFreeData			\
135
  --name=virNetMessageFree                      \
136 137 138
  --name=virNetClientFree                       \
  --name=virNetClientProgramFree                \
  --name=virNetClientStreamFree                 \
139 140
  --name=virNetServerFree                       \
  --name=virNetServerClientFree                 \
141 142 143
  --name=virNetServerMDNSFree                   \
  --name=virNetServerMDNSEntryFree              \
  --name=virNetServerMDNSGroupFree              \
144 145
  --name=virNetServerProgramFree                \
  --name=virNetServerServiceFree                \
146
  --name=virNetSocketFree                       \
147 148
  --name=virNetSASLContextFree                  \
  --name=virNetSASLSessionFree                  \
149
  --name=virNetTLSSessionFree                   \
150 151 152 153 154
  --name=virNWFilterDefFree			\
  --name=virNWFilterEntryFree			\
  --name=virNWFilterHashTableFree		\
  --name=virNWFilterIPAddrLearnReqFree		\
  --name=virNWFilterIncludeDefFree		\
155
  --name=virNWFilterObjFree			\
156 157 158 159 160 161 162 163 164
  --name=virNWFilterRuleDefFree			\
  --name=virNWFilterRuleInstFree		\
  --name=virNetworkDefFree			\
  --name=virNetworkObjFree			\
  --name=virNodeDeviceDefFree			\
  --name=virNodeDeviceObjFree			\
  --name=virSecretDefFree			\
  --name=virStorageEncryptionFree		\
  --name=virStorageEncryptionSecretFree		\
165
  --name=virStorageFileFreeMetadata		\
166 167 168 169
  --name=virStoragePoolDefFree			\
  --name=virStoragePoolObjFree			\
  --name=virStoragePoolSourceFree		\
  --name=virStorageVolDefFree			\
H
Hu Tao 已提交
170
  --name=virThreadPoolFree			\
171
  --name=xmlBufferFree				\
172
  --name=xmlFree				\
173
  --name=xmlFreeDoc				\
E
Eric Blake 已提交
174
  --name=xmlFreeNode				\
175
  --name=xmlXPathFreeContext			\
176
  --name=xmlXPathFreeObject
177

178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
# The following template was generated by this command:
# make ID && aid free|grep '^vi'|sed 's/ .*//;s/^/#   /'
# N virBufferFreeAndReset
# y virCPUDefFree
# y virCapabilitiesFree
# y virCapabilitiesFreeGuest
# y virCapabilitiesFreeGuestDomain
# y virCapabilitiesFreeGuestFeature
# y virCapabilitiesFreeGuestMachine
# y virCapabilitiesFreeHostNUMACell
# y virCapabilitiesFreeMachines
# N virCapabilitiesFreeNUMAInfo FIXME
# y virCgroupFree
# N virConfFree               (diagnoses the "error")
# y virConfFreeList
# y virConfFreeValue
# y virDomainChrDefFree
# y virDomainControllerDefFree
# y virDomainDefFree
# y virDomainDeviceDefFree
# y virDomainDiskDefFree
# y virDomainEventCallbackListFree
# y virDomainEventFree
# y virDomainEventQueueFree
# y virDomainFSDefFree
# n virDomainFree
# n virDomainFreeName (can't fix -- returns int)
# y virDomainGraphicsDefFree
# y virDomainHostdevDefFree
# y virDomainInputDefFree
# y virDomainNetDefFree
# y virDomainObjFree
# y virDomainSnapshotDefFree
# n virDomainSnapshotFree (returns int)
# n virDomainSnapshotFreeName (returns int)
# y virDomainSnapshotObjFree
# y virDomainSoundDefFree
# y virDomainVideoDefFree
# y virDomainWatchdogDefFree
# n virDrvNodeGetCellsFreeMemory (returns int)
# n virDrvNodeGetFreeMemory (returns long long)
E
Eric Blake 已提交
219
# n virFree - dereferences param
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
# n virFreeError
# n virHashFree (takes 2 args)
# y virInterfaceDefFree
# n virInterfaceFree (returns int)
# n virInterfaceFreeName
# y virInterfaceIpDefFree
# y virInterfaceObjFree
# n virInterfaceObjListFree
# y virInterfaceProtocolDefFree
# y virJSONValueFree
# y virLastErrFreeData
# y virNWFilterDefFree
# y virNWFilterEntryFree
# n virNWFilterFree (returns int)
# y virNWFilterHashTableFree
# y virNWFilterIPAddrLearnReqFree
# y virNWFilterIncludeDefFree
237 238 239
# n virNWFilterFreeName (returns int)
# y virNWFilterObjFree
# n virNWFilterObjListFree FIXME
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
# y virNWFilterRuleDefFree
# n virNWFilterRuleFreeInstanceData (typedef)
# y virNWFilterRuleInstFree
# y virNetworkDefFree
# n virNetworkFree (returns int)
# n virNetworkFreeName (returns int)
# y virNetworkObjFree
# n virNetworkObjListFree FIXME
# n virNodeDevCapsDefFree FIXME
# y virNodeDeviceDefFree
# n virNodeDeviceFree (returns int)
# y virNodeDeviceObjFree
# n virNodeDeviceObjListFree FIXME
# n virNodeGetCellsFreeMemory (returns int)
# n virNodeGetFreeMemory (returns non-void)
# y virSecretDefFree
# n virSecretFree (returns non-void)
# n virSecretFreeName (2 args)
# n virSecurityLabelDefFree FIXME
# n virStorageBackendDiskMakeFreeExtent (returns non-void)
# y virStorageEncryptionFree
# y virStorageEncryptionSecretFree
# n virStorageFreeType (enum)
# y virStoragePoolDefFree
# n virStoragePoolFree (returns non-void)
# n virStoragePoolFreeName (returns non-void)
# y virStoragePoolObjFree
# n virStoragePoolObjListFree FIXME
# y virStoragePoolSourceFree
# y virStorageVolDefFree
# n virStorageVolFree (returns non-void)
# n virStorageVolFreeName (returns non-void)
# n virStreamFree

274 275 276
# Avoid uses of write(2).  Either switch to streams (fwrite), or use
# the safewrite wrapper.
sc_avoid_write:
E
Eric Blake 已提交
277 278 279
	@prohibit='\<write *\('						\
	in_vc_files='\.c$$'						\
	halt='consider using safewrite instead of write'		\
280
	  $(_sc_search_regexp)
281

282 283 284
# In debug statements, print flags as bitmask and mode_t as octal.
sc_flags_debug:
	@prohibit='\<mode=%[0-9.]*[diux]'				\
285
	halt='use %o to debug mode_t values'				\
286
	  $(_sc_search_regexp)
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
	@prohibit='[Ff]lags=%[0-9.]*l*[diou]'				\
	halt='use %x to debug flag values'				\
	  $(_sc_search_regexp)

# Prefer 'unsigned int flags', along with checks for unknown flags.
# For historical reasons, we are stuck with 'unsigned long flags' in
# migration, so check for those known 4 instances and no more in public
# API.  Also check that no flags are marked unused, and 'unsigned' should
# appear before any declaration of a flags variable (achieved by
# prohibiting the word prior to the type from ending in anything other
# than d).  The existence of long long, and of documentation about
# flags, makes the regex in the third test slightly harder.
sc_flags_usage:
	@test "$$(cat $(srcdir)/include/libvirt/libvirt.h.in		\
	    $(srcdir)/include/libvirt/virterror.h			\
	    $(srcdir)/include/libvirt/libvirt-qemu.h			\
	  | grep -c '\(long\|unsigned\) flags')" != 4 &&		\
	  { echo '$(ME): new API should use "unsigned int flags"' 1>&2;	\
	    exit 1; } || :
	@prohibit=' flags ''ATTRIBUTE_UNUSED'				\
	halt='flags should be checked with virCheckFlags'		\
	  $(_sc_search_regexp)
	@prohibit='^[^@]*([^d] (int|long long)|[^dg] long) flags[;,)]'	\
	halt='flags should be unsigned'					\
311 312
	  $(_sc_search_regexp)

E
Eric Blake 已提交
313 314 315 316 317 318
# Avoid functions that should only be called via macro counterparts.
sc_prohibit_internal_functions:
	@prohibit='vir(Free|AllocN?|ReallocN|File(Close|Fclose|Fdopen)) *\(' \
	halt='use VIR_ macros instead of internal functions'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
319 320 321 322 323 324
# Avoid raw malloc and free, except in documentation comments.
sc_prohibit_raw_allocation:
	@prohibit='^.[^*].*\<((m|c|re)alloc|free) *\([^)]'		\
	halt='use VIR_ macros from memory.h instead of malloc/free'	\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
325 326
# Avoid functions that can lead to double-close bugs.
sc_prohibit_close:
327
	@prohibit='([^>.]|^)\<[fp]?close *\('				\
E
Eric Blake 已提交
328 329 330 331 332 333
	halt='use VIR_{FORCE_}[F]CLOSE instead of [f]close'		\
	  $(_sc_search_regexp)
	@prohibit='\<fdopen *\('					\
	halt='use VIR_FDOPEN instead of fdopen'				\
	  $(_sc_search_regexp)

334 335 336 337 338 339
# Prefer virCommand for all child processes.
sc_prohibit_fork_wrappers:
	@prohibit='= *\<(fork|popen|system) *\('			\
	halt='use virCommand for child processes'			\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
340 341 342 343 344 345 346
# access with X_OK accepts directories, but we can't exec() those.
# access with F_OK or R_OK is okay, though.
sc_prohibit_access_xok:
	@prohibit='access''(at)? *\(.*X_OK'				\
	halt='use virFileIsExecutable instead of access''(,X_OK)'	\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
347 348
# Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
# Use STREQLEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
E
Eric Blake 已提交
349
snp_ = strncmp *\(.+\)
E
Eric Blake 已提交
350
sc_prohibit_strncmp:
E
Eric Blake 已提交
351 352 353 354
	@prohibit='! *strncmp *\(|\<$(snp_) *[!=]=|[!=]= *$(snp_)'	\
	exclude=':# *define STR(N?EQLEN|PREFIX)\('			\
	halt='$(ME): use STREQLEN or STRPREFIX instead of str''ncmp'	\
	  $(_sc_search_regexp)
355

E
Eric Blake 已提交
356
# Use virAsprintf rather than as'printf since *strp is undefined on error.
357
sc_prohibit_asprintf:
E
Eric Blake 已提交
358
	@prohibit='\<v?a[s]printf\>'					\
E
Eric Blake 已提交
359 360 361
	halt='use virAsprintf, not as'printf				\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
362 363 364 365 366 367
# Prefer virSetUIDGID.
sc_prohibit_setuid:
	@prohibit='\<set(re)?[ug]id\> *\('				\
	halt='use virSetUIDGID, not raw set*id'				\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
368 369 370 371 372
# Use snprintf rather than s'printf, even if buffer is provably large enough,
# since gnulib has more guarantees for snprintf portability
sc_prohibit_sprintf:
	@prohibit='\<[s]printf\>'					\
	halt='use snprintf, not s'printf				\
E
Eric Blake 已提交
373
	  $(_sc_search_regexp)
374

C
Chris Lalancette 已提交
375
sc_prohibit_strncpy:
E
Eric Blake 已提交
376 377 378
	@prohibit='strncpy *\('						\
	halt='use virStrncpy, not strncpy'				\
	  $(_sc_search_regexp)
C
Chris Lalancette 已提交
379

380
sc_prohibit_readlink:
E
Eric Blake 已提交
381 382 383
	@prohibit='readlink *\('					\
	halt='use virFileResolveLink, not readlink'			\
	  $(_sc_search_regexp)
384

385
sc_prohibit_gethostname:
E
Eric Blake 已提交
386 387 388
	@prohibit='gethostname *\('					\
	halt='use virGetHostname, not gethostname'			\
	  $(_sc_search_regexp)
389

E
Eric Blake 已提交
390
sc_prohibit_gettext_noop:
E
Eric Blake 已提交
391 392 393
	@prohibit='gettext_noop *\('					\
	halt='use N_, not gettext_noop'					\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
394

395
sc_prohibit_VIR_ERR_NO_MEMORY:
E
Eric Blake 已提交
396 397 398
	@prohibit='\<V''IR_ERR_NO_MEMORY\>'				\
	halt='use virReportOOMError, not V'IR_ERR_NO_MEMORY		\
	  $(_sc_search_regexp)
399

E
Eric Blake 已提交
400
# Use a subshell for each function, to give the optimal warning message.
401
include $(srcdir)/Makefile.nonreentrant
402 403 404 405
sc_prohibit_nonreentrant:
	@fail=0 ; \
	for i in $(NON_REENTRANT) ; \
	do \
E
Eric Blake 已提交
406 407 408 409
	    (prohibit="\\<$$i *\\("					\
	     halt="use $${i}_r, not $$i"				\
	     $(_sc_search_regexp)					\
	    ) || fail=1;						\
410 411 412 413 414
	done ; \
	exit $$fail

# Prohibit the inclusion of <ctype.h>.
sc_prohibit_ctype_h:
E
Eric Blake 已提交
415 416
	@prohibit='^# *include  *<ctype\.h>'				\
	halt="don't use ctype.h; instead, use c-ctype.h"		\
417
	  $(_sc_search_regexp)
418

419 420 421 422 423 424
# Insist on correct types for [pug]id.
sc_correct_id_types:
	@prohibit='\<(int|long) *[pug]id\>'				\
	halt="use pid_t for pid, uid_t for uid, gid_t for gid"		\
	  $(_sc_search_regexp)

425 426 427 428 429 430
# Forbid sizeof foo or sizeof (foo), require sizeof(foo)
sc_size_of_brackets:
	@prohibit='sizeof\s'						\
	halt='use sizeof(foo), not sizeof (foo) or sizeof foo'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
431
# Ensure that no C source file, docs, or rng schema uses TABs for
D
David Allan 已提交
432 433
# indentation.  Also match *.h.in files, to get libvirt.h.in.  Exclude
# files in gnulib, since they're imported.
434
space_indent_files=(\.(rng|s?[ch](\.in)?|html.in|py|syms)|(daemon|tools)/.*\.in)
435
sc_TAB_in_indentation:
E
Eric Blake 已提交
436
	@prohibit='^ *	'						\
437
	in_vc_files='$(space_indent_files)$$'				\
438
	halt='indent with space, not TAB, in C, sh, html, py, syms and RNG schemas' \
439
	  $(_sc_search_regexp)
440 441 442 443 444

ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper

sc_avoid_ctype_macros:
E
Eric Blake 已提交
445 446
	@prohibit='\b($(ctype_re)) *\('					\
	halt="don't use ctype macros (use c-ctype.h)"			\
447
	  $(_sc_search_regexp)
448

449 450 451 452 453
sc_avoid_strcase:
	@prohibit='\bstrn?case(cmp|str) *\('				\
	halt="don't use raw strcase functions (use c-strcase instead)"	\
	  $(_sc_search_regexp)

454
sc_prohibit_virBufferAdd_with_string_literal:
E
Eric Blake 已提交
455 456 457
	@prohibit='\<virBufferAdd *\([^,]+, *"[^"]'			\
	halt='use virBufferAddLit, not virBufferAdd, with a string literal' \
	  $(_sc_search_regexp)
458 459 460 461

# Not only do they fail to deal well with ipv6, but the gethostby*
# functions are also not thread-safe.
sc_prohibit_gethostby:
E
Eric Blake 已提交
462 463 464
	@prohibit='\<gethostby(addr|name2?) *\('			\
	halt='use getaddrinfo, not gethostby*'				\
	  $(_sc_search_regexp)
465

466 467 468 469 470 471
# raw xmlGetProp requires some nasty casts
sc_prohibit_xmlGetProp:
	@prohibit='\<xmlGetProp *\('					\
	halt='use virXMLPropString, not xmlGetProp'			\
	  $(_sc_search_regexp)

M
Martin Kletzander 已提交
472 473 474 475 476 477
# xml(ParseURI|SaveUri) doesn't handle IPv6 URIs well
sc_prohibit_xmlURI:
	@prohibit='\<xml(ParseURI|SaveUri) *\('				\
	halt='use virURI(Parse|Format), not xml(ParseURI|SaveUri)'	\
	  $(_sc_search_regexp)

478 479 480 481 482 483
# we don't want old old-style return with parentheses around argument
sc_prohibit_return_as_function:
	@prohibit='\<return *\(([^()]*(\([^()]*\)[^()]*)*)\) *;'    \
	halt='avoid extra () with return statements'                \
	  $(_sc_search_regexp)

484 485 486 487 488 489 490 491
# ATTRIBUTE_UNUSED should only be applied in implementations, not
# header declarations
sc_avoid_attribute_unused_in_header:
	@prohibit='^[^#]*ATTRIBUTE_UNUSED([^:]|$$)'			\
	in_vc_files='\.h$$'						\
	halt='use ATTRIBUTE_UNUSED in .c rather than .h files'		\
	  $(_sc_search_regexp)

492 493 494 495 496 497
# 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 =
498 499
msg_gen_function += ESX_ERROR
msg_gen_function += ESX_VI_ERROR
M
Matthias Bolte 已提交
500
msg_gen_function += HYPERV_ERROR
501 502 503 504 505 506 507 508
msg_gen_function += PHYP_ERROR
msg_gen_function += VIR_ERROR
msg_gen_function += VMX_ERROR
msg_gen_function += XENXS_ERROR
msg_gen_function += eventReportError
msg_gen_function += ifaceError
msg_gen_function += interfaceReportError
msg_gen_function += iptablesError
509
msg_gen_function += lxcError
510 511
msg_gen_function += libxlError
msg_gen_function += macvtapError
512
msg_gen_function += networkReportError
513
msg_gen_function += nodeReportError
514
msg_gen_function += openvzError
515
msg_gen_function += pciReportError
E
Eric Blake 已提交
516
msg_gen_function += qemuReportError
517 518
msg_gen_function += qemudDispatchClientFailure
msg_gen_function += regerror
519
msg_gen_function += remoteError
520
msg_gen_function += remoteDispatchFormatError
521 522 523
msg_gen_function += statsError
msg_gen_function += streamsReportError
msg_gen_function += usbReportError
524
msg_gen_function += umlReportError
525 526
msg_gen_function += vah_error
msg_gen_function += vah_warning
527
msg_gen_function += vboxError
528
msg_gen_function += virCommandError
529
msg_gen_function += virConfError
530 531
msg_gen_function += virCPUReportError
msg_gen_function += virEventError
532
msg_gen_function += virDomainReportError
533
msg_gen_function += virGenericReportError
534
msg_gen_function += virHashError
535 536 537
msg_gen_function += virHookReportError
msg_gen_function += virInterfaceReportError
msg_gen_function += virJSONError
538 539
msg_gen_function += virLibConnError
msg_gen_function += virLibDomainError
540 541 542 543 544 545 546 547
msg_gen_function += virLibDomainSnapshotError
msg_gen_function += virLibInterfaceError
msg_gen_function += virLibNetworkError
msg_gen_function += virLibNodeDeviceError
msg_gen_function += virLibNWFilterError
msg_gen_function += virLibSecretError
msg_gen_function += virLibStoragePoolError
msg_gen_function += virLibStorageVolError
548 549
msg_gen_function += virNetworkReportError
msg_gen_function += virNodeDeviceReportError
550
msg_gen_function += virNWFilterReportError
551 552 553
msg_gen_function += virRaiseError
msg_gen_function += virReportErrorHelper
msg_gen_function += virReportSystemError
554
msg_gen_function += virSecretReportError
555
msg_gen_function += virSecurityReportError
556
msg_gen_function += virSexprError
557 558 559
msg_gen_function += virSmbiosReportError
msg_gen_function += virSocketError
msg_gen_function += virStatsError
560
msg_gen_function += virStorageReportError
561
msg_gen_function += virUtilError
562 563 564 565
msg_gen_function += virXMLError
msg_gen_function += virXenInotifyError
msg_gen_function += virXenStoreError
msg_gen_function += virXendError
566
msg_gen_function += vmwareError
567
msg_gen_function += xenapiSessionErrorHandler
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
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 += 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:
E
Eric Blake 已提交
589 590 591 592
	@prohibit='\<$(func_re) *\([^"]*"[^"]*[a-z]{3}'			\
	exclude='_\('							\
	halt='$(ME): found unmarked diagnostic(s)'			\
	  $(_sc_search_regexp)
593 594 595 596 597 598
	@{ 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; } || :
599

600 601 602 603 604 605 606 607 608 609 610 611 612 613
# Like the above, but prohibit a newline at the end of a diagnostic.
# This is subject to false positives partly because it naively looks for
# `\n"', which may not be the end of the string, and also because it takes
# two lines of context (the -A2) after the line with the function name.
# FIXME: this rule might benefit from a separate function list, in case
# there are functions to which this one applies but that do not get marked
# diagnostics.
sc_prohibit_newline_at_end_of_diagnostic:
	@grep -A2 -nE							\
	    '\<$(func_re) *\(' $$($(VC_LIST_EXCEPT))			\
	    | grep '\\n"'						\
	  && { echo '$(ME): newline at end of message(s)' 1>&2;		\
	    exit 1; } || :

614 615
# Enforce recommended preprocessor indentation style.
sc_preprocessor_indentation:
616
	@if cppi --version >/dev/null 2>&1; then			\
617
	  $(VC_LIST_EXCEPT) | grep '\.[ch]$$' | xargs cppi -a -c	\
618 619 620 621 622 623
	    || { echo '$(ME): incorrect preprocessor indentation' 1>&2;	\
		exit 1; };						\
	else								\
	  echo '$(ME): skipping test $@: cppi not installed' 1>&2;	\
	fi

624
sc_copyright_format:
E
Eric Blake 已提交
625 626 627
	@require='Copyright .*Red 'Hat', Inc\.'				\
	containing='Copyright .*Red 'Hat				\
	halt='Red Hat copyright is missing Inc.'			\
628
	  $(_sc_search_regexp)
E
Eric Blake 已提交
629 630
	@prohibit='Copyright [^(].*Red 'Hat				\
	halt='consistently use (C) in Red Hat copyright'		\
631
	  $(_sc_search_regexp)
E
Eric Blake 已提交
632 633 634
	@prohibit='\<Red''Hat\>'					\
	halt='spell Red Hat as two words'				\
	  $(_sc_search_regexp)
635 636 637 638

# Some functions/macros produce messages intended solely for developers
# and maintainers.  Do not mark them for translation.
sc_prohibit_gettext_markup:
639
	@prohibit='\<VIR_(WARN|INFO|DEBUG) *\(_\('			\
640 641
	halt='do not mark these strings for translation'		\
	  $(_sc_search_regexp)
642

E
Eric Blake 已提交
643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
# Our code is divided into modular subdirectories for a reason, and
# lower-level code must not include higher-level headers.
cross_dirs=$(patsubst $(srcdir)/src/%.,%,$(wildcard $(srcdir)/src/*/.))
cross_dirs_re=($(subst / ,/|,$(cross_dirs)))
sc_prohibit_cross_inclusion:
	@for dir in $(cross_dirs); do					\
	  case $$dir in							\
	    util/) safe="util";;					\
	    cpu/ | locking/ | network/ | rpc/ | security/)		\
	      safe="($$dir|util|conf)";;				\
	    xenapi/ | xenxs/ ) safe="($$dir|util|conf|xen)";;		\
	    *) safe="($$dir|util|conf|cpu|network|locking|rpc|security)";; \
	  esac;								\
	  in_vc_files="^src/$$dir"					\
	  prohibit='^# *include .$(cross_dirs_re)'			\
	  exclude="# *include .$$safe"					\
	  halt='unsafe cross-directory include'				\
	    $(_sc_search_regexp)					\
	done

E
Eric Blake 已提交
663 664 665 666 667 668 669 670 671 672 673
# When converting an enum to a string, make sure that we track any new
# elements added to the enum by using a _LAST marker.
sc_require_enum_last_marker:
	@grep -A1 -nE '^[^#]*VIR_ENUM_IMPL *\(' $$($(VC_LIST_EXCEPT))	\
	   | sed -ne '/VIR_ENUM_IMPL[^,]*,$$/N'				\
	     -e '/VIR_ENUM_IMPL[^,]*,[^,]*[^_,][^L,][^A,][^S,][^T,],/p'	\
	     -e '/VIR_ENUM_IMPL[^,]*,[^,]\{0,4\},/p'			\
	   | grep . &&							\
	  { echo '$(ME): enum impl needs to use _LAST marker' 1>&2;	\
	    exit 1; } || :

674 675
# We don't use this feature of maint.mk.
prev_version_file = /dev/null
676 677 678

ifeq (0,$(MAKELEVEL))
  _curr_status = .git-module-status
679 680 681 682 683 684
  # 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)
685 686 687
  # $ cat .git-module-status
  # b653eda3ac4864de205419d9f41eec267cb89eeb
  _submodule_hash = sed 's/^[ +-]//;s/ .*//'
688
  _update_required := $(shell						\
689
      cd '$(srcdir)';							\
690
      test -d .git || { echo 0; exit; };				\
691
      test -f po/Makevars || { echo 1; exit; };				\
692
      actual=$$(git submodule status | $(_submodule_hash);		\
693
		git hash-object bootstrap.conf;				\
E
Eric Blake 已提交
694
		git ls-tree -d HEAD gnulib/local | awk '{print $$3}';	\
695
		git diff .gnulib);					\
696 697
      stamp="$$($(_submodule_hash) $(_curr_status) 2>/dev/null)";	\
      test "$$stamp" = "$$actual"; echo $$?)
698 699
  _clean_requested = $(filter %clean,$(MAKECMDGOALS))
  ifeq (1,$(_update_required)$(_clean_requested))
700 701
    $(info INFO: gnulib update required; running ./autogen.sh first)
Makefile: _autogen
702 703
  endif
endif
704

705 706 707 708 709 710 711
# Give credit where due:
# Ensure that each commit author email address (possibly mapped via
# git log's .mailmap) appears in our AUTHORS file.
sc_check_author_list:
	@fail=0;							\
	for i in $$(git log --pretty=format:%aE%n|sort -u|grep -v '^$$'); do \
	  sanitized=$$(echo "$$i"|LC_ALL=C sed 's/\([^a-zA-Z0-9_@-]\)/\\\1/g'); \
712
	  grep -iq "<$$sanitized>" $(srcdir)/AUTHORS			\
713 714 715 716 717 718
	    || { printf '%s\n' "$$i" >&2; fail=1; };			\
	done;								\
	test $$fail = 1							\
	  && echo '$(ME): committer(s) not listed in AUTHORS' >&2;	\
	test $$fail = 0

719 720
# It is necessary to call autogen any time gnulib changes.  Autogen
# reruns configure, then we regenerate all Makefiles at once.
721 722 723
.PHONY: _autogen
_autogen:
	$(srcdir)/autogen.sh
724
	./config.status
725

726 727
# regenerate HACKING as part of the syntax-check
syntax-check: $(top_srcdir)/HACKING
728

729
# sc_po_check can fail if generated files are not built first
730 731 732
sc_po_check: \
		$(srcdir)/daemon/remote_dispatch.h \
		$(srcdir)/daemon/qemu_dispatch.h \
733
		$(srcdir)/src/remote/remote_client_bodies.h
734
$(srcdir)/daemon/remote_dispatch.h: $(srcdir)/src/remote/remote_protocol.x
735
	$(MAKE) -C daemon remote_dispatch.h
736 737 738
$(srcdir)/daemon/qemu_dispatch.h: $(srcdir)/src/remote/qemu_protocol.x
	$(MAKE) -C daemon qemu_dispatch.h
$(srcdir)/src/remote/remote_client_bodies.h: $(srcdir)/src/remote/remote_protocol.x
739 740
	$(MAKE) -C src remote/remote_client_bodies.h

741
# List all syntax-check exemptions:
742 743
exclude_file_name_regexp--sc_avoid_strcase = ^tools/virsh\.c$$

744
_src1=libvirt|fdstream|qemu/qemu_monitor|util/(command|util)|xen/xend_internal|rpc/virnetsocket|lxc/lxc_controller
745
exclude_file_name_regexp--sc_avoid_write = \
746
  ^(src/($(_src1))|daemon/libvirtd|tools/console|tests/(shunload|virnettlscontext)test)\.c$$
747 748 749

exclude_file_name_regexp--sc_bindtextdomain = ^(tests|examples)/

750
exclude_file_name_regexp--sc_flags_usage = ^(docs/|src/util/virnetdevtap\.c$$)
751

752
exclude_file_name_regexp--sc_libvirt_unmarked_diagnostics = \
753
  ^src/rpc/gendispatch\.pl$$
754

755
exclude_file_name_regexp--sc_po_check = ^(docs/|src/rpc/gendispatch\.pl$$)
756 757 758 759

exclude_file_name_regexp--sc_prohibit_VIR_ERR_NO_MEMORY = \
  ^(include/libvirt/virterror\.h|daemon/dispatch\.c|src/util/virterror\.c)$$

E
Eric Blake 已提交
760 761
exclude_file_name_regexp--sc_prohibit_access_xok = ^src/util/util\.c$$

762
exclude_file_name_regexp--sc_prohibit_always_true_header_tests = \
763
  ^python/(libvirt-(qemu-)?override|typewrappers)\.c$$
764 765

exclude_file_name_regexp--sc_prohibit_asprintf = \
E
Eric Blake 已提交
766
  ^(bootstrap.conf$$|src/util/util\.c$$|examples/domain-events/events-c/event-test\.c$$)
E
Eric Blake 已提交
767

768
exclude_file_name_regexp--sc_prohibit_close = \
E
Eric Blake 已提交
769
  (\.p[yl]$$|^docs/|^(src/util/virfile\.c|src/libvirt\.c)$$)
770 771

exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = \
772
  (^tests/qemuhelpdata/|\.(gif|ico|png)$$)
773

774
_src2=src/(util/command|libvirt|lxc/lxc_controller)
775
exclude_file_name_regexp--sc_prohibit_fork_wrappers = \
776
  (^($(_src2)|tests/testutils|daemon/libvirtd)\.c$$)
777 778 779

exclude_file_name_regexp--sc_prohibit_gethostname = ^src/util/util\.c$$

E
Eric Blake 已提交
780 781 782
exclude_file_name_regexp--sc_prohibit_internal_functions = \
  ^src/(util/(memory|util|virfile)\.[hc]|esx/esx_vi\.c)$$

783
exclude_file_name_regexp--sc_prohibit_newline_at_end_of_diagnostic = \
784
  ^src/rpc/gendispatch\.pl$$
785

786
exclude_file_name_regexp--sc_prohibit_nonreentrant = \
787
  ^((po|tests)/|docs/.*py$$|tools/(virsh|console)\.c$$)
788

E
Eric Blake 已提交
789
exclude_file_name_regexp--sc_prohibit_raw_allocation = \
790
  ^(src/util/memory\.[ch]|examples/.*)$$
E
Eric Blake 已提交
791

792 793
exclude_file_name_regexp--sc_prohibit_readlink = ^src/util/util\.c$$

E
Eric Blake 已提交
794 795
exclude_file_name_regexp--sc_prohibit_setuid = ^src/util/util\.c$$

796
exclude_file_name_regexp--sc_prohibit_sprintf = \
797
  ^(docs/hacking\.html\.in)|(examples/systemtap/.*stp)|(src/dtrace2systemtap\.pl)|(src/rpc/gensystemtap\.pl)$$
798 799 800 801 802 803

exclude_file_name_regexp--sc_prohibit_strncpy = \
  ^(src/util/util|tools/virsh)\.c$$

exclude_file_name_regexp--sc_prohibit_xmlGetProp = ^src/util/xml\.c$$

M
Martin Kletzander 已提交
804 805
exclude_file_name_regexp--sc_prohibit_xmlURI = ^src/util/viruri\.c$$

806 807
exclude_file_name_regexp--sc_prohibit_return_as_function = \.py$$

808
exclude_file_name_regexp--sc_require_config_h = ^examples/
809

810
exclude_file_name_regexp--sc_require_config_h_first = ^examples/
811

812
exclude_file_name_regexp--sc_trailing_blank = \.(fig|gif|ico|png)$$
813 814 815

exclude_file_name_regexp--sc_unmarked_diagnostics = \
  ^(docs/apibuild.py|tests/virt-aa-helper-test)$$
816 817

exclude_file_name_regexp--sc_size_of_brackets = cfg.mk