cfg.mk 22.2 KB
Newer Older
1
# Customize Makefile.maint.                           -*- makefile -*-
2 3
# Copyright (C) 2008-2011 Red Hat, Inc.
# 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

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

68
# Files that should never cause syntax check failures.
69
VC_LIST_ALWAYS_EXCLUDE_REGEX = ^(HACKING|docs/news\.html\.in)$$
70 71

# Functions like free() that are no-ops on NULL arguments.
72 73
useless_free_options =				\
  --name=VIR_FREE				\
74
  --name=qemuCapsFree				\
75
  --name=sexpr_free				\
76
  --name=virBitmapFree                          \
77 78 79 80 81 82 83 84 85
  --name=virCPUDefFree				\
  --name=virCapabilitiesFree			\
  --name=virCapabilitiesFreeGuest		\
  --name=virCapabilitiesFreeGuestDomain		\
  --name=virCapabilitiesFreeGuestFeature	\
  --name=virCapabilitiesFreeGuestMachine	\
  --name=virCapabilitiesFreeHostNUMACell	\
  --name=virCapabilitiesFreeMachines		\
  --name=virCgroupFree				\
86
  --name=virCommandFree				\
87 88 89
  --name=virConfFreeList			\
  --name=virConfFreeValue			\
  --name=virDomainChrDefFree			\
90
  --name=virDomainChrSourceDefFree		\
91 92 93 94 95 96 97 98 99 100 101 102 103
  --name=virDomainControllerDefFree		\
  --name=virDomainDefFree			\
  --name=virDomainDeviceDefFree			\
  --name=virDomainDiskDefFree			\
  --name=virDomainEventCallbackListFree		\
  --name=virDomainEventFree			\
  --name=virDomainEventQueueFree		\
  --name=virDomainFSDefFree			\
  --name=virDomainGraphicsDefFree		\
  --name=virDomainHostdevDefFree		\
  --name=virDomainInputDefFree			\
  --name=virDomainNetDefFree			\
  --name=virDomainObjFree			\
E
Eric Blake 已提交
104
  --name=virDomainSmartcardDefFree		\
105 106 107 108 109
  --name=virDomainSnapshotDefFree		\
  --name=virDomainSnapshotObjFree		\
  --name=virDomainSoundDefFree			\
  --name=virDomainVideoDefFree			\
  --name=virDomainWatchdogDefFree		\
110
  --name=virHashFree				\
111 112 113 114 115 116 117 118 119 120 121
  --name=virInterfaceDefFree			\
  --name=virInterfaceIpDefFree			\
  --name=virInterfaceObjFree			\
  --name=virInterfaceProtocolDefFree		\
  --name=virJSONValueFree			\
  --name=virLastErrFreeData			\
  --name=virNWFilterDefFree			\
  --name=virNWFilterEntryFree			\
  --name=virNWFilterHashTableFree		\
  --name=virNWFilterIPAddrLearnReqFree		\
  --name=virNWFilterIncludeDefFree		\
122
  --name=virNWFilterObjFree			\
123 124 125 126 127 128 129 130 131 132 133 134 135
  --name=virNWFilterRuleDefFree			\
  --name=virNWFilterRuleInstFree		\
  --name=virNetworkDefFree			\
  --name=virNetworkObjFree			\
  --name=virNodeDeviceDefFree			\
  --name=virNodeDeviceObjFree			\
  --name=virSecretDefFree			\
  --name=virStorageEncryptionFree		\
  --name=virStorageEncryptionSecretFree		\
  --name=virStoragePoolDefFree			\
  --name=virStoragePoolObjFree			\
  --name=virStoragePoolSourceFree		\
  --name=virStorageVolDefFree			\
H
Hu Tao 已提交
136
  --name=virThreadPoolFree			\
137 138
  --name=xmlFree				\
  --name=xmlXPathFreeContext			\
