1 # Customize maint.mk -*- makefile -*-
2 # Copyright (C) 2003-2011 Free Software Foundation, Inc.
4 # This program is free software: you can redistribute it and/or modify
5 # it under the terms of the GNU General Public License as published by
6 # the Free Software Foundation, either version 3 of the License, or
7 # (at your option) any later version.
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program. If not, see <http://www.gnu.org/licenses/>.
17 # Used in maint.mk's web-manual rule
18 manual_title
= Core GNU utilities
20 # Tests not to run as part of "make distcheck".
21 local-checks-to-skip
= \
24 # Tools used to bootstrap this package, used for "announcement".
25 bootstrap-tools
= autoconf
,automake
,gnulib
,bison
27 # Now that we have better tests, make this the default.
30 old_NEWS_hash
= 0869235d8e62fd7ed8d8dfacfad2e4d9
32 # Add an exemption for sc_makefile_at_at_check.
33 _makefile_at_at_check_exceptions
= ' && !/^cu_install_program =/'
35 # Our help-version script is in a slightly different location.
36 _hv_file ?
= $(srcdir)/tests
/misc
/help-version
38 # Ensure that the list of O_ symbols used to compute O_FULLBLOCK is complete.
39 dd
= $(srcdir)/src
/dd.c
42 @
{ echo O_FULLBLOCK
; echo O_NOCACHE
; \
43 perl
-nle
'/^ +\| (O_\w*)$$/ and print $$1' $(dd
); } |
sort > $@
.1
44 @
{ echo O_NOFOLLOW
; perl
-nle
'/{"[a-z]+",\s*(O_\w+)},/ and print $$1' \
45 $(dd
); } |
sort > $@
.2
46 @diff
-u
$@
.1 $@
.2 || diff
=1 || diff
=; \
49 && { echo
'$(ME): $(dd) has inconsistent O_ flag lists'>&2; \
52 # Ensure that dd's definition of LONGEST_SYMBOL stays in sync
53 # with the strings from the two affected variables.
54 dd_c
= $(srcdir)/src
/dd.c
56 ifneq ($(wildcard $(dd_c
)),)
57 @len
=$$( (sed
-n
'/conversions\[\] =$$/,/^};/p' $(dd_c
);\
58 sed
-n
'/flags\[\] =$$/,/^};/p' $(dd_c
) ) \
59 |sed
-n
'/"/s/^[^"]*"\([^"]*\)".*/\1/p' \
60 | wc
--max-line-length
); \
61 max
=$$(sed
-n
'/^#define LONGEST_SYMBOL /s///p' $(dd_c
) \
62 |tr
-d
'"' | wc
--max-line-length
); \
63 if
test "$$len" = "$$max"; then
:; else \
64 echo
'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \
69 # Many m4 macros names once began with `jm_'.
70 # On 2004-04-13, they were all changed to start with gl_ instead.
71 # Make sure that none are inadvertently reintroduced.
73 @grep
-nE
'jm_[A-Z]' \
74 $$($(VC_LIST
) m4 |grep
'\.m4$$'; echo
/dev
/null
) && \
75 { echo
'$(ME): do not use jm_ in m4 macro names' \
78 # Ensure that each root-requiring test is run via the "check-root" rule.
81 && grep check-root tests
/Makefile.am
>/dev
/null
2>&1; then \
82 t1
=sc-root.expected
; t2
=sc-root.actual
; \
83 grep
-nl
'^ *require_root_$$' \
84 $$($(VC_LIST
) tests
) |sed s
,tests
/,, |
sort > $$t1; \
85 sed
-n
'/^root_tests =[ ]*\\$$/,/[^\]$$/p' \
86 $(srcdir)/tests
/Makefile.am \
87 | sed
's/^ *//;/^root_tests =/d' \
88 | tr
-s
'\012\\' ' ' | fmt
-1 |
sort > $$t2; \
89 diff
-u
$$t1 $$t2 || diff
=1 || diff
=; \
92 && { echo
'tests/Makefile.am: missing check-root action'>&2; \
96 # Create a list of regular expressions matching the names
97 # of files included from system.h. Exclude a couple.
99 @sed
-n
'/^# *include /s///p' $(srcdir)/src
/system.h \
100 | grep
-Ev
'sys/(param|file)\.h' \
101 | sed
's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
106 Exit
() { set
+e
; (exit
$$1); exit
$$1; }; \
107 for sig in
1 2 3 13 15; do \
108 eval
"trap 'Exit $$(expr $$sig + 128)' $$sig"; \
112 # Files in src/ should not include directly any of
113 # the headers already included via system.h.
114 sc_system_h_headers
: .re-list
115 @if
test -f
$(srcdir)/src
/system.h
; then \
116 trap
'rc=$$?; rm -f .re-list; exit $$rc' 0; \
118 grep
-nE
-f .re-list \
119 $$($(VC_LIST_EXCEPT
) | grep
'^\($(srcdir)/\)\?src/') \
120 && { echo
'$(ME): the above are already included via system.h'\
121 1>&2; exit
1; } ||
:; \
126 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
127 $$($(VC_LIST_EXCEPT
)) && \
128 { echo
'$(ME): found misuse of Sun OS version numbers' 1>&2; \
131 ALL_RECURSIVE_TARGETS
+= sc_check-AUTHORS
133 @
$(MAKE
) -s
-C src _sc_check-AUTHORS
135 # Look for lines longer than 80 characters, except omit:
136 # - program-generated long lines in diff headers,
137 # - tests involving long checksum lines, and
138 # - the 'pr' test cases.
140 FILTER_LONG_LINES
= \
141 /^
[^
:]*\.diff
:[^
:]*:@@
/ d
; \
142 \|^
[^
:]*tests
/misc
/sha
[0-9]*sum
[-:]| d
; \
143 \|^
[^
:]*tests
/pr
/|
{ \|^
[^
:]*tests
/pr
/pr-tests
:|
!d
; };
145 @files
=$$($(VC_LIST_EXCEPT
)) \
146 halt
='line(s) with more than $(LINE_LEN_MAX) characters; reindent'; \
147 for file in
$$files; do \
148 expand
$$file | grep
-nE
'^.{$(LINE_LEN_MAX)}.' | \
149 sed
-e
"s|^|$$file:|" -e
'$(FILTER_LONG_LINES)'; \
150 done | grep .
&& { msg
="$$halt" $(_sc_say_and_exit
) } ||
:
152 # Option descriptions should not start with a capital letter
153 # One could grep source directly as follows:
154 # grep -E " {2,6}-.*[^.] [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
155 # but that would miss descriptions not on the same line as the -option.
156 ALL_RECURSIVE_TARGETS
+= sc_option_desc_uppercase
157 sc_option_desc_uppercase
:
158 @
$(MAKE
) -s
-C src all_programs
159 @
$(MAKE
) -s
-C man
$@
161 # Ensure all man/*.[1x] files are present
162 ALL_RECURSIVE_TARGETS
+= sc_man_file_correlation
163 sc_man_file_correlation
:
164 @
$(MAKE
) -s
-C src all_programs
165 @
$(MAKE
) -s
-C man
$@
167 # Ensure that the end of each release's section is marked by two empty lines.
168 sc_NEWS_two_empty_lines
:
169 @sed
-n
4,/Noteworthy
/p
$(srcdir)/NEWS \
170 | perl
-n0e
'/(^|\n)\n\n\* Noteworthy/ or exit 1' \
171 ||
{ echo
'$(ME): use two empty lines to separate NEWS sections' \
174 # Perl-based tests used to exec perl from a #!/bin/sh script.
175 # Now they all start with #!/usr/bin/perl and the portability
176 # infrastructure is in tests/Makefile.am. Make sure no old-style
177 # script sneaks back in.
178 sc_no_exec_perl_coreutils
:
179 @if
test -f
$(srcdir)/tests
/Coreutils.pm
; then \
180 grep
'^exec *\$$PERL.*MCoreutils' $$($(VC_LIST
) tests
) && \
181 { echo
1>&2 '$(ME): found anachronistic Perl-based tests'; \
185 # Don't use "readlink" or "readlinkat" directly
186 sc_prohibit_readlink
:
187 @prohibit
='\<readlink(at)? \(' \
188 halt
='do not use readlink(at); use via xreadlink or areadlink*' \
191 # Don't use address of "stat" or "lstat" functions
192 sc_prohibit_stat_macro_address
:
193 @prohibit
='\<l?stat '':|&l?stat\>' \
194 halt
='stat() and lstat() may be function-like macros' \
197 # Ensure that date's --help output stays in sync with the info
198 # documentation for GNU strftime. The only exception is %N,
199 # which date accepts but GNU strftime does not.
200 extract_char
= sed
's/^[^%][^%]*%\(.\).*/\1/'
202 @if
test -f
$(srcdir)/src
/date.c
; then \
203 grep
'^ %. ' $(srcdir)/src
/date.c |
sort \
204 |
$(extract_char
) > $@
-src
; \
206 info libc date calendar format
2>/dev
/null|grep
'^ `%.'\'\
207 |
$(extract_char
); } |
sort > $@
-info; \
208 if
test $$(stat
--format
%s
$@
-info) != 2; then \
209 diff
-u
$@
-src
$@
-info || exit
1; \
211 echo
'$(ME): skipping $@: libc info not installed' 1>&2; \
213 rm -f
$@
-src
$@
-info; \
216 # Indent only with spaces.
217 sc_prohibit_tab_based_indentation
:
219 halt
='TAB in indentation; use only spaces' \
222 # The SEE ALSO section of a man page should not be terminated with
223 # a period. Check the first line after each "SEE ALSO" line in man/*.x:
224 sc_prohibit_man_see_also_period
:
225 @grep
-nB1
'\.$$' $$($(VC_LIST_EXCEPT
) | grep
'man/.*\.x$$') \
226 | grep
-A1
-e
'-\[SEE ALSO\]' | grep
'\.$$' && \
227 { echo
'$(ME): do not end "SEE ALSO" section with a period' \
230 # Don't use "indent-tabs-mode: nil" anymore. No longer needed.
231 sc_prohibit_emacs__indent_tabs_mode__setting
:
232 @prohibit
='^( *[*#] *)?indent-tabs-mode:' \
233 halt
='use of emacs indent-tabs-mode: setting' \
236 # Ensure that each file that contains fail=1 also contains fail=0.
237 # Otherwise, setting file=1 in the environment would make tests fail
240 @prohibit
='\<fail=0\>' \
241 halt
='fail=0 initialization' \
244 # Ensure that "stdio--.h" is used where appropriate.
245 sc_require_stdio_safer
:
246 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
247 files
=$$(grep
-l
'\bfreopen \?(' $$($(VC_LIST_EXCEPT
) \
248 | grep
'\.[ch]$$')); \
249 test -n
"$$files" && grep
-LE
'include "stdio--.h"' $$files \
251 { echo
'$(ME): the above files should use "stdio--.h"' \
252 1>&2; exit
1; } ||
:; \
256 sc_prohibit_perl_hash_quotes
:
257 @prohibit
="\{'[A-Z_]+' *[=}]" \
258 halt
="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}" \
261 # Prefer xnanosleep over other less-precise sleep methods
263 @prohibit
='\<(nano|u)?sleep \(' \
264 halt
='prefer xnanosleep over other sleep interfaces' \
267 # Use print_ver_ (from init.cfg), not open-coded $VERBOSE check.
268 sc_prohibit_verbose_version
:
269 @prohibit
='test "\$$VERBOSE" = yes && .* --version' \
270 halt
='use the print_ver_ function instead...' \
273 # Use framework_failure_, not the old name without the trailing underscore.
274 sc_prohibit_framework_failure
:
275 @prohibit
='\<framework_''failure\>' \
276 halt
='use framework_failure_ instead' \
279 ###########################################################
280 _p0
= \
([^
"'/]\|"\
([^
\"]\|
[\
].\
)*"\|'\([^\']\|[\].\)*'
281 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\
([^
\']\|
[\
].\
)*'\)*
282 _pre_anchored = ^\($(_pre)\)
283 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
284 # help font-lock mode: '
286 # A sed expression that removes ANSI C and ISO C99 comments.
287 # Derived from the one in GNU gettext's 'moopp' preprocessor.
288 _sed_remove_comments
= \
292 s
,$(_pre_anchored
)//.
*,\
1,; \
294 s
,$(_pre_anchored
)/[*]\
($(_comment_and_close
),\
1 ,; \
297 s
,$(_pre_anchored
)/[*].
*,\
1 ,; \
301 s
,^\
($(_comment_and_close
),,; \
309 # Quote all single quotes.
310 _sed_rm_comments_q
= $(subst ','\'',$(_sed_remove_comments))
311 # help font-lock mode: '
313 _space_before_paren_exempt
=?
\\n
\\$$
314 _space_before_paren_exempt
= \
315 (^
*\
#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
316 # Ensure that there is a space before each open parenthesis in C code.
317 sc_space_before_open_paren
:
318 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
320 for c in
$$($(VC_LIST_EXCEPT
) | grep
'\.[ch]$$'); do \
321 sed
'$(_sed_rm_comments_q)' $$c 2>/dev
/null \
322 | grep
-i
'[[:alnum:]](' \
323 | grep
-vE
'$(_space_before_paren_exempt)' \
324 | grep .
&& { fail
=1; echo
"*** $$c"; }; \
327 { echo
'$(ME): the above files lack a space-before-open-paren' \
328 1>&2; exit
1; } ||
:; \
332 # Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
333 # Use STREQ_LEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
335 @grep
-nE
'! *str''ncmp *\(|\<str''ncmp *\(.+\) *[!=]=' \
336 $$($(VC_LIST_EXCEPT
)) \
337 | grep
-vE
':# *define STR(N?EQ_LEN|PREFIX)\(' && \
338 { echo
'$(ME): use STREQ_LEN or STRPREFIX instead of str''ncmp' \
341 # Enforce recommended preprocessor indentation style.
342 sc_preprocessor_indentation
:
343 @if cppi
--version
>/dev
/null
2>&1; then \
344 $(VC_LIST_EXCEPT
) | grep
'\.[ch]$$' | xargs cppi
-a
-c \
345 ||
{ echo
'$(ME): incorrect preprocessor indentation' 1>&2; \
348 echo
'$(ME): skipping test $@: cppi not installed' 1>&2; \
351 # Override the default Cc: used in generating an announcement.
352 announcement_Cc_
= $(translation_project_
), \
353 coreutils@gnu.org
, coreutils-announce@gnu.org
355 -include $(srcdir)/dist-check.mk
357 update-copyright-env
= \
358 UPDATE_COPYRIGHT_USE_INTERVALS
=1 \
359 UPDATE_COPYRIGHT_MAX_LINE_LENGTH
=79
361 # List syntax-check exemptions.
362 exclude_file_name_regexp--sc_space_tab
= \
363 ^
(tests
/pr
/|tests
/misc
/nl
$$|gl
/.
*\.diff
$$)
364 exclude_file_name_regexp--sc_bindtextdomain
= ^
(gl
/.
*|lib
/euidaccess-stat
)\.c
$$
365 exclude_file_name_regexp--sc_unmarked_diagnostics
= ^build-aux
/cvsu
$$
366 exclude_file_name_regexp--sc_error_message_uppercase
= ^build-aux
/cvsu
$$
367 exclude_file_name_regexp--sc_trailing_blank
= ^tests
/pr
/
368 exclude_file_name_regexp--sc_system_h_headers
= \
369 ^src
/((system|copy
)\.h|libstdbuf\.c
)$$
371 _src
= (false|lbracket|ls-
(dir|ls|vdir
)|tac-pipe|uname-
(arch|uname
))
372 exclude_file_name_regexp--sc_require_config_h_first
= \
373 (^lib
/buffer-lcm\.c|src
/$(_src
)\.c
)$$
374 exclude_file_name_regexp--sc_require_config_h
= \
375 $(exclude_file_name_regexp--sc_require_config_h_first
)
377 exclude_file_name_regexp--sc_po_check
= ^gl
/
378 exclude_file_name_regexp--sc_prohibit_always-defined_macros
= ^src
/seq\.c
$$
379 exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF
= ^tests
/pr
/
380 exclude_file_name_regexp--sc_program_name
= ^
(gl
/.
*|lib
/euidaccess-stat
)\.c
$$
381 exclude_file_name_regexp--sc_file_system
= \
382 NEWS|^
(tests
/init\.cfg|src
/df\.c|tests
/misc
/df-P
)$$
383 exclude_file_name_regexp--sc_prohibit_always_true_header_tests
= \
385 exclude_file_name_regexp--sc_prohibit_fail_0
= \
386 (^tests
/init\.sh|Makefile\.am|\.mk
)$$
387 exclude_file_name_regexp--sc_prohibit_atoi_atof
= ^lib
/euidaccess-stat\.c
$$
388 exclude_file_name_regexp--sc_prohibit_tab_based_indentation
= \
389 ^tests
/pr
/|
(^gl
/lib
/reg.
*\.c\.diff|Makefile
(\.am
)?|\.mk|^man
/help2man
)$$
390 exclude_file_name_regexp--sc_preprocessor_indentation
= \
391 ^
(gl
/lib
/rand-isaac\.
[ch
]|gl
/tests
/test-rand-isaac\.c
)$$
394 exclude_file_name_regexp--sc_prohibit_stat_st_blocks
= \
395 ^
(src
/system\.h|tests
/du
/2g
)$$