1# -*-Makefile-*- 2# This Makefile fragment tries to be general-purpose enough to be 3# used by many projects via the gnulib maintainer-makefile module. 4 5## Copyright (C) 2001-2014 Free Software Foundation, Inc. 6## 7## This program is free software: you can redistribute it and/or modify 8## it under the terms of the GNU General Public License as published by 9## the Free Software Foundation, either version 3 of the License, or 10## (at your option) any later version. 11## 12## This program is distributed in the hope that it will be useful, 13## but WITHOUT ANY WARRANTY; without even the implied warranty of 14## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15## GNU General Public License for more details. 16## 17## You should have received a copy of the GNU General Public License 18## along with this program. If not, see <http://www.gnu.org/licenses/>. 19 20# This is reported not to work with make-3.79.1 21# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) 22ME := maint.mk 23 24# Helper variables. 25_empty = 26_sp = $(_empty) $(_empty) 27 28# _equal,S1,S2 29# ------------ 30# If S1 == S2, return S1, otherwise the empty string. 31_equal = $(and $(findstring $(1),$(2)),$(findstring $(2),$(1))) 32 33# member-check,VARIABLE,VALID-VALUES 34# ---------------------------------- 35# Check that $(VARIABLE) is in the space-separated list of VALID-VALUES, and 36# return it. Die otherwise. 37member-check = \ 38 $(strip \ 39 $(if $($(1)), \ 40 $(if $(findstring $(_sp),$($(1))), \ 41 $(error invalid $(1): '$($(1))', expected $(2)), \ 42 $(or $(findstring $(_sp)$($(1))$(_sp),$(_sp)$(2)$(_sp)), \ 43 $(error invalid $(1): '$($(1))', expected $(2)))), \ 44 $(error $(1) undefined))) 45 46# Do not save the original name or timestamp in the .tar.gz file. 47# Use --rsyncable if available. 48gzip_rsyncable := \ 49 $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null \ 50 && printf %s --rsyncable) 51GZIP_ENV = '--no-name --best $(gzip_rsyncable)' 52 53GIT = git 54VC = $(GIT) 55 56VC_LIST = $(srcdir)/$(_build-aux)/vc-list-files -C $(srcdir) 57 58# You can override this variable in cfg.mk to set your own regexp 59# matching files to ignore. 60VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$ 61 62# This is to preprocess robustly the output of $(VC_LIST), so that even 63# when $(srcdir) is a pathological name like "....", the leading sed command 64# removes only the intended prefix. 65_dot_escaped_srcdir = $(subst .,\.,$(srcdir)) 66 67# Post-process $(VC_LIST) output, prepending $(srcdir)/, but only 68# when $(srcdir) is not ".". 69ifeq ($(srcdir),.) 70 _prepend_srcdir_prefix = 71else 72 _prepend_srcdir_prefix = | $(SED) 's|^|$(srcdir)/|' 73endif 74 75# In order to be able to consistently filter "."-relative names, 76# (i.e., with no $(srcdir) prefix), this definition is careful to 77# remove any $(srcdir) prefix, and to restore what it removes. 78_sc_excl = \ 79 $(or $(exclude_file_name_regexp--$@),^$$) 80VC_LIST_EXCEPT = \ 81 $(VC_LIST) | $(SED) 's|^$(_dot_escaped_srcdir)/||' \ 82 | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \ 83 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \ 84 | grep -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \ 85 $(_prepend_srcdir_prefix) 86 87ifeq ($(origin prev_version_file), undefined) 88 prev_version_file = $(srcdir)/.prev-version 89endif 90 91PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null) 92VERSION_REGEXP = $(subst .,\.,$(VERSION)) 93PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION)) 94 95ifeq ($(VC),$(GIT)) 96 this-vc-tag = v$(VERSION) 97 this-vc-tag-regexp = v$(VERSION_REGEXP) 98else 99 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]') 100 tag-this-version = $(subst .,_,$(VERSION)) 101 this-vc-tag = $(tag-package)-$(tag-this-version) 102 this-vc-tag-regexp = $(this-vc-tag) 103endif 104my_distdir = $(PACKAGE)-$(VERSION) 105 106# Old releases are stored here. 107release_archive_dir ?= ../release 108 109# If RELEASE_TYPE is undefined, but RELEASE is, use its second word. 110# But overwrite VERSION. 111ifdef RELEASE 112 VERSION := $(word 1, $(RELEASE)) 113 RELEASE_TYPE ?= $(word 2, $(RELEASE)) 114endif 115 116# Validate and return $(RELEASE_TYPE), or die. 117RELEASE_TYPES = alpha beta stable 118release-type = $(call member-check,RELEASE_TYPE,$(RELEASE_TYPES)) 119 120# Override gnu_rel_host and url_dir_list in cfg.mk if these are not right. 121# Use alpha.gnu.org for alpha and beta releases. 122# Use ftp.gnu.org for stable releases. 123gnu_ftp_host-alpha = alpha.gnu.org 124gnu_ftp_host-beta = alpha.gnu.org 125gnu_ftp_host-stable = ftp.gnu.org 126gnu_rel_host ?= $(gnu_ftp_host-$(release-type)) 127 128url_dir_list ?= $(if $(call _equal,$(gnu_rel_host),ftp.gnu.org), \ 129 http://ftpmirror.gnu.org/$(PACKAGE), \ 130 ftp://$(gnu_rel_host)/gnu/$(PACKAGE)) 131 132# Override this in cfg.mk if you are using a different format in your 133# NEWS file. 134today = $(shell date +%Y-%m-%d) 135 136# Select which lines of NEWS are searched for $(news-check-regexp). 137# This is a sed line number spec. The default says that we search 138# lines 1..10 of NEWS for $(news-check-regexp). 139# If you want to search only line 3 or only lines 20-22, use "3" or "20,22". 140news-check-lines-spec ?= 1,10 141news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)' 142 143# Prevent programs like 'sort' from considering distinct strings to be equal. 144# Doing it here saves us from having to set LC_ALL elsewhere in this file. 145export LC_ALL = C 146 147## --------------- ## 148## Sanity checks. ## 149## --------------- ## 150 151ifneq ($(_gl-Makefile),) 152_cfg_mk := $(wildcard $(srcdir)/cfg.mk) 153 154# Collect the names of rules starting with 'sc_'. 155syntax-check-rules := $(sort $(shell $(SED) -n \ 156 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' $(srcdir)/$(ME) $(_cfg_mk))) 157.PHONY: $(syntax-check-rules) 158 159ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0) 160 local-checks-available += $(syntax-check-rules) 161else 162 local-checks-available += no-vc-detected 163no-vc-detected: 164 @echo "No version control files detected; skipping syntax check" 165endif 166.PHONY: $(local-checks-available) 167 168# Arrange to print the name of each syntax-checking rule just before running it. 169$(syntax-check-rules): %: %.m 170sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules)) 171.PHONY: $(sc_m_rules_) 172$(sc_m_rules_): 173 @echo $(patsubst sc_%.m, %, $@) 174 @date +%s.%N > .sc-start-$(basename $@) 175 176# Compute and print the elapsed time for each syntax-check rule. 177sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules)) 178.PHONY: $(sc_z_rules_) 179$(sc_z_rules_): %.z: % 180 @end=$$(date +%s.%N); \ 181 start=$$(cat .sc-start-$*); \ 182 rm -f .sc-start-$*; \ 183 awk -v s=$$start -v e=$$end \ 184 'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null 185 186# The patsubst here is to replace each sc_% rule with its sc_%.z wrapper 187# that computes and prints elapsed time. 188local-check := \ 189 $(patsubst sc_%, sc_%.z, \ 190 $(filter-out $(local-checks-to-skip), $(local-checks-available))) 191 192syntax-check: $(local-check) 193endif 194 195# _sc_search_regexp 196# 197# This macro searches for a given construct in the selected files and 198# then takes some action. 199# 200# Parameters (shell variables): 201# 202# prohibit | require 203# 204# Regular expression (ERE) denoting either a forbidden construct 205# or a required construct. Those arguments are exclusive. 206# 207# exclude 208# 209# Regular expression (ERE) denoting lines to ignore that matched 210# a prohibit construct. For example, this can be used to exclude 211# comments that mention why the nearby code uses an alternative 212# construct instead of the simpler prohibited construct. 213# 214# in_vc_files | in_files 215# 216# grep-E-style regexp selecting the files to check. For in_vc_files, 217# the regexp is used to select matching files from the list of all 218# version-controlled files; for in_files, it's from the names printed 219# by "find $(srcdir)". When neither is specified, use all files that 220# are under version control. 221# 222# containing | non_containing 223# 224# Select the files (non) containing strings matching this regexp. 225# If both arguments are specified then CONTAINING takes 226# precedence. 227# 228# with_grep_options 229# 230# Extra options for grep. 231# 232# ignore_case 233# 234# Ignore case. 235# 236# halt 237# 238# Message to display before to halting execution. 239# 240# Finally, you may exempt files based on an ERE matching file names. 241# For example, to exempt from the sc_space_tab check all files with the 242# .diff suffix, set this Make variable: 243# 244# exclude_file_name_regexp--sc_space_tab = \.diff$ 245# 246# Note that while this functionality is mostly inherited via VC_LIST_EXCEPT, 247# when filtering by name via in_files, we explicitly filter out matching 248# names here as well. 249 250# Initialize each, so that envvar settings cannot interfere. 251export require = 252export prohibit = 253export exclude = 254export in_vc_files = 255export in_files = 256export containing = 257export non_containing = 258export halt = 259export with_grep_options = 260 261# By default, _sc_search_regexp does not ignore case. 262export ignore_case = 263_ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :) 264 265define _sc_say_and_exit 266 dummy=; : so we do not need a semicolon before each use; \ 267 { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; }; 268endef 269 270define _sc_search_regexp 271 dummy=; : so we do not need a semicolon before each use; \ 272 \ 273 : Check arguments; \ 274 test -n "$$prohibit" && test -n "$$require" \ 275 && { msg='Cannot specify both prohibit and require' \ 276 $(_sc_say_and_exit) } || :; \ 277 test -z "$$prohibit" && test -z "$$require" \ 278 && { msg='Should specify either prohibit or require' \ 279 $(_sc_say_and_exit) } || :; \ 280 test -z "$$prohibit" && test -n "$$exclude" \ 281 && { msg='Use of exclude requires a prohibit pattern' \ 282 $(_sc_say_and_exit) } || :; \ 283 test -n "$$in_vc_files" && test -n "$$in_files" \ 284 && { msg='Cannot specify both in_vc_files and in_files' \ 285 $(_sc_say_and_exit) } || :; \ 286 test "x$$halt" != x \ 287 || { msg='halt not defined' $(_sc_say_and_exit) }; \ 288 \ 289 : Filter by file name; \ 290 if test -n "$$in_files"; then \ 291 files=$$(find $(srcdir) | grep -E "$$in_files" \ 292 | grep -Ev '$(_sc_excl)'); \ 293 else \ 294 files=$$($(VC_LIST_EXCEPT)); \ 295 if test -n "$$in_vc_files"; then \ 296 files=$$(echo "$$files" | grep -E "$$in_vc_files"); \ 297 fi; \ 298 fi; \ 299 \ 300 : Filter by content; \ 301 test -n "$$files" && test -n "$$containing" \ 302 && { files=$$(grep -l "$$containing" $$files); } || :; \ 303 test -n "$$files" && test -n "$$non_containing" \ 304 && { files=$$(grep -vl "$$non_containing" $$files); } || :; \ 305 \ 306 : Check for the construct; \ 307 if test -n "$$files"; then \ 308 if test -n "$$prohibit"; then \ 309 grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \ 310 | grep -vE "$${exclude:-^$$}" \ 311 && { msg="$$halt" $(_sc_say_and_exit) } || :; \ 312 else \ 313 grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \ 314 | grep . \ 315 && { msg="$$halt" $(_sc_say_and_exit) } || :; \ 316 fi \ 317 else :; \ 318 fi || :; 319endef 320 321sc_avoid_if_before_free: 322 @$(srcdir)/$(_build-aux)/useless-if-before-free \ 323 $(useless_free_options) \ 324 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \ 325 { echo '$(ME): found useless "if" before "free" above' 1>&2; \ 326 exit 1; } || : 327 328sc_cast_of_argument_to_free: 329 @prohibit='\<free *\( *\(' halt="don't cast free argument" \ 330 $(_sc_search_regexp) 331 332sc_cast_of_x_alloc_return_value: 333 @prohibit='\*\) *x(m|c|re)alloc\>' \ 334 halt="don't cast x*alloc return value" \ 335 $(_sc_search_regexp) 336 337sc_cast_of_alloca_return_value: 338 @prohibit='\*\) *alloca\>' \ 339 halt="don't cast alloca return value" \ 340 $(_sc_search_regexp) 341 342sc_space_tab: 343 @prohibit='[ ] ' \ 344 halt='found SPACE-TAB sequence; remove the SPACE' \ 345 $(_sc_search_regexp) 346 347# Don't use *scanf or the old ato* functions in "real" code. 348# They provide no error checking mechanism. 349# Instead, use strto* functions. 350sc_prohibit_atoi_atof: 351 @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \ 352 halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \ 353 $(_sc_search_regexp) 354 355# Use STREQ rather than comparing strcmp == 0, or != 0. 356sp_ = strcmp *\(.+\) 357sc_prohibit_strcmp: 358 @prohibit='! *strcmp *\(|\<$(sp_) *[!=]=|[!=]= *$(sp_)' \ 359 exclude='# *define STRN?EQ\(' \ 360 halt='replace strcmp calls above with STREQ/STRNEQ' \ 361 $(_sc_search_regexp) 362 363# Really. You don't want to use this function. 364# It may fail to NUL-terminate the destination, 365# and always NUL-pads out to the specified length. 366sc_prohibit_strncpy: 367 @prohibit='\<strncpy *\(' \ 368 halt='do not use strncpy, period' \ 369 $(_sc_search_regexp) 370 371# Pass EXIT_*, not number, to usage, exit, and error (when exiting) 372# Convert all uses automatically, via these two commands: 373# git grep -l '\<exit *(1)' \ 374# | grep -vEf .x-sc_prohibit_magic_number_exit \ 375# | xargs --no-run-if-empty \ 376# perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/' 377# git grep -l '\<exit *(0)' \ 378# | grep -vEf .x-sc_prohibit_magic_number_exit \ 379# | xargs --no-run-if-empty \ 380# perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/' 381sc_prohibit_magic_number_exit: 382 @prohibit='(^|[^.])\<(usage|exit|error) ?\(-?[0-9]+[,)]' \ 383 exclude='exit \(77\)|error ?\(((0|77),|[^,]*)' \ 384 halt='use EXIT_* values rather than magic number' \ 385 $(_sc_search_regexp) 386 387# Using EXIT_SUCCESS as the first argument to error is misleading, 388# since when that parameter is 0, error does not exit. Use '0' instead. 389sc_error_exit_success: 390 @prohibit='error *\(EXIT_SUCCESS,' \ 391 in_vc_files='\.[chly]$$' \ 392 halt='found error (EXIT_SUCCESS' \ 393 $(_sc_search_regexp) 394 395# "FATAL:" should be fully upper-cased in error messages 396# "WARNING:" should be fully upper-cased, or fully lower-cased 397sc_error_message_warn_fatal: 398 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 399 | grep -E '"Warning|"Fatal|"fatal' && \ 400 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \ 401 exit 1; } || : 402 403# Error messages should not start with a capital letter 404sc_error_message_uppercase: 405 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 406 | grep -E '"[A-Z]' \ 407 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \ 408 { echo '$(ME): found capitalized error message' 1>&2; \ 409 exit 1; } || : 410 411# Error messages should not end with a period 412sc_error_message_period: 413 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 414 | grep -E '[^."]\."' && \ 415 { echo '$(ME): found error message ending in period' 1>&2; \ 416 exit 1; } || : 417 418sc_file_system: 419 @prohibit=file''system \ 420 ignore_case=1 \ 421 halt='found use of "file''system"; spell it "file system"' \ 422 $(_sc_search_regexp) 423 424# Don't use cpp tests of this symbol. All code assumes config.h is included. 425sc_prohibit_have_config_h: 426 @prohibit='^# *if.*HAVE''_CONFIG_H' \ 427 halt='found use of HAVE''_CONFIG_H; remove' \ 428 $(_sc_search_regexp) 429 430# Nearly all .c files must include <config.h>. However, we also permit this 431# via inclusion of a package-specific header, if cfg.mk specified one. 432# config_h_header must be suitable for grep -E. 433config_h_header ?= <config\.h> 434sc_require_config_h: 435 @require='^# *include $(config_h_header)' \ 436 in_vc_files='\.c$$' \ 437 halt='the above files do not include <config.h>' \ 438 $(_sc_search_regexp) 439 440# You must include <config.h> before including any other header file. 441# This can possibly be via a package-specific header, if given by cfg.mk. 442sc_require_config_h_first: 443 @if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \ 444 fail=0; \ 445 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \ 446 grep '^# *include\>' $$i | $(SED) 1q \ 447 | grep -E '^# *include $(config_h_header)' > /dev/null \ 448 || { echo $$i; fail=1; }; \ 449 done; \ 450 test $$fail = 1 && \ 451 { echo '$(ME): the above files include some other header' \ 452 'before <config.h>' 1>&2; exit 1; } || :; \ 453 else :; \ 454 fi 455 456sc_prohibit_HAVE_MBRTOWC: 457 @prohibit='\bHAVE_MBRTOWC\b' \ 458 halt="do not use $$prohibit; it is always defined" \ 459 $(_sc_search_regexp) 460 461# To use this "command" macro, you must first define two shell variables: 462# h: the header name, with no enclosing <> or "" 463# re: a regular expression that matches IFF something provided by $h is used. 464define _sc_header_without_use 465 dummy=; : so we do not need a semicolon before each use; \ 466 h_esc=`echo '[<"]'"$$h"'[">]'|$(SED) 's/\./\\\\./g'`; \ 467 if $(VC_LIST_EXCEPT) | grep '\.c$$' > /dev/null; then \ 468 files=$$(grep -l '^# *include '"$$h_esc" \ 469 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \ 470 grep -LE "$$re" $$files | grep . && \ 471 { echo "$(ME): the above files include $$h but don't use it" \ 472 1>&2; exit 1; } || :; \ 473 else :; \ 474 fi 475endef 476 477# Prohibit the inclusion of assert.h without an actual use of assert. 478sc_prohibit_assert_without_use: 479 @h='assert.h' re='\<assert *\(' $(_sc_header_without_use) 480 481# Prohibit the inclusion of close-stream.h without an actual use. 482sc_prohibit_close_stream_without_use: 483 @h='close-stream.h' re='\<close_stream *\(' $(_sc_header_without_use) 484 485# Prohibit the inclusion of getopt.h without an actual use. 486sc_prohibit_getopt_without_use: 487 @h='getopt.h' re='\<getopt(_long)? *\(' $(_sc_header_without_use) 488 489# Don't include quotearg.h unless you use one of its functions. 490sc_prohibit_quotearg_without_use: 491 @h='quotearg.h' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use) 492 493# Don't include quote.h unless you use one of its functions. 494sc_prohibit_quote_without_use: 495 @h='quote.h' re='\<quote((_n)? *\(|_quoting_options\>)' \ 496 $(_sc_header_without_use) 497 498# Don't include this header unless you use one of its functions. 499sc_prohibit_long_options_without_use: 500 @h='long-options.h' re='\<parse_long_options *\(' \ 501 $(_sc_header_without_use) 502 503# Don't include this header unless you use one of its functions. 504sc_prohibit_inttostr_without_use: 505 @h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \ 506 $(_sc_header_without_use) 507 508# Don't include this header unless you use one of its functions. 509sc_prohibit_ignore_value_without_use: 510 @h='ignore-value.h' re='\<ignore_(value|ptr) *\(' \ 511 $(_sc_header_without_use) 512 513# Don't include this header unless you use one of its functions. 514sc_prohibit_error_without_use: 515 @h='error.h' \ 516 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\ 517 $(_sc_header_without_use) 518 519# Don't include xalloc.h unless you use one of its functions. 520# Consider these symbols: 521# perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__'; 522# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h 523# Divide into two sets on case, and filter each through this: 524# | sort | perl -MRegexp::Assemble -le \ 525# 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g' 526# Note this was produced by the above: 527# _xa1 = \ 528#x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup) 529# But we can do better, in at least two ways: 530# 1) take advantage of two "dup"-suffixed strings: 531# x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup) 532# 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable 533# "char|[cmz]" 534# x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) 535_xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) 536_xa2 = X([CZ]|N?M)ALLOC 537sc_prohibit_xalloc_without_use: 538 @h='xalloc.h' \ 539 re='\<($(_xa1)|$(_xa2)) *\('\ 540 $(_sc_header_without_use) 541 542# Extract function names: 543# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h 544_hash_re = \ 545clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning 546_hash_fn = \<($(_hash_re)) *\( 547_hash_struct = (struct )?\<[Hh]ash_(table|tuning)\> 548sc_prohibit_hash_without_use: 549 @h='hash.h' \ 550 re='$(_hash_fn)|$(_hash_struct)'\ 551 $(_sc_header_without_use) 552 553sc_prohibit_cloexec_without_use: 554 @h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \ 555 $(_sc_header_without_use) 556 557sc_prohibit_posixver_without_use: 558 @h='posixver.h' re='\<posix2_version *\(' $(_sc_header_without_use) 559 560sc_prohibit_same_without_use: 561 @h='same.h' re='\<same_name *\(' $(_sc_header_without_use) 562 563sc_prohibit_hash_pjw_without_use: 564 @h='hash-pjw.h' \ 565 re='\<hash_pjw\>' \ 566 $(_sc_header_without_use) 567 568sc_prohibit_safe_read_without_use: 569 @h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \ 570 $(_sc_header_without_use) 571 572sc_prohibit_argmatch_without_use: 573 @h='argmatch.h' \ 574 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \ 575 $(_sc_header_without_use) 576 577sc_prohibit_canonicalize_without_use: 578 @h='canonicalize.h' \ 579 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode|file_name)' \ 580 $(_sc_header_without_use) 581 582sc_prohibit_root_dev_ino_without_use: 583 @h='root-dev-ino.h' \ 584 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \ 585 $(_sc_header_without_use) 586 587sc_prohibit_openat_without_use: 588 @h='openat.h' \ 589 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat|(FCHMOD|FCHOWN|STAT)AT_INLINE)\>' \ 590 $(_sc_header_without_use) 591 592# Prohibit the inclusion of c-ctype.h without an actual use. 593ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\ 594|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper 595sc_prohibit_c_ctype_without_use: 596 @h='c-ctype.h' re='\<c_($(ctype_re)) *\(' \ 597 $(_sc_header_without_use) 598 599# The following list was generated by running: 600# man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \ 601# | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt 602_sig_functions = \ 603 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \ 604 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \ 605 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \ 606 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo 607_sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions))) 608# The following were extracted from "man signal.h" manually. 609_sig_types_and_consts = \ 610 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \ 611 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \ 612 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \ 613 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \ 614 sigstack sigval stack_t ucontext_t 615# generated via this: 616# perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70 617_sig_names = \ 618 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \ 619 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \ 620 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \ 621 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \ 622 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \ 623 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \ 624 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \ 625 SIGXCPU SIGXFSZ 626_sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts))) 627 628# Prohibit the inclusion of signal.h without an actual use. 629sc_prohibit_signal_without_use: 630 @h='signal.h' \ 631 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \ 632 $(_sc_header_without_use) 633 634# Don't include stdio--.h unless you use one of its functions. 635sc_prohibit_stdio--_without_use: 636 @h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\(' \ 637 $(_sc_header_without_use) 638 639# Don't include stdio-safer.h unless you use one of its functions. 640sc_prohibit_stdio-safer_without_use: 641 @h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\(' \ 642 $(_sc_header_without_use) 643 644# Prohibit the inclusion of strings.h without a sensible use. 645# Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible. 646sc_prohibit_strings_without_use: 647 @h='strings.h' \ 648 re='\<(strn?casecmp|ffs(ll)?)\>' \ 649 $(_sc_header_without_use) 650 651# Get the list of symbol names with this: 652# perl -lne '/^# *define ([A-Z]\w+)\(/ and print $1' lib/intprops.h|fmt 653_intprops_names = \ 654 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \ 655 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \ 656 INT_BITS_STRLEN_BOUND INT_STRLEN_BOUND INT_BUFSIZE_BOUND \ 657 INT_ADD_RANGE_OVERFLOW INT_SUBTRACT_RANGE_OVERFLOW \ 658 INT_NEGATE_RANGE_OVERFLOW INT_MULTIPLY_RANGE_OVERFLOW \ 659 INT_DIVIDE_RANGE_OVERFLOW INT_REMAINDER_RANGE_OVERFLOW \ 660 INT_LEFT_SHIFT_RANGE_OVERFLOW INT_ADD_OVERFLOW INT_SUBTRACT_OVERFLOW \ 661 INT_NEGATE_OVERFLOW INT_MULTIPLY_OVERFLOW INT_DIVIDE_OVERFLOW \ 662 INT_REMAINDER_OVERFLOW INT_LEFT_SHIFT_OVERFLOW 663_intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names))) 664# Prohibit the inclusion of intprops.h without an actual use. 665sc_prohibit_intprops_without_use: 666 @h='intprops.h' \ 667 re='\<($(_intprops_syms_re)) *\(' \ 668 $(_sc_header_without_use) 669 670_stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t 671# Prohibit the inclusion of stddef.h without an actual use. 672sc_prohibit_stddef_without_use: 673 @h='stddef.h' \ 674 re='\<($(_stddef_syms_re))\>' \ 675 $(_sc_header_without_use) 676 677_de1 = dirfd|(close|(fd)?open|read|rewind|seek|tell)dir(64)?(_r)? 678_de2 = (versionsort|struct dirent|getdirentries|alphasort|scandir(at)?)(64)? 679_de3 = MAXNAMLEN|DIR|ino_t|d_ino|d_fileno|d_namlen 680_dirent_syms_re = $(_de1)|$(_de2)|$(_de3) 681# Prohibit the inclusion of dirent.h without an actual use. 682sc_prohibit_dirent_without_use: 683 @h='dirent.h' \ 684 re='\<($(_dirent_syms_re))\>' \ 685 $(_sc_header_without_use) 686 687# Prohibit the inclusion of verify.h without an actual use. 688sc_prohibit_verify_without_use: 689 @h='verify.h' \ 690 re='\<(verify(true|expr)?|static_assert) *\(' \ 691 $(_sc_header_without_use) 692 693# Don't include xfreopen.h unless you use one of its functions. 694sc_prohibit_xfreopen_without_use: 695 @h='xfreopen.h' re='\<xfreopen *\(' $(_sc_header_without_use) 696 697sc_obsolete_symbols: 698 @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \ 699 halt='do not use HAVE''_FCNTL_H or O'_NDELAY \ 700 $(_sc_search_regexp) 701 702# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ 703 704# Each nonempty ChangeLog line must start with a year number, or a TAB. 705sc_changelog: 706 @prohibit='^[^12 ]' \ 707 in_vc_files='^ChangeLog$$' \ 708 halt='found unexpected prefix in a ChangeLog' \ 709 $(_sc_search_regexp) 710 711# Ensure that each .c file containing a "main" function also 712# calls set_program_name. 713sc_program_name: 714 @require='set_program_name *\(.*\);' \ 715 in_vc_files='\.c$$' \ 716 containing='\<main *(' \ 717 halt='the above files do not call set_program_name' \ 718 $(_sc_search_regexp) 719 720# Ensure that each .c file containing a "main" function also 721# calls bindtextdomain. 722sc_bindtextdomain: 723 @require='bindtextdomain *\(' \ 724 in_vc_files='\.c$$' \ 725 containing='\<main *(' \ 726 halt='the above files do not call bindtextdomain' \ 727 $(_sc_search_regexp) 728 729# Require that the final line of each test-lib.sh-using test be this one: 730# Exit $fail 731# Note: this test requires GNU grep's --label= option. 732Exit_witness_file ?= tests/test-lib.sh 733Exit_base := $(notdir $(Exit_witness_file)) 734sc_require_test_exit_idiom: 735 @if test -f $(srcdir)/$(Exit_witness_file); then \ 736 die=0; \ 737 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \ 738 $$($(VC_LIST) tests)); do \ 739 tail -n1 $$i | grep '^Exit .' > /dev/null \ 740 && : || { die=1; echo $$i; } \ 741 done; \ 742 test $$die = 1 && \ 743 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \ 744 echo 1>&2 'Exit something'; \ 745 exit 1; } || :; \ 746 fi 747 748sc_trailing_blank: 749 @prohibit='[ ]$$' \ 750 halt='found trailing blank(s)' \ 751 exclude='^Binary file .* matches$$' \ 752 $(_sc_search_regexp) 753 754# Match lines like the following, but where there is only one space 755# between the options and the description: 756# -D, --all-repeated[=delimit-method] print all duplicate lines\n 757longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)? 758sc_two_space_separator_in_usage: 759 @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \ 760 halt='help2man requires at least two spaces between an option and its description'\ 761 $(_sc_search_regexp) 762 763# A regexp matching function names like "error" that may be used 764# to emit translatable messages. 765_gl_translatable_diag_func_re ?= error 766 767# Look for diagnostics that aren't marked for translation. 768# This won't find any for which error's format string is on a separate line. 769sc_unmarked_diagnostics: 770 @prohibit='\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \ 771 exclude='(_|ngettext ?)\(' \ 772 halt='found unmarked diagnostic(s)' \ 773 $(_sc_search_regexp) 774 775# Avoid useless parentheses like those in this example: 776# #if defined (SYMBOL) || defined (SYM2) 777sc_useless_cpp_parens: 778 @prohibit='^# *if .*defined *\(' \ 779 halt='found useless parentheses in cpp directive' \ 780 $(_sc_search_regexp) 781 782# List headers for which HAVE_HEADER_H is always true, assuming you are 783# using the appropriate gnulib module. CAUTION: for each "unnecessary" 784# #if HAVE_HEADER_H that you remove, be sure that your project explicitly 785# requires the gnulib module that guarantees the usability of that header. 786gl_assured_headers_ = \ 787 cd $(gnulib_dir)/lib && echo *.in.h|$(SED) 's/\.in\.h//g' 788 789# Convert the list of names to upper case, and replace each space with "|". 790az_ = abcdefghijklmnopqrstuvwxyz 791AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ 792gl_header_upper_case_or_ = \ 793 $$($(gl_assured_headers_) \ 794 | tr $(az_)/.- $(AZ_)___ \ 795 | tr -s ' ' '|' \ 796 ) 797sc_prohibit_always_true_header_tests: 798 @or=$(gl_header_upper_case_or_); \ 799 re="HAVE_($$or)_H"; \ 800 prohibit='\<'"$$re"'\>' \ 801 halt=$$(printf '%s\n' \ 802 'do not test the above HAVE_<header>_H symbol(s);' \ 803 ' with the corresponding gnulib module, they are always true') \ 804 $(_sc_search_regexp) 805 806sc_prohibit_defined_have_decl_tests: 807 @prohibit='(#[ ]*ifn?def|\<defined)\>[ (]+HAVE_DECL_' \ 808 halt='HAVE_DECL macros are always defined' \ 809 $(_sc_search_regexp) 810 811# ================================================================== 812gl_other_headers_ ?= \ 813 intprops.h \ 814 openat.h \ 815 stat-macros.h 816 817# Perl -lne code to extract "significant" cpp-defined symbols from a 818# gnulib header file, eliminating a few common false-positives. 819# The exempted names below are defined only conditionally in gnulib, 820# and hence sometimes must/may be defined in application code. 821gl_extract_significant_defines_ = \ 822 /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\ 823 && $$2 !~ /(?:rpl_|_used_without_)/\ 824 && $$1 !~ /^(?:NSIG|ENODATA)$$/\ 825 && $$1 !~ /^(?:SA_RESETHAND|SA_RESTART)$$/\ 826 and print $$1 827 828# Create a list of regular expressions matching the names 829# of macros that are guaranteed to be defined by parts of gnulib. 830define def_sym_regex 831 gen_h=$(gl_generated_headers_); \ 832 (cd $(gnulib_dir)/lib; \ 833 for f in *.in.h $(gl_other_headers_); do \ 834 test -f $$f \ 835 && perl -lne '$(gl_extract_significant_defines_)' $$f; \ 836 done; \ 837 ) | sort -u \ 838 | $(SED) 's/^/^ *# *(define|undef) */;s/$$/\\>/' 839endef 840 841# Don't define macros that we already get from gnulib header files. 842sc_prohibit_always-defined_macros: 843 @if test -d $(gnulib_dir); then \ 844 case $$(echo all: | grep -l -f - Makefile) in Makefile);; *) \ 845 echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \ 846 esac; \ 847 $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT)) \ 848 && { echo '$(ME): define the above via some gnulib .h file' \ 849 1>&2; exit 1; } || :; \ 850 fi 851# ================================================================== 852 853# Prohibit checked in backup files. 854sc_prohibit_backup_files: 855 @$(VC_LIST) | grep '~$$' && \ 856 { echo '$(ME): found version controlled backup file' 1>&2; \ 857 exit 1; } || : 858 859# Require the latest GPL. 860sc_GPL_version: 861 @prohibit='either ''version [^3]' \ 862 halt='GPL vN, N!=3' \ 863 $(_sc_search_regexp) 864 865# Require the latest GFDL. Two regexp, since some .texi files end up 866# line wrapping between 'Free Documentation License,' and 'Version'. 867_GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any) 868sc_GFDL_version: 869 @prohibit='$(_GFDL_regexp)' \ 870 halt='GFDL vN, N!=3' \ 871 $(_sc_search_regexp) 872 873# Don't use Texinfo's @acronym{}. 874# http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html 875texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$ 876sc_texinfo_acronym: 877 @prohibit='@acronym\{' \ 878 in_vc_files='$(texinfo_suffix_re_)' \ 879 halt='found use of Texinfo @acronym{}' \ 880 $(_sc_search_regexp) 881 882cvs_keywords = \ 883 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State 884 885sc_prohibit_cvs_keyword: 886 @prohibit='\$$($(cvs_keywords))\$$' \ 887 halt='do not use CVS keyword expansion' \ 888 $(_sc_search_regexp) 889 890# This Perl code is slightly obfuscated. Not only is each "$" doubled 891# because it's in a Makefile, but the $$c's are comments; we cannot 892# use "#" due to the way the script ends up concatenated onto one line. 893# It would be much more concise, and would produce better output (including 894# counts) if written as: 895# perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ... 896# but that would be far less efficient, reading the entire contents 897# of each file, rather than just the last two bytes of each. 898# In addition, while the code below detects both blank lines and a missing 899# newline at EOF, the above detects only the former. 900# 901# This is a perl script that is expected to be the single-quoted argument 902# to a command-line "-le". The remaining arguments are file names. 903# Print the name of each file that does not end in exactly one newline byte. 904# I.e., warn if there are blank lines (2 or more newlines), or if the 905# last byte is not a newline. However, currently we don't complain 906# about any file that contains exactly one byte. 907# Exit nonzero if at least one such file is found, otherwise, exit 0. 908# Warn about, but otherwise ignore open failure. Ignore seek/read failure. 909# 910# Use this if you want to remove trailing empty lines from selected files: 911# perl -pi -0777 -e 's/\n\n+$/\n/' files... 912# 913require_exactly_one_NL_at_EOF_ = \ 914 foreach my $$f (@ARGV) \ 915 { \ 916 open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next; \ 917 my $$p = sysseek (F, -2, 2); \ 918 my $$c = "seek failure probably means file has < 2 bytes; ignore"; \ 919 my $$last_two_bytes; \ 920 defined $$p and $$p = sysread F, $$last_two_bytes, 2; \ 921 close F; \ 922 $$c = "ignore read failure"; \ 923 $$p && ($$last_two_bytes eq "\n\n" \ 924 || substr ($$last_two_bytes,1) ne "\n") \ 925 and (print $$f), $$fail=1; \ 926 } \ 927 END { exit defined $$fail } 928sc_prohibit_empty_lines_at_EOF: 929 @perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \ 930 || { echo '$(ME): empty line(s) or no newline at EOF' \ 931 1>&2; exit 1; } || : 932 933# Make sure we don't use st_blocks. Use ST_NBLOCKS instead. 934# This is a bit of a kludge, since it prevents use of the string 935# even in comments, but for now it does the job with no false positives. 936sc_prohibit_stat_st_blocks: 937 @prohibit='[.>]st_blocks' \ 938 halt='do not use st_blocks; use ST_NBLOCKS' \ 939 $(_sc_search_regexp) 940 941# Make sure we don't define any S_IS* macros in src/*.c files. 942# They're already defined via gnulib's sys/stat.h replacement. 943sc_prohibit_S_IS_definition: 944 @prohibit='^ *# *define *S_IS' \ 945 halt='do not define S_IS* macros; include <sys/stat.h>' \ 946 $(_sc_search_regexp) 947 948# Perl block to convert a match to FILE_NAME:LINENO:TEST, 949# that is shared by two definitions below. 950perl_filename_lineno_text_ = \ 951 -e ' {' \ 952 -e ' $$n = ($$` =~ tr/\n/\n/ + 1);' \ 953 -e ' ($$v = $$&) =~ s/\n/\\n/g;' \ 954 -e ' print "$$ARGV:$$n:$$v\n";' \ 955 -e ' }' 956 957prohibit_doubled_word_RE_ ?= \ 958 /\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims 959prohibit_doubled_word_ = \ 960 -e 'while ($(prohibit_doubled_word_RE_))' \ 961 $(perl_filename_lineno_text_) 962 963# Define this to a regular expression that matches 964# any filename:dd:match lines you want to ignore. 965# The default is to ignore no matches. 966ignore_doubled_word_match_RE_ ?= ^$$ 967 968sc_prohibit_doubled_word: 969 @perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT)) \ 970 | grep -vE '$(ignore_doubled_word_match_RE_)' \ 971 | grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || : 972 973# A regular expression matching undesirable combinations of words like 974# "can not"; this matches them even when the two words appear on different 975# lines, but not when there is an intervening delimiter like "#" or "*". 976# Similarly undesirable, "See @xref{...}", since an @xref should start 977# a sentence. Explicitly prohibit any prefix of "see" or "also". 978# Also prohibit a prefix matching "\w+ +". 979# @pxref gets the same see/also treatment and should be parenthesized; 980# presume it must *not* start a sentence. 981bad_xref_re_ ?= (?:[\w,:;] +|(?:see|also)\s+)\@xref\{ 982bad_pxref_re_ ?= (?:[.!?]|(?:see|also))\s+\@pxref\{ 983prohibit_undesirable_word_seq_RE_ ?= \ 984 /(?:\bcan\s+not\b|$(bad_xref_re_)|$(bad_pxref_re_))/gims 985prohibit_undesirable_word_seq_ = \ 986 -e 'while ($(prohibit_undesirable_word_seq_RE_))' \ 987 $(perl_filename_lineno_text_) 988# Define this to a regular expression that matches 989# any filename:dd:match lines you want to ignore. 990# The default is to ignore no matches. 991ignore_undesirable_word_sequence_RE_ ?= ^$$ 992 993sc_prohibit_undesirable_word_seq: 994 @perl -n -0777 $(prohibit_undesirable_word_seq_) \ 995 $$($(VC_LIST_EXCEPT)) \ 996 | grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \ 997 && { echo '$(ME): undesirable word sequence' >&2; exit 1; } || : 998 999# Except for shell files and for loops, double semicolon is probably a mistake 1000sc_prohibit_double_semicolon: 1001 @prohibit='; *;[ {} \]*(/[/*]|$$)' \ 1002 in_vc_files='\.[chly]$$' \ 1003 exclude='\bfor *\(.*\)' \ 1004 halt="Double semicolon detected" \ 1005 $(_sc_search_regexp) 1006 1007_ptm1 = use "test C1 && test C2", not "test C1 -''a C2" 1008_ptm2 = use "test C1 || test C2", not "test C1 -''o C2" 1009# Using test's -a and -o operators is not portable. 1010# We prefer test over [, since the latter is spelled [[ in configure.ac. 1011sc_prohibit_test_minus_ao: 1012 @prohibit='(\<test| \[+) .+ -[ao] ' \ 1013 halt='$(_ptm1); $(_ptm2)' \ 1014 $(_sc_search_regexp) 1015 1016# Avoid a test bashism. 1017sc_prohibit_test_double_equal: 1018 @prohibit='(\<test| \[+) .+ == ' \ 1019 containing='#! */bin/[a-z]*sh' \ 1020 halt='use "test x = x", not "test x =''= x"' \ 1021 $(_sc_search_regexp) 1022 1023# Each program that uses proper_name_utf8 must link with one of the 1024# ICONV libraries. Otherwise, some ICONV library must appear in LDADD. 1025# The perl -0777 invocation below extracts the possibly-multi-line 1026# definition of LDADD from the appropriate Makefile.am and exits 0 1027# when it contains "ICONV". 1028sc_proper_name_utf8_requires_ICONV: 1029 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\ 1030 if test "x$$progs" != x; then \ 1031 fail=0; \ 1032 for p in $$progs; do \ 1033 dir=$$(dirname "$$p"); \ 1034 perl -0777 \ 1035 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \ 1036 $$dir/Makefile.am && continue; \ 1037 base=$$(basename "$$p" .c); \ 1038 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \ 1039 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \ 1040 done; \ 1041 test $$fail = 1 && \ 1042 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \ 1043 exit 1; } || :; \ 1044 fi 1045 1046# Warn about "c0nst struct Foo const foo[]", 1047# but not about "char const *const foo" or "#define const const". 1048sc_redundant_const: 1049 @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \ 1050 halt='redundant "const" in declarations' \ 1051 $(_sc_search_regexp) 1052 1053sc_const_long_option: 1054 @prohibit='^ *static.*struct option ' \ 1055 exclude='const struct option|struct option const' \ 1056 halt='add "const" to the above declarations' \ 1057 $(_sc_search_regexp) 1058 1059NEWS_hash = \ 1060 $$($(SED) -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \ 1061 $(srcdir)/NEWS \ 1062 | perl -0777 -pe \ 1063 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \ 1064 | md5sum - \ 1065 | $(SED) 's/ .*//') 1066 1067# Ensure that we don't accidentally insert an entry into an old NEWS block. 1068sc_immutable_NEWS: 1069 @if test -f $(srcdir)/NEWS; then \ 1070 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \ 1071 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \ 1072 fi 1073 1074# Update the hash stored above. Do this after each release and 1075# for any corrections to old entries. 1076update-NEWS-hash: NEWS 1077 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \ 1078 $(srcdir)/cfg.mk 1079 1080# Ensure that we use only the standard $(VAR) notation, 1081# not @...@ in Makefile.am, now that we can rely on automake 1082# to emit a definition for each substituted variable. 1083# However, there is still one case in which @VAR@ use is not just 1084# legitimate, but actually required: when augmenting an automake-defined 1085# variable with a prefix. For example, gettext uses this: 1086# MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@ 1087# otherwise, makeinfo would put German or French (current locale) 1088# navigation hints in the otherwise-English documentation. 1089# 1090# Allow the package to add exceptions via a hook in cfg.mk; 1091# for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by 1092# setting this to ' && !/PRAGMA_SYSTEM_HEADER/'. 1093_makefile_at_at_check_exceptions ?= 1094sc_makefile_at_at_check: 1095 @perl -ne '/\@\w+\@/' \ 1096 -e ' && !/(\w+)\s+=.*\@\1\@$$/' \ 1097 -e ''$(_makefile_at_at_check_exceptions) \ 1098 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \ 1099 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \ 1100 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || : 1101 1102news-check: NEWS 1103 $(AM_V_GEN)if $(SED) -n $(news-check-lines-spec)p $< \ 1104 | grep -E $(news-check-regexp) >/dev/null; then \ 1105 :; \ 1106 else \ 1107 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \ 1108 exit 1; \ 1109 fi 1110 1111sc_makefile_TAB_only_indentation: 1112 @prohibit='^ [ ]{8}' \ 1113 in_vc_files='akefile|\.mk$$' \ 1114 halt='found TAB-8-space indentation' \ 1115 $(_sc_search_regexp) 1116 1117sc_m4_quote_check: 1118 @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \ 1119 in_vc_files='(^configure\.ac|\.m4)$$' \ 1120 halt='quote the first arg to AC_DEF*' \ 1121 $(_sc_search_regexp) 1122 1123fix_po_file_diag = \ 1124'you have changed the set of files with translatable diagnostics;\n\ 1125apply the above patch\n' 1126 1127# Verify that all source files using _() (more specifically, files that 1128# match $(_gl_translatable_string_re)) are listed in po/POTFILES.in. 1129po_file ?= $(srcdir)/po/POTFILES.in 1130generated_files ?= $(srcdir)/lib/*.[ch] 1131_gl_translatable_string_re ?= \b(N?_|gettext *)\([^)"]*("|$$) 1132sc_po_check: 1133 @if test -f $(po_file); then \ 1134 grep -E -v '^(#|$$)' $(po_file) \ 1135 | grep -v '^src/false\.c$$' | sort > $@-1; \ 1136 files=; \ 1137 for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do \ 1138 test -r $$file || continue; \ 1139 case $$file in \ 1140 *.m4|*.mk) continue ;; \ 1141 *.?|*.??) ;; \ 1142 *) continue;; \ 1143 esac; \ 1144 case $$file in \ 1145 *.[ch]) \ 1146 base=`expr " $$file" : ' \(.*\)\..'`; \ 1147 { test -f $$base.l || test -f $$base.y; } && continue;; \ 1148 esac; \ 1149 files="$$files $$file"; \ 1150 done; \ 1151 grep -E -l '$(_gl_translatable_string_re)' $$files \ 1152 | $(SED) 's|^$(_dot_escaped_srcdir)/||' | sort -u > $@-2; \ 1153 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \ 1154 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \ 1155 rm -f $@-1 $@-2; \ 1156 fi 1157 1158# Sometimes it is useful to change the PATH environment variable 1159# in Makefiles. When doing so, it's better not to use the Unix-centric 1160# path separator of ':', but rather the automake-provided '$(PATH_SEPARATOR)'. 1161msg = 'Do not use ":" above; use $$(PATH_SEPARATOR) instead' 1162sc_makefile_path_separator_check: 1163 @prohibit='PATH[=].*:' \ 1164 in_vc_files='akefile|\.mk$$' \ 1165 halt=$(msg) \ 1166 $(_sc_search_regexp) 1167 1168# Check that 'make alpha' will not fail at the end of the process, 1169# i.e., when pkg-M.N.tar.xz already exists (either in "." or in ../release) 1170# and is read-only. 1171writable-files: 1172 $(AM_V_GEN)if test -d $(release_archive_dir); then \ 1173 for file in $(DIST_ARCHIVES); do \ 1174 for p in ./ $(release_archive_dir)/; do \ 1175 test -e $$p$$file || continue; \ 1176 test -w $$p$$file \ 1177 || { echo ERROR: $$p$$file is not writable; fail=1; }; \ 1178 done; \ 1179 done; \ 1180 test "$$fail" && exit 1 || : ; \ 1181 else :; \ 1182 fi 1183 1184v_etc_file = $(gnulib_dir)/lib/version-etc.c 1185sample-test = tests/sample-test 1186texi = doc/$(PACKAGE).texi 1187# Make sure that the copyright date in $(v_etc_file) is up to date. 1188# Do the same for the $(sample-test) and the main doc/.texi file. 1189sc_copyright_check: 1190 @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \ 1191 in_files=$(v_etc_file) \ 1192 halt='out of date copyright in $(v_etc_file); update it' \ 1193 $(_sc_search_regexp) 1194 @require='# Copyright \(C\) '$$(date +%Y)' Free' \ 1195 in_vc_files=$(sample-test) \ 1196 halt='out of date copyright in $(sample-test); update it' \ 1197 $(_sc_search_regexp) 1198 @require='Copyright @copyright\{\} .*'$$(date +%Y) \ 1199 in_vc_files=$(texi) \ 1200 halt='out of date copyright in $(texi); update it' \ 1201 $(_sc_search_regexp) 1202 1203# If tests/help-version exists and seems to be new enough, assume that its 1204# use of init.sh and path_prepend_ is correct, and ensure that every other 1205# use of init.sh is identical. 1206# This is useful because help-version cross-checks prog --version 1207# with $(VERSION), which verifies that its path_prepend_ invocation 1208# sets PATH correctly. This is an inexpensive way to ensure that 1209# the other init.sh-using tests also get it right. 1210_hv_file ?= $(srcdir)/tests/help-version 1211_hv_regex_weak ?= ^ *\. .*/init\.sh" 1212# Fix syntax-highlighters " 1213_hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh" 1214sc_cross_check_PATH_usage_in_tests: 1215 @if test -f $(_hv_file); then \ 1216 grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \ 1217 || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2; \ 1218 exit 0; }; \ 1219 grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null \ 1220 || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \ 1221 exit 1; }; \ 1222 good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file)); \ 1223 grep -LFx "$$good" \ 1224 $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT))) \ 1225 | grep . && \ 1226 { echo "$(ME): the above files use path_prepend_ inconsistently" \ 1227 1>&2; exit 1; } || :; \ 1228 fi 1229 1230# BRE regex of file contents to identify a test script. 1231_test_script_regex ?= \<init\.sh\> 1232 1233# In tests, use "compare expected actual", not the reverse. 1234sc_prohibit_reversed_compare_failure: 1235 @prohibit='\<compare [^ ]+ ([^ ]*exp|/dev/null)' \ 1236 containing='$(_test_script_regex)' \ 1237 halt='reversed compare arguments' \ 1238 $(_sc_search_regexp) 1239 1240# #if HAVE_... will evaluate to false for any non numeric string. 1241# That would be flagged by using -Wundef, however gnulib currently 1242# tests many undefined macros, and so we can't enable that option. 1243# So at least preclude common boolean strings as macro values. 1244sc_Wundef_boolean: 1245 @prohibit='^#define.*(yes|no|true|false)$$' \ 1246 in_files='$(CONFIG_INCLUDE)' \ 1247 halt='Use 0 or 1 for macro values' \ 1248 $(_sc_search_regexp) 1249 1250# Even if you use pathmax.h to guarantee that PATH_MAX is defined, it might 1251# not be constant, or might overflow a stack. In general, use PATH_MAX as 1252# a limit, not an array or alloca size. 1253sc_prohibit_path_max_allocation: 1254 @prohibit='(\balloca *\([^)]*|\[[^]]*)\bPATH_MAX' \ 1255 halt='Avoid stack allocations of size PATH_MAX' \ 1256 $(_sc_search_regexp) 1257 1258sc_vulnerable_makefile_CVE-2009-4029: 1259 @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \ 1260 in_files='(^|/)Makefile\.in$$' \ 1261 halt=$$(printf '%s\n' \ 1262 'the above files are vulnerable; beware of running' \ 1263 ' "make dist*" rules, and upgrade to fixed automake' \ 1264 ' see http://bugzilla.redhat.com/542609 for details') \ 1265 $(_sc_search_regexp) 1266 1267sc_vulnerable_makefile_CVE-2012-3386: 1268 @prohibit='chmod a\+w \$$\(distdir\)' \ 1269 in_files='(^|/)Makefile\.in$$' \ 1270 halt=$$(printf '%s\n' \ 1271 'the above files are vulnerable; beware of running' \ 1272 ' "make distcheck", and upgrade to fixed automake' \ 1273 ' see http://bugzilla.redhat.com/CVE-2012-3386 for details') \ 1274 $(_sc_search_regexp) 1275 1276vc-diff-check: 1277 $(AM_V_GEN)(unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || : 1278 $(AM_V_at)if test -s vc-diffs; then \ 1279 cat vc-diffs; \ 1280 echo "Some files are locally modified:" 1>&2; \ 1281 exit 1; \ 1282 else \ 1283 rm vc-diffs; \ 1284 fi 1285 1286rel-files = $(DIST_ARCHIVES) 1287 1288gnulib_dir ?= $(srcdir)/gnulib 1289gnulib-version = $$(cd $(gnulib_dir) \ 1290 && { git describe || git rev-parse --short=10 HEAD; } ) 1291bootstrap-tools ?= autoconf,automake,gnulib 1292 1293gpgv = $$(gpgv2 --version >/dev/null && echo gpgv2 || echo gpgv) 1294# If it's not already specified, derive the GPG key ID from 1295# the signed tag we've just applied to mark this release. 1296gpg_key_ID ?= \ 1297 $$(cd $(srcdir) \ 1298 && git cat-file tag v$(VERSION) \ 1299 | $(gpgv) --status-fd 1 --keyring /dev/null - - 2>/dev/null \ 1300 | awk '/^\[GNUPG:\] ERRSIG / {print $$3; exit}') 1301 1302translation_project_ ?= coordinator@translationproject.org 1303 1304# Make info-gnu the default only for a stable release. 1305announcement_Cc_stable = $(translation_project_), $(PACKAGE_BUGREPORT) 1306announcement_mail_headers_stable = \ 1307 To: info-gnu@gnu.org \ 1308 Cc: $(announcement_Cc_) \ 1309 Mail-Followup-To: $(PACKAGE_BUGREPORT) 1310 1311announcement_Cc_alpha = $(translation_project_) 1312announcement_mail_headers_alpha = \ 1313 To: $(PACKAGE_BUGREPORT) \ 1314 Cc: $(announcement_Cc_) 1315 1316announcement_mail_Cc_beta = $(announcement_mail_Cc_alpha) 1317announcement_mail_headers_beta = $(announcement_mail_headers_alpha) 1318 1319announcement_mail_Cc_ ?= $(announcement_mail_Cc_$(release-type)) 1320announcement_mail_headers_ ?= $(announcement_mail_headers_$(release-type)) 1321announcement: NEWS ChangeLog $(rel-files) 1322# Not $(AM_V_GEN) since the output of this command serves as 1323# announcement message: it would start with " GEN announcement". 1324 $(AM_V_at)$(srcdir)/$(_build-aux)/announce-gen \ 1325 --mail-headers='$(announcement_mail_headers_)' \ 1326 --release-type=$(release-type) \ 1327 --package=$(PACKAGE) \ 1328 --prev=$(PREV_VERSION) \ 1329 --curr=$(VERSION) \ 1330 --gpg-key-id=$(gpg_key_ID) \ 1331 --srcdir=$(srcdir) \ 1332 --news=$(srcdir)/NEWS \ 1333 --bootstrap-tools=$(bootstrap-tools) \ 1334 $$(case ,$(bootstrap-tools), in (*,gnulib,*) \ 1335 echo --gnulib-version=$(gnulib-version);; esac) \ 1336 --no-print-checksums \ 1337 $(addprefix --url-dir=, $(url_dir_list)) 1338 1339.PHONY: release-commit 1340release-commit: 1341 $(AM_V_GEN)cd $(srcdir) \ 1342 && $(_build-aux)/do-release-commit-and-tag \ 1343 -C $(abs_builddir) $(RELEASE) 1344 1345## ---------------- ## 1346## Updating files. ## 1347## ---------------- ## 1348 1349ftp-gnu = ftp://ftp.gnu.org/gnu 1350www-gnu = http://www.gnu.org 1351 1352upload_dest_dir_ ?= $(PACKAGE) 1353upload_command = \ 1354 $(srcdir)/$(_build-aux)/gnupload $(GNUPLOADFLAGS) \ 1355 --to $(gnu_rel_host):$(upload_dest_dir_) \ 1356 $(rel-files) 1357emit_upload_commands: 1358 @echo ===================================== 1359 @echo ===================================== 1360 @echo '$(upload_command)' 1361 @echo '# send the ~/announce-$(my_distdir) e-mail' 1362 @echo ===================================== 1363 @echo ===================================== 1364 1365.PHONY: upload 1366upload: 1367 $(AM_V_GEN)$(upload_command) 1368 1369define emit-commit-log 1370 printf '%s\n' 'maint: post-release administrivia' '' \ 1371 '* NEWS: Add header line for next release.' \ 1372 '* .prev-version: Record previous version.' \ 1373 '* cfg.mk (old_NEWS_hash): Auto-update.' 1374endef 1375 1376.PHONY: no-submodule-changes 1377no-submodule-changes: 1378 $(AM_V_GEN)if test -d $(srcdir)/.git \ 1379 && git --version >/dev/null 2>&1; then \ 1380 diff=$$(cd $(srcdir) && git submodule -q foreach \ 1381 git diff-index --name-only HEAD) \ 1382 || exit 1; \ 1383 case $$diff in '') ;; \ 1384 *) echo '$(ME): submodule files are locally modified:'; \ 1385 echo "$$diff"; exit 1;; esac; \ 1386 else \ 1387 : ; \ 1388 fi 1389 1390submodule-checks ?= no-submodule-changes public-submodule-commit 1391 1392# Ensure that each sub-module commit we're using is public. 1393# Without this, it is too easy to tag and release code that 1394# cannot be built from a fresh clone. 1395.PHONY: public-submodule-commit 1396public-submodule-commit: 1397 $(AM_V_GEN)if test -d $(srcdir)/.git \ 1398 && git --version >/dev/null 2>&1; then \ 1399 cd $(srcdir) && \ 1400 git submodule --quiet foreach \ 1401 'test "$$(git rev-parse "$$sha1")" \ 1402 = "$$(git merge-base origin "$$sha1")"' \ 1403 || { echo '$(ME): found non-public submodule commit' >&2; \ 1404 exit 1; }; \ 1405 else \ 1406 : ; \ 1407 fi 1408# This rule has a high enough utility/cost ratio that it should be a 1409# dependent of "check" by default. However, some of us do occasionally 1410# commit a temporary change that deliberately points to a non-public 1411# submodule commit, and want to be able to use rules like "make check". 1412# In that case, run e.g., "make check gl_public_submodule_commit=" 1413# to disable this test. 1414gl_public_submodule_commit ?= public-submodule-commit 1415check: $(gl_public_submodule_commit) 1416 1417.PHONY: alpha beta stable release 1418ALL_RECURSIVE_TARGETS += alpha beta stable 1419alpha beta stable: $(local-check) writable-files $(submodule-checks) 1420 $(AM_V_GEN)test $@ = stable \ 1421 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \ 1422 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\ 1423 || : 1424 $(AM_V_at)$(MAKE) vc-diff-check 1425 $(AM_V_at)$(MAKE) news-check 1426 $(AM_V_at)$(MAKE) distcheck 1427 $(AM_V_at)$(MAKE) dist 1428 $(AM_V_at)$(MAKE) $(release-prep-hook) RELEASE_TYPE=$@ 1429 $(AM_V_at)$(MAKE) -s emit_upload_commands RELEASE_TYPE=$@ 1430 1431release: 1432 $(AM_V_GEN)$(MAKE) _version 1433 $(AM_V_GEN)$(MAKE) $(release-type) 1434 1435# Override this in cfg.mk if you follow different procedures. 1436release-prep-hook ?= release-prep 1437 1438gl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?] 1439.PHONY: release-prep 1440release-prep: 1441 $(AM_V_GEN)$(MAKE) --no-print-directory -s announcement \ 1442 > ~/announce-$(my_distdir) 1443 $(AM_V_at)if test -d $(release_archive_dir); then \ 1444 ln $(rel-files) $(release_archive_dir); \ 1445 chmod a-w $(rel-files); \ 1446 fi 1447 $(AM_V_at)echo $(VERSION) > $(prev_version_file) 1448 $(AM_V_at)$(MAKE) update-NEWS-hash 1449 $(AM_V_at)perl -pi \ 1450 -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' \ 1451 $(srcdir)/NEWS 1452 $(AM_V_at)msg=$$($(emit-commit-log)) || exit 1; \ 1453 cd $(srcdir) && $(VC) commit -m "$$msg" -a 1454 1455# Override this with e.g., -s $(srcdir)/some_other_name.texi 1456# if the default $(PACKAGE)-derived name doesn't apply. 1457gendocs_options_ ?= 1458 1459.PHONY: web-manual 1460web-manual: 1461 $(AM_V_GEN)test -z "$(manual_title)" \ 1462 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || : 1463 $(AM_V_at)cd '$(srcdir)/doc'; \ 1464 $(SHELL) ../$(_build-aux)/gendocs.sh $(gendocs_options_) \ 1465 -o '$(abs_builddir)/doc/manual' \ 1466 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \ 1467 "$(PACKAGE_NAME) - $(manual_title)" 1468 $(AM_V_at)echo " *** Upload the doc/manual directory to web-cvs." 1469 1470.PHONY: web-manual-update 1471web-manual-update: 1472 $(AM_V_GEN)cd $(srcdir) \ 1473 && $(_build-aux)/gnu-web-doc-update -C $(abs_builddir) 1474 1475 1476# Code Coverage 1477 1478init-coverage: 1479 $(MAKE) $(AM_MAKEFLAGS) clean 1480 lcov --directory . --zerocounters 1481 1482COVERAGE_CCOPTS ?= "-g --coverage" 1483COVERAGE_OUT ?= doc/coverage 1484 1485build-coverage: 1486 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) 1487 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check 1488 mkdir -p $(COVERAGE_OUT) 1489 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \ 1490 --capture 1491 1492gen-coverage: 1493 genhtml --output-directory $(COVERAGE_OUT) \ 1494 $(COVERAGE_OUT)/$(PACKAGE).info \ 1495 --highlight --frames --legend \ 1496 --title "$(PACKAGE_NAME)" 1497 1498coverage: init-coverage build-coverage gen-coverage 1499 1500# Some projects carry local adjustments for gnulib modules via patches in 1501# a gnulib patch directory whose default name is gl/ (defined in bootstrap 1502# via local_gl_dir=gl). Those patches become stale as the originals evolve 1503# in gnulib. Use this rule to refresh any stale patches. It applies each 1504# patch to the original in $(gnulib_dir) and uses the temporary result to 1505# generate a fuzz-free .diff file. If you customize the name of your local 1506# gnulib patch directory via bootstrap.conf, this rule detects that name. 1507# Run this from a non-VPATH (i.e., srcdir) build directory. 1508.PHONY: refresh-gnulib-patches 1509refresh-gnulib-patches: 1510 gl=gl; \ 1511 if test -f bootstrap.conf; then \ 1512 t=$$(perl -lne '/^\s*local_gl_dir=(\S+)/ and $$d=$$1;' \ 1513 -e 'END{defined $$d and print $$d}' bootstrap.conf); \ 1514 test -n "$$t" && gl=$$t; \ 1515 fi; \ 1516 for diff in $$(cd $$gl; git ls-files | grep '\.diff$$'); do \ 1517 b=$$(printf %s "$$diff"|$(SED) 's/\.diff$$//'); \ 1518 VERSION_CONTROL=none \ 1519 patch "$(gnulib_dir)/$$b" "$$gl/$$diff" || exit 1; \ 1520 ( cd $(gnulib_dir) || exit 1; \ 1521 git diff "$$b" > "../$$gl/$$diff"; \ 1522 git checkout $$b ) || exit 1; \ 1523 done 1524 1525# Update gettext files. 1526PACKAGE ?= $(shell basename $(PWD)) 1527PO_DOMAIN ?= $(PACKAGE) 1528POURL = http://translationproject.org/latest/$(PO_DOMAIN)/ 1529PODIR ?= po 1530refresh-po: 1531 rm -f $(PODIR)/*.po && \ 1532 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \ 1533 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \ 1534 echo 'en@boldquot' > $(PODIR)/LINGUAS && \ 1535 echo 'en@quot' >> $(PODIR)/LINGUAS && \ 1536 ls $(PODIR)/*.po | $(SED) 's/\.po//;s,$(PODIR)/,,' | \ 1537 sort >> $(PODIR)/LINGUAS 1538 1539 # Running indent once is not idempotent, but running it twice is. 1540INDENT_SOURCES ?= $(C_SOURCES) 1541.PHONY: indent 1542indent: 1543 indent $(INDENT_SOURCES) 1544 indent $(INDENT_SOURCES) 1545 1546# If you want to set UPDATE_COPYRIGHT_* environment variables, 1547# put the assignments in this variable. 1548update-copyright-env ?= 1549 1550# Run this rule once per year (usually early in January) 1551# to update all FSF copyright year lists in your project. 1552# If you have an additional project-specific rule, 1553# add it in cfg.mk along with a line 'update-copyright: prereq'. 1554# By default, exclude all variants of COPYING; you can also 1555# add exemptions (such as ChangeLog..* for rotated change logs) 1556# in the file .x-update-copyright. 1557.PHONY: update-copyright 1558update-copyright: 1559 $(AM_V_GEN)grep -l -w Copyright \ 1560 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \ 1561 | $(update-copyright-env) xargs $(srcdir)/$(_build-aux)/$@ 1562 1563# This tight_scope test is skipped with a warning if $(_gl_TS_headers) is not 1564# overridden and $(_gl_TS_dir)/Makefile.am does not mention noinst_HEADERS. 1565 1566# NOTE: to override any _gl_TS_* default value, you must 1567# define the variable(s) using "export" in cfg.mk. 1568_gl_TS_dir ?= src 1569 1570ALL_RECURSIVE_TARGETS += sc_tight_scope 1571sc_tight_scope: tight-scope.mk 1572 @fail=0; \ 1573 if ! grep '^ *export _gl_TS_headers *=' $(srcdir)/cfg.mk \ 1574 > /dev/null \ 1575 && ! grep -w noinst_HEADERS $(srcdir)/$(_gl_TS_dir)/Makefile.am \ 1576 > /dev/null 2>&1; then \ 1577 echo '$(ME): skipping $@'; \ 1578 else \ 1579 $(MAKE) -s -C $(_gl_TS_dir) \ 1580 -f Makefile \ 1581 -f $(abs_top_srcdir)/cfg.mk \ 1582 -f $(abs_top_builddir)/$< \ 1583 _gl_tight_scope \ 1584 || fail=1; \ 1585 fi; \ 1586 rm -f $<; \ 1587 exit $$fail 1588 1589tight-scope.mk: $(ME) 1590 @rm -f $@ $@-t 1591 @perl -ne '/^# TS-start/.../^# TS-end/ and print' $(srcdir)/$(ME) > $@-t 1592 @chmod a=r $@-t && mv $@-t $@ 1593 1594ifeq (a,b) 1595# TS-start 1596 1597# Most functions should have static scope. 1598# Any that don't must be marked with 'extern', but 'main' 1599# and 'usage' are exceptions: they're always extern, but 1600# do not need to be marked. Symbols matching '__.*' are 1601# reserved by the compiler, so are automatically excluded below. 1602_gl_TS_unmarked_extern_functions ?= main usage 1603_gl_TS_function_match ?= /^(?:$(_gl_TS_extern)) +.*?(\S+) *\(/ 1604 1605# If your project uses a macro like "XTERN", then put 1606# the following in cfg.mk to override this default: 1607# export _gl_TS_extern = extern|XTERN 1608_gl_TS_extern ?= extern 1609 1610# The second nm|grep checks for file-scope variables with 'extern' scope. 1611# Without gnulib's progname module, you might put program_name here. 1612# Symbols matching '__.*' are reserved by the compiler, 1613# so are automatically excluded below. 1614_gl_TS_unmarked_extern_vars ?= 1615 1616# NOTE: the _match variables are perl expressions -- not mere regular 1617# expressions -- so that you can extend them to match other patterns 1618# and easily extract matched variable names. 1619# For example, if your project declares some global variables via 1620# a macro like this: GLOBAL(type, var_name, initializer), then you 1621# can override this definition to automatically extract those names: 1622# export _gl_TS_var_match = \ 1623# /^(?:$(_gl_TS_extern)) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/ 1624_gl_TS_var_match ?= /^(?:$(_gl_TS_extern)) .*?(\w+)(\[.*?\])?;/ 1625 1626# The names of object files in (or relative to) $(_gl_TS_dir). 1627_gl_TS_obj_files ?= *.$(OBJEXT) 1628 1629# Files in which to search for the one-line style extern declarations. 1630# $(_gl_TS_dir)-relative. 1631_gl_TS_headers ?= $(noinst_HEADERS) 1632_gl_TS_other_headers ?= *.h 1633 1634.PHONY: _gl_tight_scope 1635_gl_tight_scope: $(bin_PROGRAMS) 1636 t=exceptions-$$$$; \ 1637 trap 's=$$?; rm -f $$t; exit $$s' 0; \ 1638 for sig in 1 2 3 13 15; do \ 1639 eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \ 1640 done; \ 1641 src=`for f in $(SOURCES); do \ 1642 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ 1643 hdr=`for f in $(_gl_TS_headers); do \ 1644 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ 1645 ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_functions); \ 1646 grep -h -A1 '^extern .*[^;]$$' $$src \ 1647 | grep -vE '^(extern |--)' | $(SED) 's/ .*//'; \ 1648 perl -lne \ 1649 '$(_gl_TS_function_match) and print "^$$1\$$"' $$hdr; \ 1650 ) | sort -u > $$t; \ 1651 nm -e $(_gl_TS_obj_files)|$(SED) -n 's/.* T //p'|grep -Ev -f $$t \ 1652 && { echo the above functions should have static scope >&2; \ 1653 exit 1; } || : ; \ 1654 ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_vars); \ 1655 perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' \ 1656 $$hdr $(_gl_TS_other_headers) \ 1657 ) | sort -u > $$t; \ 1658 nm -e $(_gl_TS_obj_files) | $(SED) -n 's/.* [BCDGRS] //p' \ 1659 | sort -u | grep -Ev -f $$t \ 1660 && { echo the above variables should have static scope >&2; \ 1661 exit 1; } || : 1662# TS-end 1663endif 1664