139
  --name=xmlXPathFreeObject
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
# 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)
# n virFree (dereferences param)
# 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
200 201 202
# n virNWFilterFreeName (returns int)
# y virNWFilterObjFree
# n virNWFilterObjListFree FIXME
203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
# 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

237 238 239
# Avoid uses of write(2).  Either switch to streams (fwrite), or use
# the safewrite wrapper.
sc_avoid_write:
E
Eric Blake 已提交
240 241 242
	@prohibit='\<write *\('						\
	in_vc_files='\.c$$'						\
	halt='consider using safewrite instead of write'		\
243
	  $(_sc_search_regexp)
244

E
Eric Blake 已提交
245 246
# Avoid functions that can lead to double-close bugs.
sc_prohibit_close:
247
	@prohibit='([^>.]|^)\<[fp]?close *\('				\
E
Eric Blake 已提交
248 249 250 251 252 253
	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)

254 255 256 257 258 259 260
# Prefer virCommand for all child processes.
# XXX - eventually, we want to enhance this to also prohibit virExec.
sc_prohibit_fork_wrappers:
	@prohibit='= *\<(fork|popen|system) *\('			\
	halt='use virCommand for child processes'			\
	  $(_sc_search_regexp)

E
Eric Blake 已提交
261 262 263 264 265 266 267
# 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 已提交
268 269 270
# Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
# Use STREQLEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
sc_prohibit_strncmp:
271
	@grep -nE '! *str''ncmp *\(|\<str''ncmp *\(.+\) *[!=]='		\
E
Eric Blake 已提交
272
	    $$($(VC_LIST_EXCEPT))					\
273
	  | grep -vE ':# *define STR(N?EQLEN|PREFIX)\(' &&		\
E
Eric Blake 已提交
274 275
	  { echo '$(ME): use STREQLEN or STRPREFIX instead of str''ncmp' \
		1>&2; exit 1; } || :
276

E
Eric Blake 已提交
277
# Use virAsprintf rather than as'printf since *strp is undefined on error.
278
sc_prohibit_asprintf:
E
Eric Blake 已提交
279
	@prohibit='\<v?a[s]printf\>'					\
E
Eric Blake 已提交
280 281 282 283 284 285 286 287
	halt='use virAsprintf, not as'printf				\
	  $(_sc_search_regexp)

# 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 已提交
288
	  $(_sc_search_regexp)
289

C
Chris Lalancette 已提交
290
sc_prohibit_strncpy:
E
Eric Blake 已提交
291 292 293
	@prohibit='strncpy *\('						\
	halt='use virStrncpy, not strncpy'				\
	  $(_sc_search_regexp)
C
Chris Lalancette 已提交
294

295
sc_prohibit_readlink:
E
Eric Blake 已提交
296 297 298
	@prohibit='readlink *\('					\
	halt='use virFileResolveLink, not readlink'			\
	  $(_sc_search_regexp)
299

300
sc_prohibit_gethostname:
E
Eric Blake 已提交
301 302 303
	@prohibit='gethostname *\('					\
	halt='use virGetHostname, not gethostname'			\
	  $(_sc_search_regexp)
304

E
Eric Blake 已提交
305
sc_prohibit_gettext_noop:
E
Eric Blake 已提交
306 307 308
	@prohibit='gettext_noop *\('					\
	halt='use N_, not gettext_noop'					\
	  $(_sc_search_regexp)
E
Eric Blake 已提交
309

310
sc_prohibit_VIR_ERR_NO_MEMORY:
E
Eric Blake 已提交
311 312 313
	@prohibit='\<V''IR_ERR_NO_MEMORY\>'				\
	halt='use virReportOOMError, not V'IR_ERR_NO_MEMORY		\
	  $(_sc_search_regexp)
314

E
Eric Blake 已提交
315
# Use a subshell for each function, to give the optimal warning message.
316
include $(srcdir)/Makefile.nonreentrant
317 318 319 320
sc_prohibit_nonreentrant:
	@fail=0 ; \
	for i in $(NON_REENTRANT) ; \
	do \
