cfg.mk 29.6 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

# 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
16 17
# along with this program.  If not, see
# <http://www.gnu.org/licenses/>.
18 19 20 21 22 23 24 25 26 27 28

# 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

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

E
Eric Blake 已提交
32 33 34
# 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 已提交
35
  $(srcdir)/daemon/*_dispatch.h \
E
Eric Blake 已提交
36 37 38 39
  $(srcdir)/src/remote/*_client_bodies.h \
  $(srcdir)/src/remote/*_protocol.[ch] \
  $(srcdir)/gnulib/lib/*.[ch]

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

43 44
# Tests not to run as part of "make distcheck".
local-checks-to-skip =			\
45
  changelog-check			\
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 80 81 82 83 84 85 86
# Most developers don't run 'make distcheck'.  We want the official
# dist to be secure, but don't want to penalize other developers
# using a distro that has not yet picked up the automake fix.
# FIXME remove this ifeq (making the syntax check unconditional)
# once fixed automake (1.11.6 or 1.12.2+) is more common.
ifeq ($(filter dist%, $(MAKECMDGOALS)), )
local-checks-to-skip +=	sc_vulnerable_makefile_CVE-2012-3386
else
87
distdir: sc_vulnerable_makefile_CVE-2012-3386.z
88 89
endif

90
# Files that should never cause syntax check failures.
91 92
VC_LIST_ALWAYS_EXCLUDE_REGEX = \
  (^(HACKING|docs/(news\.html\.in|.*\.patch))|\.po)$$
93 94

# Functions like free() that are no-ops on NULL arguments.
95 96
useless_free_options =				\
  --name=VIR_FREE				\
97
  --name=qemuCapsFree				\
98
  --name=qemuMigrationCookieFree                \
99
  --name=qemuMigrationCookieGraphicsFree        \
100
  --name=sexpr_free				\
101
  --name=virBandwidthDefFree			\
102
  --name=virBitmapFree                          \
103 104 105 106 107 108 109 110 111
  --name=virCPUDefFree				\
  --name=virCapabilitiesFree			\
  --name=virCapabilitiesFreeGuest		\
  --name=virCapabilitiesFreeGuestDomain		\
  --name=virCapabilitiesFreeGuestFeature	\
  --name=virCapabilitiesFreeGuestMachine	\
  --name=virCapabilitiesFreeHostNUMACell	\
  --name=virCapabilitiesFreeMachines		\
  --name=virCgroupFree				\
112
  --name=virCommandFree				\
113 114
  --name=virConfFreeList			\
  --name=virConfFreeValue			\
115
  --name=virDomainActualNetDefFree		\
116
  --name=virDomainChrDefFree			\
117
  --name=virDomainChrSourceDefFree		\
118 119 120 121 122 123 124
  --name=virDomainControllerDefFree		\
  --name=virDomainDefFree			\
  --name=virDomainDeviceDefFree			\
  --name=virDomainDiskDefFree			\
  --name=virDomainEventCallbackListFree		\
  --name=virDomainEventFree			\
  --name=virDomainEventQueueFree		\
125
  --name=virDomainEventStateFree		\
126 127 128 129 130 131
  --name=virDomainFSDefFree			\
  --name=virDomainGraphicsDefFree		\
  --name=virDomainHostdevDefFree		\
  --name=virDomainInputDefFree			\
  --name=virDomainNetDefFree			\
  --name=virDomainObjFree			\
E
Eric Blake 已提交
132
  --name=virDomainSmartcardDefFree		\
133 134 135 136 137
  --name=virDomainSnapshotDefFree		\
  --name=virDomainSnapshotObjFree		\
  --name=virDomainSoundDefFree			\
  --name=virDomainVideoDefFree			\
  --name=virDomainWatchdogDefFree		\
138
  --name=virFileDirectFdFree			\
139
  --name=virHashFree				\
140 141 142 143 144 145
  --name=virInterfaceDefFree			\
  --name=virInterfaceIpDefFree			\
  --name=virInterfaceObjFree			\
  --name=virInterfaceProtocolDefFree		\
  --name=virJSONValueFree			\
  --name=virLastErrFreeData			\
146
  --name=virNetMessageFree                      \
147 148 149
  --name=virNetServerMDNSFree                   \
  --name=virNetServerMDNSEntryFree              \
  --name=virNetServerMDNSGroupFree              \
150 151 152 153 154
  --name=virNWFilterDefFree			\
  --name=virNWFilterEntryFree			\
  --name=virNWFilterHashTableFree		\
  --name=virNWFilterIPAddrLearnReqFree		\
  --name=virNWFilterIncludeDefFree		\
155
  --name=virNWFilterObjFree			\
156 157 158 159 160 161
  --name=virNWFilterRuleDefFree			\
  --name=virNWFilterRuleInstFree		\
  --name=virNetworkDefFree			\
  --name=virNetworkObjFree			\
  --name=virNodeDeviceDefFree			\
  --name=virNodeDeviceObjFree			\
162 163
  --name=virObjectUnref                         \
  --name=virObjectFreeCallback                  \
164 165 166
  --name=virSecretDefFree			\
  --name=virStorageEncryptionFree		\
  --name=virStorageEncryptionSecretFree		\
167
  --name=virStorageFileFreeMetadata		\
168 169 170 171
  --name=virStoragePoolDefFree			\
  --name=virStoragePoolObjFree			\
  --name=virStoragePoolSourceFree		\
  --name=virStorageVolDefFree			\
H
Hu Tao 已提交
172
  --name=virThreadPoolFree			\
173
  --name=xmlBufferFree				\
174
  --name=xmlFree				\
175
  --name=xmlFreeDoc				\
E
Eric Blake 已提交
176
  --name=xmlFreeNode				\
177
  --name=xmlXPathFreeContext			\
178
  --name=xmlXPathFreeObject
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 219 220
# 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 已提交
221
# n virFree - dereferences param
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
# 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
239 240 241
# n virNWFilterFreeName (returns int)
# y virNWFilterObjFree
# n virNWFilterObjListFree FIXME
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 274 275
# 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

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

284 285 286
# In debug statements, print flags as bitmask and mode_t as octal.
sc_flags_debug:
	@prohibit='\<mode=%[0-9.]*[diux]'				\
287
	halt='use %o to debug mode_t values'				\
288
	  $(_sc_search_regexp)
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
	@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'					\
313 314
	  $(_sc_search_regexp)

E
Eric Blake 已提交
315 316 317 318 319 320
# 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 已提交
321 322 323 324 325 326
# 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 已提交
327 328
# Avoid functions that can lead to double-close bugs.
sc_prohibit_close:
329
	@prohibit='([^>.]|^)\<[fp]?close *\('				\
E
Eric Blake 已提交
330 331 332 333 334 335
	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)

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

342 343 344 345 346 347
# Prefer mkostemp with O_CLOEXEC.
sc_prohibit_mkstemp:
	@prohibit='[^"]\<mkstemps? *\('					\
	halt='use mkostemp with O_CLOEXEC instead of mkstemp'		\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
348 349 350 351 352 353 354
# 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 已提交
355 356
# 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 已提交
357
snp_ = strncmp *\(.+\)
E
Eric Blake 已提交
358
sc_prohibit_strncmp:
E
Eric Blake 已提交
359 360
	@prohibit='! *strncmp *\(|\<$(snp_) *[!=]=|[!=]= *$(snp_)'	\
	exclude=':# *define STR(N?EQLEN|PREFIX)\('			\
361
	halt='use STREQLEN or STRPREFIX instead of str''ncmp'		\
E
Eric Blake 已提交
362
	  $(_sc_search_regexp)
363

E
Eric Blake 已提交
364 365 366 367
# strtol and friends are too easy to misuse
sc_prohibit_strtol:
	@prohibit='\bstrto(u?ll?|[ui]max) *\('				\
	exclude='exempt from syntax-check'				\
368
	halt='use virStrToLong_*, not strtol variants'			\
E
Eric Blake 已提交
369 370 371
	  $(_sc_search_regexp)
	@prohibit='\bstrto[df] *\('					\
	exclude='exempt from syntax-check'				\
372
	halt='use virStrToDouble, not strtod variants'			\
E
Eric Blake 已提交
373 374
	  $(_sc_search_regexp)

E
Eric Blake 已提交
375
# Use virAsprintf rather than as'printf since *strp is undefined on error.
376
sc_prohibit_asprintf:
E
Eric Blake 已提交
377
	@prohibit='\<v?a[s]printf\>'					\
E
Eric Blake 已提交
378 379 380
	halt='use virAsprintf, not as'printf				\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
381 382 383 384 385 386
# Prefer virSetUIDGID.
sc_prohibit_setuid:
	@prohibit='\<set(re)?[ug]id\> *\('				\
	halt='use virSetUIDGID, not raw set*id'				\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
387 388 389 390 391
# 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 已提交
392
	  $(_sc_search_regexp)
393

394
sc_prohibit_readlink:
395
	@prohibit='\<readlink *\('					\
E
Eric Blake 已提交
396 397
	halt='use virFileResolveLink, not readlink'			\
	  $(_sc_search_regexp)
398

399
sc_prohibit_gethostname:
E
Eric Blake 已提交
400 401 402
	@prohibit='gethostname *\('					\
	halt='use virGetHostname, not gethostname'			\
	  $(_sc_search_regexp)
403

E
Eric Blake 已提交
404
sc_prohibit_gettext_noop:
E
Eric Blake 已提交
405 406 407
	@prohibit='gettext_noop *\('					\
	halt='use N_, not gettext_noop'					\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
408

409
sc_prohibit_VIR_ERR_NO_MEMORY:
E
Eric Blake 已提交
410 411 412
	@prohibit='\<V''IR_ERR_NO_MEMORY\>'				\
	halt='use virReportOOMError, not V'IR_ERR_NO_MEMORY		\
	  $(_sc_search_regexp)
413

414 415 416 417 418
sc_prohibit_PATH_MAX:
	@prohibit='\<P''ATH_MAX\>'				\
	halt='dynamically allocate paths, do not use P'ATH_MAX	\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
419
# Use a subshell for each function, to give the optimal warning message.
420
include $(srcdir)/Makefile.nonreentrant
421 422 423 424
sc_prohibit_nonreentrant:
	@fail=0 ; \
	for i in $(NON_REENTRANT) ; \
	do \
E
Eric Blake 已提交
425 426 427 428
	    (prohibit="\\<$$i *\\("					\
	     halt="use $${i}_r, not $$i"				\
	     $(_sc_search_regexp)					\
	    ) || fail=1;						\
429 430 431 432 433
	done ; \
	exit $$fail

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

438 439 440 441 442 443
# 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)

444 445 446 447 448 449
# 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 已提交
450
# Ensure that no C source file, docs, or rng schema uses TABs for
D
David Allan 已提交
451 452
# indentation.  Also match *.h.in files, to get libvirt.h.in.  Exclude
# files in gnulib, since they're imported.
453
space_indent_files=(\.(rng|s?[ch](\.in)?|html.in|py|pl|syms)|(daemon|tools)/.*\.in)
454
sc_TAB_in_indentation:
E
Eric Blake 已提交
455
	@prohibit='^ *	'						\
456
	in_vc_files='$(space_indent_files)$$'				\
457
	halt='indent with space, not TAB, in C, sh, html, py, syms and RNG schemas' \
458
	  $(_sc_search_regexp)
459 460 461 462 463

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

sc_avoid_ctype_macros:
E
Eric Blake 已提交
464 465
	@prohibit='\b($(ctype_re)) *\('					\
	halt="don't use ctype macros (use c-ctype.h)"			\
466
	  $(_sc_search_regexp)
467

468 469 470 471 472
sc_avoid_strcase:
	@prohibit='\bstrn?case(cmp|str) *\('				\
	halt="don't use raw strcase functions (use c-strcase instead)"	\
	  $(_sc_search_regexp)

473
sc_prohibit_virBufferAdd_with_string_literal:
E
Eric Blake 已提交
474 475 476
	@prohibit='\<virBufferAdd *\([^,]+, *"[^"]'			\
	halt='use virBufferAddLit, not virBufferAdd, with a string literal' \
	  $(_sc_search_regexp)
477 478 479 480

# 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 已提交
481 482 483
	@prohibit='\<gethostby(addr|name2?) *\('			\
	halt='use getaddrinfo, not gethostby*'				\
	  $(_sc_search_regexp)
484

485 486 487 488 489 490
# raw xmlGetProp requires some nasty casts
sc_prohibit_xmlGetProp:
	@prohibit='\<xmlGetProp *\('					\
	halt='use virXMLPropString, not xmlGetProp'			\
	  $(_sc_search_regexp)

M
Martin Kletzander 已提交
491 492 493 494 495 496
# 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)

497 498 499 500 501 502
# 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)

503 504 505 506 507 508 509 510
# 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)

511 512 513 514 515 516
# 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 =
517
msg_gen_function += VIR_ERROR
518 519
msg_gen_function += lxcError
msg_gen_function += regerror
520 521
msg_gen_function += vah_error
msg_gen_function += vah_warning
522
msg_gen_function += virGenericReportError
523 524
msg_gen_function += virLibConnError
msg_gen_function += virLibDomainError
525 526 527 528 529 530 531 532
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
533
msg_gen_function += virRaiseError
534
msg_gen_function += virReportError
535 536
msg_gen_function += virReportErrorHelper
msg_gen_function += virReportSystemError
537
msg_gen_function += xenapiSessionErrorHandler
538 539 540 541 542 543 544 545 546

# 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 += vshPrint
# msg_gen_function += vshError

547
func_or := $(shell echo $(msg_gen_function)|tr -s ' ' '|')
548 549 550 551 552 553 554 555
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 已提交
556 557
	@prohibit='\<$(func_re) *\([^"]*"[^"]*[a-z]{3}'			\
	exclude='_\('							\
558
	halt='found unmarked diagnostic(s)'				\
E
Eric Blake 已提交
559
	  $(_sc_search_regexp)
560 561
	@{ grep     -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT));   \
	   grep -A1 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
562
	   | sed 's/_("\([^\"]\|\\.\)\+"//;s/[	 ]"%s"//'		\
563 564 565
	   | grep '[	 ]"' &&						\
	  { echo '$(ME): found unmarked diagnostic(s)' 1>&2;		\
	    exit 1; } || :
566

567 568 569 570 571 572 573 574 575 576 577 578 579 580
# 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; } || :

581 582 583 584 585 586 587 588 589 590 591 592 593
# Look for diagnostics that lack a % in the format string, except that we
# allow VIR_ERROR to do this, and ignore functions that take a single
# string rather than a format argument.
sc_prohibit_diagnostic_without_format:
	@{ grep     -nE '\<$(func_re) *\(.*;$$' $$($(VC_LIST_EXCEPT));   \
	   grep -A2 -nE '\<$(func_re) *\(.*,$$' $$($(VC_LIST_EXCEPT)); } \
	   | sed -rn -e ':l; /[,"]$$/ {N;b l;}'				 \
		-e '/(xenapiSessionErrorHandler|vah_(error|warning))/d'	 \
		-e '/\<$(func_re) *\([^"]*"([^%"]|"\n[^"]*")*"[,)]/p'	 \
           | grep -vE 'VIR_ERROR' &&					 \
	  { echo '$(ME): found diagnostic without %' 1>&2;		 \
	    exit 1; } || :

594
# The strings "" and "%s" should never be marked for translation.
595
# Files under tests/ and examples/ should not be translated.
596 597
sc_prohibit_useless_translation:
	@prohibit='_\("(%s)?"\)'					\
598 599 600 601 602
	halt='found useless translation'				\
	  $(_sc_search_regexp)
	@prohibit='\<N?_ *\('						\
	in_vc_files='^(tests|examples)/'				\
	halt='no translations in tests or examples'			\
603 604
	  $(_sc_search_regexp)

605 606 607 608 609 610 611 612 613
# When splitting a diagnostic across lines, ensure that there is a space
# or \n on one side of the split.
sc_require_whitespace_in_translation:
	@grep -n -A1 '"$$' $$($(VC_LIST_EXCEPT))   			\
	   | sed -ne ':l; /"$$/ {N;b l;}; s/"\n[^"]*"/""/g; s/\\n/ /g'	\
		-e '/_(.*[^\ ]""[^\ ]/p' | grep . &&			\
	  { echo '$(ME): missing whitespace at line split' 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 639 640 641 642
# Prefer the new URL listing over the old street address listing when
# calling out where to get a copy of the [L]GPL.
sc_copyright_address:
	@prohibit=Boston,' MA'						\
	halt='Point to <http://www.gnu.org/licenses/>, not an address'	\
	  $(_sc_search_regexp)

643 644 645
# Some functions/macros produce messages intended solely for developers
# and maintainers.  Do not mark them for translation.
sc_prohibit_gettext_markup:
646
	@prohibit='\<VIR_(WARN|INFO|DEBUG) *\(_\('			\
647 648
	halt='do not mark these strings for translation'		\
	  $(_sc_search_regexp)
649

E
Eric Blake 已提交
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
# 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 已提交
670 671 672 673 674 675 676 677 678 679 680
# 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; } || :

681 682
# We don't use this feature of maint.mk.
prev_version_file = /dev/null
683 684 685

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

E
Eric Blake 已提交
713 714 715 716 717 718 719
# It is necessary to call autogen any time gnulib changes.  Autogen
# reruns configure, then we regenerate all Makefiles at once.
.PHONY: _autogen
_autogen:
	$(srcdir)/autogen.sh
	./config.status

720
# regenerate HACKING as part of the syntax-check
721 722 723 724 725 726
syntax-check: $(top_srcdir)/HACKING bracket-spacing-check

bracket-spacing-check:
	$(AM_V_GEN)files=`$(VC_LIST) | grep '\.c$$'`; \
	$(PERL) $(top_srcdir)/build-aux/bracket-spacing.pl $$files || \
          (echo $(ME): incorrect whitespace around brackets, see HACKING for rules && exit 1)
727

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

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

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

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

749 750 751
exclude_file_name_regexp--sc_copyright_address = \
  ^COPYING\.LIB$$

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

754
exclude_file_name_regexp--sc_libvirt_unmarked_diagnostics = \
755
  ^(src/rpc/gendispatch\.pl$$|tests/)
756

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

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

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

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

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

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

exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = \
E
Eric Blake 已提交
774
  (^tests/(qemuhelp|nodeinfo)data/|\.(gif|ico|png|diff)$$)
775

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

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

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

785
exclude_file_name_regexp--sc_prohibit_newline_at_end_of_diagnostic = \
786
  ^src/rpc/gendispatch\.pl$$
787

788
exclude_file_name_regexp--sc_prohibit_nonreentrant = \
M
Martin Kletzander 已提交
789
  ^((po|tests)/|docs/.*py|run.in$$)
790

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

794
exclude_file_name_regexp--sc_prohibit_readlink = \
E
Eric Blake 已提交
795
  ^src/(util/util|lxc/lxc_container)\.c$$
796

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

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

E
Eric Blake 已提交
802
exclude_file_name_regexp--sc_prohibit_strncpy = ^src/util/util\.c$$
803

E
Eric Blake 已提交
804 805 806
exclude_file_name_regexp--sc_prohibit_strtol = \
  ^src/(util/sexpr|(vbox|xen|xenxs)/.*)\.c$$

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

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

811 812
exclude_file_name_regexp--sc_prohibit_return_as_function = \.py$$

813
_virsh_includes=(edit|domain-monitor|domain|volume|pool|network|interface|nwfilter|secret|snapshot|host|nodedev)
814
exclude_file_name_regexp--sc_require_config_h = ^(examples/|tools/virsh-$(_virsh_includes)\.c$$)
815

816
exclude_file_name_regexp--sc_require_config_h_first = ^(examples/|tools/virsh-$(_virsh_includes)\.c$$)
817

818 819
exclude_file_name_regexp--sc_trailing_blank = \
  (/qemuhelpdata/|\.(fig|gif|ico|png)$$)
820 821 822

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

exclude_file_name_regexp--sc_size_of_brackets = cfg.mk