Mercurial > gnulib
annotate top/maint.mk @ 16726:518ff78686bb
maint.mk: fix syntax checks without exclusions
Commit 727075d0 skipped per-line exclusions if ${exclude} is left
undefined, but was immediately broken by commit 44de969c which
always initialized the variable to the empty string.
* top/maint.mk (_sc_search_regexp): Allow for empty variable.
Reported by Daniel P. Berrange.
Signed-off-by: Eric Blake <eblake@redhat.com>
author | Eric Blake <eblake@redhat.com> |
---|---|
date | Thu, 29 Mar 2012 20:47:55 -0600 |
parents | fcfa472825d5 |
children | b05bc6bf8e60 |
rev | line source |
---|---|
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1 # -*-Makefile-*- |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
2 # This Makefile fragment tries to be general-purpose enough to be |
11501
5223ecd9ec17
maint.mk: import improvements from m4
Eric Blake <ebb9@byu.net>
parents:
11500
diff
changeset
|
3 # used by many projects via the gnulib maintainer-makefile module. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
4 |
16201
8250f2777afc
maint: update all copyright year number ranges
Jim Meyering <meyering@redhat.com>
parents:
16134
diff
changeset
|
5 ## Copyright (C) 2001-2012 Free Software Foundation, Inc. |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
6 ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
7 ## This program is free software: you can redistribute it and/or modify |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
8 ## it under the terms of the GNU General Public License as published by |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
9 ## the Free Software Foundation, either version 3 of the License, or |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
10 ## (at your option) any later version. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
11 ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
12 ## This program is distributed in the hope that it will be useful, |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
15 ## GNU General Public License for more details. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
16 ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
17 ## You should have received a copy of the GNU General Public License |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
18 ## along with this program. If not, see <http://www.gnu.org/licenses/>. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
19 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
20 # This is reported not to work with make-3.79.1 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
22 ME := maint.mk |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
23 |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
24 # Diagnostic for continued use of deprecated variable. |
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
25 # Remove in 2013 |
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
26 ifneq ($(build_aux),) |
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
27 $(error "$(ME): \ |
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
28 set $$(_build-aux) relative to $$(srcdir) instead of $$(build_aux)") |
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
29 endif |
11563
861b812ba15f
top/maint.mk: Make $(srcdir)/build-aux configurable.
Simon Josefsson <simon@josefsson.org>
parents:
11547
diff
changeset
|
30 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
31 # Do not save the original name or timestamp in the .tar.gz file. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
32 # Use --rsyncable if available. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
33 gzip_rsyncable := \ |
13376 | 34 $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null \ |
35 && printf %s --rsyncable) | |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
36 GZIP_ENV = '--no-name --best $(gzip_rsyncable)' |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
37 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
38 GIT = git |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
39 VC = $(GIT) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
40 |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
41 VC_LIST = $(srcdir)/$(_build-aux)/vc-list-files -C $(srcdir) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
42 |
12736
123f8b43a3aa
top/maint.mk (VC_LIST_EXCEPT): Filter list through VC_LIST_ALWAYS_EXCLUDE_REGEX.
Simon Josefsson <simon@josefsson.org>
parents:
12608
diff
changeset
|
43 # You can override this variable in cfg.mk to set your own regexp |
123f8b43a3aa
top/maint.mk (VC_LIST_EXCEPT): Filter list through VC_LIST_ALWAYS_EXCLUDE_REGEX.
Simon Josefsson <simon@josefsson.org>
parents:
12608
diff
changeset
|
44 # matching files to ignore. |
123f8b43a3aa
top/maint.mk (VC_LIST_EXCEPT): Filter list through VC_LIST_ALWAYS_EXCLUDE_REGEX.
Simon Josefsson <simon@josefsson.org>
parents:
12608
diff
changeset
|
45 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$ |
123f8b43a3aa
top/maint.mk (VC_LIST_EXCEPT): Filter list through VC_LIST_ALWAYS_EXCLUDE_REGEX.
Simon Josefsson <simon@josefsson.org>
parents:
12608
diff
changeset
|
46 |
12768
f12919d53a60
maint.mk: make VC_LIST_EXCEPT robustly handle a srcdir containing "."
Jim Meyering <meyering@redhat.com>
parents:
12767
diff
changeset
|
47 # This is to preprocess robustly the output of $(VC_LIST), so that even |
f12919d53a60
maint.mk: make VC_LIST_EXCEPT robustly handle a srcdir containing "."
Jim Meyering <meyering@redhat.com>
parents:
12767
diff
changeset
|
48 # when $(srcdir) is a pathological name like "....", the leading sed command |
f12919d53a60
maint.mk: make VC_LIST_EXCEPT robustly handle a srcdir containing "."
Jim Meyering <meyering@redhat.com>
parents:
12767
diff
changeset
|
49 # removes only the intended prefix. |
12771
a11a67aec9bf
maint.mk: fix syntax-check in a non-srcdir build directory
Jim Meyering <meyering@redhat.com>
parents:
12768
diff
changeset
|
50 _dot_escaped_srcdir = $(subst .,\.,$(srcdir)) |
12768
f12919d53a60
maint.mk: make VC_LIST_EXCEPT robustly handle a srcdir containing "."
Jim Meyering <meyering@redhat.com>
parents:
12767
diff
changeset
|
51 |
12773
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
52 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
53 # when $(srcdir) is not ".". |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
54 ifeq ($(srcdir),.) |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
55 _prepend_srcdir_prefix = |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
56 else |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
57 _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|' |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
58 endif |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
59 |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
60 # In order to be able to consistently filter "."-relative names, |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
61 # (i.e., with no $(srcdir) prefix), this definition is careful to |
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
62 # remove any $(srcdir) prefix, and to restore what it removes. |
14432
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
63 _sc_excl = \ |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
64 $(if $(exclude_file_name_regexp--$@),$(exclude_file_name_regexp--$@),^$$) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
65 VC_LIST_EXCEPT = \ |
12768
f12919d53a60
maint.mk: make VC_LIST_EXCEPT robustly handle a srcdir containing "."
Jim Meyering <meyering@redhat.com>
parents:
12767
diff
changeset
|
66 $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \ |
12767
941bc7981053
maint.mk: fix VC_LIST_EXCEPT for srcdir != builddir
Jiri Denemark <jdenemar@redhat.com>
parents:
12736
diff
changeset
|
67 | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \ |
941bc7981053
maint.mk: fix VC_LIST_EXCEPT for srcdir != builddir
Jiri Denemark <jdenemar@redhat.com>
parents:
12736
diff
changeset
|
68 else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \ |
14432
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
69 | grep -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \ |
12773
1fedbaac4fa9
maint.mk: do not prepend "./" after filtering
Jim Meyering <meyering@redhat.com>
parents:
12771
diff
changeset
|
70 $(_prepend_srcdir_prefix) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
71 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
72 ifeq ($(origin prev_version_file), undefined) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
73 prev_version_file = $(srcdir)/.prev-version |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
74 endif |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
75 |
11736
9f4d092a26a4
maint.mk: avoid warnings about missing files
Jim Meyering <meyering@redhat.com>
parents:
11733
diff
changeset
|
76 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
77 VERSION_REGEXP = $(subst .,\.,$(VERSION)) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
78 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION)) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
79 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
80 ifeq ($(VC),$(GIT)) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
81 this-vc-tag = v$(VERSION) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
82 this-vc-tag-regexp = v$(VERSION_REGEXP) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
83 else |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
84 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]') |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
85 tag-this-version = $(subst .,_,$(VERSION)) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
86 this-vc-tag = $(tag-package)-$(tag-this-version) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
87 this-vc-tag-regexp = $(this-vc-tag) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
88 endif |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
89 my_distdir = $(PACKAGE)-$(VERSION) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
90 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
91 # Old releases are stored here. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
92 release_archive_dir ?= ../release |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
93 |
12329
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
94 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right. |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
95 # Use alpha.gnu.org for alpha and beta releases. |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
96 # Use ftp.gnu.org for stable releases. |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
97 gnu_ftp_host-alpha = alpha.gnu.org |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
98 gnu_ftp_host-beta = alpha.gnu.org |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
99 gnu_ftp_host-stable = ftp.gnu.org |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
100 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE)) |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
101 |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
102 ifeq ($(gnu_rel_host),ftp.gnu.org) |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
103 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE) |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
104 else |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
105 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE) |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
106 endif |
1d8d8b72ddd8
build: mention ftp redirector in release announcements
Eric Blake <ebb9@byu.net>
parents:
12325
diff
changeset
|
107 |
12383
a22f69c2029c
maintainer-makefile: allow customization of NEWS entry format
Alfred M. Szmidt <ams@gnu.org>
parents:
12329
diff
changeset
|
108 # Override this in cfg.mk if you are using a different format in your |
a22f69c2029c
maintainer-makefile: allow customization of NEWS entry format
Alfred M. Szmidt <ams@gnu.org>
parents:
12329
diff
changeset
|
109 # NEWS file. |
12384
8620ff59758a
maint.mk: news-check: use grep -E
Jim Meyering <meyering@redhat.com>
parents:
12383
diff
changeset
|
110 today = $(shell date +%Y-%m-%d) |
13393
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
111 |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
112 # Select which lines of NEWS are searched for $(news-check-regexp). |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
113 # This is a sed line number spec. The default says that we search |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
114 # lines 1..10 of NEWS for $(news-check-regexp). |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
115 # If you want to search only line 3 or only lines 20-22, use "3" or "20,22". |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
116 news-check-lines-spec ?= 1,10 |
12385
ad3ca6ce84b0
maint.mk: backslash-escape parens in default regexp
Jim Meyering <meyering@redhat.com>
parents:
12384
diff
changeset
|
117 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)' |
12383
a22f69c2029c
maintainer-makefile: allow customization of NEWS entry format
Alfred M. Szmidt <ams@gnu.org>
parents:
12329
diff
changeset
|
118 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
119 # Prevent programs like 'sort' from considering distinct strings to be equal. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
120 # Doing it here saves us from having to set LC_ALL elsewhere in this file. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
121 export LC_ALL = C |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
122 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
123 ## --------------- ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
124 ## Sanity checks. ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
125 ## --------------- ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
126 |
11736
9f4d092a26a4
maint.mk: avoid warnings about missing files
Jim Meyering <meyering@redhat.com>
parents:
11733
diff
changeset
|
127 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk') |
9f4d092a26a4
maint.mk: avoid warnings about missing files
Jim Meyering <meyering@redhat.com>
parents:
11733
diff
changeset
|
128 |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
129 # Collect the names of rules starting with 'sc_'. |
11927
234941dec230
maint.mk: sort the list of syntax-check rules
Daniel P. Berrange <berrange@redhat.com>
parents:
11909
diff
changeset
|
130 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \ |
234941dec230
maint.mk: sort the list of syntax-check rules
Daniel P. Berrange <berrange@redhat.com>
parents:
11909
diff
changeset
|
131 $(srcdir)/$(ME) $(_cfg_mk))) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
132 .PHONY: $(syntax-check-rules) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
133 |
14357
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
134 ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0) |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
135 local-checks-available += $(syntax-check-rules) |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
136 else |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
137 local-checks-available += no-vc-detected |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
138 no-vc-detected: |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
139 @echo "No version control files detected; skipping syntax check" |
e52d28567d4e
maintainer-makefile: make syntax-check a no-op from tarballs
Eric Blake <eblake@redhat.com>
parents:
14216
diff
changeset
|
140 endif |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
141 .PHONY: $(local-checks-available) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
142 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
143 # Arrange to print the name of each syntax-checking rule just before running it. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
144 $(syntax-check-rules): %: %.m |
12866
bedb32c7fa1b
maint.mk: mark syntax-check sc_*.m rules as .PHONY
Jim Meyering <meyering@redhat.com>
parents:
12865
diff
changeset
|
145 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules)) |
bedb32c7fa1b
maint.mk: mark syntax-check sc_*.m rules as .PHONY
Jim Meyering <meyering@redhat.com>
parents:
12865
diff
changeset
|
146 .PHONY: $(sc_m_rules_) |
bedb32c7fa1b
maint.mk: mark syntax-check sc_*.m rules as .PHONY
Jim Meyering <meyering@redhat.com>
parents:
12865
diff
changeset
|
147 $(sc_m_rules_): |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
148 @echo $(patsubst sc_%.m, %, $@) |
13208
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
149 @date +%s.%N > .sc-start-$(basename $@) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
150 |
13208
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
151 # Compute and print the elapsed time for each syntax-check rule. |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
152 sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules)) |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
153 .PHONY: $(sc_z_rules_) |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
154 $(sc_z_rules_): %.z: % |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
155 @end=$$(date +%s.%N); \ |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
156 start=$$(cat .sc-start-$*); \ |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
157 rm -f .sc-start-$*; \ |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
158 awk -v s=$$start -v e=$$end \ |
13221
6b5e6ecef4f5
maint.mk: generate more concise timing data for syntax-check rules
Jim Meyering <meyering@redhat.com>
parents:
13210
diff
changeset
|
159 'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null |
13208
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
160 |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
161 # The patsubst here is to replace each sc_% rule with its sc_%.z wrapper |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
162 # that computes and prints elapsed time. |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
163 local-check := \ |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
164 $(patsubst sc_%, sc_%.z, \ |
85be704c72eb
maint.mk: print the elapsed time for each syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13207
diff
changeset
|
165 $(filter-out $(local-checks-to-skip), $(local-checks-available))) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
166 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
167 syntax-check: $(local-check) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
168 |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
169 # _sc_search_regexp |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
170 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
171 # This macro searches for a given construct in the selected files and |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
172 # then takes some action. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
173 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
174 # Parameters (shell variables): |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
175 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
176 # prohibit | require |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
177 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
178 # Regular expression (ERE) denoting either a forbidden construct |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
179 # or a required construct. Those arguments are exclusive. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
180 # |
16552
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
181 # exclude |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
182 # |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
183 # Regular expression (ERE) denoting lines to ignore that matched |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
184 # a prohibit construct. For example, this can be used to exclude |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
185 # comments that mention why the nearby code uses an alternative |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
186 # construct instead of the simpler prohibited construct. |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
187 # |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
188 # in_vc_files | in_files |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
189 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
190 # grep-E-style regexp denoting the files to check. If no files |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
191 # are specified the default are all the files that are under |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
192 # version control. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
193 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
194 # containing | non_containing |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
195 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
196 # Select the files (non) containing strings matching this regexp. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
197 # If both arguments are specified then CONTAINING takes |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
198 # precedence. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
199 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
200 # with_grep_options |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
201 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
202 # Extra options for grep. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
203 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
204 # ignore_case |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
205 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
206 # Ignore case. |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
207 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
208 # halt |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
209 # |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
210 # Message to display before to halting execution. |
14432
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
211 # |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
212 # Finally, you may exempt files based on an ERE matching file names. |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
213 # For example, to exempt from the sc_space_tab check all files with the |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
214 # .diff suffix, set this Make variable: |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
215 # |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
216 # exclude_file_name_regexp--sc_space_tab = \.diff$ |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
217 # |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
218 # Note that while this functionality is mostly inherited via VC_LIST_EXCEPT, |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
219 # when filtering by name via in_files, we explicitly filter out matching |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
220 # names here as well. |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
221 |
16553
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
222 # Initialize each, so that envvar settings cannot interfere. |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
223 export require = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
224 export prohibit = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
225 export exclude = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
226 export in_vc_files = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
227 export in_files = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
228 export containing = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
229 export non_containing = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
230 export halt = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
231 export with_grep_options = |
3542db992ebe
maint.mk: avoid spurious failure of _sc_search_regexp-using tests
Jim Meyering <jim@meyering.net>
parents:
16552
diff
changeset
|
232 |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
233 # By default, _sc_search_regexp does not ignore case. |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
234 export ignore_case = |
13376 | 235 _ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
236 |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
237 define _sc_say_and_exit |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
238 dummy=; : so we do not need a semicolon before each use; \ |
13376 | 239 { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; }; |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
240 endef |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
241 |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
242 define _sc_search_regexp |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
243 dummy=; : so we do not need a semicolon before each use; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
244 \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
245 : Check arguments; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
246 test -n "$$prohibit" && test -n "$$require" \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
247 && { msg='Cannot specify both prohibit and require' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
248 $(_sc_say_and_exit) } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
249 test -z "$$prohibit" && test -z "$$require" \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
250 && { msg='Should specify either prohibit or require' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
251 $(_sc_say_and_exit) } || :; \ |
16552
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
252 test -z "$$prohibit" && test -n "$$exclude" \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
253 && { msg='Use of exclude requires a prohibit pattern' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
254 $(_sc_say_and_exit) } || :; \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
255 test -n "$$in_vc_files" && test -n "$$in_files" \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
256 && { msg='Cannot specify both in_vc_files and in_files' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
257 $(_sc_say_and_exit) } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
258 test "x$$halt" != x \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
259 || { msg='halt not defined' $(_sc_say_and_exit) }; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
260 \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
261 : Filter by file name; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
262 if test -n "$$in_files"; then \ |
14432
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
263 files=$$(find $(srcdir) | grep -E "$$in_files" \ |
dcc1567d7f4e
maint.mk: allow fine-grained syntax-check exclusion via Make variables
Jim Meyering <meyering@redhat.com>
parents:
14415
diff
changeset
|
264 | grep -Ev '$(exclude_file_name_regexp--$@)'); \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
265 else \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
266 files=$$($(VC_LIST_EXCEPT)); \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
267 if test -n "$$in_vc_files"; then \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
268 files=$$(echo "$$files" | grep -E "$$in_vc_files"); \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
269 fi; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
270 fi; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
271 \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
272 : Filter by content; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
273 test -n "$$files" && test -n "$$containing" \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
274 && { files=$$(grep -l "$$containing" $$files); } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
275 test -n "$$files" && test -n "$$non_containing" \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
276 && { files=$$(grep -vl "$$non_containing" $$files); } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
277 \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
278 : Check for the construct; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
279 if test -n "$$files"; then \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
280 if test -n "$$prohibit"; then \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
281 grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \ |
16726
518ff78686bb
maint.mk: fix syntax checks without exclusions
Eric Blake <eblake@redhat.com>
parents:
16691
diff
changeset
|
282 | grep -vE "$${exclude:-^$$}" \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
283 && { msg="$$halt" $(_sc_say_and_exit) } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
284 else \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
285 grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
286 | grep . \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
287 && { msg="$$halt" $(_sc_say_and_exit) } || :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
288 fi \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
289 else :; \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
290 fi || :; |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
291 endef |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
292 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
293 sc_avoid_if_before_free: |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
294 @$(srcdir)/$(_build-aux)/useless-if-before-free \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
295 $(useless_free_options) \ |
11518
956eb61203ab
top/maint.mk (sc_avoid_if_before_free): Except useless-if-before-free script.
Simon Josefsson <simon@josefsson.org>
parents:
11517
diff
changeset
|
296 $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) && \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
297 { echo '$(ME): found useless "if" before "free" above' 1>&2; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
298 exit 1; } || : |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
299 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
300 sc_cast_of_argument_to_free: |
16322
7256be967b3a
maint.mk: use more readable (yet functionally equivalent) quoting
Jim Meyering <meyering@redhat.com>
parents:
16299
diff
changeset
|
301 @prohibit='\<free *\( *\(' halt="don't cast free argument" \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
302 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
303 |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
304 sc_cast_of_x_alloc_return_value: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
305 @prohibit='\*\) *x(m|c|re)alloc\>' \ |
16322
7256be967b3a
maint.mk: use more readable (yet functionally equivalent) quoting
Jim Meyering <meyering@redhat.com>
parents:
16299
diff
changeset
|
306 halt="don't cast x*alloc return value" \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
307 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
308 |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
309 sc_cast_of_alloca_return_value: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
310 @prohibit='\*\) *alloca\>' \ |
16322
7256be967b3a
maint.mk: use more readable (yet functionally equivalent) quoting
Jim Meyering <meyering@redhat.com>
parents:
16299
diff
changeset
|
311 halt="don't cast alloca return value" \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
312 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
313 |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
314 sc_space_tab: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
315 @prohibit='[ ] ' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
316 halt='found SPACE-TAB sequence; remove the SPACE' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
317 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
318 |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
319 # Don't use *scanf or the old ato* functions in "real" code. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
320 # They provide no error checking mechanism. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
321 # Instead, use strto* functions. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
322 sc_prohibit_atoi_atof: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
323 @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\(' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
324 halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
325 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
326 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
327 # Use STREQ rather than comparing strcmp == 0, or != 0. |
16386
bb8c8cc1050d
maint.mk: tell sc_prohibit_strcmp to ding "0 == strcmp (...)", too
Jim Meyering <meyering@redhat.com>
parents:
16360
diff
changeset
|
328 sp_ = strcmp *\(.+\) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
329 sc_prohibit_strcmp: |
16552
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
330 @prohibit='! *strcmp *\(|\<$(sp_) *[!=]=|[!=]= *$(sp_)' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
331 exclude=':# *define STRN?EQ\(' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
332 halt='$(ME): replace strcmp calls above with STREQ/STRNEQ' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
333 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
334 |
12208
a377ab624fcc
maint: detect usage(1) and other suspicious exits
Eric Blake <ebb9@byu.net>
parents:
12083
diff
changeset
|
335 # Pass EXIT_*, not number, to usage, exit, and error (when exiting) |
12325
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
336 # Convert all uses automatically, via these two commands: |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
337 # git grep -l '\<exit *(1)' \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
338 # | grep -vEf .x-sc_prohibit_magic_number_exit \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
339 # | xargs --no-run-if-empty \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
340 # perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/' |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
341 # git grep -l '\<exit *(0)' \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
342 # | grep -vEf .x-sc_prohibit_magic_number_exit \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
343 # | xargs --no-run-if-empty \ |
444e305ec8cc
maint.mk: improve sc_prohibit_magic_number_exit
Jim Meyering <meyering@redhat.com>
parents:
12287
diff
changeset
|
344 # perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/' |
12208
a377ab624fcc
maint: detect usage(1) and other suspicious exits
Eric Blake <ebb9@byu.net>
parents:
12083
diff
changeset
|
345 sc_prohibit_magic_number_exit: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
346 @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
347 halt='use EXIT_* values rather than magic number' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
348 $(_sc_search_regexp) |
12208
a377ab624fcc
maint: detect usage(1) and other suspicious exits
Eric Blake <ebb9@byu.net>
parents:
12083
diff
changeset
|
349 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
350 # Using EXIT_SUCCESS as the first argument to error is misleading, |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
351 # since when that parameter is 0, error does not exit. Use '0' instead. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
352 sc_error_exit_success: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
353 @prohibit='error *\(EXIT_SUCCESS,' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
354 in_vc_files='\.[chly]$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
355 halt='found error (EXIT_SUCCESS' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
356 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
357 |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
358 # "FATAL:" should be fully upper-cased in error messages |
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
359 # "WARNING:" should be fully upper-cased, or fully lower-cased |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
360 sc_error_message_warn_fatal: |
13102
9c58202271c4
maint.mk: match 0 or more whitespace-before-function-call '('
Jose E. Marchesi <jemarch@gnu.org>
parents:
13101
diff
changeset
|
361 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
362 | grep -E '"Warning|"Fatal|"fatal' && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
363 { echo '$(ME): use FATAL, WARNING or warning' 1>&2; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
364 exit 1; } || : |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
365 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
366 # Error messages should not start with a capital letter |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
367 sc_error_message_uppercase: |
13102
9c58202271c4
maint.mk: match 0 or more whitespace-before-function-call '('
Jose E. Marchesi <jemarch@gnu.org>
parents:
13101
diff
changeset
|
368 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
369 | grep -E '"[A-Z]' \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
370 | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
371 { echo '$(ME): found capitalized error message' 1>&2; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
372 exit 1; } || : |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
373 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
374 # Error messages should not end with a period |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
375 sc_error_message_period: |
13102
9c58202271c4
maint.mk: match 0 or more whitespace-before-function-call '('
Jose E. Marchesi <jemarch@gnu.org>
parents:
13101
diff
changeset
|
376 @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT)) \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
377 | grep -E '[^."]\."' && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
378 { echo '$(ME): found error message ending in period' 1>&2; \ |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
379 exit 1; } || : |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
380 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
381 sc_file_system: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
382 @prohibit=file''system \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
383 ignore_case=1 \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
384 halt='found use of "file''system"; spell it "file system"' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
385 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
386 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
387 # Don't use cpp tests of this symbol. All code assumes config.h is included. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
388 sc_prohibit_have_config_h: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
389 @prohibit='^# *if.*HAVE''_CONFIG_H' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
390 halt='found use of HAVE''_CONFIG_H; remove' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
391 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
392 |
11519
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
393 # Nearly all .c files must include <config.h>. However, we also permit this |
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
394 # via inclusion of a package-specific header, if cfg.mk specified one. |
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
395 # config_h_header must be suitable for grep -E. |
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
396 config_h_header ?= <config\.h> |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
397 sc_require_config_h: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
398 @require='^# *include $(config_h_header)' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
399 in_vc_files='\.c$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
400 halt='the above files do not include <config.h>' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
401 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
402 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
403 # You must include <config.h> before including any other header file. |
11519
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
404 # This can possibly be via a package-specific header, if given by cfg.mk. |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
405 sc_require_config_h_first: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
406 @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
407 fail=0; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
408 for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
409 grep '^# *include\>' $$i | sed 1q \ |
11519
49521800ab0c
maint.mk: allow package-specific header to provide <config.h>
Eric Blake <ebb9@byu.net>
parents:
11518
diff
changeset
|
410 | grep -E '^# *include $(config_h_header)' > /dev/null \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
411 || { echo $$i; fail=1; }; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
412 done; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
413 test $$fail = 1 && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
414 { echo '$(ME): the above files include some other header' \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
415 'before <config.h>' 1>&2; exit 1; } || :; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
416 else :; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
417 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
418 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
419 sc_prohibit_HAVE_MBRTOWC: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
420 @prohibit='\bHAVE_MBRTOWC\b' \ |
13202
69a6d1611d1b
maint.mk: correct a diagnostic
Jim Meyering <meyering@redhat.com>
parents:
13192
diff
changeset
|
421 halt="do not use $$prohibit; it is always defined" \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
422 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
423 |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
424 # To use this "command" macro, you must first define two shell variables: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
425 # h: the header name, with no enclosing <> or "" |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
426 # re: a regular expression that matches IFF something provided by $h is used. |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
427 define _sc_header_without_use |
11853
97a383c7cec4
maint.mk: _header_without_use: fix a quoting bug and remove a bash'ism
Jim Meyering <meyering@redhat.com>
parents:
11847
diff
changeset
|
428 dummy=; : so we do not need a semicolon before each use; \ |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
429 h_esc=`echo '[<"]'"$$h"'[">]'|sed 's/\./\\\\./g'`; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
430 if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then \ |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
431 files=$$(grep -l '^# *include '"$$h_esc" \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
432 $$($(VC_LIST_EXCEPT) | grep '\.c$$')) && \ |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
433 grep -LE "$$re" $$files | grep . && \ |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
434 { echo "$(ME): the above files include $$h but don't use it" \ |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
435 1>&2; exit 1; } || :; \ |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
436 else :; \ |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
437 fi |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
438 endef |
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
439 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
440 # Prohibit the inclusion of assert.h without an actual use of assert. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
441 sc_prohibit_assert_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
442 @h='assert.h' re='\<assert *\(' $(_sc_header_without_use) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
443 |
12245
86929e33bdad
maint.mk: Prohibit inclusion of "close-stream.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12208
diff
changeset
|
444 # Prohibit the inclusion of close-stream.h without an actual use. |
86929e33bdad
maint.mk: Prohibit inclusion of "close-stream.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12208
diff
changeset
|
445 sc_prohibit_close_stream_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
446 @h='close-stream.h' re='\<close_stream *\(' $(_sc_header_without_use) |
12245
86929e33bdad
maint.mk: Prohibit inclusion of "close-stream.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12208
diff
changeset
|
447 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
448 # Prohibit the inclusion of getopt.h without an actual use. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
449 sc_prohibit_getopt_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
450 @h='getopt.h' re='\<getopt(_long)? *\(' $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
451 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
452 # Don't include quotearg.h unless you use one of its functions. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
453 sc_prohibit_quotearg_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
454 @h='quotearg.h' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
455 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
456 # Don't include quote.h unless you use one of its functions. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
457 sc_prohibit_quote_without_use: |
16691
fcfa472825d5
quote: fix syntax-check
Akim Demaille <akim@lrde.epita.fr>
parents:
16556
diff
changeset
|
458 @h='quote.h' re='\<quote((_n)? *\(|_quoting_options\>)' \ |
fcfa472825d5
quote: fix syntax-check
Akim Demaille <akim@lrde.epita.fr>
parents:
16556
diff
changeset
|
459 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
460 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
461 # Don't include this header unless you use one of its functions. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
462 sc_prohibit_long_options_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
463 @h='long-options.h' re='\<parse_long_options *\(' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
464 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
465 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
466 # Don't include this header unless you use one of its functions. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
467 sc_prohibit_inttostr_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
468 @h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
469 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
470 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
471 # Don't include this header unless you use one of its functions. |
12861
2afdfba76c99
maint.mk: prohibit inclusion of "ignore-value.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12827
diff
changeset
|
472 sc_prohibit_ignore_value_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
473 @h='ignore-value.h' re='\<ignore_(value|ptr) *\(' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
474 $(_sc_header_without_use) |
12861
2afdfba76c99
maint.mk: prohibit inclusion of "ignore-value.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12827
diff
changeset
|
475 |
2afdfba76c99
maint.mk: prohibit inclusion of "ignore-value.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12827
diff
changeset
|
476 # Don't include this header unless you use one of its functions. |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
477 sc_prohibit_error_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
478 @h='error.h' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
479 re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
480 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
481 |
12287
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
482 # Don't include xalloc.h unless you use one of its functions. |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
483 # Consider these symbols: |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
484 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__'; |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
485 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h |
12287
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
486 # Divide into two sets on case, and filter each through this: |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
487 # | sort | perl -MRegexp::Assemble -le \ |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
488 # 'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g' |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
489 # Note this was produced by the above: |
12576
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
490 # _xa1 = \ |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
491 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup) |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
492 # But we can do better, in at least two ways: |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
493 # 1) take advantage of two "dup"-suffixed strings: |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
494 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup) |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
495 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
496 # "char|[cmz]" |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
497 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) |
51b39cac47f1
maint.mk: include 4 more function names in alloca.h-checking regexp
Jim Meyering <meyering@redhat.com>
parents:
12559
diff
changeset
|
498 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup) |
12287
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
499 _xa2 = X([CZ]|N?M)ALLOC |
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
500 sc_prohibit_xalloc_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
501 @h='xalloc.h' \ |
12287
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
502 re='\<($(_xa1)|$(_xa2)) *\('\ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
503 $(_sc_header_without_use) |
12287
0c467c7c0132
maint.mk: Prohibit inclusion of "xalloc.h" without use.
Jim Meyering <meyering@redhat.com>
parents:
12245
diff
changeset
|
504 |
12863
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
505 # Extract function names: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
506 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h |
12863
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
507 _hash_re = \ |
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
508 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning |
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
509 _hash_fn = \<($(_hash_re)) *\( |
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
510 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\> |
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
511 sc_prohibit_hash_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
512 @h='hash.h' \ |
12863
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
513 re='$(_hash_fn)|$(_hash_struct)'\ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
514 $(_sc_header_without_use) |
12863
8fd1fe5e9683
maint.mk: prohibit inclusion of "hash.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12861
diff
changeset
|
515 |
14855
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
516 sc_prohibit_cloexec_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
517 @h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \ |
14855
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
518 $(_sc_header_without_use) |
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
519 |
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
520 sc_prohibit_posixver_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
521 @h='posixver.h' re='\<posix2_version *\(' $(_sc_header_without_use) |
14855
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
522 |
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
523 sc_prohibit_same_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
524 @h='same.h' re='\<same_name *\(' $(_sc_header_without_use) |
14855
d08e35db9bba
maint.mk: add three prohibit-header-without-use rules
Jim Meyering <meyering@redhat.com>
parents:
14801
diff
changeset
|
525 |
12865
19a113553866
maint.mk: prohibit inclusion of "hash-pjw.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12864
diff
changeset
|
526 sc_prohibit_hash_pjw_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
527 @h='hash-pjw.h' \ |
16299
1e8c74a6b668
maint: enable sc_prohibit_hash_pjw_without_use
Jim Meyering <meyering@redhat.com>
parents:
16261
diff
changeset
|
528 re='\<hash_pjw\>' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
529 $(_sc_header_without_use) |
12865
19a113553866
maint.mk: prohibit inclusion of "hash-pjw.h" without_use
Jim Meyering <meyering@redhat.com>
parents:
12864
diff
changeset
|
530 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
531 sc_prohibit_safe_read_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
532 @h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
533 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
534 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
535 sc_prohibit_argmatch_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
536 @h='argmatch.h' \ |
15337
787a6021ecd5
maint.mk: correct omissions in prohibit_argmatch_without_use check
Jim Meyering <meyering@redhat.com>
parents:
15321
diff
changeset
|
537 re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
538 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
539 |
12035
2898ee238452
syntax-check: detect unnecessary inclusion of canonicalize.h
Jim Meyering <meyering@redhat.com>
parents:
11969
diff
changeset
|
540 sc_prohibit_canonicalize_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
541 @h='canonicalize.h' \ |
16331
2f966fea20dc
maint.mk: sc_prohibit_canonicalize_without_use: avoid false positive
Jim Meyering <meyering@redhat.com>
parents:
16322
diff
changeset
|
542 re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode|file_name)' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
543 $(_sc_header_without_use) |
12035
2898ee238452
syntax-check: detect unnecessary inclusion of canonicalize.h
Jim Meyering <meyering@redhat.com>
parents:
11969
diff
changeset
|
544 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
545 sc_prohibit_root_dev_ino_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
546 @h='root-dev-ino.h' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
547 re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
548 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
549 |
11954
c2aabb82023d
syntax-check: detect unnecessary inclusion of openat.h
Jim Meyering <meyering@redhat.com>
parents:
11927
diff
changeset
|
550 sc_prohibit_openat_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
551 @h='openat.h' \ |
11969
25d12bf7e5bf
openat: provide more convenience names
Eric Blake <ebb9@byu.net>
parents:
11954
diff
changeset
|
552 re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
553 $(_sc_header_without_use) |
11954
c2aabb82023d
syntax-check: detect unnecessary inclusion of openat.h
Jim Meyering <meyering@redhat.com>
parents:
11927
diff
changeset
|
554 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
555 # Prohibit the inclusion of c-ctype.h without an actual use. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
556 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
557 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
558 sc_prohibit_c_ctype_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
559 @h='c-ctype.h' re='\<c_($(ctype_re)) *\(' \ |
13098
8d61d11c6cf0
maint.mk: split a long line
Jim Meyering <meyering@redhat.com>
parents:
13097
diff
changeset
|
560 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
561 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
562 _empty = |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
563 _sp = $(_empty) $(_empty) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
564 # The following list was generated by running: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
565 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
566 # | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
567 _sig_functions = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
568 bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
569 sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
570 siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
571 sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
572 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions))) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
573 # The following were extracted from "man signal.h" manually. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
574 _sig_types_and_consts = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
575 MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
576 SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
577 SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
578 SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
579 sigstack sigval stack_t ucontext_t |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
580 # generated via this: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
581 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
582 _sig_names = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
583 SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
584 SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
585 SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
586 SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
587 SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
588 SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1 \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
589 SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
590 SIGXCPU SIGXFSZ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
591 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts))) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
592 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
593 # Prohibit the inclusion of signal.h without an actual use. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
594 sc_prohibit_signal_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
595 @h='signal.h' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
596 re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
597 $(_sc_header_without_use) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
598 |
14756
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
599 # Don't include stdio--.h unless you use one of its functions. |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
600 sc_prohibit_stdio--_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
601 @h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\(' \ |
14756
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
602 $(_sc_header_without_use) |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
603 |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
604 # Don't include stdio-safer.h unless you use one of its functions. |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
605 sc_prohibit_stdio-safer_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
606 @h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\(' \ |
14756
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
607 $(_sc_header_without_use) |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
608 |
13304
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
609 # Prohibit the inclusion of strings.h without a sensible use. |
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
610 # Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible. |
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
611 sc_prohibit_strings_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
612 @h='strings.h' \ |
13304
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
613 re='\<(strn?casecmp|ffs(ll)?)\>' \ |
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
614 $(_sc_header_without_use) |
e5593199cd7e
maint.mk: prohibit unwarranted use of <strings.h>
Jim Meyering <meyering@redhat.com>
parents:
13302
diff
changeset
|
615 |
13029
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
616 # Get the list of symbol names with this: |
15319
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
617 # perl -lne '/^# *define ([A-Z]\w+)\(/ and print $1' lib/intprops.h|fmt |
13029
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
618 _intprops_names = \ |
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
619 TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT \ |
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
620 TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM \ |
15319
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
621 INT_BITS_STRLEN_BOUND INT_STRLEN_BOUND INT_BUFSIZE_BOUND \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
622 INT_ADD_RANGE_OVERFLOW INT_SUBTRACT_RANGE_OVERFLOW \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
623 INT_NEGATE_RANGE_OVERFLOW INT_MULTIPLY_RANGE_OVERFLOW \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
624 INT_DIVIDE_RANGE_OVERFLOW INT_REMAINDER_RANGE_OVERFLOW \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
625 INT_LEFT_SHIFT_RANGE_OVERFLOW INT_ADD_OVERFLOW INT_SUBTRACT_OVERFLOW \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
626 INT_NEGATE_OVERFLOW INT_MULTIPLY_OVERFLOW INT_DIVIDE_OVERFLOW \ |
cf58fc92428c
maint.mk: update sc_prohibit_intprops_without_use
Eric Blake <eblake@redhat.com>
parents:
15316
diff
changeset
|
627 INT_REMAINDER_OVERFLOW INT_LEFT_SHIFT_OVERFLOW |
13029
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
628 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names))) |
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
629 # Prohibit the inclusion of intprops.h without an actual use. |
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
630 sc_prohibit_intprops_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
631 @h='intprops.h' \ |
13029
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
632 re='\<($(_intprops_syms_re)) *\(' \ |
13097
ef132cd978fc
maint.mk: s/_header_without_use/_sc_header_without_use/
Jose E. Marchesi <jemarch@gnu.org>
parents:
13085
diff
changeset
|
633 $(_sc_header_without_use) |
13029
44ae789f77b0
maint.mk: prohibit inclusion of "intprops.h" without use
Jim Meyering <meyering@redhat.com>
parents:
12866
diff
changeset
|
634 |
14216
676f66180a36
maint.mk: add syntax-check rule: detect unnecessary #include <stddef.h>
Jim Meyering <meyering@redhat.com>
parents:
14210
diff
changeset
|
635 _stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t |
676f66180a36
maint.mk: add syntax-check rule: detect unnecessary #include <stddef.h>
Jim Meyering <meyering@redhat.com>
parents:
14210
diff
changeset
|
636 # Prohibit the inclusion of stddef.h without an actual use. |
676f66180a36
maint.mk: add syntax-check rule: detect unnecessary #include <stddef.h>
Jim Meyering <meyering@redhat.com>
parents:
14210
diff
changeset
|
637 sc_prohibit_stddef_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
638 @h='stddef.h' \ |
15990
2f6844abf7fd
maint.mk: fix a bug in sc_prohibit_stddef_without_use
Jim Meyering <meyering@redhat.com>
parents:
15989
diff
changeset
|
639 re='\<($(_stddef_syms_re))\>' \ |
14216
676f66180a36
maint.mk: add syntax-check rule: detect unnecessary #include <stddef.h>
Jim Meyering <meyering@redhat.com>
parents:
14210
diff
changeset
|
640 $(_sc_header_without_use) |
676f66180a36
maint.mk: add syntax-check rule: detect unnecessary #include <stddef.h>
Jim Meyering <meyering@redhat.com>
parents:
14210
diff
changeset
|
641 |
16035
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
642 _de1 = dirfd|(close|(fd)?open|read|rewind|seek|tell)dir(64)?(_r)? |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
643 _de2 = (versionsort|struct dirent|getdirentries|alphasort|scandir(at)?)(64)? |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
644 _de3 = MAXNAMLEN|DIR|ino_t|d_ino|d_fileno|d_namlen |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
645 _dirent_syms_re = $(_de1)|$(_de2)|$(_de3) |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
646 # Prohibit the inclusion of dirent.h without an actual use. |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
647 sc_prohibit_dirent_without_use: |
16053
48e53ddfb126
maint.mk: silence new syntax check
Eric Blake <eblake@redhat.com>
parents:
16035
diff
changeset
|
648 @h='dirent.h' \ |
16035
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
649 re='\<($(_dirent_syms_re))\>' \ |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
650 $(_sc_header_without_use) |
88def2ddf509
maint.mk: also prohibit inclusion of dirent.h without use
Jim Meyering <meyering@redhat.com>
parents:
16000
diff
changeset
|
651 |
15437
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
652 # Prohibit the inclusion of verify.h without an actual use. |
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
653 sc_prohibit_verify_without_use: |
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
654 @h='verify.h' \ |
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
655 re='\<(verify(true|expr)?|static_assert) *\(' \ |
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
656 $(_sc_header_without_use) |
055938f44a46
maint.mk: prohibit inclusion of "verify.h" without use
Jim Meyering <meyering@redhat.com>
parents:
15409
diff
changeset
|
657 |
14756
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
658 # Don't include xfreopen.h unless you use one of its functions. |
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
659 sc_prohibit_xfreopen_without_use: |
15321
eada9764cc6a
maint.mk: enhance useless header checks
Eric Blake <eblake@redhat.com>
parents:
15319
diff
changeset
|
660 @h='xfreopen.h' re='\<xfreopen *\(' $(_sc_header_without_use) |
14756
b44f65e44220
maint.mk: three new prohibit_<HDR>_without_use rules
Jim Meyering <meyering@redhat.com>
parents:
14754
diff
changeset
|
661 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
662 sc_obsolete_symbols: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
663 @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
664 halt='do not use HAVE''_FCNTL_H or O'_NDELAY \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
665 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
666 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
667 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
668 |
11468
65ab7e6dcafe
maint.mk: import changes to syntax-check macros from coreutils
Reuben Thomas <rrt@sc3d.org>
parents:
11406
diff
changeset
|
669 # Each nonempty ChangeLog line must start with a year number, or a TAB. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
670 sc_changelog: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
671 @prohibit='^[^12 ]' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
672 in_vc_files='^ChangeLog$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
673 halt='found unexpected prefix in a ChangeLog' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
674 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
675 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
676 # Ensure that each .c file containing a "main" function also |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
677 # calls set_program_name. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
678 sc_program_name: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
679 @require='set_program_name *\(m?argv\[0\]\);' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
680 in_vc_files='\.c$$' \ |
13853
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
681 containing='\<main *(' \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
682 halt='the above files do not call set_program_name' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
683 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
684 |
13853
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
685 # Ensure that each .c file containing a "main" function also |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
686 # calls bindtextdomain. |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
687 sc_bindtextdomain: |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
688 @require='bindtextdomain *\(' \ |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
689 in_vc_files='\.c$$' \ |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
690 containing='\<main *(' \ |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
691 halt='the above files do not call bindtextdomain' \ |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
692 $(_sc_search_regexp) |
2f3dbd409322
maintainer-makefile: check for i18n setup
Eric Blake <eblake@redhat.com>
parents:
13704
diff
changeset
|
693 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
694 # Require that the final line of each test-lib.sh-using test be this one: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
695 # Exit $fail |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
696 # Note: this test requires GNU grep's --label= option. |
11646
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
697 Exit_witness_file ?= tests/test-lib.sh |
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
698 Exit_base := $(notdir $(Exit_witness_file)) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
699 sc_require_test_exit_idiom: |
11646
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
700 @if test -f $(srcdir)/$(Exit_witness_file); then \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
701 die=0; \ |
11646
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
702 for i in $$(grep -l -F 'srcdir/$(Exit_base)' \ |
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
703 $$($(VC_LIST) tests)); do \ |
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
704 tail -n1 $$i | grep '^Exit .' > /dev/null \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
705 && : || { die=1; echo $$i; } \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
706 done; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
707 test $$die = 1 && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
708 { echo 1>&2 '$(ME): the final line in each of the above is not:'; \ |
11646
fc7e7bde323e
tests: maint.mk: make sc_require_test_exit_idiom more generic
Jim Meyering <meyering@redhat.com>
parents:
11575
diff
changeset
|
709 echo 1>&2 'Exit something'; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
710 exit 1; } || :; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
711 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
712 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
713 sc_trailing_blank: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
714 @prohibit='[ ]$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
715 halt='found trailing blank(s)' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
716 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
717 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
718 # Match lines like the following, but where there is only one space |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
719 # between the options and the description: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
720 # -D, --all-repeated[=delimit-method] print all duplicate lines\n |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
721 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)? |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
722 sc_two_space_separator_in_usage: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
723 @prohibit='^ *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
724 halt='help2man requires at least two spaces between an option and its description'\ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
725 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
726 |
14864
93b21a56e926
maint.mk: sc_unmarked_diagnostics: don't hard-code "error"
Jim Meyering <meyering@redhat.com>
parents:
14855
diff
changeset
|
727 # A regexp matching function names like "error" that may be used |
93b21a56e926
maint.mk: sc_unmarked_diagnostics: don't hard-code "error"
Jim Meyering <meyering@redhat.com>
parents:
14855
diff
changeset
|
728 # to emit translatable messages. |
93b21a56e926
maint.mk: sc_unmarked_diagnostics: don't hard-code "error"
Jim Meyering <meyering@redhat.com>
parents:
14855
diff
changeset
|
729 _gl_translatable_diag_func_re ?= error |
93b21a56e926
maint.mk: sc_unmarked_diagnostics: don't hard-code "error"
Jim Meyering <meyering@redhat.com>
parents:
14855
diff
changeset
|
730 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
731 # Look for diagnostics that aren't marked for translation. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
732 # This won't find any for which error's format string is on a separate line. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
733 sc_unmarked_diagnostics: |
16552
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
734 @prohibit='\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
735 exclude='(_|ngettext ?)\(' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
736 halt='$(ME): found unmarked diagnostic(s)' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
737 $(_sc_search_regexp) |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
738 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
739 # Avoid useless parentheses like those in this example: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
740 # #if defined (SYMBOL) || defined (SYM2) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
741 sc_useless_cpp_parens: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
742 @prohibit='^# *if .*defined *\(' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
743 halt='found useless parentheses in cpp directive' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
744 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
745 |
13275
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
746 # List headers for which HAVE_HEADER_H is always true, assuming you are |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
747 # using the appropriate gnulib module. CAUTION: for each "unnecessary" |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
748 # #if HAVE_HEADER_H that you remove, be sure that your project explicitly |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
749 # requires the gnulib module that guarantees the usability of that header. |
13277
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
750 gl_assured_headers_ = \ |
13278
a7cc50668746
maint.mk: fix a bug introduced in last change
Jim Meyering <meyering@redhat.com>
parents:
13277
diff
changeset
|
751 cd $(gnulib_dir)/lib && echo *.in.h|sed 's/\.in\.h//g' |
13275
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
752 |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
753 # Convert the list of names to upper case, and replace each space with "|". |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
754 az_ = abcdefghijklmnopqrstuvwxyz |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
755 AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ |
13277
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
756 gl_header_upper_case_or_ = \ |
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
757 $$($(gl_assured_headers_) \ |
13275
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
758 | tr $(az_)/.- $(AZ_)___ \ |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
759 | tr -s ' ' '|' \ |
13277
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
760 ) |
13275
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
761 sc_prohibit_always_true_header_tests: |
13277
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
762 @or=$(gl_header_upper_case_or_); \ |
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
763 re="HAVE_($$or)_H"; \ |
b07571bc9838
maint.mk: avoid side-effect in latest syntax-check
Jim Meyering <meyering@redhat.com>
parents:
13275
diff
changeset
|
764 prohibit='\<'"$$re"'\>' \ |
13704
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
765 halt=$$(printf '%s\n' \ |
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
766 'do not test the above HAVE_<header>_H symbol(s);' \ |
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
767 ' with the corresponding gnulib module, they are always true') \ |
13275
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
768 $(_sc_search_regexp) |
2917aab6182c
maint.mk: syntax-check: prohibit HAVE_<header>_H that are always true
Jim Meyering <meyering@redhat.com>
parents:
13253
diff
changeset
|
769 |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
770 # ================================================================== |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
771 gl_other_headers_ ?= \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
772 intprops.h \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
773 openat.h \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
774 stat-macros.h |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
775 |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
776 # Perl -lne code to extract "significant" cpp-defined symbols from a |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
777 # gnulib header file, eliminating a few common false-positives. |
15989
30a6c0b6ac8c
maint.mk: exempt ENODATA from a syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
15966
diff
changeset
|
778 # The exempted names below are defined only conditionally in gnulib, |
30a6c0b6ac8c
maint.mk: exempt ENODATA from a syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
15966
diff
changeset
|
779 # and hence sometimes must/may be defined in application code. |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
780 gl_extract_significant_defines_ = \ |
13337
23825f79a03a
maint.mk: gnulib doesn't guarantee NSIG
Eric Blake <eblake@redhat.com>
parents:
13333
diff
changeset
|
781 /^\# *define ([^_ (][^ (]*)(\s*\(|\s+\w+)/\ |
23825f79a03a
maint.mk: gnulib doesn't guarantee NSIG
Eric Blake <eblake@redhat.com>
parents:
13333
diff
changeset
|
782 && $$2 !~ /(?:rpl_|_used_without_)/\ |
15989
30a6c0b6ac8c
maint.mk: exempt ENODATA from a syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
15966
diff
changeset
|
783 && $$1 !~ /^(?:NSIG|ENODATA)$$/\ |
15478
206163b08a1f
maint.mk: avoid sc_prohibit_always-defined_macros failure in coreutils
Jim Meyering <meyering@redhat.com>
parents:
15437
diff
changeset
|
784 && $$1 !~ /^(?:SA_RESETHAND|SA_RESTART)$$/\ |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
785 and print $$1 |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
786 |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
787 # Create a list of regular expressions matching the names |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
788 # of macros that are guaranteed to be defined by parts of gnulib. |
13333
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
789 define def_sym_regex |
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
790 gen_h=$(gl_generated_headers_); \ |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
791 (cd $(gnulib_dir)/lib; \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
792 for f in *.in.h $(gl_other_headers_); do \ |
15660
d12c46223fa1
maint.mk: avoid warnings from perl about missing files
Martin von Gagern <Martin.vGagern@gmx.net>
parents:
15615
diff
changeset
|
793 test -f $$f \ |
d12c46223fa1
maint.mk: avoid warnings from perl about missing files
Martin von Gagern <Martin.vGagern@gmx.net>
parents:
15615
diff
changeset
|
794 && perl -lne '$(gl_extract_significant_defines_)' $$f; \ |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
795 done; \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
796 ) | sort -u \ |
13378
c4a059473950
maint.mk: also prohibit "#undef" of always-defined symbols
Jim Meyering <meyering@redhat.com>
parents:
13376
diff
changeset
|
797 | sed 's/^/^ *# *(define|undef) */;s/$$/\\>/' |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
798 endef |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
799 |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
800 # Don't define macros that we already get from gnulib header files. |
13333
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
801 sc_prohibit_always-defined_macros: |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
802 @if test -d $(gnulib_dir); then \ |
13333
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
803 case $$(echo all: | grep -l -f - Makefile) in Makefile);; *) \ |
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
804 echo '$(ME): skipping $@: you lack GNU grep' 1>&2; exit 0;; \ |
dd75a1afe536
maint.mk: avoid using a temporary file in the always-defined-macros check
Jim Meyering <meyering@redhat.com>
parents:
13331
diff
changeset
|
805 esac; \ |
13378
c4a059473950
maint.mk: also prohibit "#undef" of always-defined symbols
Jim Meyering <meyering@redhat.com>
parents:
13376
diff
changeset
|
806 $(def_sym_regex) | grep -E -f - $$($(VC_LIST_EXCEPT)) \ |
13329
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
807 && { echo '$(ME): define the above via some gnulib .h file' \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
808 1>&2; exit 1; } || :; \ |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
809 fi |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
810 # ================================================================== |
256d057c7f1f
maint.mk: prohibit definition of symbols defined by gnulib
Jim Meyering <meyering@redhat.com>
parents:
13309
diff
changeset
|
811 |
13253
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
812 # Prohibit checked in backup files. |
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
813 sc_prohibit_backup_files: |
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
814 @$(VC_LIST) | grep '~$$' && \ |
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
815 { echo '$(ME): found version controlled backup file' 1>&2; \ |
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
816 exit 1; } || : |
51e653bb55dd
top/maint.mk (sc_prohibit_backup_files): Prohibit checked in backup files.
Simon Josefsson <simon@josefsson.org>
parents:
13241
diff
changeset
|
817 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
818 # Require the latest GPL. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
819 sc_GPL_version: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
820 @prohibit='either ''version [^3]' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
821 halt='GPL vN, N!=3' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
822 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
823 |
12593
e8847ec6bc92
maint.mk: detect incorrect GFDL usage
Eric Blake <ebb9@byu.net>
parents:
12592
diff
changeset
|
824 # Require the latest GFDL. Two regexp, since some .texi files end up |
e8847ec6bc92
maint.mk: detect incorrect GFDL usage
Eric Blake <ebb9@byu.net>
parents:
12592
diff
changeset
|
825 # line wrapping between 'Free Documentation License,' and 'Version'. |
e8847ec6bc92
maint.mk: detect incorrect GFDL usage
Eric Blake <ebb9@byu.net>
parents:
12592
diff
changeset
|
826 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any) |
e8847ec6bc92
maint.mk: detect incorrect GFDL usage
Eric Blake <ebb9@byu.net>
parents:
12592
diff
changeset
|
827 sc_GFDL_version: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
828 @prohibit='$(_GFDL_regexp)' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
829 halt='GFDL vN, N!=3' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
830 $(_sc_search_regexp) |
12593
e8847ec6bc92
maint.mk: detect incorrect GFDL usage
Eric Blake <ebb9@byu.net>
parents:
12592
diff
changeset
|
831 |
13880
fe3adfe381fa
maint.mk: add a URL discussing the no-@acronym policy
Jim Meyering <meyering@redhat.com>
parents:
13871
diff
changeset
|
832 # Don't use Texinfo's @acronym{}. |
fe3adfe381fa
maint.mk: add a URL discussing the no-@acronym policy
Jim Meyering <meyering@redhat.com>
parents:
13871
diff
changeset
|
833 # http://lists.gnu.org/archive/html/bug-gnulib/2010-03/msg00321.html |
13233
2376509f2722
maint.mk: texinfo_suffix_re_: correct the default regexp
Jim Meyering <meyering@redhat.com>
parents:
13232
diff
changeset
|
834 texinfo_suffix_re_ ?= \.(txi|texi(nfo)?)$$ |
13045
04f53e0b1556
top/maint.mk (sc_texinfo_acronym): Add rule.
Simon Josefsson <simon@josefsson.org>
parents:
13029
diff
changeset
|
835 sc_texinfo_acronym: |
13232
80668c656e53
top/maint.mk (sc_texinfo_acronym): Improve filename regexp.
Simon Josefsson <simon@josefsson.org>
parents:
13221
diff
changeset
|
836 @prohibit='@acronym\{' \ |
80668c656e53
top/maint.mk (sc_texinfo_acronym): Improve filename regexp.
Simon Josefsson <simon@josefsson.org>
parents:
13221
diff
changeset
|
837 in_vc_files='$(texinfo_suffix_re_)' \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
838 halt='found use of Texinfo @acronym{}' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
839 $(_sc_search_regexp) |
13045
04f53e0b1556
top/maint.mk (sc_texinfo_acronym): Add rule.
Simon Josefsson <simon@josefsson.org>
parents:
13029
diff
changeset
|
840 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
841 cvs_keywords = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
842 Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
843 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
844 sc_prohibit_cvs_keyword: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
845 @prohibit='\$$($(cvs_keywords))\$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
846 halt='do not use CVS keyword expansion' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
847 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
848 |
13209
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
849 # This Perl code is slightly obfuscated. Not only is each "$" doubled |
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
850 # because it's in a Makefile, but the $$c's are comments; we cannot |
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
851 # use "#" due to the way the script ends up concatenated onto one line. |
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
852 # It would be much more concise, and would produce better output (including |
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
853 # counts) if written as: |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
854 # perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ... |
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
855 # but that would be far less efficient, reading the entire contents |
13209
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
856 # of each file, rather than just the last two bytes of each. |
14394
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
857 # In addition, while the code below detects both blank lines and a missing |
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
858 # newline at EOF, the above detects only the former. |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
859 # |
13209
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
860 # This is a perl script that is expected to be the single-quoted argument |
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
861 # to a command-line "-le". The remaining arguments are file names. |
16261
0505376775c9
maint.mk: fix description in comment
Jim Meyering <meyering@redhat.com>
parents:
16235
diff
changeset
|
862 # Print the name of each file that does not end in exactly one newline byte. |
14394
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
863 # I.e., warn if there are blank lines (2 or more newlines), or if the |
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
864 # last byte is not a newline. However, currently we don't complain |
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
865 # about any file that contains exactly one byte. |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
866 # Exit nonzero if at least one such file is found, otherwise, exit 0. |
13209
473dffe238d2
maint.mk: improve empty-line-at-EOF check
Jim Meyering <meyering@redhat.com>
parents:
13208
diff
changeset
|
867 # Warn about, but otherwise ignore open failure. Ignore seek/read failure. |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
868 # |
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
869 # Use this if you want to remove trailing empty lines from selected files: |
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
870 # perl -pi -0777 -e 's/\n\n+$/\n/' files... |
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
871 # |
14394
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
872 require_exactly_one_NL_at_EOF_ = \ |
13241
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
873 foreach my $$f (@ARGV) \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
874 { \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
875 open F, "<", $$f or (warn "failed to open $$f: $$!\n"), next; \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
876 my $$p = sysseek (F, -2, 2); \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
877 my $$c = "seek failure probably means file has < 2 bytes; ignore"; \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
878 my $$last_two_bytes; \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
879 defined $$p and $$p = sysread F, $$last_two_bytes, 2; \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
880 close F; \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
881 $$c = "ignore read failure"; \ |
14394
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
882 $$p && ($$last_two_bytes eq "\n\n" \ |
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
883 || substr ($$last_two_bytes,1) ne "\n") \ |
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
884 and (print $$f), $$fail=1; \ |
13241
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
885 } \ |
cf12b14b472b
maint.mk: use gnu-style indentation in an embedded perl script
Jim Meyering <meyering@redhat.com>
parents:
13233
diff
changeset
|
886 END { exit defined $$fail } |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
887 sc_prohibit_empty_lines_at_EOF: |
14394
74d1558ae43f
maint.mk: detect missing-NL-at-EOF, too
Jim Meyering <meyering@redhat.com>
parents:
14357
diff
changeset
|
888 @perl -le '$(require_exactly_one_NL_at_EOF_)' $$($(VC_LIST_EXCEPT)) \ |
14523
0ba2e3063130
maint.mk: Don't trigger sc_space_tab check.
Simon Josefsson <simon@josefsson.org>
parents:
14471
diff
changeset
|
889 || { echo '$(ME): empty line(s) or no newline at EOF' \ |
14572
7eb49e79c178
maint.mk: remove useless semicolon and backslash
Jim Meyering <meyering@redhat.com>
parents:
14563
diff
changeset
|
890 1>&2; exit 1; } || : |
13203
0f51b742ab58
maint.mk: new syntax-check rule: prohibit empty lines at end of file
Jim Meyering <meyering@redhat.com>
parents:
13202
diff
changeset
|
891 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
892 # Make sure we don't use st_blocks. Use ST_NBLOCKS instead. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
893 # This is a bit of a kludge, since it prevents use of the string |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
894 # even in comments, but for now it does the job with no false positives. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
895 sc_prohibit_stat_st_blocks: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
896 @prohibit='[.>]st_blocks' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
897 halt='do not use st_blocks; use ST_NBLOCKS' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
898 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
899 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
900 # Make sure we don't define any S_IS* macros in src/*.c files. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
901 # They're already defined via gnulib's sys/stat.h replacement. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
902 sc_prohibit_S_IS_definition: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
903 @prohibit='^ *# *define *S_IS' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
904 halt='do not define S_IS* macros; include <sys/stat.h>' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
905 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
906 |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
907 # Perl block to convert a match to FILE_NAME:LINENO:TEST, |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
908 # that is shared by two definitions below. |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
909 perl_filename_lineno_text_ = \ |
14575
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
910 -e ' {' \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
911 -e ' $$n = ($$` =~ tr/\n/\n/ + 1);' \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
912 -e ' ($$v = $$&) =~ s/\n/\\n/g;' \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
913 -e ' print "$$ARGV:$$n:$$v\n";' \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
914 -e ' }' |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
915 |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
916 prohibit_doubled_word_RE_ ?= \ |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
917 /\b(then?|[iao]n|i[fst]|but|f?or|at|and|[dt]o)\s+\1\b/gims |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
918 prohibit_doubled_word_ = \ |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
919 -e 'while ($(prohibit_doubled_word_RE_))' \ |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
920 $(perl_filename_lineno_text_) |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
921 |
14575
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
922 # Define this to a regular expression that matches |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
923 # any filename:dd:match lines you want to ignore. |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
924 # The default is to ignore no matches. |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
925 ignore_doubled_word_match_RE_ ?= ^$$ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
926 |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
927 sc_prohibit_doubled_word: |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
928 @perl -n -0777 $(prohibit_doubled_word_) $$($(VC_LIST_EXCEPT)) \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
929 | grep -vE '$(ignore_doubled_word_match_RE_)' \ |
df394b4db95d
maint.mk: prohibit doubled words
Jim Meyering <meyering@redhat.com>
parents:
14572
diff
changeset
|
930 | grep . && { echo '$(ME): doubled words' 1>&2; exit 1; } || : |
14563
4f85858b0e7f
maint.mk: prohibit \<the the\>
Jim Meyering <meyering@redhat.com>
parents:
14560
diff
changeset
|
931 |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
932 # A regular expression matching undesirable combinations of words like |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
933 # "can not"; this matches them even when the two words appear on different |
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
934 # lines, but not when there is an intervening delimiter like "#" or "*". |
14725
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
935 prohibit_undesirable_word_seq_RE_ ?= \ |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
936 /\bcan\s+not\b/gims |
14725
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
937 prohibit_undesirable_word_seq_ = \ |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
938 -e 'while ($(prohibit_undesirable_word_seq_RE_))' \ |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
939 $(perl_filename_lineno_text_) |
14725
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
940 # Define this to a regular expression that matches |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
941 # any filename:dd:match lines you want to ignore. |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
942 # The default is to ignore no matches. |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
943 ignore_undesirable_word_sequence_RE_ ?= ^$$ |
14724
ba27b43f49e7
maint.mk: improve "can not" detection and generalize rule name
Jim Meyering <meyering@redhat.com>
parents:
14718
diff
changeset
|
944 |
14725
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
945 sc_prohibit_undesirable_word_seq: |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
946 @perl -n -0777 $(prohibit_undesirable_word_seq_) \ |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
947 $$($(VC_LIST_EXCEPT)) \ |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
948 | grep -vE '$(ignore_undesirable_word_sequence_RE_)' | grep . \ |
d27620fb3331
maint.mk: adjust previous commit
Jim Meyering <meyering@redhat.com>
parents:
14724
diff
changeset
|
949 && { echo '$(ME): undesirable word sequence' >&2; exit 1; } || : |
14560
ff63cf60e142
maint.mk: prohibit use of "can not"
Jim Meyering <meyering@redhat.com>
parents:
14523
diff
changeset
|
950 |
13085
fb5165836aea
maint.mk: prohibit use of test's -o and -a operators
Jim Meyering <meyering@redhat.com>
parents:
13058
diff
changeset
|
951 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2" |
fb5165836aea
maint.mk: prohibit use of test's -o and -a operators
Jim Meyering <meyering@redhat.com>
parents:
13058
diff
changeset
|
952 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2" |
fb5165836aea
maint.mk: prohibit use of test's -o and -a operators
Jim Meyering <meyering@redhat.com>
parents:
13058
diff
changeset
|
953 # Using test's -a and -o operators is not portable. |
13101
8dad7d30953c
maint.mk: check for [ as well as test
Eric Blake <eblake@redhat.com>
parents:
13098
diff
changeset
|
954 # We prefer test over [, since the latter is spelled [[ in configure.ac. |
13085
fb5165836aea
maint.mk: prohibit use of test's -o and -a operators
Jim Meyering <meyering@redhat.com>
parents:
13058
diff
changeset
|
955 sc_prohibit_test_minus_ao: |
13104
3f4bdc04f3f1
maint.mk: fix some fallout
Eric Blake <eblake@redhat.com>
parents:
13103
diff
changeset
|
956 @prohibit='(\<test| \[+) .+ -[ao] ' \ |
3f4bdc04f3f1
maint.mk: fix some fallout
Eric Blake <eblake@redhat.com>
parents:
13103
diff
changeset
|
957 halt='$(_ptm1); $(_ptm2)' \ |
3f4bdc04f3f1
maint.mk: fix some fallout
Eric Blake <eblake@redhat.com>
parents:
13103
diff
changeset
|
958 $(_sc_search_regexp) |
13085
fb5165836aea
maint.mk: prohibit use of test's -o and -a operators
Jim Meyering <meyering@redhat.com>
parents:
13058
diff
changeset
|
959 |
13855
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
960 # Avoid a test bashism. |
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
961 sc_prohibit_test_double_equal: |
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
962 @prohibit='(\<test| \[+) .+ == ' \ |
13865
85922ab33c1c
maintainer-makefile: cover a few more files
Eric Blake <eblake@redhat.com>
parents:
13858
diff
changeset
|
963 containing='#! */bin/[a-z]*sh' \ |
13855
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
964 halt='use "test x = x", not "test x =''= x"' \ |
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
965 $(_sc_search_regexp) |
78d646edb95c
maintainer-makefile: prohibit test x == x
Eric Blake <eblake@redhat.com>
parents:
13853
diff
changeset
|
966 |
12608
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
967 # Each program that uses proper_name_utf8 must link with one of the |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
968 # ICONV libraries. Otherwise, some ICONV library must appear in LDADD. |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
969 # The perl -0777 invocation below extracts the possibly-multi-line |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
970 # definition of LDADD from the appropriate Makefile.am and exits 0 |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
971 # when it contains "ICONV". |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
972 sc_proper_name_utf8_requires_ICONV: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
973 @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
974 if test "x$$progs" != x; then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
975 fail=0; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
976 for p in $$progs; do \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
977 dir=$$(dirname "$$p"); \ |
12608
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
978 perl -0777 \ |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
979 -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)' \ |
d2cfa946257a
maint.mk: extend proper_name_utf8-vs-LIBICONV-checking rule
Jim Meyering <meyering@redhat.com>
parents:
12606
diff
changeset
|
980 $$dir/Makefile.am && continue; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
981 base=$$(basename "$$p" .c); \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
982 grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
983 || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
984 done; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
985 test $$fail = 1 && \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
986 { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
987 exit 1; } || :; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
988 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
989 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
990 # Warn about "c0nst struct Foo const foo[]", |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
991 # but not about "char const *const foo" or "#define const const". |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
992 sc_redundant_const: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
993 @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
994 halt='redundant "const" in declarations' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
995 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
996 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
997 sc_const_long_option: |
16552
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
998 @prohibit='^ *static.*struct option ' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
999 exclude='const struct option|struct option const' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
1000 halt='$(ME): add "const" to the above declarations' \ |
b9f8d388ab96
maint.mk: add per-line exclusions to prohibitions
Eric Blake <eblake@redhat.com>
parents:
16386
diff
changeset
|
1001 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1002 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1003 NEWS_hash = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1004 $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p' \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1005 $(srcdir)/NEWS \ |
12592
f46f6a6b078c
maint.mk: ignore multi-line copyright in NEWS
Eric Blake <ebb9@byu.net>
parents:
12581
diff
changeset
|
1006 | perl -0777 -pe \ |
f46f6a6b078c
maint.mk: ignore multi-line copyright in NEWS
Eric Blake <ebb9@byu.net>
parents:
12581
diff
changeset
|
1007 's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1008 | md5sum - \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1009 | sed 's/ .*//') |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1010 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1011 # Ensure that we don't accidentally insert an entry into an old NEWS block. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1012 sc_immutable_NEWS: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1013 @if test -f $(srcdir)/NEWS; then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1014 test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : || \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1015 { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1016 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1017 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1018 # Update the hash stored above. Do this after each release and |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1019 # for any corrections to old entries. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1020 update-NEWS-hash: NEWS |
11750
246d2e2f523d
maint.mk: relax update-NEWS-hash to accept more syntax
Peter Simons <simons@cryp.to>
parents:
11736
diff
changeset
|
1021 perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1022 $(srcdir)/cfg.mk |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1023 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1024 # Ensure that we use only the standard $(VAR) notation, |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1025 # not @...@ in Makefile.am, now that we can rely on automake |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1026 # to emit a definition for each substituted variable. |
14611
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1027 # However, there is still one case in which @VAR@ use is not just |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1028 # legitimate, but actually required: when augmenting an automake-defined |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1029 # variable with a prefix. For example, gettext uses this: |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1030 # MAKEINFO = env LANG= LC_MESSAGES= LC_ALL= LANGUAGE= @MAKEINFO@ |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1031 # otherwise, makeinfo would put German or French (current locale) |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1032 # navigation hints in the otherwise-English documentation. |
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1033 # |
12606
47c45341eca0
maint.mk: allow packages to add makefile @@ exceptions
Eric Blake <ebb9@byu.net>
parents:
12593
diff
changeset
|
1034 # Allow the package to add exceptions via a hook in cfg.mk; |
47c45341eca0
maint.mk: allow packages to add makefile @@ exceptions
Eric Blake <ebb9@byu.net>
parents:
12593
diff
changeset
|
1035 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by |
47c45341eca0
maint.mk: allow packages to add makefile @@ exceptions
Eric Blake <ebb9@byu.net>
parents:
12593
diff
changeset
|
1036 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'. |
47c45341eca0
maint.mk: allow packages to add makefile @@ exceptions
Eric Blake <ebb9@byu.net>
parents:
12593
diff
changeset
|
1037 _makefile_at_at_check_exceptions ?= |
47c45341eca0
maint.mk: allow packages to add makefile @@ exceptions
Eric Blake <ebb9@byu.net>
parents:
12593
diff
changeset
|
1038 sc_makefile_at_at_check: |
16360
817d5933e56e
maint.mk: also prohibit lower-case @var@
Eric Blake <eblake@redhat.com>
parents:
16331
diff
changeset
|
1039 @perl -ne '/\@\w+\@/' \ |
817d5933e56e
maint.mk: also prohibit lower-case @var@
Eric Blake <eblake@redhat.com>
parents:
16331
diff
changeset
|
1040 -e ' && !/(\w+)\s+=.*\@\1\@$$/' \ |
14611
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1041 -e ''$(_makefile_at_at_check_exceptions) \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1042 -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}' \ |
14611
268395c9bfdf
maint.mk: makefile_at_at_check extend and clean up
Jim Meyering <meyering@redhat.com>
parents:
14575
diff
changeset
|
1043 $$($(VC_LIST_EXCEPT) | grep -E '(^|/)(Makefile\.am|[^/]+\.mk)$$') \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1044 && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || : |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1045 |
12384
8620ff59758a
maint.mk: news-check: use grep -E
Jim Meyering <meyering@redhat.com>
parents:
12383
diff
changeset
|
1046 news-check: NEWS |
13393
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
1047 if sed -n $(news-check-lines-spec)p $(srcdir)/NEWS \ |
50e9a2259a7d
maint.mk: make the news-check rule more configurable
Peter Simons <simons@cryp.to>
parents:
13378
diff
changeset
|
1048 | grep -E $(news-check-regexp) >/dev/null; then \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1049 :; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1050 else \ |
12384
8620ff59758a
maint.mk: news-check: use grep -E
Jim Meyering <meyering@redhat.com>
parents:
12383
diff
changeset
|
1051 echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1052 exit 1; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1053 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1054 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1055 sc_makefile_TAB_only_indentation: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1056 @prohibit='^ [ ]{8}' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1057 in_vc_files='akefile|\.mk$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1058 halt='found TAB-8-space indentation' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1059 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1060 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1061 sc_m4_quote_check: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1062 @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1063 in_vc_files='(^configure\.ac|\.m4)$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1064 halt='quote the first arg to AC_DEF*' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1065 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1066 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1067 fix_po_file_diag = \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1068 'you have changed the set of files with translatable diagnostics;\n\ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1069 apply the above patch\n' |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1070 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1071 # Verify that all source files using _() are listed in po/POTFILES.in. |
14433
00046711b6a6
maint.mk: let po check work in VPATH build
Eric Blake <eblake@redhat.com>
parents:
14432
diff
changeset
|
1072 po_file ?= $(srcdir)/po/POTFILES.in |
14704
0223f2067342
maintainer-makefile: make sc_po_check easier to tune
Eric Blake <eblake@redhat.com>
parents:
14699
diff
changeset
|
1073 generated_files ?= $(srcdir)/lib/*.[ch] |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1074 sc_po_check: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1075 @if test -f $(po_file); then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1076 grep -E -v '^(#|$$)' $(po_file) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1077 | grep -v '^src/false\.c$$' | sort > $@-1; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1078 files=; \ |
14704
0223f2067342
maintainer-makefile: make sc_po_check easier to tune
Eric Blake <eblake@redhat.com>
parents:
14699
diff
changeset
|
1079 for file in $$($(VC_LIST_EXCEPT)) $(generated_files); do \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1080 test -r $$file || continue; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1081 case $$file in \ |
11710
e59c94826772
maint.mk: don't look for translatable strings in *.m4 or *.mk
Jim Meyering <meyering@redhat.com>
parents:
11646
diff
changeset
|
1082 *.m4|*.mk) continue ;; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1083 *.?|*.??) ;; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1084 *) continue;; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1085 esac; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1086 case $$file in \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1087 *.[ch]) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1088 base=`expr " $$file" : ' \(.*\)\..'`; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1089 { test -f $$base.l || test -f $$base.y; } && continue;; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1090 esac; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1091 files="$$files $$file"; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1092 done; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1093 grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files \ |
14439
6a7f017ac09c
maint.mk: sort file names *after* new transformation
Jim Meyering <meyering@redhat.com>
parents:
14438
diff
changeset
|
1094 | sed 's|^$(_dot_escaped_srcdir)/||' | sort -u > $@-2; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1095 diff -u -L $(po_file) -L $(po_file) $@-1 $@-2 \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1096 || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; }; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1097 rm -f $@-1 $@-2; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1098 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1099 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1100 # Sometimes it is useful to change the PATH environment variable |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1101 # in Makefiles. When doing so, it's better not to use the Unix-centric |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1102 # path separator of ':', but rather the automake-provided '$(PATH_SEPARATOR)'. |
16322
7256be967b3a
maint.mk: use more readable (yet functionally equivalent) quoting
Jim Meyering <meyering@redhat.com>
parents:
16299
diff
changeset
|
1103 msg = '$(ME): Do not use ":" above; use $$(PATH_SEPARATOR) instead' |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1104 sc_makefile_path_separator_check: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1105 @prohibit='PATH[=].*:' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1106 in_vc_files='akefile|\.mk$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1107 halt=$(msg) \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1108 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1109 |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1110 # Check that 'make alpha' will not fail at the end of the process, |
15811
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1111 # i.e., when pkg-M.N.tar.xz already exists (either in "." or in ../release) |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1112 # and is read-only. |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1113 writable-files: |
15811
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1114 if test -d $(release_archive_dir); then \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1115 for file in $(DIST_ARCHIVES); do \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1116 for p in ./ $(release_archive_dir)/; do \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1117 test -e $$p$$file || continue; \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1118 test -w $$p$$file \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1119 || { echo ERROR: $$p$$file is not writable; fail=1; }; \ |
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1120 done; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1121 done; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1122 test "$$fail" && exit 1 || : ; \ |
15811
bc3da814a8b3
maint.mk: adjust a release-related rule not to require use of gzip
Jim Meyering <meyering@redhat.com>
parents:
15660
diff
changeset
|
1123 else :; \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1124 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1125 |
13635
102e01a1ca93
maint.mk: avoid obscure sc_copyright_check failure in coreutils
Jim Meyering <meyering@redhat.com>
parents:
13393
diff
changeset
|
1126 v_etc_file = $(gnulib_dir)/lib/version-etc.c |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1127 sample-test = tests/sample-test |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1128 texi = doc/$(PACKAGE).texi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1129 # Make sure that the copyright date in $(v_etc_file) is up to date. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1130 # Do the same for the $(sample-test) and the main doc/.texi file. |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1131 sc_copyright_check: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1132 @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1133 in_files=$(v_etc_file) \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1134 halt='out of date copyright in $(v_etc_file); update it' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1135 $(_sc_search_regexp) |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1136 @require='# Copyright \(C\) '$$(date +%Y)' Free' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1137 in_vc_files=$(sample-test) \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1138 halt='out of date copyright in $(sample-test); update it' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1139 $(_sc_search_regexp) |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1140 @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1141 in_vc_files=$(texi) \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1142 halt='out of date copyright in $(texi); update it' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1143 $(_sc_search_regexp) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1144 |
13185
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1145 # If tests/help-version exists and seems to be new enough, assume that its |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1146 # use of init.sh and path_prepend_ is correct, and ensure that every other |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1147 # use of init.sh is identical. |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1148 # This is useful because help-version cross-checks prog --version |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1149 # with $(VERSION), which verifies that its path_prepend_ invocation |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1150 # sets PATH correctly. This is an inexpensive way to ensure that |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1151 # the other init.sh-using tests also get it right. |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1152 _hv_file ?= $(srcdir)/tests/help-version |
13331
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1153 _hv_regex_weak ?= ^ *\. .*/init\.sh" |
15315
94b3a0b47189
maint.mk: add syntax-check to avoid char[PATH_MAX]
Eric Blake <eblake@redhat.com>
parents:
14864
diff
changeset
|
1154 # Fix syntax-highlighters " |
13331
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1155 _hv_regex_strong ?= ^ *\. "\$${srcdir=\.}/init\.sh" |
13185
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1156 sc_cross_check_PATH_usage_in_tests: |
13192
ba35e9647b3b
maint.mk: print better diagnostic when there is no $(_hv_file)
Jim Meyering <meyering@redhat.com>
parents:
13185
diff
changeset
|
1157 @if test -f $(_hv_file); then \ |
13331
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1158 grep -l 'VERSION mismatch' $(_hv_file) >/dev/null \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1159 || { echo "$@: skipped: no such file: $(_hv_file)" 1>&2; \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1160 exit 0; }; \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1161 grep -lE '$(_hv_regex_strong)' $(_hv_file) >/dev/null \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1162 || { echo "$@: $(_hv_file) lacks conforming use of init.sh" 1>&2; \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1163 exit 1; }; \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1164 good=$$(grep -E '$(_hv_regex_strong)' $(_hv_file)); \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1165 grep -LFx "$$good" \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1166 $$(grep -lE '$(_hv_regex_weak)' $$($(VC_LIST_EXCEPT))) \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1167 | grep . && \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1168 { echo "$(ME): the above files use path_prepend_ inconsistently" \ |
dc2c7e3048ec
maint.mk: improve sc_cross_check_PATH_usage_in_tests
Jim Meyering <meyering@redhat.com>
parents:
13329
diff
changeset
|
1169 1>&2; exit 1; } || :; \ |
13185
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1170 fi |
8845faccc61b
maint.mk: add a PATH crosschecking syntax-check rule
Jim Meyering <meyering@redhat.com>
parents:
13126
diff
changeset
|
1171 |
16134
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1172 # BRE regex of file contents to identify a test script. |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1173 _test_script_regex ?= \<init\.sh\> |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1174 |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1175 # In tests, use "compare expected actual", not the reverse. |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1176 sc_prohibit_reversed_compare_failure: |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1177 @prohibit='\<compare [^ ]+ ([^ ]*exp|/dev/null)' \ |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1178 containing='$(_test_script_regex)' \ |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1179 halt='reversed compare arguments' \ |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1180 $(_sc_search_regexp) |
456f788a2768
maint.mk: add syntax check for use of compare from init.sh
Eric Blake <eblake@redhat.com>
parents:
16088
diff
changeset
|
1181 |
12816
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1182 # #if HAVE_... will evaluate to false for any non numeric string. |
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1183 # That would be flagged by using -Wundef, however gnulib currently |
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1184 # tests many undefined macros, and so we can't enable that option. |
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1185 # So at least preclude common boolean strings as macro values. |
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1186 sc_Wundef_boolean: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1187 @prohibit='^#define.*(yes|no|true|false)$$' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1188 in_files='$(CONFIG_INCLUDE)' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1189 halt='Use 0 or 1 for macro values' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1190 $(_sc_search_regexp) |
12816
7a4d2814715b
syntax-check: detect incorrect boolean macro values in config.h
Pádraig Brady <P@draigBrady.com>
parents:
12773
diff
changeset
|
1191 |
15315
94b3a0b47189
maint.mk: add syntax-check to avoid char[PATH_MAX]
Eric Blake <eblake@redhat.com>
parents:
14864
diff
changeset
|
1192 # Even if you use pathmax.h to guarantee that PATH_MAX is defined, it might |
15316
b62cfb73a10c
maint.mk: test further PATH_MAX issues
Eric Blake <eblake@redhat.com>
parents:
15315
diff
changeset
|
1193 # not be constant, or might overflow a stack. In general, use PATH_MAX as |
b62cfb73a10c
maint.mk: test further PATH_MAX issues
Eric Blake <eblake@redhat.com>
parents:
15315
diff
changeset
|
1194 # a limit, not an array or alloca size. |
b62cfb73a10c
maint.mk: test further PATH_MAX issues
Eric Blake <eblake@redhat.com>
parents:
15315
diff
changeset
|
1195 sc_prohibit_path_max_allocation: |
b62cfb73a10c
maint.mk: test further PATH_MAX issues
Eric Blake <eblake@redhat.com>
parents:
15315
diff
changeset
|
1196 @prohibit='(\balloca *\([^)]*|\[[^]]*)PATH_MAX' \ |
b62cfb73a10c
maint.mk: test further PATH_MAX issues
Eric Blake <eblake@redhat.com>
parents:
15315
diff
changeset
|
1197 halt='Avoid stack allocations of size PATH_MAX' \ |
15315
94b3a0b47189
maint.mk: add syntax-check to avoid char[PATH_MAX]
Eric Blake <eblake@redhat.com>
parents:
14864
diff
changeset
|
1198 $(_sc_search_regexp) |
94b3a0b47189
maint.mk: add syntax-check to avoid char[PATH_MAX]
Eric Blake <eblake@redhat.com>
parents:
14864
diff
changeset
|
1199 |
12827
d844fd639561
maint: add a syntax-check rule to check for vulnerable Makefile.in
Jim Meyering <meyering@redhat.com>
parents:
12816
diff
changeset
|
1200 sc_vulnerable_makefile_CVE-2009-4029: |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1201 @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \ |
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1202 in_files=$$(find $(srcdir) -name Makefile.in) \ |
13704
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
1203 halt=$$(printf '%s\n' \ |
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
1204 'the above files are vulnerable; beware of running' \ |
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
1205 ' "make dist*" rules, and upgrade to fixed automake' \ |
fe063c25c0ce
maint.mk: avoid unexpanded \n in two diagnostics
Jim Meyering <meyering@redhat.com>
parents:
13635
diff
changeset
|
1206 ' see http://bugzilla.redhat.com/542609 for details') \ |
13103
3622812c3a89
maint.mk: _sc_search_regexp: generalize and rename from _prohibit_regexp
Jose E. Marchesi <jemarch@gnu.org>
parents:
13102
diff
changeset
|
1207 $(_sc_search_regexp) |
12827
d844fd639561
maint: add a syntax-check rule to check for vulnerable Makefile.in
Jim Meyering <meyering@redhat.com>
parents:
12816
diff
changeset
|
1208 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1209 vc-diff-check: |
11501
5223ecd9ec17
maint.mk: import improvements from m4
Eric Blake <ebb9@byu.net>
parents:
11500
diff
changeset
|
1210 (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || : |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1211 if test -s vc-diffs; then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1212 cat vc-diffs; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1213 echo "Some files are locally modified:" 1>&2; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1214 exit 1; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1215 else \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1216 rm vc-diffs; \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1217 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1218 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1219 rel-files = $(DIST_ARCHIVES) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1220 |
11575
cfe435cf936c
maint.mk: allow gnulib_dir in VPATH build
Eric Blake <ebb9@byu.net>
parents:
11573
diff
changeset
|
1221 gnulib_dir ?= $(srcdir)/gnulib |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1222 gnulib-version = $$(cd $(gnulib_dir) && git describe) |
11501
5223ecd9ec17
maint.mk: import improvements from m4
Eric Blake <ebb9@byu.net>
parents:
11500
diff
changeset
|
1223 bootstrap-tools ?= autoconf,automake,gnulib |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1224 |
12539
dafd055586ef
maint.mk: don't require explicit gpg_key_ID in cfg.mk
Jim Meyering <meyering@redhat.com>
parents:
12538
diff
changeset
|
1225 # If it's not already specified, derive the GPG key ID from |
dafd055586ef
maint.mk: don't require explicit gpg_key_ID in cfg.mk
Jim Meyering <meyering@redhat.com>
parents:
12538
diff
changeset
|
1226 # the signed tag we've just applied to mark this release. |
dafd055586ef
maint.mk: don't require explicit gpg_key_ID in cfg.mk
Jim Meyering <meyering@redhat.com>
parents:
12538
diff
changeset
|
1227 gpg_key_ID ?= \ |
16055
8063ffd1fa6d
maint.mk: extract GPG key ID without using a temporary file
Jim Meyering <meyering@redhat.com>
parents:
16053
diff
changeset
|
1228 $$(git cat-file tag v$(VERSION) \ |
8063ffd1fa6d
maint.mk: extract GPG key ID without using a temporary file
Jim Meyering <meyering@redhat.com>
parents:
16053
diff
changeset
|
1229 | gpgv --status-fd 1 --keyring /dev/null - - 2>/dev/null \ |
8063ffd1fa6d
maint.mk: extract GPG key ID without using a temporary file
Jim Meyering <meyering@redhat.com>
parents:
16053
diff
changeset
|
1230 | sed -n '/^\[GNUPG:\] ERRSIG /{s///;s/ .*//p;q}') |
12539
dafd055586ef
maint.mk: don't require explicit gpg_key_ID in cfg.mk
Jim Meyering <meyering@redhat.com>
parents:
12538
diff
changeset
|
1231 |
13306
3b72fc82a799
maint.mk, announce-gen: allow project-specific announcement mail headers
Jim Meyering <meyering@redhat.com>
parents:
13304
diff
changeset
|
1232 translation_project_ ?= coordinator@translationproject.org |
14699
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1233 |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1234 # Make info-gnu the default only for a stable release. |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1235 ifeq ($(RELEASE_TYPE),stable) |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1236 announcement_Cc_ ?= $(translation_project_), $(PACKAGE_BUGREPORT) |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1237 announcement_mail_headers_ ?= \ |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1238 To: info-gnu@gnu.org \ |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1239 Cc: $(announcement_Cc_) \ |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1240 Mail-Followup-To: $(PACKAGE_BUGREPORT) |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1241 else |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1242 announcement_Cc_ ?= $(translation_project_) |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1243 announcement_mail_headers_ ?= \ |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1244 To: $(PACKAGE_BUGREPORT) \ |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1245 Cc: $(announcement_Cc_) |
6b83b217fcdd
maint.mk: use info-gnu@ as the default only for a stable release
Jim Meyering <meyering@redhat.com>
parents:
14651
diff
changeset
|
1246 endif |
13306
3b72fc82a799
maint.mk, announce-gen: allow project-specific announcement mail headers
Jim Meyering <meyering@redhat.com>
parents:
13304
diff
changeset
|
1247 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1248 announcement: NEWS ChangeLog $(rel-files) |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
1249 @$(srcdir)/$(_build-aux)/announce-gen \ |
13306
3b72fc82a799
maint.mk, announce-gen: allow project-specific announcement mail headers
Jim Meyering <meyering@redhat.com>
parents:
13304
diff
changeset
|
1250 --mail-headers='$(announcement_mail_headers_)' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1251 --release-type=$(RELEASE_TYPE) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1252 --package=$(PACKAGE) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1253 --prev=$(PREV_VERSION) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1254 --curr=$(VERSION) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1255 --gpg-key-id=$(gpg_key_ID) \ |
12581
25232b487199
maint: support 'make announcement' from a VPATH build
Eric Blake <ebb9@byu.net>
parents:
12576
diff
changeset
|
1256 --news=$(srcdir)/NEWS \ |
11501
5223ecd9ec17
maint.mk: import improvements from m4
Eric Blake <ebb9@byu.net>
parents:
11500
diff
changeset
|
1257 --bootstrap-tools=$(bootstrap-tools) \ |
16554
dad9ad605e56
maint.mk: allow announcement for non-gnulib project
Eric Blake <eblake@redhat.com>
parents:
16553
diff
changeset
|
1258 $$(case ,$(bootstrap-tools), in (*,gnulib,*) \ |
dad9ad605e56
maint.mk: allow announcement for non-gnulib project
Eric Blake <eblake@redhat.com>
parents:
16553
diff
changeset
|
1259 echo --gnulib-version=$(gnulib-version);; esac) \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1260 --no-print-checksums \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1261 $(addprefix --url-dir=, $(url_dir_list)) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1262 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1263 ## ---------------- ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1264 ## Updating files. ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1265 ## ---------------- ## |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1266 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1267 ftp-gnu = ftp://ftp.gnu.org/gnu |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1268 www-gnu = http://www.gnu.org |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1269 |
12864
9ab78f8f0368
maint.mk: allow the default upload destination dir to be overridden
Jim Meyering <meyering@redhat.com>
parents:
12863
diff
changeset
|
1270 upload_dest_dir_ ?= $(PACKAGE) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1271 emit_upload_commands: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1272 @echo ===================================== |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1273 @echo ===================================== |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
1274 @echo "$(srcdir)/$(_build-aux)/gnupload $(GNUPLOADFLAGS) \\" |
12864
9ab78f8f0368
maint.mk: allow the default upload destination dir to be overridden
Jim Meyering <meyering@redhat.com>
parents:
12863
diff
changeset
|
1275 @echo " --to $(gnu_rel_host):$(upload_dest_dir_) \\" |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1276 @echo " $(rel-files)" |
12538
a8059f620e8f
maint.mk: create announcement template in ~/, not in /tmp
Jim Meyering <meyering@redhat.com>
parents:
12443
diff
changeset
|
1277 @echo '# send the ~/announce-$(my_distdir) e-mail' |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1278 @echo ===================================== |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1279 @echo ===================================== |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1280 |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1281 define emit-commit-log |
15587
a9fbdd1023d5
maint.mk: mark the post-release commit log with "maint: " prefix
Jim Meyering <meyering@redhat.com>
parents:
15493
diff
changeset
|
1282 printf '%s\n' 'maint: post-release administrivia' '' \ |
a9fbdd1023d5
maint.mk: mark the post-release commit log with "maint: " prefix
Jim Meyering <meyering@redhat.com>
parents:
15493
diff
changeset
|
1283 '* NEWS: Add header line for next release.' \ |
a9fbdd1023d5
maint.mk: mark the post-release commit log with "maint: " prefix
Jim Meyering <meyering@redhat.com>
parents:
15493
diff
changeset
|
1284 '* .prev-version: Record previous version.' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1285 '* cfg.mk (old_NEWS_hash): Auto-update.' |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1286 endef |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1287 |
11534
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1288 .PHONY: no-submodule-changes |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1289 no-submodule-changes: |
11547
3f43faadaf9d
maint: make the new no-submodule-changes rule VPATH-safe
Eric Blake <ebb9@byu.net>
parents:
11534
diff
changeset
|
1290 if test -d $(srcdir)/.git; then \ |
3f43faadaf9d
maint: make the new no-submodule-changes rule VPATH-safe
Eric Blake <ebb9@byu.net>
parents:
11534
diff
changeset
|
1291 diff=$$(cd $(srcdir) && git submodule -q foreach \ |
3f43faadaf9d
maint: make the new no-submodule-changes rule VPATH-safe
Eric Blake <ebb9@byu.net>
parents:
11534
diff
changeset
|
1292 git diff-index --name-only HEAD) \ |
11534
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1293 || exit 1; \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1294 case $$diff in '') ;; \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1295 *) echo '$(ME): submodule files are locally modified:'; \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1296 echo "$$diff"; exit 1;; esac; \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1297 else \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1298 : ; \ |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1299 fi |
9f608fba8b1c
build: ensure that a release build fails when a submodule is unclean
Jim Meyering <meyering@redhat.com>
parents:
11519
diff
changeset
|
1300 |
14137
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1301 submodule-checks ?= no-submodule-changes public-submodule-commit |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1302 |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1303 # Ensure that each sub-module commit we're using is public. |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1304 # Without this, it is too easy to tag and release code that |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1305 # cannot be built from a fresh clone. |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1306 .PHONY: public-submodule-commit |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1307 public-submodule-commit: |
14190
6699cf2b13db
maint.mk: improve the public-submodule-commit rule
Jim Meyering <meyering@redhat.com>
parents:
14140
diff
changeset
|
1308 $(AM_V_GEN)if test -d $(srcdir)/.git; then \ |
6699cf2b13db
maint.mk: improve the public-submodule-commit rule
Jim Meyering <meyering@redhat.com>
parents:
14140
diff
changeset
|
1309 cd $(srcdir) && \ |
14210
59d4ae9d48d6
maintainer-makefile: work with older git for submodule check
Eric Blake <eblake@redhat.com>
parents:
14201
diff
changeset
|
1310 git submodule --quiet foreach test '$$(git rev-parse $$sha1)' \ |
59d4ae9d48d6
maintainer-makefile: work with older git for submodule check
Eric Blake <eblake@redhat.com>
parents:
14201
diff
changeset
|
1311 = '$$(git merge-base origin $$sha1)' \ |
14137
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1312 || { echo '$(ME): found non-public submodule commit' >&2; \ |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1313 exit 1; }; \ |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1314 else \ |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1315 : ; \ |
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1316 fi |
14199
d6780f2a0ebc
maint.mk: make "check" depend on public-submodule-commit by default
Jim Meyering <meyering@redhat.com>
parents:
14190
diff
changeset
|
1317 # This rule has a high enough utility/cost ratio that it should be a |
d6780f2a0ebc
maint.mk: make "check" depend on public-submodule-commit by default
Jim Meyering <meyering@redhat.com>
parents:
14190
diff
changeset
|
1318 # dependent of "check" by default. However, some of us do occasionally |
d6780f2a0ebc
maint.mk: make "check" depend on public-submodule-commit by default
Jim Meyering <meyering@redhat.com>
parents:
14190
diff
changeset
|
1319 # commit a temporary change that deliberately points to a non-public |
d6780f2a0ebc
maint.mk: make "check" depend on public-submodule-commit by default
Jim Meyering <meyering@redhat.com>
parents:
14190
diff
changeset
|
1320 # submodule commit, and want to be able to use rules like "make check". |
14201
0efdc4f3700e
maint.mk: adjust variable name to be consistent with other gl_ vars
Jim Meyering <meyering@redhat.com>
parents:
14199
diff
changeset
|
1321 # In that case, run e.g., "make check gl_public_submodule_commit=" |
14199
d6780f2a0ebc
maint.mk: make "check" depend on public-submodule-commit by default
Jim Meyering <meyering@redhat.com>
parents:
14190
diff
changeset
|
1322 # to disable this test. |
14201
0efdc4f3700e
maint.mk: adjust variable name to be consistent with other gl_ vars
Jim Meyering <meyering@redhat.com>
parents:
14199
diff
changeset
|
1323 gl_public_submodule_commit ?= public-submodule-commit |
0efdc4f3700e
maint.mk: adjust variable name to be consistent with other gl_ vars
Jim Meyering <meyering@redhat.com>
parents:
14199
diff
changeset
|
1324 check: $(gl_public_submodule_commit) |
14137
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1325 |
12083
b7b81ca175f4
maint.mk: requiring "make major" was annoying, for a "minor" release.
Jim Meyering <meyering@redhat.com>
parents:
12035
diff
changeset
|
1326 .PHONY: alpha beta stable |
b7b81ca175f4
maint.mk: requiring "make major" was annoying, for a "minor" release.
Jim Meyering <meyering@redhat.com>
parents:
12035
diff
changeset
|
1327 ALL_RECURSIVE_TARGETS += alpha beta stable |
14137
2dbfa19b11d0
maint.mk: add pre-release check to ensure submodule commits are public
Eric Blake <eblake@redhat.com>
parents:
14079
diff
changeset
|
1328 alpha beta stable: $(local-check) writable-files $(submodule-checks) |
12083
b7b81ca175f4
maint.mk: requiring "make major" was annoying, for a "minor" release.
Jim Meyering <meyering@redhat.com>
parents:
12035
diff
changeset
|
1329 test $@ = stable \ |
b7b81ca175f4
maint.mk: requiring "make major" was annoying, for a "minor" release.
Jim Meyering <meyering@redhat.com>
parents:
12035
diff
changeset
|
1330 && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1331 || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1332 || : |
11909
2cd9af4a1b6a
maint.mk: remove more coreutils-specific targets; XZ_OPT=-9ev
Jim Meyering <meyering@redhat.com>
parents:
11853
diff
changeset
|
1333 $(MAKE) vc-diff-check |
12384
8620ff59758a
maint.mk: news-check: use grep -E
Jim Meyering <meyering@redhat.com>
parents:
12383
diff
changeset
|
1334 $(MAKE) news-check |
11909
2cd9af4a1b6a
maint.mk: remove more coreutils-specific targets; XZ_OPT=-9ev
Jim Meyering <meyering@redhat.com>
parents:
11853
diff
changeset
|
1335 $(MAKE) distcheck |
16556
25b84e0d96a6
maint: don't specify XZ_OPT=-9ev in dist-related rule
Jim Meyering <meyering@redhat.com>
parents:
16554
diff
changeset
|
1336 $(MAKE) dist |
12443
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1337 $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@ |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1338 $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@ |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1339 |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1340 # Override this in cfg.mk if you follow different procedures. |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1341 release-prep-hook ?= release-prep |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1342 |
13871
8c865631b168
maint.mk: rename variable: s/noteworthy/gl_noteworthy_news_/
Jim Meyering <meyering@redhat.com>
parents:
13865
diff
changeset
|
1343 gl_noteworthy_news_ = * Noteworthy changes in release ?.? (????-??-??) [?] |
12443
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1344 .PHONY: release-prep |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1345 release-prep: |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1346 case $$RELEASE_TYPE in alpha|beta|stable) ;; \ |
3a97f22a64eb
maint.mk: allow a project to override release-prep commands
Alfred M. Szmidt <ams@gnu.org>
parents:
12441
diff
changeset
|
1347 *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac |
14709
8fd3118c13f8
maint.mk: suppress "Entering/Leaving directory" diag in announcement
Jim Meyering <meyering@redhat.com>
parents:
14704
diff
changeset
|
1348 $(MAKE) --no-print-directory -s announcement > ~/announce-$(my_distdir) |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1349 if test -d $(release_archive_dir); then \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1350 ln $(rel-files) $(release_archive_dir); \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1351 chmod a-w $(rel-files); \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1352 fi |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1353 echo $(VERSION) > $(prev_version_file) |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1354 $(MAKE) update-NEWS-hash |
13871
8c865631b168
maint.mk: rename variable: s/noteworthy/gl_noteworthy_news_/
Jim Meyering <meyering@redhat.com>
parents:
13865
diff
changeset
|
1355 perl -pi -e '$$. == 3 and print "$(gl_noteworthy_news_)\n\n\n"' NEWS |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1356 $(emit-commit-log) > .ci-msg |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1357 $(VC) commit -F .ci-msg -a |
12538
a8059f620e8f
maint.mk: create announcement template in ~/, not in /tmp
Jim Meyering <meyering@redhat.com>
parents:
12443
diff
changeset
|
1358 rm .ci-msg |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1359 |
13309
eeb72cb4f562
maint.mk: allow to pass options to gendocs.sh
Jim Meyering <meyering@redhat.com>
parents:
13306
diff
changeset
|
1360 # Override this with e.g., -s $(srcdir)/some_other_name.texi |
eeb72cb4f562
maint.mk: allow to pass options to gendocs.sh
Jim Meyering <meyering@redhat.com>
parents:
13306
diff
changeset
|
1361 # if the default $(PACKAGE)-derived name doesn't apply. |
eeb72cb4f562
maint.mk: allow to pass options to gendocs.sh
Jim Meyering <meyering@redhat.com>
parents:
13306
diff
changeset
|
1362 gendocs_options_ ?= |
eeb72cb4f562
maint.mk: allow to pass options to gendocs.sh
Jim Meyering <meyering@redhat.com>
parents:
13306
diff
changeset
|
1363 |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1364 .PHONY: web-manual |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1365 web-manual: |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1366 @test -z "$(manual_title)" \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1367 && { echo define manual_title in cfg.mk 1>&2; exit 1; } || : |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1368 @cd '$(srcdir)/doc'; \ |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
1369 $(SHELL) ../$(_build-aux)/gendocs.sh $(gendocs_options_) \ |
13309
eeb72cb4f562
maint.mk: allow to pass options to gendocs.sh
Jim Meyering <meyering@redhat.com>
parents:
13306
diff
changeset
|
1370 -o '$(abs_builddir)/doc/manual' \ |
11495
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1371 --email $(PACKAGE_BUGREPORT) $(PACKAGE) \ |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1372 "$(PACKAGE_NAME) - $(manual_title)" |
d88c5ec9288d
Sync maint.mk with coreutils.
Simon Josefsson <simon@josefsson.org>
parents:
11484
diff
changeset
|
1373 @echo " *** Upload the doc/manual directory to web-cvs." |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1374 |
10738
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1375 # Code Coverage |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1376 |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1377 init-coverage: |
11406
ae9bcb808cfd
maint.mk: really add $(AM_MAKEFLAGS)
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
11405
diff
changeset
|
1378 $(MAKE) $(AM_MAKEFLAGS) clean |
10738
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1379 lcov --directory . --zerocounters |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1380 |
10757
0affc3e42aa9
maint.mk: Use --coverage.
Simon Josefsson <simon@josefsson.org>
parents:
10738
diff
changeset
|
1381 COVERAGE_CCOPTS ?= "-g --coverage" |
10738
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1382 COVERAGE_OUT ?= doc/coverage |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1383 |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1384 build-coverage: |
11406
ae9bcb808cfd
maint.mk: really add $(AM_MAKEFLAGS)
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
11405
diff
changeset
|
1385 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) |
ae9bcb808cfd
maint.mk: really add $(AM_MAKEFLAGS)
Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
parents:
11405
diff
changeset
|
1386 $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check |
10738
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1387 mkdir -p $(COVERAGE_OUT) |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1388 lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \ |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1389 --capture |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1390 |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1391 gen-coverage: |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1392 genhtml --output-directory $(COVERAGE_OUT) \ |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1393 $(COVERAGE_OUT)/$(PACKAGE).info \ |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1394 --highlight --frames --legend \ |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1395 --title "$(PACKAGE_NAME)" |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1396 |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1397 coverage: init-coverage build-coverage gen-coverage |
af888e12d10d
top/maint.mk: Add coverage rules, inspired by scripts in gnupdf.
Simon Josefsson <simon@josefsson.org>
parents:
10368
diff
changeset
|
1398 |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1399 # Update gettext files. |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1400 PACKAGE ?= $(shell basename $(PWD)) |
11484
489151a3b578
maintainer-makefile: (PO_DOMAIN): New variable, allows overriding of gettext domain.
Simon Josefsson <simon@josefsson.org>
parents:
11468
diff
changeset
|
1401 PO_DOMAIN ?= $(PACKAGE) |
489151a3b578
maintainer-makefile: (PO_DOMAIN): New variable, allows overriding of gettext domain.
Simon Josefsson <simon@josefsson.org>
parents:
11468
diff
changeset
|
1402 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/ |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1403 PODIR ?= po |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1404 refresh-po: |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1405 rm -f $(PODIR)/*.po && \ |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1406 echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \ |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1407 wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \ |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1408 echo 'en@boldquot' > $(PODIR)/LINGUAS && \ |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1409 echo 'en@quot' >> $(PODIR)/LINGUAS && \ |
10828
45b8dcc40064
maintainer-makefile: Fix sed regexp.
Simon Josefsson <simon@josefsson.org>
parents:
10757
diff
changeset
|
1410 ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1411 |
13286
bacd8565eeaa
top/maint.mk (indent): Run twice to produce idempotent results.
Simon Josefsson <simon@josefsson.org>
parents:
13278
diff
changeset
|
1412 # Running indent once is not idempotent, but running it twice is. |
9811
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1413 INDENT_SOURCES ?= $(C_SOURCES) |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1414 .PHONY: indent |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1415 indent: |
5f79eb63c21e
Alter GNUmakefile to install into top directory.
Eric Blake <ebb9@byu.net>
parents:
diff
changeset
|
1416 indent $(INDENT_SOURCES) |
13286
bacd8565eeaa
top/maint.mk (indent): Run twice to produce idempotent results.
Simon Josefsson <simon@josefsson.org>
parents:
13278
diff
changeset
|
1417 indent $(INDENT_SOURCES) |
11776
9deb84e458cb
maint.mk: add a copyright-updating rule
Jim Meyering <meyering@redhat.com>
parents:
11750
diff
changeset
|
1418 |
11834
5c2855361aa1
maint.mk: support update-copyright-env
Joel E. Denny <jdenny@clemson.edu>
parents:
11788
diff
changeset
|
1419 # If you want to set UPDATE_COPYRIGHT_* environment variables, |
5c2855361aa1
maint.mk: support update-copyright-env
Joel E. Denny <jdenny@clemson.edu>
parents:
11788
diff
changeset
|
1420 # put the assignments in this variable. |
5c2855361aa1
maint.mk: support update-copyright-env
Joel E. Denny <jdenny@clemson.edu>
parents:
11788
diff
changeset
|
1421 update-copyright-env ?= |
5c2855361aa1
maint.mk: support update-copyright-env
Joel E. Denny <jdenny@clemson.edu>
parents:
11788
diff
changeset
|
1422 |
11776
9deb84e458cb
maint.mk: add a copyright-updating rule
Jim Meyering <meyering@redhat.com>
parents:
11750
diff
changeset
|
1423 # Run this rule once per year (usually early in January) |
9deb84e458cb
maint.mk: add a copyright-updating rule
Jim Meyering <meyering@redhat.com>
parents:
11750
diff
changeset
|
1424 # to update all FSF copyright year lists in your project. |
11836
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1425 # If you have an additional project-specific rule, |
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1426 # add it in cfg.mk along with a line 'update-copyright: prereq'. |
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1427 # By default, exclude all variants of COPYING; you can also |
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1428 # add exemptions (such as ChangeLog..* for rotated change logs) |
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1429 # in the file .x-update-copyright. |
11776
9deb84e458cb
maint.mk: add a copyright-updating rule
Jim Meyering <meyering@redhat.com>
parents:
11750
diff
changeset
|
1430 .PHONY: update-copyright |
11836
4103ca3d0881
maint.mk: simplify update-copyright rule
Eric Blake <ebb9@byu.net>
parents:
11834
diff
changeset
|
1431 update-copyright: |
11847
5dd8e8cf05db
maint.mk: give full control over update-copyright exclusions
Joel E. Denny <jdenny@clemson.edu>
parents:
11836
diff
changeset
|
1432 grep -l -w Copyright \ |
5dd8e8cf05db
maint.mk: give full control over update-copyright exclusions
Joel E. Denny <jdenny@clemson.edu>
parents:
11836
diff
changeset
|
1433 $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \ |
16000
79bbea2afc18
maint.mk: don't maintain a second build-aux variable.
Gary V. Vaughan <gary@gnu.org>
parents:
15990
diff
changeset
|
1434 | $(update-copyright-env) xargs $(srcdir)/$(_build-aux)/$@ |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1435 |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1436 # This tight_scope test is skipped with a warning if $(_gl_TS_headers) is not |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1437 # overridden and $(_gl_TS_dir)/Makefile.am does not mention noinst_HEADERS. |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1438 |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1439 # NOTE: to override any _gl_TS_* default value, you must |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1440 # define the variable(s) using "export" in cfg.mk. |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1441 _gl_TS_dir ?= src |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1442 |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1443 ALL_RECURSIVE_TARGETS += sc_tight_scope |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1444 sc_tight_scope: tight-scope.mk |
15615
79e8ec9a79db
maint.mk: sc_tight_scope: propagate failure from sub-make
Jim Meyering <meyering@redhat.com>
parents:
15587
diff
changeset
|
1445 @fail=0; \ |
79e8ec9a79db
maint.mk: sc_tight_scope: propagate failure from sub-make
Jim Meyering <meyering@redhat.com>
parents:
15587
diff
changeset
|
1446 if ! grep '^ *export _gl_TS_headers *=' $(srcdir)/cfg.mk \ |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1447 > /dev/null \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1448 && ! grep -w noinst_HEADERS $(srcdir)/$(_gl_TS_dir)/Makefile.am \ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1449 > /dev/null 2>&1; then \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1450 echo '$(ME): skipping $@'; \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1451 else \ |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1452 $(MAKE) -s -C $(_gl_TS_dir) \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1453 -f Makefile \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1454 -f $(abs_top_srcdir)/cfg.mk \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1455 -f $(abs_top_builddir)/$< \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1456 _gl_tight_scope \ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1457 || fail=1; \ |
15615
79e8ec9a79db
maint.mk: sc_tight_scope: propagate failure from sub-make
Jim Meyering <meyering@redhat.com>
parents:
15587
diff
changeset
|
1458 fi; \ |
79e8ec9a79db
maint.mk: sc_tight_scope: propagate failure from sub-make
Jim Meyering <meyering@redhat.com>
parents:
15587
diff
changeset
|
1459 rm -f $<; \ |
79e8ec9a79db
maint.mk: sc_tight_scope: propagate failure from sub-make
Jim Meyering <meyering@redhat.com>
parents:
15587
diff
changeset
|
1460 exit $$fail |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1461 |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1462 tight-scope.mk: $(ME) |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1463 @rm -f $@ $@-t |
16088
780e83599399
maint.mk: fix tight-scope.mk generation in VPATH builds.
Gary V. Vaughan <gary@gnu.org>
parents:
16055
diff
changeset
|
1464 @perl -ne '/^# TS-start/.../^# TS-end/ and print' $(srcdir)/$(ME) > $@-t |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1465 @chmod a=r $@-t && mv $@-t $@ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1466 |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1467 ifeq (a,b) |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1468 # TS-start |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1469 |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1470 # Most functions should have static scope. |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1471 # Any that don't must be marked with 'extern', but 'main' |
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1472 # and 'usage' are exceptions: they're always extern, but |
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1473 # do not need to be marked. Symbols matching '__.*' are |
14754
1299c18d8f6a
maint.mk: exclude compiler symbols from sc_tight_scope
Pádraig Brady <P@draigBrady.com>
parents:
14728
diff
changeset
|
1474 # reserved by the compiler, so are automatically excluded below. |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1475 _gl_TS_unmarked_extern_functions ?= main usage |
15493
1634a5da2f6e
maint.mk: relax the default _gl_TS_function_match regexp
Jim Meyering <meyering@redhat.com>
parents:
15478
diff
changeset
|
1476 _gl_TS_function_match ?= /^(?:$(_gl_TS_extern)) +.*?(\S+) *\(/ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1477 |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1478 # If your project uses a macro like "XTERN", then put |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1479 # the following in cfg.mk to override this default: |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1480 # export _gl_TS_extern = extern|XTERN |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1481 _gl_TS_extern ?= extern |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1482 |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1483 # The second nm|grep checks for file-scope variables with 'extern' scope. |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1484 # Without gnulib's progname module, you might put program_name here. |
16235
18a38c9615f0
In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents:
16212
diff
changeset
|
1485 # Symbols matching '__.*' are reserved by the compiler, |
14754
1299c18d8f6a
maint.mk: exclude compiler symbols from sc_tight_scope
Pádraig Brady <P@draigBrady.com>
parents:
14728
diff
changeset
|
1486 # so are automatically excluded below. |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1487 _gl_TS_unmarked_extern_vars ?= |
14718
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1488 |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1489 # NOTE: the _match variables are perl expressions -- not mere regular |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1490 # expressions -- so that you can extend them to match other patterns |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1491 # and easily extract matched variable names. |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1492 # For example, if your project declares some global variables via |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1493 # a macro like this: GLOBAL(type, var_name, initializer), then you |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1494 # can override this definition to automatically extract those names: |
b952f928cb43
maint.mk: change semantics/name of tight_scope variables
Jim Meyering <meyering@redhat.com>
parents:
14717
diff
changeset
|
1495 # export _gl_TS_var_match = \ |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1496 # /^(?:$(_gl_TS_extern)) .*?\**(\w+)(\[.*?\])?;/ || /\bGLOBAL\(.*?,\s*(.*?),/ |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1497 _gl_TS_var_match ?= /^(?:$(_gl_TS_extern)) .*?(\w+)(\[.*?\])?;/ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1498 |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1499 # The names of object files in (or relative to) $(_gl_TS_dir). |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1500 _gl_TS_obj_files ?= *.$(OBJEXT) |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1501 |
14801
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1502 # Files in which to search for the one-line style extern declarations. |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1503 # $(_gl_TS_dir)-relative. |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1504 _gl_TS_headers ?= $(noinst_HEADERS) |
60872968acd0
maint.mk: more tight_scope improvements
Jim Meyering <meyering@redhat.com>
parents:
14800
diff
changeset
|
1505 |
14716
8cfc1daa9cff
maint.mk: tweak new rule's name not to impinge
Jim Meyering <meyering@redhat.com>
parents:
14715
diff
changeset
|
1506 .PHONY: _gl_tight_scope |
8cfc1daa9cff
maint.mk: tweak new rule's name not to impinge
Jim Meyering <meyering@redhat.com>
parents:
14715
diff
changeset
|
1507 _gl_tight_scope: $(bin_PROGRAMS) |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1508 t=exceptions-$$$$; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1509 trap 's=$$?; rm -f $$t; exit $$s' 0; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1510 for sig in 1 2 3 13 15; do \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1511 eval "trap 'v=`expr $$sig + 128`; (exit $$v); exit $$v' $$sig"; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1512 done; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1513 src=`for f in $(SOURCES); do \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1514 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1515 hdr=`for f in $(_gl_TS_headers); do \ |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1516 test -f $$f && d= || d=$(srcdir)/; echo $$d$$f; done`; \ |
14754
1299c18d8f6a
maint.mk: exclude compiler symbols from sc_tight_scope
Pádraig Brady <P@draigBrady.com>
parents:
14728
diff
changeset
|
1517 ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_functions); \ |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1518 grep -h -A1 '^extern .*[^;]$$' $$src \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1519 | grep -vE '^(extern |--)' | sed 's/ .*//'; \ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1520 perl -lne \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1521 '$(_gl_TS_function_match) and print "^$$1\$$"' $$hdr; \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1522 ) | sort -u > $$t; \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1523 nm -e $(_gl_TS_obj_files) | sed -n 's/.* T //p'|grep -Ev -f $$t \ |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1524 && { echo the above functions should have static scope >&2; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1525 exit 1; } || : ; \ |
14754
1299c18d8f6a
maint.mk: exclude compiler symbols from sc_tight_scope
Pádraig Brady <P@draigBrady.com>
parents:
14728
diff
changeset
|
1526 ( printf '^%s$$\n' '__.*' $(_gl_TS_unmarked_extern_vars); \ |
14800
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1527 perl -lne '$(_gl_TS_var_match) and print "^$$1\$$"' $$hdr *.h \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1528 ) | sort -u > $$t; \ |
a5a7a62228b6
maint.mk: generalize/improve the tight-scope rule
Jim Meyering <meyering@redhat.com>
parents:
14756
diff
changeset
|
1529 nm -e $(_gl_TS_obj_files) | sed -n 's/.* [BCDGRS] //p' \ |
14715
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1530 | sort -u | grep -Ev -f $$t \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1531 && { echo the above variables should have static scope >&2; \ |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1532 exit 1; } || : |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1533 # TS-end |
80242e285601
maint.mk: add a syntax-check rule to ensure tightly-scoped symbols
Jim Meyering <meyering@redhat.com>
parents:
14709
diff
changeset
|
1534 endif |