E
Eric Blake 已提交
321 322 323 324
	    (prohibit="\\<$$i *\\("					\
	     halt="use $${i}_r, not $$i"				\
	     $(_sc_search_regexp)					\
	    ) || fail=1;						\
325 326 327 328 329
	done ; \
	exit $$fail

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

E
Eric Blake 已提交
334
# Ensure that no C source file, docs, or rng schema uses TABs for
D
David Allan 已提交
335 336
# indentation.  Also match *.h.in files, to get libvirt.h.in.  Exclude
# files in gnulib, since they're imported.
337
space_indent_files=(\.(rng|s?[ch](\.in)?|html.in|py)|(daemon|tools)/.*\.in)
338
sc_TAB_in_indentation:
E
Eric Blake 已提交
339
	@prohibit='^ *	'						\
340 341
	in_vc_files='$(space_indent_files)$$'				\
	halt='indent with space, not TAB, in C, sh, html, py, and RNG schemas' \
342
	  $(_sc_search_regexp)
343 344 345 346 347

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

sc_avoid_ctype_macros:
E
Eric Blake 已提交
348 349
	@prohibit='\b($(ctype_re)) *\('					\
	halt="don't use ctype macros (use c-ctype.h)"			\
350
	  $(_sc_search_regexp)
351

352 353 354 355 356
sc_avoid_strcase:
	@prohibit='\bstrn?case(cmp|str) *\('				\
	halt="don't use raw strcase functions (use c-strcase instead)"	\
	  $(_sc_search_regexp)

357
sc_prohibit_virBufferAdd_with_string_literal:
E
Eric Blake 已提交
358 359 360
	@prohibit='\<virBufferAdd *\([^,]+, *"[^"]'			\
	halt='use virBufferAddLit, not virBufferAdd, with a string literal' \
	  $(_sc_search_regexp)
361 362 363 364

# 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 已提交
365 366 367
	@prohibit='\<gethostby(addr|name2?) *\('			\
	halt='use getaddrinfo, not gethostby*'				\
	  $(_sc_search_regexp)
368

369 370 371 372 373 374
# raw xmlGetProp requires some nasty casts
sc_prohibit_xmlGetProp:
	@prohibit='\<xmlGetProp *\('					\
	halt='use virXMLPropString, not xmlGetProp'			\
	  $(_sc_search_regexp)

375 376 377 378 379 380
# 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 =
381 382
msg_gen_function += ESX_ERROR
msg_gen_function += ESX_VI_ERROR
383 384 385 386 387 388 389 390 391
msg_gen_function += PHYP_ERROR
msg_gen_function += VIR_ERROR
msg_gen_function += VIR_ERROR0
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
392
msg_gen_function += lxcError
393 394
msg_gen_function += libxlError
msg_gen_function += macvtapError
395
msg_gen_function += networkReportError
396
msg_gen_function += nodeReportError
397
msg_gen_function += openvzError
398
msg_gen_function += pciReportError
E
Eric Blake 已提交
399
msg_gen_function += qemuReportError
400 401
msg_gen_function += qemudDispatchClientFailure
msg_gen_function += regerror
402
msg_gen_function += remoteError
403
msg_gen_function += remoteDispatchFormatError
404 405 406
msg_gen_function += statsError
msg_gen_function += streamsReportError
msg_gen_function += usbReportError
407
msg_gen_function += umlReportError
408 409
msg_gen_function += vah_error
msg_gen_function += vah_warning
410
msg_gen_function += vboxError
411
msg_gen_function += virCommandError
412
msg_gen_function += virConfError
413 414
msg_gen_function += virCPUReportError
msg_gen_function += virEventError
415
msg_gen_function += virDomainReportError
416
msg_gen_function += virGenericReportError
417
msg_gen_function += virHashError
418 419 420
msg_gen_function += virHookReportError
msg_gen_function += virInterfaceReportError
msg_gen_function += virJSONError
421 422
msg_gen_function += virLibConnError
msg_gen_function += virLibDomainError
423 424 425 426 427 428 429 430
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
431 432
msg_gen_function += virNetworkReportError
msg_gen_function += virNodeDeviceReportError
433
msg_gen_function += virNWFilterReportError
434 435 436
msg_gen_function += virRaiseError
msg_gen_function += virReportErrorHelper
msg_gen_function += virReportSystemError
437
msg_gen_function += virSecretReportError
438
msg_gen_function += virSecurityReportError
439
msg_gen_function += virSexprError
440 441 442
msg_gen_function += virSmbiosReportError
msg_gen_function += virSocketError
msg_gen_function += virStatsError
443
msg_gen_function += virStorageReportError
444
msg_gen_function += virUtilError
445 446 447 448
msg_gen_function += virXMLError
msg_gen_function += virXenInotifyError
msg_gen_function += virXenStoreError
msg_gen_function += virXendError
449
msg_gen_function += vmwareError
450
msg_gen_function += xenapiSessionErrorHandler
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
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:
	@grep -nE							\
