1 # Customize maint.mk -*- makefile -*-
2 # Copyright (C) 2003-2015 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 # Use the direct link. This is guaranteed to work immediately, while
21 # it can take a while for the faster mirror links to become usable.
22 url_dir_list
= http
://ftp.gnu.org
/gnu
/$(PACKAGE
)
24 # Tests not to run as part of "make distcheck".
25 local-checks-to-skip
= \
26 sc_proper_name_utf8_requires_ICONV
28 # Tools used to bootstrap this package, used for "announcement".
29 bootstrap-tools
= autoconf
,automake
,gnulib
,bison
31 # Now that we have better tests, make this the default.
34 # Comparing tarball sizes compressed using different xz presets, we see that
35 # an -8e-compressed tarball is only 9KiB larger than the -9e-compressed one.
36 # Using -8e is preferred, since that lets the decompression process use half
37 # the memory (32MiB rather than 64MiB).
38 # $ for i in {7,8,9}{e,}; do \
39 # (n=$(xz -$i < coreutils-8.15*.tar|wc -c);echo $n $i) & done |sort -nr
48 old_NEWS_hash
= 5c64c69e6303deaceecacc4b498a61fd
50 # Add an exemption for sc_makefile_at_at_check.
51 _makefile_at_at_check_exceptions
= ' && !/^cu_install_prog/ && !/dynamic-dep/'
53 # Our help-version script is in a slightly different location.
54 _hv_file ?
= $(srcdir)/tests
/misc
/help-version
56 # Ensure that the list of O_ symbols used to compute O_FULLBLOCK is complete.
57 dd
= $(srcdir)/src
/dd.c
60 @
{ echo O_FULLBLOCK
; echo O_NOCACHE
; \
61 perl
-nle
'/^ +\| (O_\w*)$$/ and print $$1' $(dd
); } |
sort > $@
.1
62 @
{ echo O_NOFOLLOW
; perl
-nle
'/{"[a-z]+",\s*(O_\w+)},/ and print $$1' \
63 $(dd
); } |
sort > $@
.2
64 @diff
-u
$@
.1 $@
.2; diff
=$$?
; \
67 ||
{ echo
'$(ME): $(dd) has inconsistent O_ flag lists'>&2; \
70 # Ensure that dd's definition of LONGEST_SYMBOL stays in sync
71 # with the strings from the two affected variables.
72 dd_c
= $(srcdir)/src
/dd.c
74 ifneq ($(wildcard $(dd_c
)),)
75 @len
=$$( (sed
-n
'/conversions\[\] =$$/,/^};/p' $(dd_c
);\
76 sed
-n
'/flags\[\] =$$/,/^};/p' $(dd_c
) ) \
77 |sed
-n
'/"/s/^[^"]*"\([^"]*\)".*/\1/p'| wc
-L
);\
78 max
=$$(sed
-n
'/^#define LONGEST_SYMBOL /s///p' $(dd_c
) \
79 |tr
-d
'"' | wc
-L
); \
80 if
test "$$len" = "$$max"; then
:; else \
81 echo
'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \
86 # Many m4 macros names once began with 'jm_'.
87 # On 2004-04-13, they were all changed to start with gl_ instead.
88 # Make sure that none are inadvertently reintroduced.
90 @grep
-nE
'jm_[A-Z]' \
91 $$($(VC_LIST
) m4 |grep
'\.m4$$'; echo
/dev
/null
) && \
92 { echo
'$(ME): do not use jm_ in m4 macro names' \
95 # Ensure that each root-requiring test is run via the "check-root" rule.
97 @t1
=sc-root.expected
; t2
=sc-root.actual
; \
98 grep
-nl
'^ *require_root_$$' `$(VC_LIST) tests` | \
99 sed
's|.*/tests/|tests/|' |
sort > $$t1; \
100 for t in
$(all_root_tests
); do echo
$$t; done |
sort > $$t2; \
101 st
=0; diff
-u
$$t1 $$t2 || st
=1; \
105 # Ensure that all version-controlled test cases are listed in $(all_tests).
106 sc_tests_list_consistency
:
108 test_extensions_rx
=`echo $(TEST_EXTENSIONS) \
109 | sed -e "s/ /|/g" -e "s/$$bs./$$bs$$bs./g"`; \
111 for t in
$(all_tests
); do echo
$$t; done
; \
113 $(SHELL
) build-aux
/vc-list-files tests \
114 | grep
-Ev
'^tests/(factor/(run|create-test)|init)\.sh$$' \
115 |
$(EGREP
) "$$test_extensions_rx\$$"; \
116 } |
sort | uniq
-u | grep .
&& exit
1; :
118 # Ensure that all version-controlled test scripts are executable.
120 @set
-o noglob
2>/dev
/null || set
-f
; \
121 find_ext
="-name '' "`printf -- "-o -name *%s " $(TEST_EXTENSIONS)`;\
122 find
$(srcdir)/tests
/ \
( $$find_ext \
) \
! -perm
-u
+x
-print \
123 |
{ sed
"s|^$(srcdir)/||"; git ls-files
$(srcdir)/tests
/; } \
125 | sed
-e
"s/^/$(ME): Please make test executable: /" | grep . \
128 # Ensure all gnulib patches apply cleanly
129 sc_ensure_gl_diffs_apply_cleanly
:
130 @find
$(srcdir)/gl
/ -name
'*.diff' | while read p
; do \
131 patch
--fuzz
=0 -f
-s
-d
$(srcdir)/gnulib
/ -p1
--dry-run
< "$$p" >&2 \
132 ||
{ echo
"$$p" >&2; echo
'To refresh all gl patches run:' \
133 'make refresh-gnulib-patches' >&2; exit
1; } \
136 # Avoid :>file which doesn't propagate errors
137 sc_prohibit_colon_redirection
:
138 @cd
$(srcdir)/tests
&& GIT_PAGER
= git grep
-n
': *>.*||' \
139 && { echo
'$(ME): '"The leading colon in :> will hide errors" 1>&2; \
143 # Create a list of regular expressions matching the names
144 # of files included from system.h. Exclude a couple.
146 @sed
-n
'/^# *include /s///p' $(srcdir)/src
/system.h \
147 | grep
-Ev
'sys/(param|file)\.h' \
148 | sed
's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
153 Exit
() { set
+e
; (exit
$$1); exit
$$1; }; \
154 for sig in
1 2 3 13 15; do \
155 eval
"trap 'Exit $$(expr $$sig + 128)' $$sig"; \
159 # Files in src/ should not include directly any of
160 # the headers already included via system.h.
161 sc_system_h_headers
: .re-list
162 @if
test -f
$(srcdir)/src
/system.h
; then \
163 trap
'rc=$$?; rm -f .re-list; exit $$rc' 0; \
165 grep
-nE
-f .re-list \
166 $$($(VC_LIST_EXCEPT
) | grep
'^\($(srcdir)/\)\?src/') \
167 && { echo
'$(ME): the above are already included via system.h'\
168 1>&2; exit
1; } ||
:; \
171 # Files in src/ should not use '%s' notation in format strings,
172 # i.e., single quotes around %s (or similar) should be avoided.
173 sc_prohibit_quotes_notation
:
174 @cd
$(srcdir)/src
&& GIT_PAGER
= git grep
-n
"\".*[\`']%s'.*\"" *.c \
175 && { echo
'$(ME): '"Use quote() to avoid quoted '%s' notation" 1>&2; \
179 # Files in src/ should quote all strings in error() output, so that
180 # unexpected input chars like \r etc. don't corrupt the error.
181 # In edge cases this can be avoided by putting the format string
182 # on a separate line to the following arguments.
184 @cd
$(srcdir)/src
&& GIT_PAGER
= git grep
-n
'error *(.*%s.*, [^(]*);$$'\
185 *.c | grep
-v
', q' \
186 && { echo
'$(ME): '"Use quote() for error string arguments" 1>&2; \
190 # Files in src/ should quote all file names in error() output
191 # using quotef(), to provide quoting only when necessary,
192 # but also provide better support for copy and paste when used.
193 sc_error_shell_quotes
:
194 @cd
$(srcdir)/src
&& \
195 { GIT_PAGER
= git grep
-E \
196 'error \(.*%s[:"], .*(name|file)[^"]*\);$$' *.c
; \
197 GIT_PAGER
= git grep
-E \
198 ' quote[ _].*file' *.c
; } \
199 | grep
-Ev
'(quotef|q[^ ]*name)' \
200 && { echo
'$(ME): '"Use quotef() for colon delimited names" 1>&2; \
204 # Files in src/ should quote all file names in error() output
205 # using quoteaf() when the name is separated with spaces,
206 # to distinguish the file name at issue and
207 # to provide better support for copy and paste.
208 sc_error_shell_always_quotes
:
209 @cd
$(srcdir)/src
&& GIT_PAGER
= git grep
-E \
210 'error \(.*[^:] %s[ "].*, .*(name|file)[^"]*\);$$' \
211 *.c | grep
-Ev
'(quoteaf|q[^ ]*name)' \
212 && { echo
'$(ME): '"Use quoteaf() for space delimited names" 1>&2; \
215 @cd
$(srcdir)/src
&& GIT_PAGER
= git grep
-E
-A1 \
216 'error \([^%]*[^:] %s[ "]' *.c | grep
'quotef' \
217 && { echo
'$(ME): '"Use quoteaf() for space delimited names" 1>&2; \
221 # Avoid unstyled quoting to internal slots and thus destined for diagnostics
222 # as that can leak unescaped control characters to the output, when using
223 # the default "literal" quoting style.
224 # Instead use quotef(), or quoteaf() or in edge cases quotearg_n_style_colon().
225 # A more general PCRE would be @prohibit='quotearg_.*(?!(style|buffer))'
226 sc_prohibit-quotearg
:
227 @prohibit
='quotearg(_n)?(|_colon|_char|_mem) ' \
228 in_vc_files
='\.c$$' \
229 halt
='Unstyled diagnostic quoting detected' \
234 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
235 $$($(VC_LIST_EXCEPT
)) && \
236 { echo
'$(ME): found misuse of Sun OS version numbers' 1>&2; \
239 # Ensure that the list of programs and author names is accurate.
240 # We need a UTF8 locale. If a lack of locale support or a missing
241 # translation inhibits printing of UTF-8 names, just skip this test.
242 au_dotdot
= authors-dotdot
243 au_actual
= authors-actual
244 sc_check-AUTHORS
: $(all_programs
)
245 @locale
=en_US.UTF-8
; \
246 LC_ALL
=$$locale .
/src
/cat
--version \
247 | grep
' Torbjorn ' > /dev
/null \
248 && { echo
"$@: skipping this check"; exit
0; }; \
249 rm -f
$(au_actual
) $(au_dotdot
); \
250 for i in
`ls $(all_programs) \
251 | sed -e 's,^src/,,' -e 's,$(EXEEXT)$$,,' \
253 | $(ASSORT) -u`; do \
254 test "$$i" = '[' && continue
; \
256 if
test "$$i" = install; then \
258 elif
test "$$i" = test; then \
261 LC_ALL
=$$locale .
/src
/$$exe --version \
262 | perl
-0 -p
-e
's/,\n/, /gm' \
263 | sed
-n
-e
'/Written by /{ s//'"$$i"': /;' \
264 -e
's/,* and /, /; s/\.$$//; p; }'; \
265 done
> $(au_actual
) && \
266 sed
-n
'/^[^ ][^ ]*:/p' $(srcdir)/AUTHORS
> $(au_dotdot
) \
267 && diff
$(au_actual
) $(au_dotdot
) \
268 && rm -f
$(au_actual
) $(au_dotdot
)
270 # Each program with a non-ASCII author name must link with LIBICONV.
271 sc_check-I18N-AUTHORS
:
272 @cd
$(srcdir)/src
&& \
273 for i in
$$(git grep
-l
-w proper_name_utf8
*.c|sed
's/\.c//'); do \
274 grep
-E
"^src_$${i}_LDADD"' .?= .*\$$\(LIBICONV\)' local.mk \
276 ||
{ echo
"$(ME): link rules for $$i do not include" \
277 '$$(LIBICONV)' 1>&2; exit
1; }; \
280 # Disallow the C99 printf size specifiers %z and %j as they're not portable.
281 # The gnulib printf replacement does support them, however the printf
282 # replacement is not currently explicitly depended on by the gnulib error()
283 # module for example. Also we use fprintf() in a few places to output simple
284 # formats but don't use the gnulib module as it is seen as overkill at present.
285 # We'd have to adjust the above gnulib items before disabling this.
286 sc_prohibit-c99-printf-format
:
287 @cd
$(srcdir)/src
&& GIT_PAGER
= git grep
-n
'%[0*]*[jz][udx]' *.c \
288 && { echo
'$(ME): Use PRI*MAX instead of %j or %z' 1>&2; exit
1; } \
291 # Ensure the alternative __attribute (keyword) form isn't used as
292 # that form is not elided where required. Also ensure that we don't
293 # directly use attributes already defined by gnulib.
294 # TODO: move the check for _GL... attributes to gnulib.
295 sc_prohibit-gl-attributes
:
296 @prohibit
='__attribute |__(unused|pure|const)__' \
297 in_vc_files
='\.[ch]$$' \
298 halt
='Use _GL... attribute macros' \
301 # Look for lines longer than 80 characters, except omit:
302 # - program-generated long lines in diff headers,
303 # - the help2man script copied from upstream,
304 # - tests involving long checksum lines, and
305 # - the 'pr' test cases.
306 FILTER_LONG_LINES
= \
307 \|^
[^
:]*man
/help2man
:| d
; \
308 \|^
[^
:]*tests
/misc
/sha
[0-9]*sum.
*\.pl
[-:]| d
; \
309 \|^
[^
:]*tests
/pr
/|
{ \|^
[^
:]*tests
/pr
/pr-tests
:|
!d
; };
311 @wc
-L
/dev
/null
>/dev
/null
2>/dev
/null \
312 ||
{ echo
"$@: skipping: wc -L not supported"; exit
0; }; \
313 sed
-r
1q
/dev
/null
2>/dev
/null \
314 ||
{ echo
"$@: skipping: sed -r not supported"; exit
0; }; \
315 files
=$$($(VC_LIST_EXCEPT
) | xargs wc
-L | sed
-rn
'/ total$$/d;\
316 s/^ *(8[1-9]|9[0-9]|[0-9]\{3,\}) //p'); \
317 halt
='line(s) with more than 80 characters; reindent'; \
318 for file in
$$files; do \
319 expand
$$file | grep
-nE
'^.{80}.' | \
320 sed
-e
"s|^|$$file:|" -e
'$(FILTER_LONG_LINES)'; \
321 done | grep .
&& { msg
="$$halt" $(_sc_say_and_exit
) } ||
:
323 # Option descriptions should not start with a capital letter.
324 # One could grep source directly as follows:
325 # grep -E " {2,6}-.*[^.] [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
326 # but that would miss descriptions not on the same line as the -option.
327 sc_option_desc_uppercase
: $(ALL_MANS
)
328 @grep
'^\\fB\\-' -A1 man
/*.1 | LC_ALL
=C grep
'\.1.[A-Z][a-z]' \
329 && { echo
1>&2 '$@: found initial capitals in --help'; exit
1; } ||
:
331 # Ensure all man/*.[1x] files are present.
332 sc_man_file_correlation
: check-x-vs-1 check-programs-vs-x
334 # Ensure that for each .x file in the 'man/' subdirectory, there is a
335 # corresponding .1 file in the definition of $(EXTRA_MANS).
336 # But since that expansion usually lacks programs like arch and hostname,
337 # add them here manually.
340 @PATH
=.
/src
$(PATH_SEPARATOR
)$$PATH; export PATH
; \
342 (cd
$(srcdir)/man
&& ls
-1 *.x
) \
343 | sed
's/\.x$$//' |
$(ASSORT
) > $$t; \
344 (echo
$(patsubst man
/%,%,$(ALL_MANS
)) \
345 | tr
-s
' ' '\n' | sed
's/\.1$$//') \
346 |
$(ASSORT
) -u | diff
- $$t ||
{ rm $$t; exit
1; }; \
349 # Ensure that non-trivial .x files in the 'man/' subdirectory,
350 # i.e., files exceeding a line count of 20 or a byte count of 1000,
351 # contain a Copyright notice.
352 .PHONY
: sc_man_check_x_copyright
353 sc_man_check_x_copyright
:
355 cd
$(srcdir) && wc
-cl man
/*.x | head
-n-1 \
356 | awk
'$$1 >= 20 || $$2 >= 1000 {print $$3}' \
357 | xargs grep
-L
'Copyright .* Free Software Foundation' \
359 && { echo
1>&2 '$@: exceeding file size/line count limit' \
360 '- please add a copyright note'; status
=1; }; \
363 # Writing a portable rule to generate a manpage like '[.1' would be
364 # a nightmare, so filter that out.
365 all-progs-but-lbracket
= $(filter-out [,$(patsubst src
/%,%,$(all_programs
)))
367 # Ensure that for each coreutils program there is a corresponding
368 # '.x' file in the 'man/' subdirectory.
369 .PHONY
: check-programs-vs-x
372 for p in dummy
$(all-progs-but-lbracket
); do \
373 case
$$p in
*.so
) continue
;; esac
; \
374 test $$p = dummy
&& continue
; \
375 test $$p = ginstall
&& p
=install ||
: ; \
376 test -f
$(srcdir)/man
/$$p.x \
377 ||
{ echo missing
$$p.x
1>&2; status
=1; }; \
381 # Ensure we can check out on case insensitive file systems
382 sc_case_insensitive_file_names
: src
/uniq
383 @git ls-files |
sort -f | src
/uniq
-Di | grep .
&& \
384 { echo
"$(ME): the above file(s) conflict on case insensitive" \
385 " file systems" 1>&2; exit
1; } ||
:
387 # Ensure that the end of each release's section is marked by two empty lines.
388 sc_NEWS_two_empty_lines
:
389 @sed
-n
4,/Noteworthy
/p
$(srcdir)/NEWS \
390 | perl
-n0e
'/(^|\n)\n\n\* Noteworthy/ or exit 1' \
391 ||
{ echo
'$(ME): use two empty lines to separate NEWS sections' \
394 # With split lines, don't leave an operator at end of line.
395 # Instead, put it on the following line, where it is more apparent.
396 # Don't bother checking for "*" at end of line, since it provokes
397 # far too many false positives, matching constructs like "TYPE *".
398 # Similarly, omit "=" (initializers).
399 binop_re_ ?
= [-/+^
!<>]|
[-/+*^
!<>=]=|
&&?|\|\|?|
<<=?|
>>=?
400 sc_prohibit_operator_at_end_of_line
:
401 @prohibit
='. ($(binop_re_))$$' \
402 in_vc_files
='\.[chly]$$' \
403 halt
='found operator at end of line' \
406 # Don't use "readlink" or "readlinkat" directly
407 sc_prohibit_readlink
:
408 @prohibit
='\<readlink(at)? \(' \
409 halt
='do not use readlink(at); use via xreadlink or areadlink*' \
412 # Don't use address of "stat" or "lstat" functions
413 sc_prohibit_stat_macro_address
:
414 @prohibit
='\<l?stat '':|&l?stat\>' \
415 halt
='stat() and lstat() may be function-like macros' \
418 # Ensure that date's --help output stays in sync with the info
419 # documentation for GNU strftime. The only exception is %N,
420 # which date accepts but GNU strftime does not.
421 extract_char
= sed
's/^[^%][^%]*%\(.\).*/\1/'
423 @if
test -f
$(srcdir)/src
/date.c
; then \
424 grep
'^ %. ' $(srcdir)/src
/date.c |
sort \
425 |
$(extract_char
) > $@
-src
; \
427 info libc date calendar format
2>/dev
/null \
428 | grep
"^ *['\`]%.'$$"|
$(extract_char
); }|
sort >$@
-info;\
429 if
test $$(stat
--format
%s
$@
-info) != 2; then \
430 diff
-u
$@
-src
$@
-info || exit
1; \
432 echo
'$(ME): skipping $@: libc info not installed' 1>&2; \
434 rm -f
$@
-src
$@
-info; \
437 # Indent only with spaces.
438 sc_prohibit_tab_based_indentation
:
440 halt
='TAB in indentation; use only spaces' \
443 # Enforce lowercase 'e' in "I.e.".
444 sc_prohibit_uppercase_id_est
:
446 halt
='Uppercase "Id Est" abbreviation; use "I.e.," instead' \
449 # Enforce double-space before "I.e." at the beginning of a sentence.
450 sc_ensure_dblspace_after_dot_before_id_est
:
451 @prohibit
='\. I\.e\.' \
452 halt
='Single space after dot before "i.e."; use ". i.e." instead' \
455 # Enforce comma after "i.e." (at least before a blank or at EOL).
456 sc_ensure_comma_after_id_est
:
457 @prohibit
='[Ii]\.e\.( |$$)' \
458 halt
='Missing comma after "i.e."; use "i.e.," instead' \
461 # The SEE ALSO section of a man page should not be terminated with
462 # a period. Check the first line after each "SEE ALSO" line in man/*.x:
463 sc_prohibit_man_see_also_period
:
464 @grep
-nB1
'\.$$' $$($(VC_LIST_EXCEPT
) | grep
'man/.*\.x$$') \
465 | grep
-A1
-e
'-\[SEE ALSO\]' | grep
'\.$$' && \
466 { echo
'$(ME): do not end "SEE ALSO" section with a period' \
469 # Don't use "indent-tabs-mode: nil" anymore. No longer needed.
470 sc_prohibit_emacs__indent_tabs_mode__setting
:
471 @prohibit
='^( *[*#] *)?indent-tabs-mode:' \
472 halt
='use of emacs indent-tabs-mode: setting' \
475 # Ensure that tests don't include a redundant fail=0.
477 @prohibit
='\<fail=0\>' \
478 halt
='fail=0 initialization' \
481 # Ensure that tests don't use `cmd ... && fail=1` as that hides crashes.
482 # The "exclude" expression allows common idioms like `test ... && fail=1`
483 # and the 2>... portion allows commands that redirect stderr and so probably
484 # independently check its contents and thus detect any crash messages.
485 sc_prohibit_and_fail_1
:
486 @prohibit
='&& fail=1' \
487 exclude
='(stat|kill|test |EGREP|grep|env|compare|2> *[^/])' \
488 halt
='&& fail=1 detected. Please use: returns_ 1 ... || fail=1' \
489 in_vc_files
='^tests/' \
492 # The mode part of a setfacl -m option argument must be three bytes long.
493 # I.e., an argument of user:bin:rw or user:bin:r will make Solaris 10's
494 # setfacl reject it with: "Unrecognized character found in mode field".
495 # Use hyphens to give it a length of 3: "...:rw-" or "...:r--".
496 sc_prohibit_short_facl_mode_spec
:
497 @prohibit
='\<setfacl .*-m.*:.*:[rwx-]{1,2} ' \
498 halt
='setfacl mode string length < 3; extend with hyphen(s)' \
501 # Ensure that "stdio--.h" is used where appropriate.
502 sc_require_stdio_safer
:
503 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
504 files
=$$(grep
-l
'\bfreopen \?(' $$($(VC_LIST_EXCEPT
) \
505 | grep
'\.[ch]$$')); \
506 test -n
"$$files" && grep
-LE
'include "stdio--.h"' $$files \
508 { echo
'$(ME): the above files should use "stdio--.h"' \
509 1>&2; exit
1; } ||
:; \
513 sc_prohibit_perl_hash_quotes
:
514 @prohibit
="\{'[A-Z_]+' *[=}]" \
515 halt
="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}" \
518 # Prefer xnanosleep over other less-precise sleep methods
520 @prohibit
='\<(nano|u)?sleep \(' \
521 halt
='prefer xnanosleep over other sleep interfaces' \
524 # Use print_ver_ (from init.cfg), not open-coded $VERBOSE check.
525 sc_prohibit_verbose_version
:
526 @prohibit
='test "\$$VERBOSE" = yes && .* --version' \
527 halt
='use the print_ver_ function instead...' \
530 # Use framework_failure_, not the old name without the trailing underscore.
531 sc_prohibit_framework_failure
:
532 @prohibit
='\<framework_''failure\>' \
533 halt
='use framework_failure_ instead' \
536 # Prohibit the use of `...` in tests/. Use $(...) instead.
537 sc_prohibit_test_backticks
:
538 @prohibit
='`' in_vc_files
='^tests/' \
539 halt
='use $$(...), not `...` in tests/' \
542 # Ensure that compare is used to check empty files
543 # so that the unexpected contents are displayed
544 sc_prohibit_test_empty
:
545 @prohibit
='test -s.*&&' in_vc_files
='^tests/' \
546 halt
='use `compare /dev/null ...`, not `test -s ...` in tests/' \
549 # Programs like sort, ls, expr use PROG_FAILURE in place of EXIT_FAILURE.
550 # Others, use the EXIT_CANCELED, EXIT_ENOENT, etc. macros defined in system.h.
551 # In those programs, ensure that EXIT_FAILURE is not used by mistake.
552 sc_some_programs_must_avoid_exit_failure
:
553 @grep
-nw EXIT_FAILURE \
554 $$(git grep
-El
'[^T]_FAILURE|EXIT_CANCELED' $(srcdir)/src
) \
555 | grep
-vE
'= EXIT_FAILURE|return .* \?' | grep . \
556 && { echo
'$(ME): do not use EXIT_FAILURE in the above' \
559 # Ensure that tests call the get_min_ulimit_v_ function if using ulimit -v
560 sc_prohibit_test_ulimit_without_require_
:
561 @
(git grep
-l get_min_ulimit_v_
$(srcdir)/tests
; \
562 git grep
-l
'ulimit -v' $(srcdir)/tests
) \
563 |
sort | uniq
-u | grep .
&& { echo
"$(ME): the above test(s)"\
564 " should match get_min_ulimit_v_ with ulimit -v" 1>&2; exit
1; } ||
:
566 # Ensure that tests call the cleanup_ function if using background processes
567 sc_prohibit_test_background_without_cleanup_
:
568 @
(git grep
-El
'( &$$|&[^&]*=\$$!)' $(srcdir)/tests
; \
569 git grep
-l
'cleanup_()' $(srcdir)/tests | sed p
) \
570 |
sort | uniq
-u | grep .
&& { echo
"$(ME): the above test(s)"\
571 " should use cleanup_ for background processes" 1>&2; exit
1; } ||
:
573 # Ensure that tests call the print_ver_ function for programs which are
574 # actually used in that test.
575 sc_prohibit_test_calls_print_ver_with_irrelevant_argument
:
576 @git grep
-w print_ver_
$(srcdir)/tests \
577 | sed
's#:print_ver_##' \
579 while read file name
; do \
580 for i in
$$name; do \
581 case
"$$i" in
install) i
=ginstall
;; esac
; \
582 grep
-w
"$$i" $$file|grep
-vw print_ver_|grep
-q . \
584 echo
"*** Test: $$file, offending: $$i." 1>&2; };\
587 test $$fail = 0 || exit
1; \
588 } ||
{ echo
"$(ME): the above test(s) call print_ver_ for" \
589 "program(s) they don't use" 1>&2; exit
1; }
591 # Exempt the contents of any usage function from the following.
592 _continued_string_col_1
= \
593 s
/^usage .
*?
\n}//ms
;/\\\n\w
/ and
print ("$$ARGV\n"),$$e=1;END
{$$e||
=0;exit
$$e}
594 # Ding any source file that has a continued string with an alphabetic in the
595 # first column of the following line. We prohibit them because they usually
596 # trigger false positives in tools that try to map an arbitrary line number
597 # to the enclosing function name. Of course, very many strings do precisely
598 # this, *when they are part of the usage function*. That is why we exempt
599 # the contents of any function named "usage".
600 sc_prohibit_continued_string_alpha_in_column_1
:
601 @perl
-0777 -ne
'$(_continued_string_col_1)' \
602 $$($(VC_LIST_EXCEPT
) | grep
'\.[ch]$$') \
603 ||
{ echo
'$(ME): continued string with word in first column' \
605 # Use this to list offending lines:
606 # git ls-files |grep '\.[ch]$' | xargs \
607 # perl -n -0777 -e 's/^usage.*?\n}//ms;/\\\n\w/ and print "$ARGV\n"' \
608 # | xargs grep -A1 '\\$'|grep '\.[ch][:-][_a-zA-Z]'
611 ###########################################################
612 _p0
= \
([^
"'/]\|"\
([^
\"]\|
[\
].\
)*"\|'\([^\']\|[\].\)*'
613 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\
([^
\']\|
[\
].\
)*'\)*
614 _pre_anchored = ^\($(_pre)\)
615 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
616 # help font-lock mode: '
618 # A sed expression that removes ANSI C and ISO C99 comments.
619 # Derived from the one in GNU gettext's 'moopp' preprocessor.
620 _sed_remove_comments
= \
624 s
,$(_pre_anchored
)//.
*,\
1,; \
626 s
,$(_pre_anchored
)/[*]\
($(_comment_and_close
),\
1 ,; \
629 s
,$(_pre_anchored
)/[*].
*,\
1 ,; \
633 s
,^\
($(_comment_and_close
),,; \
641 # Quote all single quotes.
642 _sed_rm_comments_q
= $(subst ','\'',$(_sed_remove_comments))
643 # help font-lock mode: '
645 _space_before_paren_exempt
=?
\\n
\\$$
646 _space_before_paren_exempt
= \
647 (^
*\
#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
648 # Ensure that there is a space before each open parenthesis in C code.
649 sc_space_before_open_paren
:
650 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
652 for c in
$$($(VC_LIST_EXCEPT
) | grep
'\.[ch]$$'); do \
653 sed
'$(_sed_rm_comments_q)' $$c 2>/dev
/null \
654 | grep
-i
'[[:alnum:]](' \
655 | grep
-vE
'$(_space_before_paren_exempt)' \
656 | grep .
&& { fail
=1; echo
"*** $$c"; }; \
659 { echo
'$(ME): the above files lack a space-before-open-paren' \
660 1>&2; exit
1; } ||
:; \
664 # Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
665 # Use STREQ_LEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
667 @prohibit
='^[^#].*str''ncmp *\(' \
668 halt
='use STREQ_LEN or STRPREFIX instead of str''ncmp' \
671 # Enforce recommended preprocessor indentation style.
672 sc_preprocessor_indentation
:
673 @if cppi
--version
>/dev
/null
2>&1; then \
674 $(VC_LIST_EXCEPT
) | grep
'\.[ch]$$' | xargs cppi
-a
-c \
675 ||
{ echo
'$(ME): incorrect preprocessor indentation' 1>&2; \
678 echo
'$(ME): skipping test $@: cppi not installed' 1>&2; \
681 # THANKS.in is a list of name/email pairs for people who are mentioned in
682 # commit logs (and generated ChangeLog), but who are not also listed as an
683 # author of a commit. Name/email pairs of commit authors are automatically
684 # extracted from the repository. As a very minor factorization, when
685 # someone who was initially listed only in THANKS.in later authors a commit,
686 # this rule detects that their pair may now be removed from THANKS.in.
687 sc_THANKS_in_duplicates
:
688 @
{ git log
--pretty
=format
:%aN |
sort -u
; \
689 cut
-b-36
$(srcdir)/THANKS.in \
690 | sed
'/^$$/,/^$$/!d;/^$$/d;s/ *$$//'; } \
691 |
sort | uniq
-d | grep . \
692 && { echo
'$(ME): remove the above names from THANKS.in' \
695 # Ensure the contributor list stays sorted. Use our sort as other
696 # implementations may result in a different order.
697 sc_THANKS_in_sorted
: src
/sort
698 @sed
'/^$$/,/^$$/!d;/^$$/d' $(srcdir)/THANKS.in
> $@
.1; \
699 LC_ALL
=en_US.UTF-8 src
/sort -f
-k1
,1 $@
.1 > $@
.2
700 @diff
-u
$@
.1 $@
.2; diff
=$$?
; \
703 ||
{ echo
'$(ME): THANKS.in is unsorted' 1>&2; exit
1; }
705 # Look for developer diagnostics that are marked for translation.
706 # This won't find any for which devmsg's format string is on a separate line.
707 sc_marked_devdiagnostics
:
708 @prohibit
='\<devmsg *\(.*_\(' \
709 halt
='found marked developer diagnostic(s)' \
712 # Ensure we keep hex constants as 4 or 8 bytes for consistency
713 # and so that make src/fs-magic-compare works consistently
715 @sed
-n
's|.*/\* \(0x[0-9A-Fa-f]\{1,\}\) .*\*/|\1|p' \
716 $(srcdir)/src
/stat.c | grep
-Ev
'^0x([0-9A-F]{4}){1,2}$$' \
717 && { echo
'$(ME): Constants in src/stat.c should be 4 or 8' \
718 'upper-case chars' 1>&2; exit
1; } ||
:
720 # Ensure gnulib generated files are ignored
721 # TODO: Perhaps augment gnulib-tool to do this in lib/.gitignore?
722 sc_gitignore_missing
:
723 @
{ sed
-n
'/^\/lib\/.*\.h$$/{p;p}' .gitignore
; \
724 find lib
-name
'*.in*' ! -name
'*~' ! -name
'sys_*' | \
725 sed
's|^|/|; s|_\(.*in\.h\)|/\1|; s/\.in//'; } | \
726 sort | uniq
-u | grep .
&& { echo
'$(ME): Add above' \
727 'entries to .gitignore' >&2; exit
1; } ||
:
729 # Flag redundant entries in .gitignore
730 sc_gitignore_redundant
:
731 @
{ grep ^
/lib .gitignore
; sed
's|^|/lib|' lib
/.gitignore
; } | \
732 sort | uniq
-d | grep .
&& { echo
'$(ME): Remove above' \
733 'entries from .gitignore' >&2; exit
1; } ||
:
735 # Override the default Cc: used in generating an announcement.
736 announcement_Cc_
= $(translation_project_
), \
737 coreutils@gnu.org
, coreutils-announce@gnu.org
739 -include $(srcdir)/dist-check.mk
741 update-copyright-env
= \
742 UPDATE_COPYRIGHT_FORCE
=1 \
743 UPDATE_COPYRIGHT_USE_INTERVALS
=2 \
744 UPDATE_COPYRIGHT_MAX_LINE_LENGTH
=79
746 # List syntax-check exemptions.
747 exclude_file_name_regexp--sc_space_tab
= \
748 ^
(tests
/pr
/|tests
/misc
/nl\.sh
$$|gl
/.
*\.diff
$$|man
/help2man
$$)
749 exclude_file_name_regexp--sc_bindtextdomain
= \
750 ^
(gl
/.
*|lib
/euidaccess-stat|src
/make-prime-list
)\.c
$$
751 exclude_file_name_regexp--sc_trailing_blank
= \
752 ^
(tests
/pr
/|gl
/.
*\.diff
$$|man
/help2man
)
753 exclude_file_name_regexp--sc_system_h_headers
= \
754 ^src
/((system|copy
)\.h|make-prime-list\.c
)$$
756 _src
= (false|lbracket|ls-
(dir|ls|vdir
)|tac-pipe|uname-
(arch|uname
))
757 exclude_file_name_regexp--sc_require_config_h_first
= \
758 (^lib
/buffer-lcm\.c|gl
/lib
/xdecto.max\.c|src
/$(_src
)\.c
)$$
759 exclude_file_name_regexp--sc_require_config_h
= \
760 $(exclude_file_name_regexp--sc_require_config_h_first
)
762 exclude_file_name_regexp--sc_po_check
= ^
(gl
/|man
/help2man
)
763 exclude_file_name_regexp--sc_prohibit_always-defined_macros
= \
764 ^src
/(seq|remove
)\.c
$$
765 exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF
= ^tests
/pr
/
766 exclude_file_name_regexp--sc_program_name
= \
767 ^
(gl
/.
*|lib
/euidaccess-stat|src
/make-prime-list
)\.c
$$
768 exclude_file_name_regexp--sc_file_system
= \
769 NEWS|^
(init\.cfg|src
/df\.c|tests
/df
/df-P\.sh|tests
/df
/df-output\.sh
)$$
770 exclude_file_name_regexp--sc_prohibit_always_true_header_tests
= \
772 exclude_file_name_regexp--sc_prohibit_fail_0
= \
773 (^.
*/git-hooks
/commit-msg|^tests
/init\.sh|Makefile\.am|\.mk|.
*\.texi
)$$
774 exclude_file_name_regexp--sc_prohibit_atoi_atof
= ^lib
/euidaccess-stat\.c
$$
776 # longlong.h is maintained elsewhere.
777 _ll
= ^src
/longlong\.h
$$
778 exclude_file_name_regexp--sc_useless_cpp_parens
= $(_ll
)
779 exclude_file_name_regexp--sc_space_before_open_paren
= $(_ll
)
781 tbi_1
= ^tests
/pr
/|
(^gl
/lib
/reg.
*\.c\.diff|\.mk|^man
/help2man
)$$
782 tbi_2
= ^scripts
/git-hooks
/(pre-commit|pre-applypatch|applypatch-msg
)$$
783 tbi_3
= (GNU
)?
[Mm
]akefile
(\.am
)?
$$|
$(_ll
)
784 exclude_file_name_regexp--sc_prohibit_tab_based_indentation
= \
785 $(tbi_1
)|
$(tbi_2
)|
$(tbi_3
)
787 exclude_file_name_regexp--sc_preprocessor_indentation
= \
788 ^
(gl
/lib
/rand-isaac\.
[ch
]|gl
/tests
/test-rand-isaac\.c
)$$|
$(_ll
)
789 exclude_file_name_regexp--sc_prohibit_stat_st_blocks
= \
790 ^
(src
/system\.h|tests
/du
/2g\.sh
)$$
792 exclude_file_name_regexp--sc_prohibit_continued_string_alpha_in_column_1
= \
793 ^src
/(system\.h|od\.c|printf\.c|getlimits\.c
)$$
795 exclude_file_name_regexp--sc_prohibit_test_backticks
= \
796 ^tests
/(local\.mk|
(init|misc
/stdbuf|factor
/create-test
)\.sh
)$$
798 # Exempt test.c, since it's nominally shared, and relatively static.
799 exclude_file_name_regexp--sc_prohibit_operator_at_end_of_line
= \
800 ^src
/(ptx|
test|head
)\.c
$$
802 exclude_file_name_regexp--sc_error_message_uppercase
= ^src
/factor\.c
$$
803 exclude_file_name_regexp--sc_prohibit_atoi_atof
= ^src
/make-prime-list\.c
$$
805 # Exception here as we don't want __attribute elided on non GCC
806 exclude_file_name_regexp--sc_prohibit-gl-attributes
= ^src
/libstdbuf\.c
$$
808 exclude_file_name_regexp--sc_prohibit_uppercase_id_est
= \.diff
$$
809 exclude_file_name_regexp--sc_ensure_dblspace_after_dot_before_id_est
= \.diff
$$
810 exclude_file_name_regexp--sc_ensure_comma_after_id_est
= \.diff|
$(_ll
)$$
811 exclude_file_name_regexp--sc_long_lines
= \.diff
$$|
$(_ll
)
813 # Augment AM_CFLAGS to include our per-directory options:
814 AM_CFLAGS
+= $($(@D
)_CFLAGS
)
816 src_CFLAGS
= $(WARN_CFLAGS
)
817 lib_CFLAGS
= $(GNULIB_WARN_CFLAGS
)
818 gnulib-tests_CFLAGS
= $(GNULIB_TEST_WARN_CFLAGS
)
820 # Configuration to make the tight-scope syntax-check rule work with
821 # non-recursive make.
822 # Note _gl_TS_headers use _single line_ extern function declarations,
823 # while *_SOURCES use the _two line_ form.
824 export _gl_TS_headers
= $(noinst_HEADERS
)
825 # Add exceptions for --enable-single-binary renamed functions.
826 _gl_TS_unmarked_extern_functions
= main usage
827 _gl_TS_unmarked_extern_functions
+= single_binary_main_.
* _usage_.
*
828 # Headers to search for single line extern _data_ declarations.
829 _gl_TS_other_headers
= $(srcdir)/src
/*.h src
/*.h
830 # Tell the tight_scope rule about an exceptional "extern" variable.
831 # Normally, the rule would detect its declaration, but that uses a
832 # different name, __clz_tab.
833 _gl_TS_unmarked_extern_vars
= factor_clz_tab
834 # Other tight_scope settings
836 _gl_TS_obj_files
= src
/*.
$(OBJEXT
)