1 # Customize maint.mk -*- makefile -*-
2 # Copyright (C) 2003-2012 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
= \
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
= b081ffe4128201150126951b1d8263e1
50 # Add an exemption for sc_makefile_at_at_check.
51 _makefile_at_at_check_exceptions
= ' && !/^cu_install_program =/'
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
=1 || 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' \
78 | wc
--max-line-length
); \
79 max
=$$(sed
-n
'/^#define LONGEST_SYMBOL /s///p' $(dd_c
) \
80 |tr
-d
'"' | wc
--max-line-length
); \
81 if
test "$$len" = "$$max"; then
:; else \
82 echo
'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \
87 # Many m4 macros names once began with 'jm_'.
88 # On 2004-04-13, they were all changed to start with gl_ instead.
89 # Make sure that none are inadvertently reintroduced.
91 @grep
-nE
'jm_[A-Z]' \
92 $$($(VC_LIST
) m4 |grep
'\.m4$$'; echo
/dev
/null
) && \
93 { echo
'$(ME): do not use jm_ in m4 macro names' \
96 # Ensure that each root-requiring test is run via the "check-root" rule.
99 && grep check-root tests
/Makefile.am
>/dev
/null
2>&1; then \
100 t1
=sc-root.expected
; t2
=sc-root.actual
; \
101 grep
-nl
'^ *require_root_$$' \
102 $$($(VC_LIST
) tests
) |sed s
,tests
/,, |
sort > $$t1; \
103 sed
-n
'/^root_tests =[ ]*\\$$/,/[^\]$$/p' \
104 $(srcdir)/tests
/Makefile.am \
105 | sed
's/^ *//;/^root_tests =/d' \
106 | tr
-s
'\012\\' ' ' | fmt
-1 |
sort > $$t2; \
107 diff
-u
$$t1 $$t2 || diff
=1 || diff
=; \
110 && { echo
'tests/Makefile.am: missing check-root action'>&2; \
114 # Create a list of regular expressions matching the names
115 # of files included from system.h. Exclude a couple.
117 @sed
-n
'/^# *include /s///p' $(srcdir)/src
/system.h \
118 | grep
-Ev
'sys/(param|file)\.h' \
119 | sed
's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
124 Exit
() { set
+e
; (exit
$$1); exit
$$1; }; \
125 for sig in
1 2 3 13 15; do \
126 eval
"trap 'Exit $$(expr $$sig + 128)' $$sig"; \
130 # Files in src/ should not include directly any of
131 # the headers already included via system.h.
132 sc_system_h_headers
: .re-list
133 @if
test -f
$(srcdir)/src
/system.h
; then \
134 trap
'rc=$$?; rm -f .re-list; exit $$rc' 0; \
136 grep
-nE
-f .re-list \
137 $$($(VC_LIST_EXCEPT
) | grep
'^\($(srcdir)/\)\?src/') \
138 && { echo
'$(ME): the above are already included via system.h'\
139 1>&2; exit
1; } ||
:; \
144 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
145 $$($(VC_LIST_EXCEPT
)) && \
146 { echo
'$(ME): found misuse of Sun OS version numbers' 1>&2; \
149 ALL_RECURSIVE_TARGETS
+= sc_check-AUTHORS
151 @
$(MAKE
) -s
-C src _sc_check-AUTHORS
153 # Look for lines longer than 80 characters, except omit:
154 # - program-generated long lines in diff headers,
155 # - tests involving long checksum lines, and
156 # - the 'pr' test cases.
158 FILTER_LONG_LINES
= \
159 /^
[^
:]*\.diff
:[^
:]*:@@
/ d
; \
160 \|^
[^
:]*tests
/misc
/sha
[0-9]*sum
[-:]| d
; \
161 \|^
[^
:]*tests
/pr
/|
{ \|^
[^
:]*tests
/pr
/pr-tests
:|
!d
; };
163 @files
=$$($(VC_LIST_EXCEPT
)) \
164 halt
='line(s) with more than $(LINE_LEN_MAX) characters; reindent'; \
165 for file in
$$files; do \
166 expand
$$file | grep
-nE
'^.{$(LINE_LEN_MAX)}.' | \
167 sed
-e
"s|^|$$file:|" -e
'$(FILTER_LONG_LINES)'; \
168 done | grep .
&& { msg
="$$halt" $(_sc_say_and_exit
) } ||
:
170 # Option descriptions should not start with a capital letter
171 # One could grep source directly as follows:
172 # grep -E " {2,6}-.*[^.] [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
173 # but that would miss descriptions not on the same line as the -option.
174 ALL_RECURSIVE_TARGETS
+= sc_option_desc_uppercase
175 sc_option_desc_uppercase
:
176 @
$(MAKE
) -s
-C src all_programs
177 @
$(MAKE
) -s
-C man
$@
179 # Ensure all man/*.[1x] files are present
180 ALL_RECURSIVE_TARGETS
+= sc_man_file_correlation
181 sc_man_file_correlation
:
182 @
$(MAKE
) -s
-C src all_programs
183 @
$(MAKE
) -s
-C man
$@
185 # Ensure that the end of each release's section is marked by two empty lines.
186 sc_NEWS_two_empty_lines
:
187 @sed
-n
4,/Noteworthy
/p
$(srcdir)/NEWS \
188 | perl
-n0e
'/(^|\n)\n\n\* Noteworthy/ or exit 1' \
189 ||
{ echo
'$(ME): use two empty lines to separate NEWS sections' \
192 # Perl-based tests used to exec perl from a #!/bin/sh script.
193 # Now they all start with #!/usr/bin/perl and the portability
194 # infrastructure is in tests/Makefile.am. Make sure no old-style
195 # script sneaks back in.
196 sc_no_exec_perl_coreutils
:
197 @if
test -f
$(srcdir)/tests
/Coreutils.pm
; then \
198 grep
'^exec *\$$PERL.*MCoreutils' $$($(VC_LIST
) tests
) && \
199 { echo
1>&2 '$(ME): found anachronistic Perl-based tests'; \
203 # With split lines, don't leave an operator at end of line.
204 # Instead, put it on the following line, where it is more apparent.
205 # Don't bother checking for "*" at end of line, since it provokes
206 # far too many false positives, matching constructs like "TYPE *".
207 # Similarly, omit "=" (initializers).
208 binop_re_ ?
= [-/+^
!<>]|
[-/+*^
!<>=]=|
&&?|\|\|?|
<<=?|
>>=?
209 sc_prohibit_operator_at_end_of_line
:
210 @prohibit
='. ($(binop_re_))$$' \
211 in_vc_files
='\.[chly]$$' \
212 halt
='found operator at end of line' \
215 # Don't use "readlink" or "readlinkat" directly
216 sc_prohibit_readlink
:
217 @prohibit
='\<readlink(at)? \(' \
218 halt
='do not use readlink(at); use via xreadlink or areadlink*' \
221 # Don't use address of "stat" or "lstat" functions
222 sc_prohibit_stat_macro_address
:
223 @prohibit
='\<l?stat '':|&l?stat\>' \
224 halt
='stat() and lstat() may be function-like macros' \
227 # Ensure that date's --help output stays in sync with the info
228 # documentation for GNU strftime. The only exception is %N,
229 # which date accepts but GNU strftime does not.
230 extract_char
= sed
's/^[^%][^%]*%\(.\).*/\1/'
232 @if
test -f
$(srcdir)/src
/date.c
; then \
233 grep
'^ %. ' $(srcdir)/src
/date.c |
sort \
234 |
$(extract_char
) > $@
-src
; \
236 info libc date calendar format
2>/dev
/null|grep
'^ `%.'\'\
237 |
$(extract_char
); } |
sort > $@
-info; \
238 if
test $$(stat
--format
%s
$@
-info) != 2; then \
239 diff
-u
$@
-src
$@
-info || exit
1; \
241 echo
'$(ME): skipping $@: libc info not installed' 1>&2; \
243 rm -f
$@
-src
$@
-info; \
246 # Indent only with spaces.
247 sc_prohibit_tab_based_indentation
:
249 halt
='TAB in indentation; use only spaces' \
252 # The SEE ALSO section of a man page should not be terminated with
253 # a period. Check the first line after each "SEE ALSO" line in man/*.x:
254 sc_prohibit_man_see_also_period
:
255 @grep
-nB1
'\.$$' $$($(VC_LIST_EXCEPT
) | grep
'man/.*\.x$$') \
256 | grep
-A1
-e
'-\[SEE ALSO\]' | grep
'\.$$' && \
257 { echo
'$(ME): do not end "SEE ALSO" section with a period' \
260 # Don't use "indent-tabs-mode: nil" anymore. No longer needed.
261 sc_prohibit_emacs__indent_tabs_mode__setting
:
262 @prohibit
='^( *[*#] *)?indent-tabs-mode:' \
263 halt
='use of emacs indent-tabs-mode: setting' \
266 # Ensure that tests don't include a redundant fail=0.
268 @prohibit
='\<fail=0\>' \
269 halt
='fail=0 initialization' \
272 # The mode part of a setfacl -m option argument must be three bytes long.
273 # I.e., an argument of user:bin:rw or user:bin:r will make Solaris 10's
274 # setfacl reject it with: "Unrecognized character found in mode field".
275 # Use hyphens to give it a length of 3: "...:rw-" or "...:r--".
276 sc_prohibit_short_facl_mode_spec
:
277 @prohibit
='\<setfacl .*-m.*:.*:[rwx-]{1,2} ' \
278 halt
='setfacl mode string length < 3; extend with hyphen(s)' \
281 # Ensure that "stdio--.h" is used where appropriate.
282 sc_require_stdio_safer
:
283 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
284 files
=$$(grep
-l
'\bfreopen \?(' $$($(VC_LIST_EXCEPT
) \
285 | grep
'\.[ch]$$')); \
286 test -n
"$$files" && grep
-LE
'include "stdio--.h"' $$files \
288 { echo
'$(ME): the above files should use "stdio--.h"' \
289 1>&2; exit
1; } ||
:; \
293 sc_prohibit_perl_hash_quotes
:
294 @prohibit
="\{'[A-Z_]+' *[=}]" \
295 halt
="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}" \
298 # Prefer xnanosleep over other less-precise sleep methods
300 @prohibit
='\<(nano|u)?sleep \(' \
301 halt
='prefer xnanosleep over other sleep interfaces' \
304 # Use print_ver_ (from init.cfg), not open-coded $VERBOSE check.
305 sc_prohibit_verbose_version
:
306 @prohibit
='test "\$$VERBOSE" = yes && .* --version' \
307 halt
='use the print_ver_ function instead...' \
310 # Use framework_failure_, not the old name without the trailing underscore.
311 sc_prohibit_framework_failure
:
312 @prohibit
='\<framework_''failure\>' \
313 halt
='use framework_failure_ instead' \
316 # Prohibit the use of `...` in tests/. Use $(...) instead.
317 sc_prohibit_test_backticks
:
318 @prohibit
='`' in_vc_files
='^tests/' \
319 halt
='use $$(...), not `...` in tests/' \
322 # Programs like sort, ls, expr use PROG_FAILURE in place of EXIT_FAILURE.
323 # Others, use the EXIT_CANCELED, EXIT_ENOENT, etc. macros defined in system.h.
324 # In those programs, ensure that EXIT_FAILURE is not used by mistake.
325 sc_some_programs_must_avoid_exit_failure
:
326 @grep
-nw EXIT_FAILURE \
327 $$(git grep
-El
'[^T]_FAILURE|EXIT_CANCELED' src
) \
328 | grep
-vE
'= EXIT_FAILURE|exit \(.* \?' | grep . \
329 && { echo
'$(ME): do not use EXIT_FAILURE in the above' \
332 # Exempt the contents of any usage function from the following.
333 _continued_string_col_1
= \
334 s
/^usage .
*?
\n}//ms
;/\\\n\w
/ and
print ("$$ARGV\n"),$$e=1;END
{$$e||
=0;exit
$$e}
335 # Ding any source file that has a continued string with an alphabetic in the
336 # first column of the following line. We prohibit them because they usually
337 # trigger false positives in tools that try to map an arbitrary line number
338 # to the enclosing function name. Of course, very many strings do precisely
339 # this, *when they are part of the usage function*. That is why we exempt
340 # the contents of any function named "usage".
341 sc_prohibit_continued_string_alpha_in_column_1
:
342 @perl
-0777 -ne
'$(_continued_string_col_1)' \
343 $$($(VC_LIST_EXCEPT
) | grep
'\.[ch]$$') \
344 ||
{ echo
'$(ME): continued string with word in first column' \
346 # Use this to list offending lines:
347 # git ls-files |grep '\.[ch]$' | xargs \
348 # perl -n -0777 -e 's/^usage.*?\n}//ms;/\\\n\w/ and print "$ARGV\n"' \
349 # | xargs grep -A1 '\\$'|grep '\.[ch][:-][_a-zA-Z]'
352 ###########################################################
353 _p0
= \
([^
"'/]\|"\
([^
\"]\|
[\
].\
)*"\|'\([^\']\|[\].\)*'
354 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\
([^
\']\|
[\
].\
)*'\)*
355 _pre_anchored = ^\($(_pre)\)
356 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
357 # help font-lock mode: '
359 # A sed expression that removes ANSI C and ISO C99 comments.
360 # Derived from the one in GNU gettext's 'moopp' preprocessor.
361 _sed_remove_comments
= \
365 s
,$(_pre_anchored
)//.
*,\
1,; \
367 s
,$(_pre_anchored
)/[*]\
($(_comment_and_close
),\
1 ,; \
370 s
,$(_pre_anchored
)/[*].
*,\
1 ,; \
374 s
,^\
($(_comment_and_close
),,; \
382 # Quote all single quotes.
383 _sed_rm_comments_q
= $(subst ','\'',$(_sed_remove_comments))
384 # help font-lock mode: '
386 _space_before_paren_exempt
=?
\\n
\\$$
387 _space_before_paren_exempt
= \
388 (^
*\
#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
389 # Ensure that there is a space before each open parenthesis in C code.
390 sc_space_before_open_paren
:
391 @if
$(VC_LIST_EXCEPT
) | grep
-l
'\.[ch]$$' > /dev
/null
; then \
393 for c in
$$($(VC_LIST_EXCEPT
) | grep
'\.[ch]$$'); do \
394 sed
'$(_sed_rm_comments_q)' $$c 2>/dev
/null \
395 | grep
-i
'[[:alnum:]](' \
396 | grep
-vE
'$(_space_before_paren_exempt)' \
397 | grep .
&& { fail
=1; echo
"*** $$c"; }; \
400 { echo
'$(ME): the above files lack a space-before-open-paren' \
401 1>&2; exit
1; } ||
:; \
405 # Similar to the gnulib maint.mk rule for sc_prohibit_strcmp
406 # Use STREQ_LEN or STRPREFIX rather than comparing strncmp == 0, or != 0.
408 @grep
-nE
'! *str''ncmp *\(|\<str''ncmp *\(.+\) *[!=]=' \
409 $$($(VC_LIST_EXCEPT
)) \
410 | grep
-vE
':# *define STR(N?EQ_LEN|PREFIX)\(' && \
411 { echo
'$(ME): use STREQ_LEN or STRPREFIX instead of str''ncmp' \
414 # Enforce recommended preprocessor indentation style.
415 sc_preprocessor_indentation
:
416 @if cppi
--version
>/dev
/null
2>&1; then \
417 $(VC_LIST_EXCEPT
) | grep
'\.[ch]$$' | xargs cppi
-a
-c \
418 ||
{ echo
'$(ME): incorrect preprocessor indentation' 1>&2; \
421 echo
'$(ME): skipping test $@: cppi not installed' 1>&2; \
424 # THANKS.in is a list of name/email pairs for people who are mentioned in
425 # commit logs (and generated ChangeLog), but who are not also listed as an
426 # author of a commit. Name/email pairs of commit authors are automatically
427 # extracted from the repository. As a very minor factorization, when
428 # someone who was initially listed only in THANKS.in later authors a commit,
429 # this rule detects that their pair may now be removed from THANKS.in.
430 sc_THANKS_in_duplicates
:
431 @
{ git log
--pretty
=format
:%aN |
sort -u
; \
432 cut
-b-36 THANKS.in | sed
'/^$$/d;s/ *$$//'; } \
433 |
sort | uniq
-d | grep . \
434 && { echo
'$(ME): remove the above names from THANKS.in' \
437 # Override the default Cc: used in generating an announcement.
438 announcement_Cc_
= $(translation_project_
), \
439 coreutils@gnu.org
, coreutils-announce@gnu.org
441 -include $(srcdir)/dist-check.mk
443 update-copyright-env
= \
444 UPDATE_COPYRIGHT_FORCE
=1 \
445 UPDATE_COPYRIGHT_USE_INTERVALS
=2 \
446 UPDATE_COPYRIGHT_MAX_LINE_LENGTH
=79
448 # List syntax-check exemptions.
449 exclude_file_name_regexp--sc_space_tab
= \
450 ^
(tests
/pr
/|tests
/misc
/nl
$$|gl
/.
*\.diff
$$)
451 exclude_file_name_regexp--sc_bindtextdomain
= ^
(gl
/.
*|lib
/euidaccess-stat
)\.c
$$
452 exclude_file_name_regexp--sc_unmarked_diagnostics
= ^build-aux
/cvsu
$$
453 exclude_file_name_regexp--sc_error_message_uppercase
= ^build-aux
/cvsu
$$
454 exclude_file_name_regexp--sc_trailing_blank
= ^tests
/pr
/
455 exclude_file_name_regexp--sc_system_h_headers
= \
456 ^src
/((system|copy
)\.h|libstdbuf\.c
)$$
458 _src
= (false|lbracket|ls-
(dir|ls|vdir
)|tac-pipe|uname-
(arch|uname
))
459 exclude_file_name_regexp--sc_require_config_h_first
= \
460 (^lib
/buffer-lcm\.c|src
/$(_src
)\.c
)$$
461 exclude_file_name_regexp--sc_require_config_h
= \
462 $(exclude_file_name_regexp--sc_require_config_h_first
)
464 exclude_file_name_regexp--sc_po_check
= ^gl
/
465 exclude_file_name_regexp--sc_prohibit_always-defined_macros
= \
466 ^src
/(seq|remove
)\.c
$$
467 exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF
= ^tests
/pr
/
468 exclude_file_name_regexp--sc_program_name
= ^
(gl
/.
*|lib
/euidaccess-stat
)\.c
$$
469 exclude_file_name_regexp--sc_file_system
= \
470 NEWS|^
(tests
/init\.cfg|src
/df\.c|tests
/df
/df-P
)$$
471 exclude_file_name_regexp--sc_prohibit_always_true_header_tests
= \
473 exclude_file_name_regexp--sc_prohibit_fail_0
= \
474 (^.
*/git-hooks
/commit-msg|^tests
/init\.sh|Makefile\.am|\.mk|.
*\.texi
)$$
475 exclude_file_name_regexp--sc_prohibit_atoi_atof
= ^lib
/euidaccess-stat\.c
$$
477 tbi_1
= ^tests
/pr
/|
(^gl
/lib
/reg.
*\.c\.diff|Makefile
(\.am
)?|\.mk|^man
/help2man
)$$
478 tbi_2
= ^scripts
/git-hooks
/(pre-commit|pre-applypatch|applypatch-msg
)$$
479 exclude_file_name_regexp--sc_prohibit_tab_based_indentation
= \
482 exclude_file_name_regexp--sc_preprocessor_indentation
= \
483 ^
(gl
/lib
/rand-isaac\.
[ch
]|gl
/tests
/test-rand-isaac\.c
)$$
484 exclude_file_name_regexp--sc_prohibit_stat_st_blocks
= \
485 ^
(src
/system\.h|tests
/du
/2g
)$$
487 exclude_file_name_regexp--sc_prohibit_continued_string_alpha_in_column_1
= \
488 ^src
/(system\.h|od\.c|printf\.c
)$$
490 exclude_file_name_regexp--sc_prohibit_test_backticks
= \
491 ^tests
/(init\.sh|
check\.mk|misc
/stdbuf
)$$
493 # Exempt test.c, since it's nominally shared, and relatively static.
494 exclude_file_name_regexp--sc_prohibit_operator_at_end_of_line
= \
495 ^src
/(ptx|
test|head
)\.c
$$