473
	    '\<$(func_re) *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))	\
474 475 476 477 478 479 480 481 482
	  | 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; } || :
483

484 485 486 487 488 489 490 491 492 493 494 495 496 497
# 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; } || :

498 499
# Enforce recommended preprocessor indentation style.
sc_preprocessor_indentation:
500
	@if cppi --version >/dev/null 2>&1; then			\
501
	  $(VC_LIST_EXCEPT) | grep '\.[ch]$$' | xargs cppi -a -c	\
502 503 504 505 506 507
	    || { echo '$(ME): incorrect preprocessor indentation' 1>&2;	\
		exit 1; };						\
	else								\
	  echo '$(ME): skipping test $@: cppi not installed' 1>&2;	\
	fi

508
sc_copyright_format:
E
Eric Blake 已提交
509 510 511
	@require='Copyright .*Red 'Hat', Inc\.'				\
	containing='Copyright .*Red 'Hat				\
	halt='Red Hat copyright is missing Inc.'			\
512
	  $(_sc_search_regexp)
E
Eric Blake 已提交
513 514
	@prohibit='Copyright [^(].*Red 'Hat				\
	halt='consistently use (C) in Red Hat copyright'		\
515 516 517 518 519
	  $(_sc_search_regexp)

# Some functions/macros produce messages intended solely for developers
# and maintainers.  Do not mark them for translation.
sc_prohibit_gettext_markup:
520
	@prohibit='\<VIR_(WARN|DEBUG)0? *\(_\('				\
521 522
	halt='do not mark these strings for translation'		\
	  $(_sc_search_regexp)
523

524 525
# We don't use this feature of maint.mk.
prev_version_file = /dev/null
526 527 528

ifeq (0,$(MAKELEVEL))
  _curr_status = .git-module-status
529 530 531 532 533 534
  # 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)
535 536 537
  # $ cat .git-module-status
  # b653eda3ac4864de205419d9f41eec267cb89eeb
  _submodule_hash = sed 's/^[ +-]//;s/ .*//'
538
  _update_required := $(shell						\
539
      cd '$(srcdir)';							\
540
      test -d .git || { echo 0; exit; };				\
541
      test -f po/Makevars || { echo 1; exit; };				\
542
      actual=$$(git submodule status | $(_submodule_hash);		\
543 544
		git hash-object bootstrap.conf;				\
		git diff .gnulib);					\
545 546
      stamp="$$($(_submodule_hash) $(_curr_status) 2>/dev/null)";	\
      test "$$stamp" = "$$actual"; echo $$?)
547 548
  _clean_requested = $(filter %clean,$(MAKECMDGOALS))
  ifeq (1,$(_update_required)$(_clean_requested))
