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