doc: group dd conv= options that are actually flags
[coreutils/ericb.git] / cfg.mk
blobe4f3faaadb983185cbd20204cb87916c40e5ab03
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 = \
22 sc_texinfo_acronym
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.
28 export VERBOSE = yes
30 old_NEWS_hash = 6830d50281733e19bb2baff7a891e1f8
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
40 sc_dd_O_FLAGS:
41 @rm -f $@.1 $@.2
42 @{ echo O_FULLBLOCK; perl -nle '/^ +\| (O_\w*)$$/ and print $$1' \
43 $(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=; \
47 rm -f $@.1 $@.2; \
48 test "$$diff" \
49 && { echo '$(ME): $(dd) has inconsistent O_ flag lists'>&2; \
50 exit 1; } || :
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
55 sc_dd_max_sym_length:
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; \
65 exit 1; \
67 endif
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.
72 sc_prohibit_jm_in_m4:
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' \
76 1>&2; exit 1; } || :
78 # Ensure that each root-requiring test is run via the "check-root" rule.
79 sc_root_tests:
80 @if test -d tests \
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=; \
90 rm -f $$t1 $$t2; \
91 test "$$diff" \
92 && { echo 'tests/Makefile.am: missing check-root action'>&2; \
93 exit 1; } || :; \
96 # Ensure that the syntax_check_exceptions file list in Makefile.am
97 # stays in sync with corresponding files in the repository.
98 sce = syntax_check_exceptions
99 sc_x_sc_dist_check:
100 @test "$$( ($(VC_LIST) | sed -n '/\.x-sc_/p' \
101 | sed 's|^$(_dot_escaped_srcdir)/||'; \
102 sed -n '/^$(sce) =[ ]*\\$$/,/[^\]$$/p' \
103 $(srcdir)/Makefile.am \
104 | sed 's/^ *//;/^$(sce) =/d' \
105 | tr -s '\012\\' ' ' | fmt -1 \
106 ) | sort | uniq -u)" \
107 && { echo 'Makefile.am: $(sce) mismatch' >&2; exit 1; } || :;
109 # Create a list of regular expressions matching the names
110 # of files included from system.h. Exclude a couple.
111 .re-list:
112 @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \
113 | grep -Ev 'sys/(param|file)\.h' \
114 | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
115 > $@-t
116 @mv $@-t $@
118 define gl_trap_
119 Exit () { set +e; (exit $$1); exit $$1; }; \
120 for sig in 1 2 3 13 15; do \
121 eval "trap 'Exit $$(expr $$sig + 128)' $$sig"; \
122 done
123 endef
125 # Files in src/ should not include directly any of
126 # the headers already included via system.h.
127 sc_system_h_headers: .re-list
128 @if test -f $(srcdir)/src/system.h; then \
129 trap 'rc=$$?; rm -f .re-list; exit $$rc' 0; \
130 $(gl_trap_); \
131 grep -nE -f .re-list \
132 $$($(VC_LIST_EXCEPT) | grep '^\($(srcdir)/\)\?src/') \
133 && { echo '$(ME): the above are already included via system.h'\
134 1>&2; exit 1; } || :; \
137 sc_sun_os_names:
138 @grep -nEi \
139 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
140 $$($(VC_LIST_EXCEPT)) && \
141 { echo '$(ME): found misuse of Sun OS version numbers' 1>&2; \
142 exit 1; } || :
144 ALL_RECURSIVE_TARGETS += sc_tight_scope
145 sc_tight_scope:
146 @$(MAKE) -s -C src $@
148 ALL_RECURSIVE_TARGETS += sc_check-AUTHORS
149 sc_check-AUTHORS:
150 @$(MAKE) -s -C src $@
152 # Look for lines longer than 80 characters, except omit:
153 # - program-generated long lines in diff headers,
154 # - tests involving long checksum lines, and
155 # - the 'pr' test cases.
156 LINE_LEN_MAX = 80
157 FILTER_LONG_LINES = \
158 /^[^:]*\.diff:[^:]*:@@ / d; \
159 \|^[^:]*tests/misc/sha[0-9]*sum[-:]| d; \
160 \|^[^:]*tests/pr/|{ \|^[^:]*tests/pr/pr-tests:| !d; };
161 sc_long_lines:
162 @files=$$($(VC_LIST_EXCEPT)) \
163 halt='line(s) with more than $(LINE_LEN_MAX) characters; reindent'; \
164 for file in $$files; do \
165 expand $$file | grep -nE '^.{$(LINE_LEN_MAX)}.' | \
166 sed -e "s|^|$$file:|" -e '$(FILTER_LONG_LINES)'; \
167 done | grep . && { msg="$$halt" $(_sc_say_and_exit) } || :
169 # Option descriptions should not start with a capital letter
170 # One could grep source directly as follows:
171 # grep -E " {2,6}-.*[^.] [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
172 # but that would miss descriptions not on the same line as the -option.
173 ALL_RECURSIVE_TARGETS += sc_option_desc_uppercase
174 sc_option_desc_uppercase:
175 @$(MAKE) -s -C src all_programs
176 @$(MAKE) -s -C man $@
178 # Ensure all man/*.[1x] files are present
179 ALL_RECURSIVE_TARGETS += sc_man_file_correlation
180 sc_man_file_correlation:
181 @$(MAKE) -s -C src all_programs
182 @$(MAKE) -s -C man $@
184 # Ensure that the end of each release's section is marked by two empty lines.
185 sc_NEWS_two_empty_lines:
186 @sed -n 4,/Noteworthy/p $(srcdir)/NEWS \
187 | perl -n0e '/(^|\n)\n\n\* Noteworthy/ or exit 1' \
188 || { echo '$(ME): use two empty lines to separate NEWS sections' \
189 1>&2; exit 1; } || :; \
191 # Perl-based tests used to exec perl from a #!/bin/sh script.
192 # Now they all start with #!/usr/bin/perl and the portability
193 # infrastructure is in tests/Makefile.am. Make sure no old-style
194 # script sneaks back in.
195 sc_no_exec_perl_coreutils:
196 @if test -f $(srcdir)/tests/Coreutils.pm; then \
197 grep '^exec *\$$PERL.*MCoreutils' $$($(VC_LIST) tests) && \
198 { echo 1>&2 '$(ME): found anachronistic Perl-based tests'; \
199 exit 1; } || :; \
202 # Don't use "readlink" or "readlinkat" directly
203 sc_prohibit_readlink:
204 @prohibit='\<readlink(at)? \(' \
205 halt='do not use readlink(at); use via xreadlink or areadlink*' \
206 $(_sc_search_regexp)
208 # Don't use address of "stat" or "lstat" functions
209 sc_prohibit_stat_macro_address:
210 @prohibit='\<l?stat '':|&l?stat\>' \
211 halt='stat() and lstat() may be function-like macros' \
212 $(_sc_search_regexp)
214 # Ensure that date's --help output stays in sync with the info
215 # documentation for GNU strftime. The only exception is %N,
216 # which date accepts but GNU strftime does not.
217 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
218 sc_strftime_check:
219 @if test -f $(srcdir)/src/date.c; then \
220 grep '^ %. ' $(srcdir)/src/date.c | sort \
221 | $(extract_char) > $@-src; \
222 { echo N; \
223 info libc date calendar format 2>/dev/null|grep '^ `%.'\'\
224 | $(extract_char); } | sort > $@-info; \
225 diff -u $@-src $@-info || exit 1; \
226 rm -f $@-src $@-info; \
229 # Indent only with spaces.
230 sc_prohibit_tab_based_indentation:
231 @prohibit='^ * ' \
232 halt='TAB in indentation; use only spaces' \
233 $(_sc_search_regexp)
235 # Don't use "indent-tabs-mode: nil" anymore. No longer needed.
236 sc_prohibit_emacs__indent_tabs_mode__setting:
237 @prohibit='^( *[*#] *)?indent-tabs-mode:' \
238 halt='use of emacs indent-tabs-mode: setting' \
239 $(_sc_search_regexp)
241 # Ensure that each file that contains fail=1 also contains fail=0.
242 # Otherwise, setting file=1 in the environment would make tests fail
243 # unexpectedly.
244 sc_prohibit_fail_0:
245 @prohibit='\<fail=0\>' \
246 halt='fail=0 initialization' \
247 $(_sc_search_regexp)
249 # Ensure that "stdio--.h" is used where appropriate.
250 sc_require_stdio_safer:
251 @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then \
252 files=$$(grep -l '\bfreopen \?(' $$($(VC_LIST_EXCEPT) \
253 | grep '\.[ch]$$')); \
254 test -n "$$files" && grep -LE 'include "stdio--.h"' $$files \
255 | grep . && \
256 { echo '$(ME): the above files should use "stdio--.h"' \
257 1>&2; exit 1; } || :; \
258 else :; \
261 sc_prohibit_perl_hash_quotes:
262 @prohibit="\{'[A-Z_]+' *[=}]" \
263 halt="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}" \
264 $(_sc_search_regexp)
266 # Prefer xnanosleep over other less-precise sleep methods
267 sc_prohibit_sleep:
268 @prohibit='\<(nano|u)?sleep \(' \
269 halt='prefer xnanosleep over other sleep interfaces' \
270 $(_sc_search_regexp)
272 # Use print_ver_ (from init.cfg), not open-coded $VERBOSE check.
273 sc_prohibit_verbose_version:
274 @prohibit='test "\$$VERBOSE" = yes && .* --version' \
275 halt='use the print_ver_ function instead...' \
276 $(_sc_search_regexp)
278 ###########################################################
279 _p0 = \([^"'/]\|"\([^\"]\|[\].\)*"\|'\([^\']\|[\].\)*'
280 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\([^\']\|[\].\)*'\)*
281 _pre_anchored = ^\($(_pre)\)
282 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
283 # help font-lock mode: '
285 # A sed expression that removes ANSI C and ISO C99 comments.
286 # Derived from the one in GNU gettext's 'moopp' preprocessor.
287 _sed_remove_comments = \
288 /[/][/*]/{ \
289 ta; \
290 :a; \
291 s,$(_pre_anchored)//.*,\1,; \
292 te; \
293 s,$(_pre_anchored)/[*]\($(_comment_and_close),\1 ,; \
294 ta; \
295 /^$(_pre)[/][*]/{ \
296 s,$(_pre_anchored)/[*].*,\1 ,; \
297 tu; \
298 :u; \
299 n; \
300 s,^\($(_comment_and_close),,; \
301 tv; \
302 s,^.*$$,,; \
303 bu; \
304 :v; \
305 }; \
306 :e; \
308 # Quote all single quotes.
309 _sed_rm_comments_q = $(subst ','\'',$(_sed_remove_comments))
310 # help font-lock mode: '
312 _space_before_paren_exempt =? \\n\\$$
313 _space_before_paren_exempt = \
314 (^ *\#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
315 # Ensure that there is a space before each open parenthesis in C code.
316 sc_space_before_open_paren:
317 @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then \
318 fail=0; \
319 for c in $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$'); do \
320 sed '$(_sed_rm_comments_q)' $$c 2>/dev/null \
321 | grep -i '[[:alnum:]](' \
322 | grep -vE '$(_space_before_paren_exempt)' \
323 | grep . && { fail=1; echo "*** $$c"; }; \
324 done; \
325 test $$fail = 1 && \
326 { echo '$(ME): the above files lack a space-before-open-paren' \
327 1>&2; exit 1; } || :; \
328 else :; \
331 # Override the default Cc: used in generating an announcement.
332 announcement_Cc_ = $(translation_project_), \
333 coreutils@gnu.org, coreutils-announce@gnu.org
335 include $(srcdir)/dist-check.mk
337 update-copyright-env = \
338 UPDATE_COPYRIGHT_USE_INTERVALS=1 \
339 UPDATE_COPYRIGHT_MAX_LINE_LENGTH=79