549 550
    $(info INFO: gnulib update required; running ./autogen.sh first)
Makefile: _autogen
551 552
  endif
endif
553

554 555 556 557 558 559 560
# 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'); \
561
	  grep -iq "<$$sanitized>" $(srcdir)/AUTHORS			\
562 563 564 565 566 567
	    || { printf '%s\n' "$$i" >&2; fail=1; };			\
	done;								\
	test $$fail = 1							\
	  && echo '$(ME): committer(s) not listed in AUTHORS' >&2;	\
	test $$fail = 0

568 569
# It is necessary to call autogen any time gnulib changes.  Autogen
# reruns configure, then we regenerate all Makefiles at once.
570 571 572
.PHONY: _autogen
_autogen:
	$(srcdir)/autogen.sh
573
	./config.status
574

575 576
# Exempt @...@ uses of these symbols.
_makefile_at_at_check_exceptions = ' && !/(SCHEMA|SYSCONF)DIR/'
577 578 579

# regenerate HACKING as part of the syntax-check
syntax-check: $(top_srcdir)/HACKING
580 581

# List all syntax-check exemptions:
582 583
exclude_file_name_regexp--sc_avoid_strcase = ^tools/virsh\.c$$

584 585 586 587 588 589
_src1=libvirt|fdstream|qemu/qemu_monitor|util/(command|util)|xen/xend_internal
exclude_file_name_regexp--sc_avoid_write = \
  ^(src/($(_src1))|daemon/libvirtd|tools/console)\.c$$

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

590 591 592
exclude_file_name_regexp--sc_libvirt_unmarked_diagnostics = \
  ^daemon/remote_generator\.pl$$

593
exclude_file_name_regexp--sc_po_check = ^(docs/|daemon/remote_generator\.pl$$)
594 595 596 597

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

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

600 601 602 603
exclude_file_name_regexp--sc_prohibit_always_true_header_tests = \
  (^docs|^python/(libvirt-override|typewrappers)\.c$$)

exclude_file_name_regexp--sc_prohibit_asprintf = \
604
  ^(bootstrap.conf$$|po/|src/util/util\.c$$|examples/domain-events/events-c/event-test\.c$$)
605

E
Eric Blake 已提交
606 607
exclude_file_name_regexp--sc_prohibit_can_not = ^po/

608 609 610
exclude_file_name_regexp--sc_prohibit_close = \
  (\.py$$|^docs/|(src/util/files\.c|src/libvirt\.c)$$)

E
Eric Blake 已提交
611 612
exclude_file_name_regexp--sc_prohibit_doubled_word = ^po/

613
exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = \
614
  (^docs/api_extension/|^tests/qemuhelpdata/|\.(gif|ico|png)$$)
615 616 617 618 619 620 621 622 623

_src2=src/(util/util|libvirt|lxc/lxc_controller)
exclude_file_name_regexp--sc_prohibit_fork_wrappers = \
  (^docs|^($(_src2)|tests/testutils|daemon/libvirtd)\.c$$)

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

exclude_file_name_regexp--sc_prohibit_gettext_noop = ^docs/

624 625 626
exclude_file_name_regexp--sc_prohibit_newline_at_end_of_diagnostic = \
  ^daemon/remote_generator\.pl$$

627 628 629 630 631 632 633 634 635 636 637 638
exclude_file_name_regexp--sc_prohibit_nonreentrant = \
  ^((po|docs|tests)/|tools/(virsh|console)\.c$$)

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

exclude_file_name_regexp--sc_prohibit_sprintf = ^(docs/|HACKING$$)

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

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

639
exclude_file_name_regexp--sc_require_config_h = ^examples/
640

641
exclude_file_name_regexp--sc_require_config_h_first = ^examples/
642 643 644 645 646

exclude_file_name_regexp--sc_trailing_blank = (^docs/|\.(fig|gif|ico|png)$$)

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