105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# -*-Makefile-*- 205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This Makefile fragment tries to be general-purpose enough to be 305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# used by many projects via the gnulib maintainer-makefile module. 405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 505436638acc7c010349a69c3395f1a57c642dc62Ying Wang## Copyright (C) 2001-2012 Free Software Foundation, Inc. 605436638acc7c010349a69c3395f1a57c642dc62Ying Wang## 705436638acc7c010349a69c3395f1a57c642dc62Ying Wang## This program is free software: you can redistribute it and/or modify 805436638acc7c010349a69c3395f1a57c642dc62Ying Wang## it under the terms of the GNU General Public License as published by 905436638acc7c010349a69c3395f1a57c642dc62Ying Wang## the Free Software Foundation, either version 3 of the License, or 1005436638acc7c010349a69c3395f1a57c642dc62Ying Wang## (at your option) any later version. 1105436638acc7c010349a69c3395f1a57c642dc62Ying Wang## 1205436638acc7c010349a69c3395f1a57c642dc62Ying Wang## This program is distributed in the hope that it will be useful, 1305436638acc7c010349a69c3395f1a57c642dc62Ying Wang## but WITHOUT ANY WARRANTY; without even the implied warranty of 1405436638acc7c010349a69c3395f1a57c642dc62Ying Wang## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1505436638acc7c010349a69c3395f1a57c642dc62Ying Wang## GNU General Public License for more details. 1605436638acc7c010349a69c3395f1a57c642dc62Ying Wang## 1705436638acc7c010349a69c3395f1a57c642dc62Ying Wang## You should have received a copy of the GNU General Public License 1805436638acc7c010349a69c3395f1a57c642dc62Ying Wang## along with this program. If not, see <http://www.gnu.org/licenses/>. 1905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 2005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is reported not to work with make-3.79.1 2105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) 2205436638acc7c010349a69c3395f1a57c642dc62Ying WangME := maint.mk 2305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 2405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Diagnostic for continued use of deprecated variable. 2505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Remove in 2013 2605436638acc7c010349a69c3395f1a57c642dc62Ying Wangifneq ($(build_aux),) 2705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(error "$(ME): \ 2805436638acc7c010349a69c3395f1a57c642dc62Ying Wangset $$(_build-aux) relative to $$(srcdir) instead of $$(build_aux)") 2905436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 3005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 3105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Helper variables. 3205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_empty = 3305436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sp = $(_empty) $(_empty) 3405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 3505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# _equal,S1,S2 3605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ------------ 3705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If S1 == S2, return S1, otherwise the empty string. 3805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_equal = $(and $(findstring $(1),$(2)),$(findstring $(2),$(1))) 3905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 4005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# member-check,VARIABLE,VALID-VALUES 4105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ---------------------------------- 4205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Check that $(VARIABLE) is in the space-separated list of VALID-VALUES, and 4305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# return it. Die otherwise. 4405436638acc7c010349a69c3395f1a57c642dc62Ying Wangmember-check = \ 4505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(strip \ 4605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(if $($(1)), \ 4705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(if $(findstring $(_sp),$($(1))), \ 4805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(error invalid $(1): '$($(1))', expected $(2)), \ 4905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(or $(findstring $(_sp)$($(1))$(_sp),$(_sp)$(2)$(_sp)), \ 5005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(error invalid $(1): '$($(1))', expected $(2)))), \ 5105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(error $(1) undefined))) 5205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 5305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Do not save the original name or timestamp in the .tar.gz file. 5405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Use --rsyncable if available. 5505436638acc7c010349a69c3395f1a57c642dc62Ying Wanggzip_rsyncable := \ 5605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null \ 5705436638acc7c010349a69c3395f1a57c642dc62Ying Wang && printf %s --rsyncable) 5805436638acc7c010349a69c3395f1a57c642dc62Ying WangGZIP_ENV = '--no-name --best $(gzip_rsyncable)' 5905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 6005436638acc7c010349a69c3395f1a57c642dc62Ying WangGIT = git 6105436638acc7c010349a69c3395f1a57c642dc62Ying WangVC = $(GIT) 6205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 6305436638acc7c010349a69c3395f1a57c642dc62Ying WangVC_LIST = $(srcdir)/$(_build-aux)/vc-list-files -C $(srcdir) 6405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 6505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# You can override this variable in cfg.mk to set your own regexp 6605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# matching files to ignore. 6705436638acc7c010349a69c3395f1a57c642dc62Ying WangVC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$ 6805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 6905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is to preprocess robustly the output of $(VC_LIST), so that even 7005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# when $(srcdir) is a pathological name like "....", the leading sed command 7105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# removes only the intended prefix. 7205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_dot_escaped_srcdir = $(subst .,\.,$(srcdir)) 7305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 7405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Post-process $(VC_LIST) output, prepending $(srcdir)/, but only 7505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# when $(srcdir) is not ".". 7605436638acc7c010349a69c3395f1a57c642dc62Ying Wangifeq ($(srcdir),.) 7705436638acc7c010349a69c3395f1a57c642dc62Ying Wang _prepend_srcdir_prefix = 7805436638acc7c010349a69c3395f1a57c642dc62Ying Wangelse 7905436638acc7c010349a69c3395f1a57c642dc62Ying Wang _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|' 8005436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 8105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 8205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# In order to be able to consistently filter "."-relative names, 8305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# (i.e., with no $(srcdir) prefix), this definition is careful to 8405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# remove any $(srcdir) prefix, and to restore what it removes. 8505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sc_excl = \ 8605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(or $(exclude_file_name_regexp--$@),^$$) 8705436638acc7c010349a69c3395f1a57c642dc62Ying WangVC_LIST_EXCEPT = \ 8805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \ 8905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \ 9005436638acc7c010349a69c3395f1a57c642dc62Ying Wang else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \ 9105436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \ 9205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_prepend_srcdir_prefix) 9305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 9405436638acc7c010349a69c3395f1a57c642dc62Ying Wangifeq ($(origin prev_version_file), undefined) 9505436638acc7c010349a69c3395f1a57c642dc62Ying Wang prev_version_file = $(srcdir)/.prev-version 9605436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 9705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 9805436638acc7c010349a69c3395f1a57c642dc62Ying WangPREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null) 9905436638acc7c010349a69c3395f1a57c642dc62Ying WangVERSION_REGEXP = $(subst .,\.,$(VERSION)) 10005436638acc7c010349a69c3395f1a57c642dc62Ying WangPREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION)) 10105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 10205436638acc7c010349a69c3395f1a57c642dc62Ying Wangifeq ($(VC),$(GIT)) 10305436638acc7c010349a69c3395f1a57c642dc62Ying Wang this-vc-tag = v$(VERSION) 10405436638acc7c010349a69c3395f1a57c642dc62Ying Wang this-vc-tag-regexp = v$(VERSION_REGEXP) 10505436638acc7c010349a69c3395f1a57c642dc62Ying Wangelse 10605436638acc7c010349a69c3395f1a57c642dc62Ying Wang tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]') 10705436638acc7c010349a69c3395f1a57c642dc62Ying Wang tag-this-version = $(subst .,_,$(VERSION)) 10805436638acc7c010349a69c3395f1a57c642dc62Ying Wang this-vc-tag = $(tag-package)-$(tag-this-version) 10905436638acc7c010349a69c3395f1a57c642dc62Ying Wang this-vc-tag-regexp = $(this-vc-tag) 11005436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 11105436638acc7c010349a69c3395f1a57c642dc62Ying Wangmy_distdir = $(PACKAGE)-$(VERSION) 11205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 11305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Old releases are stored here. 11405436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease_archive_dir ?= ../release 11505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 11605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If RELEASE_TYPE is undefined, but RELEASE is, use its second word. 11705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# But overwrite VERSION. 11805436638acc7c010349a69c3395f1a57c642dc62Ying Wangifdef RELEASE 11905436638acc7c010349a69c3395f1a57c642dc62Ying Wang VERSION := $(word 1, $(RELEASE)) 12005436638acc7c010349a69c3395f1a57c642dc62Ying Wang RELEASE_TYPE ?= $(word 2, $(RELEASE)) 12105436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 12205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 12305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Validate and return $(RELEASE_TYPE), or die. 12405436638acc7c010349a69c3395f1a57c642dc62Ying WangRELEASE_TYPES = alpha beta stable 12505436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease-type = $(call member-check,RELEASE_TYPE,$(RELEASE_TYPES)) 12605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 12705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Override gnu_rel_host and url_dir_list in cfg.mk if these are not right. 12805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Use alpha.gnu.org for alpha and beta releases. 12905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Use ftp.gnu.org for stable releases. 13005436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnu_ftp_host-alpha = alpha.gnu.org 13105436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnu_ftp_host-beta = alpha.gnu.org 13205436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnu_ftp_host-stable = ftp.gnu.org 13305436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnu_rel_host ?= $(gnu_ftp_host-$(release-type)) 13405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 13505436638acc7c010349a69c3395f1a57c642dc62Ying Wangurl_dir_list ?= $(if $(call _equal,$(gnu_rel_host),ftp.gnu.org), \ 13605436638acc7c010349a69c3395f1a57c642dc62Ying Wang http://ftpmirror.gnu.org/$(PACKAGE), \ 13705436638acc7c010349a69c3395f1a57c642dc62Ying Wang ftp://$(gnu_rel_host)/gnu/$(PACKAGE)) 13805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 13905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Override this in cfg.mk if you are using a different format in your 14005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# NEWS file. 14105436638acc7c010349a69c3395f1a57c642dc62Ying Wangtoday = $(shell date +%Y-%m-%d) 14205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 14305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Select which lines of NEWS are searched for $(news-check-regexp). 14405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is a sed line number spec. The default says that we search 14505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# lines 1..10 of NEWS for $(news-check-regexp). 14605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If you want to search only line 3 or only lines 20-22, use "3" or "20,22". 14705436638acc7c010349a69c3395f1a57c642dc62Ying Wangnews-check-lines-spec ?= 1,10 14805436638acc7c010349a69c3395f1a57c642dc62Ying Wangnews-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)' 14905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 15005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prevent programs like 'sort' from considering distinct strings to be equal. 15105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Doing it here saves us from having to set LC_ALL elsewhere in this file. 15205436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport LC_ALL = C 15305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 15405436638acc7c010349a69c3395f1a57c642dc62Ying Wang## --------------- ## 15505436638acc7c010349a69c3395f1a57c642dc62Ying Wang## Sanity checks. ## 15605436638acc7c010349a69c3395f1a57c642dc62Ying Wang## --------------- ## 15705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 15805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_cfg_mk := $(wildcard $(srcdir)/cfg.mk) 15905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 16005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Collect the names of rules starting with 'sc_'. 16105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsyntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \ 16205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(srcdir)/$(ME) $(_cfg_mk))) 16305436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: $(syntax-check-rules) 16405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 16505436638acc7c010349a69c3395f1a57c642dc62Ying Wangifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0) 16605436638acc7c010349a69c3395f1a57c642dc62Ying Wang local-checks-available += $(syntax-check-rules) 16705436638acc7c010349a69c3395f1a57c642dc62Ying Wangelse 16805436638acc7c010349a69c3395f1a57c642dc62Ying Wang local-checks-available += no-vc-detected 16905436638acc7c010349a69c3395f1a57c642dc62Ying Wangno-vc-detected: 17005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo "No version control files detected; skipping syntax check" 17105436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 17205436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: $(local-checks-available) 17305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 17405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Arrange to print the name of each syntax-checking rule just before running it. 17505436638acc7c010349a69c3395f1a57c642dc62Ying Wang$(syntax-check-rules): %: %.m 17605436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules)) 17705436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: $(sc_m_rules_) 17805436638acc7c010349a69c3395f1a57c642dc62Ying Wang$(sc_m_rules_): 17905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo $(patsubst sc_%.m, %, $@) 18005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @date +%s.%N > .sc-start-$(basename $@) 18105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 18205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Compute and print the elapsed time for each syntax-check rule. 18305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules)) 18405436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: $(sc_z_rules_) 18505436638acc7c010349a69c3395f1a57c642dc62Ying Wang$(sc_z_rules_): %.z: % 18605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @end=$$(date +%s.%N); \ 18705436638acc7c010349a69c3395f1a57c642dc62Ying Wang start=$$(cat .sc-start-$*); \ 18805436638acc7c010349a69c3395f1a57c642dc62Ying Wang rm -f .sc-start-$*; \ 18905436638acc7c010349a69c3395f1a57c642dc62Ying Wang awk -v s=$$start -v e=$$end \ 19005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null 19105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 19205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The patsubst here is to replace each sc_% rule with its sc_%.z wrapper 19305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# that computes and prints elapsed time. 19405436638acc7c010349a69c3395f1a57c642dc62Ying Wanglocal-check := \ 19505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(patsubst sc_%, sc_%.z, \ 19605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(filter-out $(local-checks-to-skip), $(local-checks-available))) 19705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 19805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsyntax-check: $(local-check) 19905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 20005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# _sc_search_regexp 20105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 20205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This macro searches for a given construct in the selected files and 20305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# then takes some action. 20405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 20505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Parameters (shell variables): 20605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 20705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# prohibit | require 20805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 20905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Regular expression (ERE) denoting either a forbidden construct 21005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# or a required construct. Those arguments are exclusive. 21105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 21205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# exclude 21305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 21405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Regular expression (ERE) denoting lines to ignore that matched 21505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# a prohibit construct. For example, this can be used to exclude 21605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# comments that mention why the nearby code uses an alternative 21705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# construct instead of the simpler prohibited construct. 21805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 21905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# in_vc_files | in_files 22005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 22105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# grep-E-style regexp selecting the files to check. For in_vc_files, 22205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# the regexp is used to select matching files from the list of all 22305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# version-controlled files; for in_files, it's from the names printed 22405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# by "find $(srcdir)". When neither is specified, use all files that 22505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# are under version control. 22605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 22705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# containing | non_containing 22805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 22905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Select the files (non) containing strings matching this regexp. 23005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If both arguments are specified then CONTAINING takes 23105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# precedence. 23205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 23305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# with_grep_options 23405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 23505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Extra options for grep. 23605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 23705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ignore_case 23805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 23905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ignore case. 24005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 24105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# halt 24205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 24305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Message to display before to halting execution. 24405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 24505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Finally, you may exempt files based on an ERE matching file names. 24605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# For example, to exempt from the sc_space_tab check all files with the 24705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# .diff suffix, set this Make variable: 24805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 24905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# exclude_file_name_regexp--sc_space_tab = \.diff$ 25005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 25105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Note that while this functionality is mostly inherited via VC_LIST_EXCEPT, 25205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# when filtering by name via in_files, we explicitly filter out matching 25305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# names here as well. 25405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 25505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Initialize each, so that envvar settings cannot interfere. 25605436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport require = 25705436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport prohibit = 25805436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport exclude = 25905436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport in_vc_files = 26005436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport in_files = 26105436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport containing = 26205436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport non_containing = 26305436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport halt = 26405436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport with_grep_options = 26505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 26605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# By default, _sc_search_regexp does not ignore case. 26705436638acc7c010349a69c3395f1a57c642dc62Ying Wangexport ignore_case = 26805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :) 26905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 27005436638acc7c010349a69c3395f1a57c642dc62Ying Wangdefine _sc_say_and_exit 27105436638acc7c010349a69c3395f1a57c642dc62Ying Wang dummy=; : so we do not need a semicolon before each use; \ 27205436638acc7c010349a69c3395f1a57c642dc62Ying Wang { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; }; 27305436638acc7c010349a69c3395f1a57c642dc62Ying Wangendef 27405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 27505436638acc7c010349a69c3395f1a57c642dc62Ying Wangdefine _sc_search_regexp 27605436638acc7c010349a69c3395f1a57c642dc62Ying Wang dummy=; : so we do not need a semicolon before each use; \ 27705436638acc7c010349a69c3395f1a57c642dc62Ying Wang \ 27805436638acc7c010349a69c3395f1a57c642dc62Ying Wang : Check arguments; \ 27905436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -n "$$prohibit" && test -n "$$require" \ 28005436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg='Cannot specify both prohibit and require' \ 28105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_say_and_exit) } || :; \ 28205436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -z "$$prohibit" && test -z "$$require" \ 28305436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg='Should specify either prohibit or require' \ 28405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_say_and_exit) } || :; \ 28505436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -z "$$prohibit" && test -n "$$exclude" \ 28605436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg='Use of exclude requires a prohibit pattern' \ 28705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_say_and_exit) } || :; \ 28805436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -n "$$in_vc_files" && test -n "$$in_files" \ 28905436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg='Cannot specify both in_vc_files and in_files' \ 29005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_say_and_exit) } || :; \ 29105436638acc7c010349a69c3395f1a57c642dc62Ying Wang test "x$$halt" != x \ 29205436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { msg='halt not defined' $(_sc_say_and_exit) }; \ 29305436638acc7c010349a69c3395f1a57c642dc62Ying Wang \ 29405436638acc7c010349a69c3395f1a57c642dc62Ying Wang : Filter by file name; \ 29505436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test -n "$$in_files"; then \ 29605436638acc7c010349a69c3395f1a57c642dc62Ying Wang files=$$(find $(srcdir) | grep -E "$$in_files" \ 29705436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -Ev '$(_sc_excl)'); \ 29805436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 29905436638acc7c010349a69c3395f1a57c642dc62Ying Wang files=$$($(VC_LIST_EXCEPT)); \ 30005436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test -n "$$in_vc_files"; then \ 30105436638acc7c010349a69c3395f1a57c642dc62Ying Wang files=$$(echo "$$files" | grep -E "$$in_vc_files"); \ 30205436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi; \ 30305436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi; \ 30405436638acc7c010349a69c3395f1a57c642dc62Ying Wang \ 30505436638acc7c010349a69c3395f1a57c642dc62Ying Wang : Filter by content; \ 30605436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -n "$$files" && test -n "$$containing" \ 30705436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { files=$$(grep -l "$$containing" $$files); } || :; \ 30805436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -n "$$files" && test -n "$$non_containing" \ 30905436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { files=$$(grep -vl "$$non_containing" $$files); } || :; \ 31005436638acc7c010349a69c3395f1a57c642dc62Ying Wang \ 31105436638acc7c010349a69c3395f1a57c642dc62Ying Wang : Check for the construct; \ 31205436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test -n "$$files"; then \ 31305436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test -n "$$prohibit"; then \ 31405436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \ 31505436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -vE "$${exclude:-^$$}" \ 31605436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg="$$halt" $(_sc_say_and_exit) } || :; \ 31705436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 31805436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \ 31905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep . \ 32005436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { msg="$$halt" $(_sc_say_and_exit) } || :; \ 32105436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi \ 32205436638acc7c010349a69c3395f1a57c642dc62Ying Wang else :; \ 32305436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi || :; 32405436638acc7c010349a69c3395f1a57c642dc62Ying Wangendef 32505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 32605436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_avoid_if_before_free: 32705436638acc7c010349a69c3395f1a57c642dc62Ying Wang @$(srcdir)/$(_build-aux)/useless-if-before-free \ 32805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(useless_free_options) \ 32905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \ 33005436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): found useless "if" before "free" above' 1>&2; \ 33105436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 33205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 33305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_cast_of_argument_to_free: 33405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<free *\( *\(' halt="don't cast free argument" \ 33505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 33605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 33705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_cast_of_x_alloc_return_value: 33805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\*\) *x(m|c|re)alloc\>' \ 33905436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt="don't cast x*alloc return value" \ 34005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 34105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 34205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_cast_of_alloca_return_value: 34305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\*\) *alloca\>' \ 34405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt="don't cast alloca return value" \ 34505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 34605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 34705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_space_tab: 34805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='[ ] ' \ 34905436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found SPACE-TAB sequence; remove the SPACE' \ 35005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 35105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 35205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't use *scanf or the old ato* functions in "real" code. 35305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# They provide no error checking mechanism. 35405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Instead, use strto* functions. 35505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_atoi_atof: 35605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \ 35705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \ 35805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 35905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 36005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Use STREQ rather than comparing strcmp == 0, or != 0. 36105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsp_ = strcmp *\(.+\) 36205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_strcmp: 36305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='! *strcmp *\(|\<$(sp_) *[!=]=|[!=]= *$(sp_)' \ 36405436638acc7c010349a69c3395f1a57c642dc62Ying Wang exclude='# *define STRN?EQ\(' \ 36505436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='replace strcmp calls above with STREQ/STRNEQ' \ 36605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 36705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 36805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Really. You don't want to use this function. 36905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# It may fail to NUL-terminate the destination, 37005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# and always NUL-pads out to the specified length. 37105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_strncpy: 37205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<strncpy *\(' \ 37305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not use strncpy, period' \ 37405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 37505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 37605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Pass EXIT_*, not number, to usage, exit, and error (when exiting) 37705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Convert all uses automatically, via these two commands: 37805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# git grep -l '\<exit *(1)' \ 37905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | grep -vEf .x-sc_prohibit_magic_number_exit \ 38005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | xargs --no-run-if-empty \ 38105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/' 38205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# git grep -l '\<exit *(0)' \ 38305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | grep -vEf .x-sc_prohibit_magic_number_exit \ 38405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | xargs --no-run-if-empty \ 38505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/' 38605436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_magic_number_exit: 38705436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='(^|[^.])\<(usage|exit|error) ?\(-?[0-9]+[,)]' \ 38805436638acc7c010349a69c3395f1a57c642dc62Ying Wang exclude='exit \(77\)|error ?\(((0|77),|[^,]*)' \ 38905436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='use EXIT_* values rather than magic number' \ 39005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 39105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 39205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Using EXIT_SUCCESS as the first argument to error is misleading, 39305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# since when that parameter is 0, error does not exit. Use '0' instead. 39405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_error_exit_success: 39505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='error *\(EXIT_SUCCESS,' \ 39605436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='\.[chly]$$' \ 39705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found error (EXIT_SUCCESS' \ 39805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 39905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 40005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# "FATAL:" should be fully upper-cased in error messages 40105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# "WARNING:" should be fully upper-cased, or fully lower-cased 40205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_error_message_warn_fatal: 40305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 40405436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -E '"Warning|"Fatal|"fatal' && \ 40505436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \ 40605436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 40705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 40805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Error messages should not start with a capital letter 40905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_error_message_uppercase: 41005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 41105436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -E '"[A-Z]' \ 41205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \ 41305436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): found capitalized error message' 1>&2; \ 41405436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 41505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 41605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Error messages should not end with a period 41705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_error_message_period: 41805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ 41905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -E '[^."]\."' && \ 42005436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): found error message ending in period' 1>&2; \ 42105436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 42205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 42305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_file_system: 42405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit=file''system \ 42505436638acc7c010349a69c3395f1a57c642dc62Ying Wang ignore_case=1 \ 42605436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found use of "file''system"; spell it "file system"' \ 42705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 42805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 42905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't use cpp tests of this symbol. All code assumes config.h is included. 43005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_have_config_h: 43105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^# *if.*HAVE''_CONFIG_H' \ 43205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found use of HAVE''_CONFIG_H; remove' \ 43305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 43405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 43505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Nearly all .c files must include <config.h>. However, we also permit this 43605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# via inclusion of a package-specific header, if cfg.mk specified one. 43705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# config_h_header must be suitable for grep -E. 43805436638acc7c010349a69c3395f1a57c642dc62Ying Wangconfig_h_header ?= <config\.h> 43905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_require_config_h: 44005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='^# *include $(config_h_header)' \ 44105436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='\.c$$' \ 44205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='the above files do not include <config.h>' \ 44305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 44405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 44505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# You must include <config.h> before including any other header file. 44605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This can possibly be via a package-specific header, if given by cfg.mk. 44705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_require_config_h_first: 44805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \ 44905436638acc7c010349a69c3395f1a57c642dc62Ying Wang fail=0; \ 45005436638acc7c010349a69c3395f1a57c642dc62Ying Wang for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \ 45105436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep '^# *include\>' $$i | sed 1q \ 45205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -E '^# *include $(config_h_header)' > /dev/null \ 45305436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo $$i; fail=1; }; \ 45405436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 45505436638acc7c010349a69c3395f1a57c642dc62Ying Wang test $$fail = 1 && \ 45605436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): the above files include some other header' \ 45705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 'before <config.h>' 1>&2; exit 1; } || :; \ 45805436638acc7c010349a69c3395f1a57c642dc62Ying Wang else :; \ 45905436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 46005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 46105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_HAVE_MBRTOWC: 46205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\bHAVE_MBRTOWC\b' \ 46305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt="do not use $$prohibit; it is always defined" \ 46405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 46505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 46605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# To use this "command" macro, you must first define two shell variables: 46705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# h: the header name, with no enclosing <> or "" 46805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# re: a regular expression that matches IFF something provided by $h is used. 46905436638acc7c010349a69c3395f1a57c642dc62Ying Wangdefine _sc_header_without_use 47005436638acc7c010349a69c3395f1a57c642dc62Ying Wang dummy=; : so we do not need a semicolon before each use; \ 47105436638acc7c010349a69c3395f1a57c642dc62Ying Wang h_esc=`echo '[<"]'"$$h"'[">]'|sed 's/\./\\\\./g'`; \ 47205436638acc7c010349a69c3395f1a57c642dc62Ying Wang if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \ 47305436638acc7c010349a69c3395f1a57c642dc62Ying Wang files=$$(grep -l '^# *include '"$$h_esc" \ 47405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \ 47505436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -LE "$$re" $$files | grep . && \ 47605436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo "$(ME): the above files include $$h but don't use it" \ 47705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 1>&2; exit 1; } || :; \ 47805436638acc7c010349a69c3395f1a57c642dc62Ying Wang else :; \ 47905436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 48005436638acc7c010349a69c3395f1a57c642dc62Ying Wangendef 48105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 48205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of assert.h without an actual use of assert. 48305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_assert_without_use: 48405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='assert.h' re='\<assert *\(' $(_sc_header_without_use) 48505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 48605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of close-stream.h without an actual use. 48705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_close_stream_without_use: 48805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='close-stream.h' re='\<close_stream *\(' $(_sc_header_without_use) 48905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 49005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of getopt.h without an actual use. 49105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_getopt_without_use: 49205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='getopt.h' re='\<getopt(_long)? *\(' $(_sc_header_without_use) 49305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 49405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include quotearg.h unless you use one of its functions. 49505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_quotearg_without_use: 49605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='quotearg.h' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use) 49705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 49805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include quote.h unless you use one of its functions. 49905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_quote_without_use: 50005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='quote.h' re='\<quote((_n)? *\(|_quoting_options\>)' \ 50105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 50205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 50305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include this header unless you use one of its functions. 50405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_long_options_without_use: 50505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='long-options.h' re='\<parse_long_options *\(' \ 50605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 50705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 50805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include this header unless you use one of its functions. 50905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_inttostr_without_use: 51005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \ 51105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 51205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 51305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include this header unless you use one of its functions. 51405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_ignore_value_without_use: 51505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='ignore-value.h' re='\<ignore_(value|ptr) *\(' \ 51605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 51705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 51805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include this header unless you use one of its functions. 51905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_error_without_use: 52005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='error.h' \ 52105436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\ 52205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 52305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 52405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include xalloc.h unless you use one of its functions. 52505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Consider these symbols: 52605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__'; 52705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h 52805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Divide into two sets on case, and filter each through this: 52905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | sort | perl -MRegexp::Assemble -le \ 53005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g' 53105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Note this was produced by the above: 53205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# _xa1 = \ 53305436638acc7c010349a69c3395f1a57c642dc62Ying Wang#x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup) 53405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# But we can do better, in at least two ways: 53505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 1) take advantage of two "dup"-suffixed strings: 53605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup) 53705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable 53805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# "char|[cmz]" 53905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) 54005436638acc7c010349a69c3395f1a57c642dc62Ying Wang_xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) 54105436638acc7c010349a69c3395f1a57c642dc62Ying Wang_xa2 = X([CZ]|N?M)ALLOC 54205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_xalloc_without_use: 54305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='xalloc.h' \ 54405436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<($(_xa1)|$(_xa2)) *\('\ 54505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 54605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 54705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Extract function names: 54805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h 54905436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hash_re = \ 55005436638acc7c010349a69c3395f1a57c642dc62Ying Wangclear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning 55105436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hash_fn = \<($(_hash_re)) *\( 55205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hash_struct = (struct )?\<[Hh]ash_(table|tuning)\> 55305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_hash_without_use: 55405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='hash.h' \ 55505436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='$(_hash_fn)|$(_hash_struct)'\ 55605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 55705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 55805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_cloexec_without_use: 55905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \ 56005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 56105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 56205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_posixver_without_use: 56305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='posixver.h' re='\<posix2_version *\(' $(_sc_header_without_use) 56405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 56505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_same_without_use: 56605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='same.h' re='\<same_name *\(' $(_sc_header_without_use) 56705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 56805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_hash_pjw_without_use: 56905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='hash-pjw.h' \ 57005436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<hash_pjw\>' \ 57105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 57205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 57305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_safe_read_without_use: 57405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \ 57505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 57605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 57705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_argmatch_without_use: 57805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='argmatch.h' \ 57905436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \ 58005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 58105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 58205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_canonicalize_without_use: 58305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='canonicalize.h' \ 58405436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode|file_name)' \ 58505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 58605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 58705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_root_dev_ino_without_use: 58805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='root-dev-ino.h' \ 58905436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \ 59005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 59105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 59205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_openat_without_use: 59305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='openat.h' \ 59405436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \ 59505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 59605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 59705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of c-ctype.h without an actual use. 59805436638acc7c010349a69c3395f1a57c642dc62Ying Wangctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\ 59905436638acc7c010349a69c3395f1a57c642dc62Ying Wang|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper 60005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_c_ctype_without_use: 60105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='c-ctype.h' re='\<c_($(ctype_re)) *\(' \ 60205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 60305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 60405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The following list was generated by running: 60505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \ 60605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt 60705436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sig_functions = \ 60805436638acc7c010349a69c3395f1a57c642dc62Ying Wang bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \ 60905436638acc7c010349a69c3395f1a57c642dc62Ying Wang sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \ 61005436638acc7c010349a69c3395f1a57c642dc62Ying Wang siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \ 61105436638acc7c010349a69c3395f1a57c642dc62Ying Wang sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo 61205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions))) 61305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The following were extracted from "man signal.h" manually. 61405436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sig_types_and_consts = \ 61505436638acc7c010349a69c3395f1a57c642dc62Ying Wang MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \ 61605436638acc7c010349a69c3395f1a57c642dc62Ying Wang SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \ 61705436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \ 61805436638acc7c010349a69c3395f1a57c642dc62Ying Wang SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \ 61905436638acc7c010349a69c3395f1a57c642dc62Ying Wang sigstack sigval stack_t ucontext_t 62005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# generated via this: 62105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70 62205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sig_names = \ 62305436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \ 62405436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \ 62505436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \ 62605436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \ 62705436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \ 62805436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \ 62905436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \ 63005436638acc7c010349a69c3395f1a57c642dc62Ying Wang SIGXCPU SIGXFSZ 63105436638acc7c010349a69c3395f1a57c642dc62Ying Wang_sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts))) 63205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 63305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of signal.h without an actual use. 63405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_signal_without_use: 63505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='signal.h' \ 63605436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \ 63705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 63805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 63905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include stdio--.h unless you use one of its functions. 64005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_stdio--_without_use: 64105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\(' \ 64205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 64305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 64405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include stdio-safer.h unless you use one of its functions. 64505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_stdio-safer_without_use: 64605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\(' \ 64705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 64805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 64905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of strings.h without a sensible use. 65005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible. 65105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_strings_without_use: 65205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='strings.h' \ 65305436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<(strn?casecmp|ffs(ll)?)\>' \ 65405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 65505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 65605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Get the list of symbol names with this: 65705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -lne '/^# *define ([A-Z]\w+)\(/ and print $1' lib/intprops.h|fmt 65805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_intprops_names = \ 65905436638acc7c010349a69c3395f1a57c642dc62Ying Wang TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \ 66005436638acc7c010349a69c3395f1a57c642dc62Ying Wang TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \ 66105436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_BITS_STRLEN_BOUND INT_STRLEN_BOUND INT_BUFSIZE_BOUND \ 66205436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_ADD_RANGE_OVERFLOW INT_SUBTRACT_RANGE_OVERFLOW \ 66305436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_NEGATE_RANGE_OVERFLOW INT_MULTIPLY_RANGE_OVERFLOW \ 66405436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_DIVIDE_RANGE_OVERFLOW INT_REMAINDER_RANGE_OVERFLOW \ 66505436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_LEFT_SHIFT_RANGE_OVERFLOW INT_ADD_OVERFLOW INT_SUBTRACT_OVERFLOW \ 66605436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_NEGATE_OVERFLOW INT_MULTIPLY_OVERFLOW INT_DIVIDE_OVERFLOW \ 66705436638acc7c010349a69c3395f1a57c642dc62Ying Wang INT_REMAINDER_OVERFLOW INT_LEFT_SHIFT_OVERFLOW 66805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names))) 66905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of intprops.h without an actual use. 67005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_intprops_without_use: 67105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='intprops.h' \ 67205436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<($(_intprops_syms_re)) *\(' \ 67305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 67405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 67505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t 67605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of stddef.h without an actual use. 67705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_stddef_without_use: 67805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='stddef.h' \ 67905436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<($(_stddef_syms_re))\>' \ 68005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 68105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 68205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_de1 = dirfd|(close|(fd)?open|read|rewind|seek|tell)dir(64)?(_r)? 68305436638acc7c010349a69c3395f1a57c642dc62Ying Wang_de2 = (versionsort|struct dirent|getdirentries|alphasort|scandir(at)?)(64)? 68405436638acc7c010349a69c3395f1a57c642dc62Ying Wang_de3 = MAXNAMLEN|DIR|ino_t|d_ino|d_fileno|d_namlen 68505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_dirent_syms_re = $(_de1)|$(_de2)|$(_de3) 68605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of dirent.h without an actual use. 68705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_dirent_without_use: 68805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='dirent.h' \ 68905436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<($(_dirent_syms_re))\>' \ 69005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 69105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 69205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit the inclusion of verify.h without an actual use. 69305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_verify_without_use: 69405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='verify.h' \ 69505436638acc7c010349a69c3395f1a57c642dc62Ying Wang re='\<(verify(true|expr)?|static_assert) *\(' \ 69605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_header_without_use) 69705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 69805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't include xfreopen.h unless you use one of its functions. 69905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_xfreopen_without_use: 70005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @h='xfreopen.h' re='\<xfreopen *\(' $(_sc_header_without_use) 70105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 70205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_obsolete_symbols: 70305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \ 70405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not use HAVE''_FCNTL_H or O'_NDELAY \ 70505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 70605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 70705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ 70805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 70905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Each nonempty ChangeLog line must start with a year number, or a TAB. 71005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_changelog: 71105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^[^12 ]' \ 71205436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='^ChangeLog$$' \ 71305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found unexpected prefix in a ChangeLog' \ 71405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 71505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 71605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ensure that each .c file containing a "main" function also 71705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# calls set_program_name. 71805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_program_name: 71905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='set_program_name *\(m?argv\[0\]\);' \ 72005436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='\.c$$' \ 72105436638acc7c010349a69c3395f1a57c642dc62Ying Wang containing='\<main *(' \ 72205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='the above files do not call set_program_name' \ 72305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 72405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 72505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ensure that each .c file containing a "main" function also 72605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# calls bindtextdomain. 72705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_bindtextdomain: 72805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='bindtextdomain *\(' \ 72905436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='\.c$$' \ 73005436638acc7c010349a69c3395f1a57c642dc62Ying Wang containing='\<main *(' \ 73105436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='the above files do not call bindtextdomain' \ 73205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 73305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 73405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Require that the final line of each test-lib.sh-using test be this one: 73505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Exit $fail 73605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Note: this test requires GNU grep's --label= option. 73705436638acc7c010349a69c3395f1a57c642dc62Ying WangExit_witness_file ?= tests/test-lib.sh 73805436638acc7c010349a69c3395f1a57c642dc62Ying WangExit_base := $(notdir $(Exit_witness_file)) 73905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_require_test_exit_idiom: 74005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if test -f $(srcdir)/$(Exit_witness_file); then \ 74105436638acc7c010349a69c3395f1a57c642dc62Ying Wang die=0; \ 74205436638acc7c010349a69c3395f1a57c642dc62Ying Wang for i in $$(grep -l -F 'srcdir/$(Exit_base)' \ 74305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(VC_LIST) tests)); do \ 74405436638acc7c010349a69c3395f1a57c642dc62Ying Wang tail -n1 $$i | grep '^Exit .' > /dev/null \ 74505436638acc7c010349a69c3395f1a57c642dc62Ying Wang && : || { die=1; echo $$i; } \ 74605436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 74705436638acc7c010349a69c3395f1a57c642dc62Ying Wang test $$die = 1 && \ 74805436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo 1>&2 '$(ME): the final line in each of the above is not:'; \ 74905436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo 1>&2 'Exit something'; \ 75005436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || :; \ 75105436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 75205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 75305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_trailing_blank: 75405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='[ ]$$' \ 75505436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found trailing blank(s)' \ 75605436638acc7c010349a69c3395f1a57c642dc62Ying Wang exclude='^Binary file .* matches$$' \ 75705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 75805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 75905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Match lines like the following, but where there is only one space 76005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# between the options and the description: 76105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# -D, --all-repeated[=delimit-method] print all duplicate lines\n 76205436638acc7c010349a69c3395f1a57c642dc62Ying Wanglongopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)? 76305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_two_space_separator_in_usage: 76405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \ 76505436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='help2man requires at least two spaces between an option and its description'\ 76605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 76705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 76805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# A regexp matching function names like "error" that may be used 76905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# to emit translatable messages. 77005436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_translatable_diag_func_re ?= error 77105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 77205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Look for diagnostics that aren't marked for translation. 77305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This won't find any for which error's format string is on a separate line. 77405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_unmarked_diagnostics: 77505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \ 77605436638acc7c010349a69c3395f1a57c642dc62Ying Wang exclude='(_|ngettext ?)\(' \ 77705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found unmarked diagnostic(s)' \ 77805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 77905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 78005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Avoid useless parentheses like those in this example: 78105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# #if defined (SYMBOL) || defined (SYM2) 78205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_useless_cpp_parens: 78305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^# *if .*defined *\(' \ 78405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found useless parentheses in cpp directive' \ 78505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 78605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 78705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# List headers for which HAVE_HEADER_H is always true, assuming you are 78805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# using the appropriate gnulib module. CAUTION: for each "unnecessary" 78905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# #if HAVE_HEADER_H that you remove, be sure that your project explicitly 79005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# requires the gnulib module that guarantees the usability of that header. 79105436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_assured_headers_ = \ 79205436638acc7c010349a69c3395f1a57c642dc62Ying Wang cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g' 79305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 79405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Convert the list of names to upper case, and replace each space with "|". 79505436638acc7c010349a69c3395f1a57c642dc62Ying Wangaz_ = abcdefghijklmnopqrstuvwxyz 79605436638acc7c010349a69c3395f1a57c642dc62Ying WangAZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ 79705436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_header_upper_case_or_ = \ 79805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(gl_assured_headers_) \ 79905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | tr $(az_)/.- $(AZ_)___ \ 80005436638acc7c010349a69c3395f1a57c642dc62Ying Wang | tr -s ' ' '|' \ 80105436638acc7c010349a69c3395f1a57c642dc62Ying Wang ) 80205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_always_true_header_tests: 80305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @or=$(gl_header_upper_case_or_); \ 80405436638acc7c010349a69c3395f1a57c642dc62Ying Wang re="HAVE_($$or)_H"; \ 80505436638acc7c010349a69c3395f1a57c642dc62Ying Wang prohibit='\<'"$$re"'\>' \ 80605436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt=$$(printf '%s\n' \ 80705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 'do not test the above HAVE_<header>_H symbol(s);' \ 80805436638acc7c010349a69c3395f1a57c642dc62Ying Wang ' with the corresponding gnulib module, they are always true') \ 80905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 81005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 81105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_defined_have_decl_tests: 81205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='#[ ]*if(n?def|.*\<defined)\>[ (]+HAVE_DECL_' \ 81305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='HAVE_DECL macros are always defined' \ 81405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 81505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 81605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ================================================================== 81705436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_other_headers_ ?= \ 81805436638acc7c010349a69c3395f1a57c642dc62Ying Wang intprops.h \ 81905436638acc7c010349a69c3395f1a57c642dc62Ying Wang openat.h \ 82005436638acc7c010349a69c3395f1a57c642dc62Ying Wang stat-macros.h 82105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 82205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Perl -lne code to extract "significant" cpp-defined symbols from a 82305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# gnulib header file, eliminating a few common false-positives. 82405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The exempted names below are defined only conditionally in gnulib, 82505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# and hence sometimes must/may be defined in application code. 82605436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_extract_significant_defines_ = \ 82705436638acc7c010349a69c3395f1a57c642dc62Ying Wang /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\ 82805436638acc7c010349a69c3395f1a57c642dc62Ying Wang && $$2 !~ /(?:rpl_|_used_without_)/\ 82905436638acc7c010349a69c3395f1a57c642dc62Ying Wang && $$1 !~ /^(?:NSIG|ENODATA)$$/\ 83005436638acc7c010349a69c3395f1a57c642dc62Ying Wang && $$1 !~ /^(?:SA_RESETHAND|SA_RESTART)$$/\ 83105436638acc7c010349a69c3395f1a57c642dc62Ying Wang and print $$1 83205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 83305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Create a list of regular expressions matching the names 83405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# of macros that are guaranteed to be defined by parts of gnulib. 83505436638acc7c010349a69c3395f1a57c642dc62Ying Wangdefine def_sym_regex 83605436638acc7c010349a69c3395f1a57c642dc62Ying Wang gen_h=$(gl_generated_headers_); \ 83705436638acc7c010349a69c3395f1a57c642dc62Ying Wang (cd $(gnulib_dir)/lib; \ 83805436638acc7c010349a69c3395f1a57c642dc62Ying Wang for f in *.in.h $(gl_other_headers_); do \ 83905436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -f $$f \ 84005436638acc7c010349a69c3395f1a57c642dc62Ying Wang && perl -lne '$(gl_extract_significant_defines_)' $$f; \ 84105436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 84205436638acc7c010349a69c3395f1a57c642dc62Ying Wang ) | sort -u \ 84305436638acc7c010349a69c3395f1a57c642dc62Ying Wang | sed 's/^/^ *# *(define|undef) */;s/$$/\\>/' 84405436638acc7c010349a69c3395f1a57c642dc62Ying Wangendef 84505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 84605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't define macros that we already get from gnulib header files. 84705436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_always-defined_macros: 84805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if test -d $(gnulib_dir); then \ 84905436638acc7c010349a69c3395f1a57c642dc62Ying Wang case $$(echo all: | grep -l -f - Makefile) in Makefile);; *) \ 85005436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \ 85105436638acc7c010349a69c3395f1a57c642dc62Ying Wang esac; \ 85205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT)) \ 85305436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo '$(ME): define the above via some gnulib .h file' \ 85405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 1>&2; exit 1; } || :; \ 85505436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 85605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ================================================================== 85705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 85805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Prohibit checked in backup files. 85905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_backup_files: 86005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @$(VC_LIST) | grep '~$$' && \ 86105436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): found version controlled backup file' 1>&2; \ 86205436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 86305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 86405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Require the latest GPL. 86505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_GPL_version: 86605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='either ''version [^3]' \ 86705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='GPL vN, N!=3' \ 86805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 86905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 87005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Require the latest GFDL. Two regexp, since some .texi files end up 87105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# line wrapping between 'Free Documentation License,' and 'Version'. 87205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any) 87305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_GFDL_version: 87405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='$(_GFDL_regexp)' \ 87505436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='GFDL vN, N!=3' \ 87605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 87705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 87805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Don't use Texinfo's @acronym{}. 87905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html 88005436638acc7c010349a69c3395f1a57c642dc62Ying Wangtexinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$ 88105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_texinfo_acronym: 88205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='@acronym\{' \ 88305436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='$(texinfo_suffix_re_)' \ 88405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found use of Texinfo @acronym{}' \ 88505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 88605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 88705436638acc7c010349a69c3395f1a57c642dc62Ying Wangcvs_keywords = \ 88805436638acc7c010349a69c3395f1a57c642dc62Ying Wang Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State 88905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 89005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_cvs_keyword: 89105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\$$($(cvs_keywords))\$$' \ 89205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not use CVS keyword expansion' \ 89305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 89405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 89505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This Perl code is slightly obfuscated. Not only is each "$" doubled 89605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# because it's in a Makefile, but the $$c's are comments; we cannot 89705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# use "#" due to the way the script ends up concatenated onto one line. 89805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# It would be much more concise, and would produce better output (including 89905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# counts) if written as: 90005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ... 90105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# but that would be far less efficient, reading the entire contents 90205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# of each file, rather than just the last two bytes of each. 90305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# In addition, while the code below detects both blank lines and a missing 90405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# newline at EOF, the above detects only the former. 90505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 90605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is a perl script that is expected to be the single-quoted argument 90705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# to a command-line "-le". The remaining arguments are file names. 90805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Print the name of each file that does not end in exactly one newline byte. 90905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# I.e., warn if there are blank lines (2 or more newlines), or if the 91005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# last byte is not a newline. However, currently we don't complain 91105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# about any file that contains exactly one byte. 91205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Exit nonzero if at least one such file is found, otherwise, exit 0. 91305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Warn about, but otherwise ignore open failure. Ignore seek/read failure. 91405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 91505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Use this if you want to remove trailing empty lines from selected files: 91605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# perl -pi -0777 -e 's/\n\n+$/\n/' files... 91705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 91805436638acc7c010349a69c3395f1a57c642dc62Ying Wangrequire_exactly_one_NL_at_EOF_ = \ 91905436638acc7c010349a69c3395f1a57c642dc62Ying Wang foreach my $$f (@ARGV) \ 92005436638acc7c010349a69c3395f1a57c642dc62Ying Wang { \ 92105436638acc7c010349a69c3395f1a57c642dc62Ying Wang open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next; \ 92205436638acc7c010349a69c3395f1a57c642dc62Ying Wang my $$p = sysseek (F, -2, 2); \ 92305436638acc7c010349a69c3395f1a57c642dc62Ying Wang my $$c = "seek failure probably means file has < 2 bytes; ignore"; \ 92405436638acc7c010349a69c3395f1a57c642dc62Ying Wang my $$last_two_bytes; \ 92505436638acc7c010349a69c3395f1a57c642dc62Ying Wang defined $$p and $$p = sysread F, $$last_two_bytes, 2; \ 92605436638acc7c010349a69c3395f1a57c642dc62Ying Wang close F; \ 92705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$c = "ignore read failure"; \ 92805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$p && ($$last_two_bytes eq "\n\n" \ 92905436638acc7c010349a69c3395f1a57c642dc62Ying Wang || substr ($$last_two_bytes,1) ne "\n") \ 93005436638acc7c010349a69c3395f1a57c642dc62Ying Wang and (print $$f), $$fail=1; \ 93105436638acc7c010349a69c3395f1a57c642dc62Ying Wang } \ 93205436638acc7c010349a69c3395f1a57c642dc62Ying Wang END { exit defined $$fail } 93305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_empty_lines_at_EOF: 93405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \ 93505436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo '$(ME): empty line(s) or no newline at EOF' \ 93605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 1>&2; exit 1; } || : 93705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 93805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Make sure we don't use st_blocks. Use ST_NBLOCKS instead. 93905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is a bit of a kludge, since it prevents use of the string 94005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# even in comments, but for now it does the job with no false positives. 94105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_stat_st_blocks: 94205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='[.>]st_blocks' \ 94305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not use st_blocks; use ST_NBLOCKS' \ 94405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 94505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 94605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Make sure we don't define any S_IS* macros in src/*.c files. 94705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# They're already defined via gnulib's sys/stat.h replacement. 94805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_S_IS_definition: 94905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^ *# *define *S_IS' \ 95005436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='do not define S_IS* macros; include <sys/stat.h>' \ 95105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 95205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 95305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Perl block to convert a match to FILE_NAME:LINENO:TEST, 95405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# that is shared by two definitions below. 95505436638acc7c010349a69c3395f1a57c642dc62Ying Wangperl_filename_lineno_text_ = \ 95605436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' {' \ 95705436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' $$n = ($$` =~ tr/\n/\n/ + 1);' \ 95805436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' ($$v = $$&) =~ s/\n/\\n/g;' \ 95905436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' print "$$ARGV:$$n:$$v\n";' \ 96005436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' }' 96105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 96205436638acc7c010349a69c3395f1a57c642dc62Ying Wangprohibit_doubled_word_RE_ ?= \ 96305436638acc7c010349a69c3395f1a57c642dc62Ying Wang /\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims 96405436638acc7c010349a69c3395f1a57c642dc62Ying Wangprohibit_doubled_word_ = \ 96505436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e 'while ($(prohibit_doubled_word_RE_))' \ 96605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(perl_filename_lineno_text_) 96705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 96805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Define this to a regular expression that matches 96905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# any filename:dd:match lines you want to ignore. 97005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The default is to ignore no matches. 97105436638acc7c010349a69c3395f1a57c642dc62Ying Wangignore_doubled_word_match_RE_ ?= ^$$ 97205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 97305436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_doubled_word: 97405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT)) \ 97505436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -vE '$(ignore_doubled_word_match_RE_)' \ 97605436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || : 97705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 97805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# A regular expression matching undesirable combinations of words like 97905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# "can not"; this matches them even when the two words appear on different 98005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# lines, but not when there is an intervening delimiter like "#" or "*". 98105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Similarly undesirable, "See @xref{...}", since an @xref should start 98205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# a sentence. Explicitly prohibit any prefix of "see" or "also". 98305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Also prohibit a prefix matching "\w+ +". 98405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# @pxref gets the same see/also treatment and should be parenthesized; 98505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# presume it must *not* start a sentence. 98605436638acc7c010349a69c3395f1a57c642dc62Ying Wangbad_xref_re_ ?= (?:[\w,:;] +|(?:see|also)\s+)\@xref\{ 98705436638acc7c010349a69c3395f1a57c642dc62Ying Wangbad_pxref_re_ ?= (?:[.!?]|(?:see|also))\s+\@pxref\{ 98805436638acc7c010349a69c3395f1a57c642dc62Ying Wangprohibit_undesirable_word_seq_RE_ ?= \ 98905436638acc7c010349a69c3395f1a57c642dc62Ying Wang /(?:\bcan\s+not\b|$(bad_xref_re_)|$(bad_pxref_re_))/gims 99005436638acc7c010349a69c3395f1a57c642dc62Ying Wangprohibit_undesirable_word_seq_ = \ 99105436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e 'while ($(prohibit_undesirable_word_seq_RE_))' \ 99205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(perl_filename_lineno_text_) 99305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Define this to a regular expression that matches 99405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# any filename:dd:match lines you want to ignore. 99505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The default is to ignore no matches. 99605436638acc7c010349a69c3395f1a57c642dc62Ying Wangignore_undesirable_word_sequence_RE_ ?= ^$$ 99705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 99805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_undesirable_word_seq: 99905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @perl -n -0777 $(prohibit_undesirable_word_seq_) \ 100005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(VC_LIST_EXCEPT)) \ 100105436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \ 100205436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo '$(ME): undesirable word sequence' >&2; exit 1; } || : 100305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 100405436638acc7c010349a69c3395f1a57c642dc62Ying Wang_ptm1 = use "test C1 && test C2", not "test C1 -''a C2" 100505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_ptm2 = use "test C1 || test C2", not "test C1 -''o C2" 100605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Using test's -a and -o operators is not portable. 100705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# We prefer test over [, since the latter is spelled [[ in configure.ac. 100805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_test_minus_ao: 100905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='(\<test| \[+) .+ -[ao] ' \ 101005436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='$(_ptm1); $(_ptm2)' \ 101105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 101205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 101305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Avoid a test bashism. 101405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_test_double_equal: 101505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='(\<test| \[+) .+ == ' \ 101605436638acc7c010349a69c3395f1a57c642dc62Ying Wang containing='#! */bin/[a-z]*sh' \ 101705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='use "test x = x", not "test x =''= x"' \ 101805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 101905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 102005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Each program that uses proper_name_utf8 must link with one of the 102105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# ICONV libraries. Otherwise, some ICONV library must appear in LDADD. 102205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The perl -0777 invocation below extracts the possibly-multi-line 102305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# definition of LDADD from the appropriate Makefile.am and exits 0 102405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# when it contains "ICONV". 102505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_proper_name_utf8_requires_ICONV: 102605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\ 102705436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test "x$$progs" != x; then \ 102805436638acc7c010349a69c3395f1a57c642dc62Ying Wang fail=0; \ 102905436638acc7c010349a69c3395f1a57c642dc62Ying Wang for p in $$progs; do \ 103005436638acc7c010349a69c3395f1a57c642dc62Ying Wang dir=$$(dirname "$$p"); \ 103105436638acc7c010349a69c3395f1a57c642dc62Ying Wang perl -0777 \ 103205436638acc7c010349a69c3395f1a57c642dc62Ying Wang -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \ 103305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$dir/Makefile.am && continue; \ 103405436638acc7c010349a69c3395f1a57c642dc62Ying Wang base=$$(basename "$$p" .c); \ 103505436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \ 103605436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \ 103705436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 103805436638acc7c010349a69c3395f1a57c642dc62Ying Wang test $$fail = 1 && \ 103905436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \ 104005436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || :; \ 104105436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 104205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 104305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Warn about "c0nst struct Foo const foo[]", 104405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# but not about "char const *const foo" or "#define const const". 104505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_redundant_const: 104605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \ 104705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='redundant "const" in declarations' \ 104805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 104905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 105005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_const_long_option: 105105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^ *static.*struct option ' \ 105205436638acc7c010349a69c3395f1a57c642dc62Ying Wang exclude='const struct option|struct option const' \ 105305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='add "const" to the above declarations' \ 105405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 105505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 105605436638acc7c010349a69c3395f1a57c642dc62Ying WangNEWS_hash = \ 105705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \ 105805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(srcdir)/NEWS \ 105905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | perl -0777 -pe \ 106005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \ 106105436638acc7c010349a69c3395f1a57c642dc62Ying Wang | md5sum - \ 106205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | sed 's/ .*//') 106305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 106405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ensure that we don't accidentally insert an entry into an old NEWS block. 106505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_immutable_NEWS: 106605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if test -f $(srcdir)/NEWS; then \ 106705436638acc7c010349a69c3395f1a57c642dc62Ying Wang test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \ 106805436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \ 106905436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 107005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 107105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Update the hash stored above. Do this after each release and 107205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# for any corrections to old entries. 107305436638acc7c010349a69c3395f1a57c642dc62Ying Wangupdate-NEWS-hash: NEWS 107405436638acc7c010349a69c3395f1a57c642dc62Ying Wang perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \ 107505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(srcdir)/cfg.mk 107605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 107705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ensure that we use only the standard $(VAR) notation, 107805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# not @...@ in Makefile.am, now that we can rely on automake 107905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# to emit a definition for each substituted variable. 108005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# However, there is still one case in which @VAR@ use is not just 108105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# legitimate, but actually required: when augmenting an automake-defined 108205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# variable with a prefix. For example, gettext uses this: 108305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@ 108405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# otherwise, makeinfo would put German or French (current locale) 108505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# navigation hints in the otherwise-English documentation. 108605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# 108705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Allow the package to add exceptions via a hook in cfg.mk; 108805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by 108905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# setting this to ' && !/PRAGMA_SYSTEM_HEADER/'. 109005436638acc7c010349a69c3395f1a57c642dc62Ying Wang_makefile_at_at_check_exceptions ?= 109105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_makefile_at_at_check: 109205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @perl -ne '/\@\w+\@/' \ 109305436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ' && !/(\w+)\s+=.*\@\1\@$$/' \ 109405436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e ''$(_makefile_at_at_check_exceptions) \ 109505436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \ 109605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \ 109705436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || : 109805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 109905436638acc7c010349a69c3395f1a57c642dc62Ying Wangnews-check: NEWS 110005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)if sed -n $(news-check-lines-spec)p $< \ 110105436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -E $(news-check-regexp) >/dev/null; then \ 110205436638acc7c010349a69c3395f1a57c642dc62Ying Wang :; \ 110305436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 110405436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \ 110505436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; \ 110605436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 110705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 110805436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_makefile_TAB_only_indentation: 110905436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^ [ ]{8}' \ 111005436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='akefile|\.mk$$' \ 111105436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='found TAB-8-space indentation' \ 111205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 111305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 111405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_m4_quote_check: 111505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \ 111605436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='(^configure\.ac|\.m4)$$' \ 111705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='quote the first arg to AC_DEF*' \ 111805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 111905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 112005436638acc7c010349a69c3395f1a57c642dc62Ying Wangfix_po_file_diag = \ 112105436638acc7c010349a69c3395f1a57c642dc62Ying Wang'you have changed the set of files with translatable diagnostics;\n\ 112205436638acc7c010349a69c3395f1a57c642dc62Ying Wangapply the above patch\n' 112305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 112405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Verify that all source files using _() (more specifically, files that 112505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# match $(_gl_translatable_string_re)) are listed in po/POTFILES.in. 112605436638acc7c010349a69c3395f1a57c642dc62Ying Wangpo_file ?= $(srcdir)/po/POTFILES.in 112705436638acc7c010349a69c3395f1a57c642dc62Ying Wanggenerated_files ?= $(srcdir)/lib/*.[ch] 112805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_translatable_string_re ?= \b(N?_|gettext *)\([^)"]*("|$$) 112905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_po_check: 113005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if test -f $(po_file); then \ 113105436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -E -v '^(#|$$)' $(po_file) \ 113205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -v '^src/false\.c$$' | sort > $@-1; \ 113305436638acc7c010349a69c3395f1a57c642dc62Ying Wang files=; \ 113405436638acc7c010349a69c3395f1a57c642dc62Ying Wang for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do \ 113505436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -r $$file || continue; \ 113605436638acc7c010349a69c3395f1a57c642dc62Ying Wang case $$file in \ 113705436638acc7c010349a69c3395f1a57c642dc62Ying Wang *.m4|*.mk) continue ;; \ 113805436638acc7c010349a69c3395f1a57c642dc62Ying Wang *.?|*.??) ;; \ 113905436638acc7c010349a69c3395f1a57c642dc62Ying Wang *) continue;; \ 114005436638acc7c010349a69c3395f1a57c642dc62Ying Wang esac; \ 114105436638acc7c010349a69c3395f1a57c642dc62Ying Wang case $$file in \ 114205436638acc7c010349a69c3395f1a57c642dc62Ying Wang *.[ch]) \ 114305436638acc7c010349a69c3395f1a57c642dc62Ying Wang base=`expr " $$file" : ' \(.*\)\..'`; \ 114405436638acc7c010349a69c3395f1a57c642dc62Ying Wang { test -f $$base.l || test -f $$base.y; } && continue;; \ 114505436638acc7c010349a69c3395f1a57c642dc62Ying Wang esac; \ 114605436638acc7c010349a69c3395f1a57c642dc62Ying Wang files="$$files $$file"; \ 114705436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 114805436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -E -l '$(_gl_translatable_string_re)' $$files \ 114905436638acc7c010349a69c3395f1a57c642dc62Ying Wang | sed 's|^$(_dot_escaped_srcdir)/||' | sort -u > $@-2; \ 115005436638acc7c010349a69c3395f1a57c642dc62Ying Wang diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \ 115105436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \ 115205436638acc7c010349a69c3395f1a57c642dc62Ying Wang rm -f $@-1 $@-2; \ 115305436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 115405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 115505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Sometimes it is useful to change the PATH environment variable 115605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# in Makefiles. When doing so, it's better not to use the Unix-centric 115705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# path separator of ':', but rather the automake-provided '$(PATH_SEPARATOR)'. 115805436638acc7c010349a69c3395f1a57c642dc62Ying Wangmsg = 'Do not use ":" above; use $$(PATH_SEPARATOR) instead' 115905436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_makefile_path_separator_check: 116005436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='PATH[=].*:' \ 116105436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files='akefile|\.mk$$' \ 116205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt=$(msg) \ 116305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 116405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 116505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Check that 'make alpha' will not fail at the end of the process, 116605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# i.e., when pkg-M.N.tar.xz already exists (either in "." or in ../release) 116705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# and is read-only. 116805436638acc7c010349a69c3395f1a57c642dc62Ying Wangwritable-files: 116905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)if test -d $(release_archive_dir); then \ 117005436638acc7c010349a69c3395f1a57c642dc62Ying Wang for file in $(DIST_ARCHIVES); do \ 117105436638acc7c010349a69c3395f1a57c642dc62Ying Wang for p in ./ $(release_archive_dir)/; do \ 117205436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -e $$p$$file || continue; \ 117305436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -w $$p$$file \ 117405436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo ERROR: $$p$$file is not writable; fail=1; }; \ 117505436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 117605436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 117705436638acc7c010349a69c3395f1a57c642dc62Ying Wang test "$$fail" && exit 1 || : ; \ 117805436638acc7c010349a69c3395f1a57c642dc62Ying Wang else :; \ 117905436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 118005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 118105436638acc7c010349a69c3395f1a57c642dc62Ying Wangv_etc_file = $(gnulib_dir)/lib/version-etc.c 118205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsample-test = tests/sample-test 118305436638acc7c010349a69c3395f1a57c642dc62Ying Wangtexi = doc/$(PACKAGE).texi 118405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Make sure that the copyright date in $(v_etc_file) is up to date. 118505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Do the same for the $(sample-test) and the main doc/.texi file. 118605436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_copyright_check: 118705436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \ 118805436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_files=$(v_etc_file) \ 118905436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='out of date copyright in $(v_etc_file); update it' \ 119005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 119105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='# Copyright \(C\) '$$(date +%Y)' Free' \ 119205436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files=$(sample-test) \ 119305436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='out of date copyright in $(sample-test); update it' \ 119405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 119505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \ 119605436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_vc_files=$(texi) \ 119705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='out of date copyright in $(texi); update it' \ 119805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 119905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 120005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If tests/help-version exists and seems to be new enough, assume that its 120105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# use of init.sh and path_prepend_ is correct, and ensure that every other 120205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# use of init.sh is identical. 120305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This is useful because help-version cross-checks prog --version 120405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# with $(VERSION), which verifies that its path_prepend_ invocation 120505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# sets PATH correctly. This is an inexpensive way to ensure that 120605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# the other init.sh-using tests also get it right. 120705436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hv_file ?= $(srcdir)/tests/help-version 120805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hv_regex_weak ?= ^ *\. .*/init\.sh" 120905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Fix syntax-highlighters " 121005436638acc7c010349a69c3395f1a57c642dc62Ying Wang_hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh" 121105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_cross_check_PATH_usage_in_tests: 121205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @if test -f $(_hv_file); then \ 121305436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \ 121405436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2; \ 121505436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 0; }; \ 121605436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null \ 121705436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \ 121805436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; }; \ 121905436638acc7c010349a69c3395f1a57c642dc62Ying Wang good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file)); \ 122005436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -LFx "$$good" \ 122105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT))) \ 122205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep . && \ 122305436638acc7c010349a69c3395f1a57c642dc62Ying Wang { echo "$(ME): the above files use path_prepend_ inconsistently" \ 122405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 1>&2; exit 1; } || :; \ 122505436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 122605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 122705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# BRE regex of file contents to identify a test script. 122805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_test_script_regex ?= \<init\.sh\> 122905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 123005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# In tests, use "compare expected actual", not the reverse. 123105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_reversed_compare_failure: 123205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='\<compare [^ ]+ ([^ ]*exp|/dev/null)' \ 123305436638acc7c010349a69c3395f1a57c642dc62Ying Wang containing='$(_test_script_regex)' \ 123405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='reversed compare arguments' \ 123505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 123605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 123705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# #if HAVE_... will evaluate to false for any non numeric string. 123805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# That would be flagged by using -Wundef, however gnulib currently 123905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# tests many undefined macros, and so we can't enable that option. 124005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# So at least preclude common boolean strings as macro values. 124105436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_Wundef_boolean: 124205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='^#define.*(yes|no|true|false)$$' \ 124305436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_files='$(CONFIG_INCLUDE)' \ 124405436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='Use 0 or 1 for macro values' \ 124505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 124605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 124705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Even if you use pathmax.h to guarantee that PATH_MAX is defined, it might 124805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# not be constant, or might overflow a stack. In general, use PATH_MAX as 124905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# a limit, not an array or alloca size. 125005436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_prohibit_path_max_allocation: 125105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='(\balloca *\([^)]*|\[[^]]*)\bPATH_MAX' \ 125205436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt='Avoid stack allocations of size PATH_MAX' \ 125305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 125405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 125505436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_vulnerable_makefile_CVE-2009-4029: 125605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \ 125705436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_files='(^|/)Makefile\.in$$' \ 125805436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt=$$(printf '%s\n' \ 125905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 'the above files are vulnerable; beware of running' \ 126005436638acc7c010349a69c3395f1a57c642dc62Ying Wang ' "make dist*" rules, and upgrade to fixed automake' \ 126105436638acc7c010349a69c3395f1a57c642dc62Ying Wang ' see http://bugzilla.redhat.com/542609 for details') \ 126205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 126305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 126405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_vulnerable_makefile_CVE-2012-3386: 126505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @prohibit='chmod a\+w \$$\(distdir\)' \ 126605436638acc7c010349a69c3395f1a57c642dc62Ying Wang in_files='(^|/)Makefile\.in$$' \ 126705436638acc7c010349a69c3395f1a57c642dc62Ying Wang halt=$$(printf '%s\n' \ 126805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 'the above files are vulnerable; beware of running' \ 126905436638acc7c010349a69c3395f1a57c642dc62Ying Wang ' "make distcheck", and upgrade to fixed automake' \ 127005436638acc7c010349a69c3395f1a57c642dc62Ying Wang ' see http://bugzilla.redhat.com/CVE-2012-3386 for details') \ 127105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(_sc_search_regexp) 127205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 127305436638acc7c010349a69c3395f1a57c642dc62Ying Wangvc-diff-check: 127405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)(unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || : 127505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)if test -s vc-diffs; then \ 127605436638acc7c010349a69c3395f1a57c642dc62Ying Wang cat vc-diffs; \ 127705436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo "Some files are locally modified:" 1>&2; \ 127805436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; \ 127905436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 128005436638acc7c010349a69c3395f1a57c642dc62Ying Wang rm vc-diffs; \ 128105436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 128205436638acc7c010349a69c3395f1a57c642dc62Ying Wang 128305436638acc7c010349a69c3395f1a57c642dc62Ying Wangrel-files = $(DIST_ARCHIVES) 128405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 128505436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnulib_dir ?= $(srcdir)/gnulib 128605436638acc7c010349a69c3395f1a57c642dc62Ying Wanggnulib-version = $$(cd $(gnulib_dir) && git describe) 128705436638acc7c010349a69c3395f1a57c642dc62Ying Wangbootstrap-tools ?= autoconf,automake,gnulib 128805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 128905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If it's not already specified, derive the GPG key ID from 129005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# the signed tag we've just applied to mark this release. 129105436638acc7c010349a69c3395f1a57c642dc62Ying Wanggpg_key_ID ?= \ 129205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$(cd $(srcdir) \ 129305436638acc7c010349a69c3395f1a57c642dc62Ying Wang && git cat-file tag v$(VERSION) \ 129405436638acc7c010349a69c3395f1a57c642dc62Ying Wang | gpgv --status-fd 1 --keyring /dev/null - - 2>/dev/null \ 129505436638acc7c010349a69c3395f1a57c642dc62Ying Wang | awk '/^\[GNUPG:\] ERRSIG / {print $$3; exit}') 129605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 129705436638acc7c010349a69c3395f1a57c642dc62Ying Wangtranslation_project_ ?= coordinator@translationproject.org 129805436638acc7c010349a69c3395f1a57c642dc62Ying Wang 129905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Make info-gnu the default only for a stable release. 130005436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_Cc_stable = $(translation_project_), $(PACKAGE_BUGREPORT) 130105436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_headers_stable = \ 130205436638acc7c010349a69c3395f1a57c642dc62Ying Wang To: info-gnu@gnu.org \ 130305436638acc7c010349a69c3395f1a57c642dc62Ying Wang Cc: $(announcement_Cc_) \ 130405436638acc7c010349a69c3395f1a57c642dc62Ying Wang Mail-Followup-To: $(PACKAGE_BUGREPORT) 130505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 130605436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_Cc_alpha = $(translation_project_) 130705436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_headers_alpha = \ 130805436638acc7c010349a69c3395f1a57c642dc62Ying Wang To: $(PACKAGE_BUGREPORT) \ 130905436638acc7c010349a69c3395f1a57c642dc62Ying Wang Cc: $(announcement_Cc_) 131005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 131105436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_Cc_beta = $(announcement_mail_Cc_alpha) 131205436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_headers_beta = $(announcement_mail_headers_alpha) 131305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 131405436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_Cc_ ?= $(announcement_mail_Cc_$(release-type)) 131505436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement_mail_headers_ ?= $(announcement_mail_headers_$(release-type)) 131605436638acc7c010349a69c3395f1a57c642dc62Ying Wangannouncement: NEWS ChangeLog $(rel-files) 131705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Not $(AM_V_GEN) since the output of this command serves as 131805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# announcement message: it would start with " GEN announcement". 131905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(srcdir)/$(_build-aux)/announce-gen \ 132005436638acc7c010349a69c3395f1a57c642dc62Ying Wang --mail-headers='$(announcement_mail_headers_)' \ 132105436638acc7c010349a69c3395f1a57c642dc62Ying Wang --release-type=$(release-type) \ 132205436638acc7c010349a69c3395f1a57c642dc62Ying Wang --package=$(PACKAGE) \ 132305436638acc7c010349a69c3395f1a57c642dc62Ying Wang --prev=$(PREV_VERSION) \ 132405436638acc7c010349a69c3395f1a57c642dc62Ying Wang --curr=$(VERSION) \ 132505436638acc7c010349a69c3395f1a57c642dc62Ying Wang --gpg-key-id=$(gpg_key_ID) \ 132605436638acc7c010349a69c3395f1a57c642dc62Ying Wang --srcdir=$(srcdir) \ 132705436638acc7c010349a69c3395f1a57c642dc62Ying Wang --news=$(srcdir)/NEWS \ 132805436638acc7c010349a69c3395f1a57c642dc62Ying Wang --bootstrap-tools=$(bootstrap-tools) \ 132905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$(case ,$(bootstrap-tools), in (*,gnulib,*) \ 133005436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo --gnulib-version=$(gnulib-version);; esac) \ 133105436638acc7c010349a69c3395f1a57c642dc62Ying Wang --no-print-checksums \ 133205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(addprefix --url-dir=, $(url_dir_list)) 133305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 133405436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: release-commit 133505436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease-commit: 133605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)cd $(srcdir) \ 133705436638acc7c010349a69c3395f1a57c642dc62Ying Wang && $(_build-aux)/do-release-commit-and-tag \ 133805436638acc7c010349a69c3395f1a57c642dc62Ying Wang -C $(abs_builddir) $(RELEASE) 133905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 134005436638acc7c010349a69c3395f1a57c642dc62Ying Wang## ---------------- ## 134105436638acc7c010349a69c3395f1a57c642dc62Ying Wang## Updating files. ## 134205436638acc7c010349a69c3395f1a57c642dc62Ying Wang## ---------------- ## 134305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 134405436638acc7c010349a69c3395f1a57c642dc62Ying Wangftp-gnu = ftp://ftp.gnu.org/gnu 134505436638acc7c010349a69c3395f1a57c642dc62Ying Wangwww-gnu = http://www.gnu.org 134605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 134705436638acc7c010349a69c3395f1a57c642dc62Ying Wangupload_dest_dir_ ?= $(PACKAGE) 134805436638acc7c010349a69c3395f1a57c642dc62Ying Wangupload_command = \ 134905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(srcdir)/$(_build-aux)/gnupload $(GNUPLOADFLAGS) \ 135005436638acc7c010349a69c3395f1a57c642dc62Ying Wang --to $(gnu_rel_host):$(upload_dest_dir_) \ 135105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(rel-files) 135205436638acc7c010349a69c3395f1a57c642dc62Ying Wangemit_upload_commands: 135305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo ===================================== 135405436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo ===================================== 135505436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo '$(upload_command)' 135605436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo '# send the ~/announce-$(my_distdir) e-mail' 135705436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo ===================================== 135805436638acc7c010349a69c3395f1a57c642dc62Ying Wang @echo ===================================== 135905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 136005436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: upload 136105436638acc7c010349a69c3395f1a57c642dc62Ying Wangupload: 136205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)$(upload_command) 136305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 136405436638acc7c010349a69c3395f1a57c642dc62Ying Wangdefine emit-commit-log 136505436638acc7c010349a69c3395f1a57c642dc62Ying Wang printf '%s\n' 'maint: post-release administrivia' '' \ 136605436638acc7c010349a69c3395f1a57c642dc62Ying Wang '* NEWS: Add header line for next release.' \ 136705436638acc7c010349a69c3395f1a57c642dc62Ying Wang '* .prev-version: Record previous version.' \ 136805436638acc7c010349a69c3395f1a57c642dc62Ying Wang '* cfg.mk (old_NEWS_hash): Auto-update.' 136905436638acc7c010349a69c3395f1a57c642dc62Ying Wangendef 137005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 137105436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: no-submodule-changes 137205436638acc7c010349a69c3395f1a57c642dc62Ying Wangno-submodule-changes: 137305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)if test -d $(srcdir)/.git; then \ 137405436638acc7c010349a69c3395f1a57c642dc62Ying Wang diff=$$(cd $(srcdir) && git submodule -q foreach \ 137505436638acc7c010349a69c3395f1a57c642dc62Ying Wang git diff-index --name-only HEAD) \ 137605436638acc7c010349a69c3395f1a57c642dc62Ying Wang || exit 1; \ 137705436638acc7c010349a69c3395f1a57c642dc62Ying Wang case $$diff in '') ;; \ 137805436638acc7c010349a69c3395f1a57c642dc62Ying Wang *) echo '$(ME): submodule files are locally modified:'; \ 137905436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo "$$diff"; exit 1;; esac; \ 138005436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 138105436638acc7c010349a69c3395f1a57c642dc62Ying Wang : ; \ 138205436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 138305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 138405436638acc7c010349a69c3395f1a57c642dc62Ying Wangsubmodule-checks ?= no-submodule-changes public-submodule-commit 138505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 138605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Ensure that each sub-module commit we're using is public. 138705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Without this, it is too easy to tag and release code that 138805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# cannot be built from a fresh clone. 138905436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: public-submodule-commit 139005436638acc7c010349a69c3395f1a57c642dc62Ying Wangpublic-submodule-commit: 139105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)if test -d $(srcdir)/.git; then \ 139205436638acc7c010349a69c3395f1a57c642dc62Ying Wang cd $(srcdir) && \ 139305436638acc7c010349a69c3395f1a57c642dc62Ying Wang git submodule --quiet foreach \ 139405436638acc7c010349a69c3395f1a57c642dc62Ying Wang test '"$$(git rev-parse "$$sha1")"' \ 139505436638acc7c010349a69c3395f1a57c642dc62Ying Wang = '"$$(git merge-base origin "$$sha1")"' \ 139605436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo '$(ME): found non-public submodule commit' >&2; \ 139705436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; }; \ 139805436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 139905436638acc7c010349a69c3395f1a57c642dc62Ying Wang : ; \ 140005436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 140105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This rule has a high enough utility/cost ratio that it should be a 140205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# dependent of "check" by default. However, some of us do occasionally 140305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# commit a temporary change that deliberately points to a non-public 140405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# submodule commit, and want to be able to use rules like "make check". 140505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# In that case, run e.g., "make check gl_public_submodule_commit=" 140605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# to disable this test. 140705436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_public_submodule_commit ?= public-submodule-commit 140805436638acc7c010349a69c3395f1a57c642dc62Ying Wangcheck: $(gl_public_submodule_commit) 140905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 141005436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: alpha beta stable release 141105436638acc7c010349a69c3395f1a57c642dc62Ying WangALL_RECURSIVE_TARGETS += alpha beta stable 141205436638acc7c010349a69c3395f1a57c642dc62Ying Wangalpha beta stable: $(local-check) writable-files $(submodule-checks) 141305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)test $@ = stable \ 141405436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \ 141505436638acc7c010349a69c3395f1a57c642dc62Ying Wang || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\ 141605436638acc7c010349a69c3395f1a57c642dc62Ying Wang || : 141705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) vc-diff-check 141805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) news-check 141905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) distcheck 142005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) dist 142105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) $(release-prep-hook) RELEASE_TYPE=$@ 142205436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) -s emit_upload_commands RELEASE_TYPE=$@ 142305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 142405436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease: 142505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)$(MAKE) $(release-type) 142605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 142705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Override this in cfg.mk if you follow different procedures. 142805436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease-prep-hook ?= release-prep 142905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 143005436638acc7c010349a69c3395f1a57c642dc62Ying Wanggl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?] 143105436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: release-prep 143205436638acc7c010349a69c3395f1a57c642dc62Ying Wangrelease-prep: 143305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)$(MAKE) --no-print-directory -s announcement \ 143405436638acc7c010349a69c3395f1a57c642dc62Ying Wang > ~/announce-$(my_distdir) 143505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)if test -d $(release_archive_dir); then \ 143605436638acc7c010349a69c3395f1a57c642dc62Ying Wang ln $(rel-files) $(release_archive_dir); \ 143705436638acc7c010349a69c3395f1a57c642dc62Ying Wang chmod a-w $(rel-files); \ 143805436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi 143905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)echo $(VERSION) > $(prev_version_file) 144005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)$(MAKE) update-NEWS-hash 144105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)perl -pi \ 144205436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' \ 144305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(srcdir)/NEWS 144405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)msg=$$($(emit-commit-log)) || exit 1; \ 144505436638acc7c010349a69c3395f1a57c642dc62Ying Wang cd $(srcdir) && $(VC) commit -m "$$msg" -a 144605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 144705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Override this with e.g., -s $(srcdir)/some_other_name.texi 144805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# if the default $(PACKAGE)-derived name doesn't apply. 144905436638acc7c010349a69c3395f1a57c642dc62Ying Wanggendocs_options_ ?= 145005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 145105436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: web-manual 145205436638acc7c010349a69c3395f1a57c642dc62Ying Wangweb-manual: 145305436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)test -z "$(manual_title)" \ 145405436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo define manual_title in cfg.mk 1>&2; exit 1; } || : 145505436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)cd '$(srcdir)/doc'; \ 145605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(SHELL) ../$(_build-aux)/gendocs.sh $(gendocs_options_) \ 145705436638acc7c010349a69c3395f1a57c642dc62Ying Wang -o '$(abs_builddir)/doc/manual' \ 145805436638acc7c010349a69c3395f1a57c642dc62Ying Wang --email $(PACKAGE_BUGREPORT) $(PACKAGE) \ 145905436638acc7c010349a69c3395f1a57c642dc62Ying Wang "$(PACKAGE_NAME) - $(manual_title)" 146005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_at)echo " *** Upload the doc/manual directory to web-cvs." 146105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 146205436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: web-manual-update 146305436638acc7c010349a69c3395f1a57c642dc62Ying Wangweb-manual-update: 146405436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)cd $(srcdir) \ 146505436638acc7c010349a69c3395f1a57c642dc62Ying Wang && $(_build-aux)/gnu-web-doc-update -C $(abs_builddir) 146605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 146705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 146805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Code Coverage 146905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 147005436638acc7c010349a69c3395f1a57c642dc62Ying Wanginit-coverage: 147105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(MAKE) $(AM_MAKEFLAGS) clean 147205436638acc7c010349a69c3395f1a57c642dc62Ying Wang lcov --directory . --zerocounters 147305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 147405436638acc7c010349a69c3395f1a57c642dc62Ying WangCOVERAGE_CCOPTS ?= "-g --coverage" 147505436638acc7c010349a69c3395f1a57c642dc62Ying WangCOVERAGE_OUT ?= doc/coverage 147605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 147705436638acc7c010349a69c3395f1a57c642dc62Ying Wangbuild-coverage: 147805436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) 147905436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check 148005436638acc7c010349a69c3395f1a57c642dc62Ying Wang mkdir -p $(COVERAGE_OUT) 148105436638acc7c010349a69c3395f1a57c642dc62Ying Wang lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \ 148205436638acc7c010349a69c3395f1a57c642dc62Ying Wang --capture 148305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 148405436638acc7c010349a69c3395f1a57c642dc62Ying Wanggen-coverage: 148505436638acc7c010349a69c3395f1a57c642dc62Ying Wang genhtml --output-directory $(COVERAGE_OUT) \ 148605436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(COVERAGE_OUT)/$(PACKAGE).info \ 148705436638acc7c010349a69c3395f1a57c642dc62Ying Wang --highlight --frames --legend \ 148805436638acc7c010349a69c3395f1a57c642dc62Ying Wang --title "$(PACKAGE_NAME)" 148905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 149005436638acc7c010349a69c3395f1a57c642dc62Ying Wangcoverage: init-coverage build-coverage gen-coverage 149105436638acc7c010349a69c3395f1a57c642dc62Ying Wang 149205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Some projects carry local adjustments for gnulib modules via patches in 149305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# a gnulib patch directory whose default name is gl/ (defined in bootstrap 149405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# via local_gl_dir=gl). Those patches become stale as the originals evolve 149505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# in gnulib. Use this rule to refresh any stale patches. It applies each 149605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# patch to the original in $(gnulib_dir) and uses the temporary result to 149705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# generate a fuzz-free .diff file. If you customize the name of your local 149805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# gnulib patch directory via bootstrap.conf, this rule detects that name. 149905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Run this from a non-VPATH (i.e., srcdir) build directory. 150005436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: refresh-gnulib-patches 150105436638acc7c010349a69c3395f1a57c642dc62Ying Wangrefresh-gnulib-patches: 150205436638acc7c010349a69c3395f1a57c642dc62Ying Wang gl=gl; \ 150305436638acc7c010349a69c3395f1a57c642dc62Ying Wang if test -f bootstrap.conf; then \ 150405436638acc7c010349a69c3395f1a57c642dc62Ying Wang t=$$(perl -lne '/^\s*local_gl_dir=(\S+)/ and $$d=$$1;' \ 150505436638acc7c010349a69c3395f1a57c642dc62Ying Wang -e 'END{defined $$d and print $$d}' bootstrap.conf); \ 150605436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -n "$$t" && gl=$$t; \ 150705436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi; \ 150805436638acc7c010349a69c3395f1a57c642dc62Ying Wang for diff in $$(cd $$gl; git ls-files | grep '\.diff$$'); do \ 150905436638acc7c010349a69c3395f1a57c642dc62Ying Wang b=$$(printf %s "$$diff"|sed 's/\.diff$$//'); \ 151005436638acc7c010349a69c3395f1a57c642dc62Ying Wang VERSION_CONTROL=none \ 151105436638acc7c010349a69c3395f1a57c642dc62Ying Wang patch "$(gnulib_dir)/$$b" "$$gl/$$diff" || exit 1; \ 151205436638acc7c010349a69c3395f1a57c642dc62Ying Wang ( cd $(gnulib_dir) || exit 1; \ 151305436638acc7c010349a69c3395f1a57c642dc62Ying Wang git diff "$$b" > "../$$gl/$$diff"; \ 151405436638acc7c010349a69c3395f1a57c642dc62Ying Wang git checkout $$b ) || exit 1; \ 151505436638acc7c010349a69c3395f1a57c642dc62Ying Wang done 151605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 151705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Update gettext files. 151805436638acc7c010349a69c3395f1a57c642dc62Ying WangPACKAGE ?= $(shell basename $(PWD)) 151905436638acc7c010349a69c3395f1a57c642dc62Ying WangPO_DOMAIN ?= $(PACKAGE) 152005436638acc7c010349a69c3395f1a57c642dc62Ying WangPOURL = http://translationproject.org/latest/$(PO_DOMAIN)/ 152105436638acc7c010349a69c3395f1a57c642dc62Ying WangPODIR ?= po 152205436638acc7c010349a69c3395f1a57c642dc62Ying Wangrefresh-po: 152305436638acc7c010349a69c3395f1a57c642dc62Ying Wang rm -f $(PODIR)/*.po && \ 152405436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \ 152505436638acc7c010349a69c3395f1a57c642dc62Ying Wang wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \ 152605436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo 'en@boldquot' > $(PODIR)/LINGUAS && \ 152705436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo 'en@quot' >> $(PODIR)/LINGUAS && \ 152805436638acc7c010349a69c3395f1a57c642dc62Ying Wang ls $(PODIR)/*.po | sed 's/\.po//;s,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS 152905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 153005436638acc7c010349a69c3395f1a57c642dc62Ying Wang # Running indent once is not idempotent, but running it twice is. 153105436638acc7c010349a69c3395f1a57c642dc62Ying WangINDENT_SOURCES ?= $(C_SOURCES) 153205436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: indent 153305436638acc7c010349a69c3395f1a57c642dc62Ying Wangindent: 153405436638acc7c010349a69c3395f1a57c642dc62Ying Wang indent $(INDENT_SOURCES) 153505436638acc7c010349a69c3395f1a57c642dc62Ying Wang indent $(INDENT_SOURCES) 153605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 153705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If you want to set UPDATE_COPYRIGHT_* environment variables, 153805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# put the assignments in this variable. 153905436638acc7c010349a69c3395f1a57c642dc62Ying Wangupdate-copyright-env ?= 154005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 154105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Run this rule once per year (usually early in January) 154205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# to update all FSF copyright year lists in your project. 154305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If you have an additional project-specific rule, 154405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# add it in cfg.mk along with a line 'update-copyright: prereq'. 154505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# By default, exclude all variants of COPYING; you can also 154605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# add exemptions (such as ChangeLog..* for rotated change logs) 154705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# in the file .x-update-copyright. 154805436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: update-copyright 154905436638acc7c010349a69c3395f1a57c642dc62Ying Wangupdate-copyright: 155005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(AM_V_GEN)grep -l -w Copyright \ 155105436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \ 155205436638acc7c010349a69c3395f1a57c642dc62Ying Wang | $(update-copyright-env) xargs $(srcdir)/$(_build-aux)/$@ 155305436638acc7c010349a69c3395f1a57c642dc62Ying Wang 155405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# This tight_scope test is skipped with a warning if $(_gl_TS_headers) is not 155505436638acc7c010349a69c3395f1a57c642dc62Ying Wang# overridden and $(_gl_TS_dir)/Makefile.am does not mention noinst_HEADERS. 155605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 155705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# NOTE: to override any _gl_TS_* default value, you must 155805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# define the variable(s) using "export" in cfg.mk. 155905436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_dir ?= src 156005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 156105436638acc7c010349a69c3395f1a57c642dc62Ying WangALL_RECURSIVE_TARGETS += sc_tight_scope 156205436638acc7c010349a69c3395f1a57c642dc62Ying Wangsc_tight_scope: tight-scope.mk 156305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @fail=0; \ 156405436638acc7c010349a69c3395f1a57c642dc62Ying Wang if ! grep '^ *export _gl_TS_headers *=' $(srcdir)/cfg.mk \ 156505436638acc7c010349a69c3395f1a57c642dc62Ying Wang > /dev/null \ 156605436638acc7c010349a69c3395f1a57c642dc62Ying Wang && ! grep -w noinst_HEADERS $(srcdir)/$(_gl_TS_dir)/Makefile.am \ 156705436638acc7c010349a69c3395f1a57c642dc62Ying Wang > /dev/null 2>&1; then \ 156805436638acc7c010349a69c3395f1a57c642dc62Ying Wang echo '$(ME): skipping $@'; \ 156905436638acc7c010349a69c3395f1a57c642dc62Ying Wang else \ 157005436638acc7c010349a69c3395f1a57c642dc62Ying Wang $(MAKE) -s -C $(_gl_TS_dir) \ 157105436638acc7c010349a69c3395f1a57c642dc62Ying Wang -f Makefile \ 157205436638acc7c010349a69c3395f1a57c642dc62Ying Wang -f $(abs_top_srcdir)/cfg.mk \ 157305436638acc7c010349a69c3395f1a57c642dc62Ying Wang -f $(abs_top_builddir)/$< \ 157405436638acc7c010349a69c3395f1a57c642dc62Ying Wang _gl_tight_scope \ 157505436638acc7c010349a69c3395f1a57c642dc62Ying Wang || fail=1; \ 157605436638acc7c010349a69c3395f1a57c642dc62Ying Wang fi; \ 157705436638acc7c010349a69c3395f1a57c642dc62Ying Wang rm -f $<; \ 157805436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit $$fail 157905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 158005436638acc7c010349a69c3395f1a57c642dc62Ying Wangtight-scope.mk: $(ME) 158105436638acc7c010349a69c3395f1a57c642dc62Ying Wang @rm -f $@ $@-t 158205436638acc7c010349a69c3395f1a57c642dc62Ying Wang @perl -ne '/^# TS-start/.../^# TS-end/ and print' $(srcdir)/$(ME) > $@-t 158305436638acc7c010349a69c3395f1a57c642dc62Ying Wang @chmod a=r $@-t && mv $@-t $@ 158405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 158505436638acc7c010349a69c3395f1a57c642dc62Ying Wangifeq (a,b) 158605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# TS-start 158705436638acc7c010349a69c3395f1a57c642dc62Ying Wang 158805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Most functions should have static scope. 158905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Any that don't must be marked with 'extern', but 'main' 159005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# and 'usage' are exceptions: they're always extern, but 159105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# do not need to be marked. Symbols matching '__.*' are 159205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# reserved by the compiler, so are automatically excluded below. 159305436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_unmarked_extern_functions ?= main usage 159405436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_function_match ?= /^(?:$(_gl_TS_extern)) +.*?(\S+) *\(/ 159505436638acc7c010349a69c3395f1a57c642dc62Ying Wang 159605436638acc7c010349a69c3395f1a57c642dc62Ying Wang# If your project uses a macro like "XTERN", then put 159705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# the following in cfg.mk to override this default: 159805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# export _gl_TS_extern = extern|XTERN 159905436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_extern ?= extern 160005436638acc7c010349a69c3395f1a57c642dc62Ying Wang 160105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The second nm|grep checks for file-scope variables with 'extern' scope. 160205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Without gnulib's progname module, you might put program_name here. 160305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Symbols matching '__.*' are reserved by the compiler, 160405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# so are automatically excluded below. 160505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_unmarked_extern_vars ?= 160605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 160705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# NOTE: the _match variables are perl expressions -- not mere regular 160805436638acc7c010349a69c3395f1a57c642dc62Ying Wang# expressions -- so that you can extend them to match other patterns 160905436638acc7c010349a69c3395f1a57c642dc62Ying Wang# and easily extract matched variable names. 161005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# For example, if your project declares some global variables via 161105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# a macro like this: GLOBAL(type, var_name, initializer), then you 161205436638acc7c010349a69c3395f1a57c642dc62Ying Wang# can override this definition to automatically extract those names: 161305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# export _gl_TS_var_match = \ 161405436638acc7c010349a69c3395f1a57c642dc62Ying Wang# /^(?:$(_gl_TS_extern)) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/ 161505436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_var_match ?= /^(?:$(_gl_TS_extern)) .*?(\w+)(\[.*?\])?;/ 161605436638acc7c010349a69c3395f1a57c642dc62Ying Wang 161705436638acc7c010349a69c3395f1a57c642dc62Ying Wang# The names of object files in (or relative to) $(_gl_TS_dir). 161805436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_obj_files ?= *.$(OBJEXT) 161905436638acc7c010349a69c3395f1a57c642dc62Ying Wang 162005436638acc7c010349a69c3395f1a57c642dc62Ying Wang# Files in which to search for the one-line style extern declarations. 162105436638acc7c010349a69c3395f1a57c642dc62Ying Wang# $(_gl_TS_dir)-relative. 162205436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_headers ?= $(noinst_HEADERS) 162305436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_TS_other_headers ?= *.h 162405436638acc7c010349a69c3395f1a57c642dc62Ying Wang 162505436638acc7c010349a69c3395f1a57c642dc62Ying Wang.PHONY: _gl_tight_scope 162605436638acc7c010349a69c3395f1a57c642dc62Ying Wang_gl_tight_scope: $(bin_PROGRAMS) 162705436638acc7c010349a69c3395f1a57c642dc62Ying Wang t=exceptions-$$$$; \ 162805436638acc7c010349a69c3395f1a57c642dc62Ying Wang trap 's=$$?; rm -f $$t; exit $$s' 0; \ 162905436638acc7c010349a69c3395f1a57c642dc62Ying Wang for sig in 1 2 3 13 15; do \ 163005436638acc7c010349a69c3395f1a57c642dc62Ying Wang eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \ 163105436638acc7c010349a69c3395f1a57c642dc62Ying Wang done; \ 163205436638acc7c010349a69c3395f1a57c642dc62Ying Wang src=`for f in $(SOURCES); do \ 163305436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ 163405436638acc7c010349a69c3395f1a57c642dc62Ying Wang hdr=`for f in $(_gl_TS_headers); do \ 163505436638acc7c010349a69c3395f1a57c642dc62Ying Wang test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ 163605436638acc7c010349a69c3395f1a57c642dc62Ying Wang ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_functions); \ 163705436638acc7c010349a69c3395f1a57c642dc62Ying Wang grep -h -A1 '^extern .*[^;]$$' $$src \ 163805436638acc7c010349a69c3395f1a57c642dc62Ying Wang | grep -vE '^(extern |--)' | sed 's/ .*//'; \ 163905436638acc7c010349a69c3395f1a57c642dc62Ying Wang perl -lne \ 164005436638acc7c010349a69c3395f1a57c642dc62Ying Wang '$(_gl_TS_function_match) and print "^$$1\$$"' $$hdr; \ 164105436638acc7c010349a69c3395f1a57c642dc62Ying Wang ) | sort -u > $$t; \ 164205436638acc7c010349a69c3395f1a57c642dc62Ying Wang nm -e $(_gl_TS_obj_files) | sed -n 's/.* T //p'|grep -Ev -f $$t \ 164305436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo the above functions should have static scope >&2; \ 164405436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : ; \ 164505436638acc7c010349a69c3395f1a57c642dc62Ying Wang ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_vars); \ 164605436638acc7c010349a69c3395f1a57c642dc62Ying Wang perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' \ 164705436638acc7c010349a69c3395f1a57c642dc62Ying Wang $$hdr $(_gl_TS_other_headers) \ 164805436638acc7c010349a69c3395f1a57c642dc62Ying Wang ) | sort -u > $$t; \ 164905436638acc7c010349a69c3395f1a57c642dc62Ying Wang nm -e $(_gl_TS_obj_files) | sed -n 's/.* [BCDGRS] //p' \ 165005436638acc7c010349a69c3395f1a57c642dc62Ying Wang | sort -u | grep -Ev -f $$t \ 165105436638acc7c010349a69c3395f1a57c642dc62Ying Wang && { echo the above variables should have static scope >&2; \ 165205436638acc7c010349a69c3395f1a57c642dc62Ying Wang exit 1; } || : 165305436638acc7c010349a69c3395f1a57c642dc62Ying Wang# TS-end 165405436638acc7c010349a69c3395f1a57c642dc62Ying Wangendif 1655