diff options
Diffstat (limited to 'cfg.mk')
| -rw-r--r-- | cfg.mk | 931 |
1 files changed, 931 insertions, 0 deletions
@@ -0,0 +1,931 @@ +# Customize maint.mk -*- makefile -*- +# Copyright (C) 2003-2023 Free Software Foundation, Inc. + +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. + +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <https://www.gnu.org/licenses/>. + +# Used in maint.mk's web-manual rule +manual_title = Core GNU utilities + +# Use the direct link. This is guaranteed to work immediately, while +# it can take a while for the faster mirror links to become usable. +url_dir_list = https://ftp.gnu.org/gnu/$(PACKAGE) + +# Exclude bundled external projects from syntax checks +VC_LIST_ALWAYS_EXCLUDE_REGEX = src/blake2/.*$$ + +# Tests not to run as part of "make distcheck". +local-checks-to-skip = \ + sc_indent + +# Tools used to bootstrap this package, used for "announcement". +bootstrap-tools = autoconf,automake,gnulib,bison + +# Now that we have better tests, make this the default. +export VERBOSE = yes + +# Comparing tarball sizes compressed using different xz presets, we see that +# an -8e-compressed tarball is only 9KiB larger than the -9e-compressed one. +# Using -8e is preferred, since that lets the decompression process use half +# the memory (32MiB rather than 64MiB). +# $ for i in {7,8,9}{e,}; do \ +# (n=$(xz -$i < coreutils-8.15*.tar|wc -c);echo $n $i) & done |sort -nr +# 5129388 7 +# 5036524 7e +# 5017476 8 +# 5010604 9 +# 4923016 8e +# 4914152 9e +export XZ_OPT = -8e + +old_NEWS_hash = c550e6659b8350f62d9cd0483bf0c199 + +# Add an exemption for sc_makefile_at_at_check. +_makefile_at_at_check_exceptions = \ + ' && !/MAKEINFO/ && !/^cu_install_prog/ && !/dynamic-dep/' + +# Our help-version script is in a slightly different location. +_hv_file ?= $(srcdir)/tests/misc/help-version + +# Ensure that the list of O_ symbols used to compute O_FULLBLOCK is complete. +dd = $(srcdir)/src/dd.c +sc_dd_O_FLAGS: + @rm -f $@.1 $@.2 + @{ echo O_FULLBLOCK; echo O_NOCACHE; \ + perl -nle '/^ +\| (O_\w*)$$/ and print $$1' $(dd); } | sort > $@.1 + @{ echo O_NOFOLLOW; perl -nle '/{"[a-z]+",\s*(O_\w+)},/ and print $$1' \ + $(dd); } | sort > $@.2 + @diff -u $@.1 $@.2; diff=$$?; \ + rm -f $@.1 $@.2; \ + test "$$diff" = 0 \ + || { echo '$(ME): $(dd) has inconsistent O_ flag lists'>&2; \ + exit 1; } + +# Ensure that dd's definition of LONGEST_SYMBOL stays in sync +# with the strings from the two affected variables. +dd_c = $(srcdir)/src/dd.c +sc_dd_max_sym_length: +ifneq ($(wildcard $(dd_c)),) + @len=$$( (sed -n '/conversions\[] =$$/,/^};/p' $(dd_c);\ + sed -n '/flags\[] =$$/,/^};/p' $(dd_c) ) \ + |sed -n '/"/s/^[^"]*"\([^"]*\)".*/\1/p'| wc -L);\ + max=$$(sed -n '/^#define LONGEST_SYMBOL /s///p' $(dd_c) \ + |tr -d '"' | wc -L); \ + if test "$$len" = "$$max"; then :; else \ + echo 'dd.c: LONGEST_SYMBOL is not longest' 1>&2; \ + exit 1; \ + fi +endif + +# Many m4 macros names once began with 'jm_'. +# On 2004-04-13, they were all changed to start with gl_ instead. +# Make sure that none are inadvertently reintroduced. +sc_prohibit_jm_in_m4: + @grep -nE 'jm_[A-Z]' \ + $$($(VC_LIST) m4 |grep '\.m4$$'; echo /dev/null) && \ + { echo '$(ME): do not use jm_ in m4 macro names' \ + 1>&2; exit 1; } || : + +# Ensure that each root-requiring test is run via the "check-root" rule. +sc_root_tests: + @t1=sc-root.expected; t2=sc-root.actual; \ + grep -nl '^ *require_root_$$' `$(VC_LIST) tests` | \ + sed 's|.*/tests/|tests/|' | sort > $$t1; \ + for t in $(all_root_tests); do echo $$t; done | sort > $$t2; \ + st=0; diff -u $$t1 $$t2 || st=1; \ + rm -f $$t1 $$t2; \ + exit $$st + +# Ensure that all version-controlled test cases are listed in $(all_tests). +sc_tests_list_consistency: + @bs="\\"; \ + test_extensions_rx=`echo $(TEST_EXTENSIONS) \ + | sed -e "s/ /|/g" -e "s/$$bs./$$bs$$bs./g"`; \ + { \ + for t in $(all_tests); do echo $$t; done; \ + cd $(top_srcdir); \ + $(SHELL) build-aux/vc-list-files tests \ + | grep -Ev '^tests/(factor/(run|create-test)|init)\.sh$$' \ + | grep -E "$$test_extensions_rx\$$"; \ + } | sort | uniq -u | grep . && exit 1; : + +# Ensure that all version-controlled test scripts are executable. +sc_tests_executable: + @set -o noglob 2>/dev/null || set -f; \ + cd $(srcdir); \ + find_ext="-name '' "`printf -- "-o -name *%s " $(TEST_EXTENSIONS)`;\ + find $(srcdir)/tests/ \( $$find_ext \) \! -perm -u+x -print \ + | { sed "s|^$(srcdir)/||"; git ls-files $(srcdir)/tests/; } \ + | sort | uniq -d \ + | sed -e "s/^/$(ME): Please make test executable: /" | grep . \ + && exit 1; : + +# Ensure all gnulib patches apply cleanly +sc_ensure_gl_diffs_apply_cleanly: + @find $(srcdir)/gl/ -name '*.diff' | while read p; do \ + patch --fuzz=0 -f -s -d $(srcdir)/gnulib/ -p1 --dry-run < "$$p" >&2 \ + || { echo "$$p" >&2; echo 'To refresh all gl patches run:' \ + 'make refresh-gnulib-patches' >&2; exit 1; } \ + done + +# Avoid :>file which doesn't propagate errors +sc_prohibit_colon_redirection: + @cd $(srcdir)/tests && GIT_PAGER= git grep -En ': *>.*\|\|' \ + && { echo '$(ME): '"The leading colon in :> will hide errors" >&2; \ + exit 1; } \ + || : + +# Ensure emit_mandatory_arg_note() is called if required +sc_ensure_emit_mandatory_arg_note: + @cd $(srcdir)/src && GIT_PAGER= git \ + grep -l -- '^ *-[^-].*--.*[^[]=' *.c \ + | xargs grep -L emit_mandatory_arg_note | grep . \ + && { echo '$(ME): '"emit_mandatory_arg_note() missing" 1>&2; \ + exit 1; } || : + +# Create a list of regular expressions matching the names +# of files included from system.h. Exclude a couple. +.re-list: + @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \ + | grep -Ev 'sys/(param|file)\.h' \ + | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \ + > $@-t + @mv $@-t $@ + +define gl_trap_ + Exit () { set +e; (exit $$1); exit $$1; }; \ + for sig in 1 2 3 13 15; do \ + eval "trap 'Exit $$(expr $$sig + 128)' $$sig"; \ + done +endef + +# Files in src/ should not include directly any of +# the headers already included via system.h. +sc_system_h_headers: .re-list + @if test -f $(srcdir)/src/system.h; then \ + trap 'rc=$$?; rm -f .re-list; exit $$rc' 0; \ + $(gl_trap_); \ + grep -nE -f .re-list \ + $$($(VC_LIST_EXCEPT) | grep -E '^($(srcdir)/)?src/') \ + && { echo '$(ME): the above are already included via system.h'\ + 1>&2; exit 1; } || :; \ + fi + +# Files in src/ should not use '%s' notation in format strings, +# i.e., single quotes around %s (or similar) should be avoided. +sc_prohibit_quotes_notation: + @cd $(srcdir)/src && GIT_PAGER= git grep -n "\".*[\`']%s'.*\"" *.c \ + && { echo '$(ME): '"Use quote() to avoid quoted '%s' notation" 1>&2; \ + exit 1; } \ + || : + +error_fns = (error|diagnose) + +# Files in src/ should quote all strings in error() output, so that +# unexpected input chars like \r etc. don't corrupt the error. +# In edge cases this can be avoided by putting the format string +# on a separate line to the arguments, or the arguments in parenthesis. +sc_error_quotes: + @cd $(srcdir)/src \ + && GIT_PAGER= git grep -E -n '$(error_fns) *\(.*%s.*, [^(]*\);$$' \ + *.c | grep -v ', q' \ + && { echo '$(ME): '"Use quote() for error string arguments" 1>&2; \ + exit 1; } \ + || : + +# Files in src/ should quote all file names in error() output +# using quotef(), to provide quoting only when necessary, +# but also provide better support for copy and paste when used. +sc_error_shell_quotes: + @cd $(srcdir)/src && \ + { GIT_PAGER= git grep -E \ + '$(error_fns) \(.*%s[:"], .*(name|file)[^"]*\);$$' *.c; \ + GIT_PAGER= git grep -E \ + ' quote[ _].*file' *.c; } \ + | grep -Ev '(quotef|q[^ ]*name)' \ + && { echo '$(ME): '"Use quotef() for colon delimited names" 1>&2; \ + exit 1; } \ + || : + +# Files in src/ should quote all file names in error() output +# using quoteaf() when the name is separated with spaces, +# to distinguish the file name at issue and +# to provide better support for copy and paste. +sc_error_shell_always_quotes: + @cd $(srcdir)/src && GIT_PAGER= git grep -E \ + '$(error_fns) \(.*[^:] %s[ "].*, .*(name|file)[^"]*\);$$' \ + *.c | grep -Ev '(quoteaf|q[^ ]*name)' \ + && { echo '$(ME): '"Use quoteaf() for space delimited names" 1>&2; \ + exit 1; } \ + || : + @cd $(srcdir)/src && GIT_PAGER= git grep -E -A1 \ + '$(error_fns) \([^%]*[^:] %s[ "]' *.c | grep 'quotef' \ + && { echo '$(ME): '"Use quoteaf() for space delimited names" 1>&2; \ + exit 1; } \ + || : + +# Avoid unstyled quoting to internal slots and thus destined for diagnostics +# as that can leak unescaped control characters to the output, when using +# the default "literal" quoting style. +# Instead use quotef(), or quoteaf() or in edge cases quotearg_n_style_colon(). +# A more general PCRE would be @prohibit='quotearg_.*(?!(style|buffer))' +sc_prohibit-quotearg: + @prohibit='quotearg(_n)?(|_colon|_char|_mem) ' \ + in_vc_files='\.c$$' \ + halt='Unstyled diagnostic quoting detected' \ + $(_sc_search_regexp) + +sc_prohibit-skip: + @prohibit='\|\| skip ' \ + halt='Use skip_ not skip' \ + $(_sc_search_regexp) + +sc_sun_os_names: + @grep -nEi \ + 'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \ + $$($(VC_LIST_EXCEPT)) && \ + { echo '$(ME): found misuse of Sun OS version numbers' 1>&2; \ + exit 1; } || : + +# Ensure that the list of programs and author names is accurate. +# We need a UTF8 locale. If a lack of locale support or a missing +# translation inhibits printing of UTF-8 names, just skip this test. +au_dotdot = authors-dotdot +au_actual = authors-actual +sc_check-AUTHORS: $(all_programs) + @locale=en_US.UTF-8; \ + LC_ALL=$$locale ./src/factor --version \ + | grep ' Torbjorn ' > /dev/null \ + && { echo "$@: skipping this check"; exit 0; }; \ + rm -f $(au_actual) $(au_dotdot); \ + for i in `ls $(all_programs) \ + | sed -e 's,^src/,,' -e 's,$(EXEEXT)$$,,' \ + | sed /libstdbuf/d \ + | $(ASSORT) -u`; do \ + test "$$i" = '[' && continue; \ + exe=$$i; \ + if test "$$i" = install; then \ + exe=ginstall; \ + elif test "$$i" = test; then \ + exe='['; \ + fi; \ + LC_ALL=$$locale ./src/$$exe --version \ + | perl -0 -p -e 's/,\n/, /gm' \ + | sed -n -e '/Written by /{ s//'"$$i"': /;' \ + -e 's/,* and /, /; s/\.$$//; p; }'; \ + done > $(au_actual) && \ + sed -n '/^[^ ][^ ]*:/p' $(srcdir)/AUTHORS > $(au_dotdot) \ + && diff $(au_actual) $(au_dotdot) \ + && rm -f $(au_actual) $(au_dotdot) + +# Ensure the alternative __attribute (keyword) form isn't used as +# that form is not elided where required. Also ensure that we don't +# directly use attributes already defined by gnulib. +# TODO: move the check for _GL... attributes to gnulib. +sc_prohibit-gl-attributes: + @prohibit='__attribute |__(unused|pure|const)__' \ + in_vc_files='\.[ch]$$' \ + halt='Use _GL... attribute macros' \ + $(_sc_search_regexp) + +# Prefer the const declaration form, with const following the type +sc_prohibit-const-char: + @prohibit='const char \*' \ + in_vc_files='\.[ch]$$' \ + halt='Use char const *, not const char *' \ + $(_sc_search_regexp) + +# Look for lines longer than 80 characters, except omit: +# - urls +# - the fdl.texi file copied from gnulib, +# - the help2man script copied from upstream, +# - tests involving long checksum lines, and +# - the 'pr' test cases. +FILTER_LONG_LINES = \ + \|^[^:]*NEWS:.*https\{,1\}://| d; \ + \|^[^:]*doc/fdl.texi:| d; \ + \|^[^:]*man/help2man:| d; \ + \|^[^:]*tests/cksum/sha[0-9]*sum.*\.pl[-:]| d; \ + \|^[^:]*tests/pr/|{ \|^[^:]*tests/pr/pr-tests:| !d; }; +sc_long_lines: + @wc -L /dev/null >/dev/null 2>/dev/null \ + || { echo "$@: skipping: wc -L not supported"; exit 0; }; \ + sed -r 1q /dev/null 2>/dev/null \ + || { echo "$@: skipping: sed -r not supported"; exit 0; }; \ + files=$$($(VC_LIST_EXCEPT) | xargs wc -L | sed -rn '/ total$$/d;\ + s/^ *(8[1-9]|9[0-9]|[0-9]{3,}) //p'); \ + halt='line(s) with more than 80 characters; reindent'; \ + for file in $$files; do \ + expand $$file | grep -nE '^.{80}.' | \ + sed -e "s|^|$$file:|" -e '$(FILTER_LONG_LINES)'; \ + done | grep . && { msg="$$halt" $(_sc_say_and_exit) } || : + +# Option descriptions should not start with a capital letter. +# One could grep source directly as follows: +# grep -E " {2,6}-.*[^.] [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$') +# but that would miss descriptions not on the same line as the -option. +sc_option_desc_uppercase: $(ALL_MANS) + @grep '^\\fB\\-' -A1 man/*.1 | LC_ALL=C grep '\.1.[A-Z][a-z]' \ + && { echo 1>&2 '$@: found initial capitals in --help'; exit 1; } || : + +# '--' should not be treated as '–' (U+2013 EN DASH) in long option names. +sc_texi_long_option_escaped: doc/coreutils.info + @grep ' –[^ ]' '$<' \ + && { echo 1>&2 '$@: found unquoted --long-option'; exit 1; } || : + +# Ensure all man/*.[1x] files are present. +sc_man_file_correlation: check-x-vs-1 check-programs-vs-x + +# Ensure that for each .x file in the 'man/' subdirectory, there is a +# corresponding .1 file in the definition of $(EXTRA_MANS). +# But since that expansion usually lacks programs like arch and hostname, +# add them here manually. +.PHONY: check-x-vs-1 +check-x-vs-1: + @PATH=./src$(PATH_SEPARATOR)$$PATH; export PATH; \ + t=$@-t; \ + (cd $(srcdir)/man && ls -1 *.x) \ + | sed 's/\.x$$//' | $(ASSORT) > $$t; \ + (echo $(patsubst man/%,%,$(ALL_MANS)) \ + | tr -s ' ' '\n' | sed 's/\.1$$//') \ + | $(ASSORT) -u | diff - $$t || { rm $$t; exit 1; }; \ + rm $$t + +# Ensure that non-trivial .x files in the 'man/' subdirectory, +# i.e., files exceeding a line count of 20 or a byte count of 1000, +# contain a Copyright notice. +.PHONY: sc_man_check_x_copyright +sc_man_check_x_copyright: + @status=0; \ + cd $(srcdir) && wc -cl man/*.x | head -n-1 \ + | awk '$$1 >= 20 || $$2 >= 1000 {print $$3}' \ + | xargs grep -L 'Copyright .* Free Software Foundation' \ + | grep . \ + && { echo 1>&2 '$@: exceeding file size/line count limit' \ + '- please add a copyright note'; status=1; }; \ + exit $$status + +# Writing a portable rule to generate a manpage like '[.1' would be +# a nightmare, so filter that out. +all-progs-but-lbracket = $(filter-out [,$(patsubst src/%,%,$(all_programs))) + +# Ensure that for each coreutils program there is a corresponding +# '.x' file in the 'man/' subdirectory. +.PHONY: check-programs-vs-x +check-programs-vs-x: + @status=0; \ + for p in dummy $(all-progs-but-lbracket); do \ + case $$p in *.so) continue;; esac; \ + test $$p = dummy && continue; \ + test $$p = ginstall && p=install || : ; \ + test -f $(srcdir)/man/$$p.x \ + || { echo missing $$p.x 1>&2; status=1; }; \ + done; \ + exit $$status + +# Ensure we can check out on case insensitive file systems +sc_case_insensitive_file_names: src/uniq + @git -C $(srcdir) ls-files | sort -f | src/uniq -Di | grep . && \ + { echo "$(ME): the above file(s) conflict on case insensitive" \ + " file systems" 1>&2; exit 1; } || : + +# Ensure that the end of each release's section is marked by two empty lines. +sc_NEWS_two_empty_lines: + @sed -n 4,/Noteworthy/p $(srcdir)/NEWS \ + | perl -n0e '/(^|\n)\n\n\* Noteworthy/ or exit 1' \ + || { echo '$(ME): use two empty lines to separate NEWS sections' \ + 1>&2; exit 1; } || : + +# With split lines, don't leave an operator at end of line. +# Instead, put it on the following line, where it is more apparent. +# Don't bother checking for "*" at end of line, since it provokes +# far too many false positives, matching constructs like "TYPE *". +# Similarly, omit "=" (initializers). +binop_re_ ?= [-/+^!<>]|[-/+*^!<>=]=|&&?|\|\|?|<<=?|>>=? +sc_prohibit_operator_at_end_of_line: + @prohibit='. ($(binop_re_))$$' \ + in_vc_files='\.[chly]$$' \ + halt='found operator at end of line' \ + $(_sc_search_regexp) + +# Partial substitutes for GNU extensions \< and \> in regexps. +begword = (^|[^_[:alnum:]]) +endword = ($$|[^_[:alnum:]]) + +# Don't use address of "stat" or "lstat" functions +sc_prohibit_stat_macro_address: + @prohibit='$(begword)l?stat '':|&l?stat$(endword)' \ + halt='stat() and lstat() may be function-like macros' \ + $(_sc_search_regexp) + +# Ensure that date's --help output stays in sync with the info +# documentation for GNU strftime. The only exception is %N and %q, +# which date accepts but GNU strftime does not. +# +# "info foo" fails with error, but not "info foo >/dev/null". +extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/' +sc_strftime_check: + @if test -f $(srcdir)/src/date.c; then \ + if info libc date calendar format 2>/dev/null | \ + grep "^ *['\`]%.'$$" >$@-tmp; then \ + { echo N; echo q; $(extract_char) $@-tmp; }| sort \ + >$@-info; \ + grep '^ %. ' $(srcdir)/src/date.c | sort \ + | $(extract_char) > $@-src; \ + diff -u $@-src $@-info || exit 1; \ + else \ + echo '$(ME): skipping $@: libc info not installed' 1>&2; \ + fi; \ + rm -f $@-info $@-src $@-tmp; \ + fi + +# Indent only with spaces. +sc_prohibit_tab_based_indentation: + @prohibit='^ * ' \ + halt='TAB in indentation; use only spaces' \ + $(_sc_search_regexp) + +# Enforce lowercase 'e' in "I.e.". +sc_prohibit_uppercase_id_est: + @prohibit='I\.E\.' \ + halt='Uppercase "Id Est" abbreviation; use "I.e.," instead' \ + $(_sc_search_regexp) + +# Enforce double-space before "I.e." at the beginning of a sentence. +sc_ensure_dblspace_after_dot_before_id_est: + @prohibit='\. I\.e\.' \ + halt='Single space after dot before "i.e."; use ". i.e." instead' \ + $(_sc_search_regexp) + +# Enforce comma after "i.e." (at least before a blank or at EOL). +sc_ensure_comma_after_id_est: + @prohibit='[Ii]\.e\.( |$$)' \ + halt='Missing comma after "i.e."; use "i.e.," instead' \ + $(_sc_search_regexp) + +# The SEE ALSO section of a man page should not be terminated with +# a period. Check the first line after each "SEE ALSO" line in man/*.x: +sc_prohibit_man_see_also_period: + @grep -nB1 '\.$$' $$($(VC_LIST_EXCEPT) | grep 'man/.*\.x$$') \ + | grep -A1 -e '-\[SEE ALSO]' | grep '\.$$' && \ + { echo '$(ME): do not end "SEE ALSO" section with a period' \ + 1>&2; exit 1; } || : + +sc_prohibit_exit_write_error: + @prohibit='error.*EXIT_FAILURE.*write error' \ + in_vc_files='\.c$$' \ + halt='Use write_error() instead' \ + $(_sc_search_regexp) + +sc_prohibit_NULL: + @prohibit='$(begword)NULL$(endword)' \ + in_vc_files='\.[ch]$$' \ + halt='use nullptr instead' \ + $(_sc_search_regexp) + +# Don't use "indent-tabs-mode: nil" anymore. No longer needed. +sc_prohibit_emacs__indent_tabs_mode__setting: + @prohibit='^( *[*#] *)?indent-tabs-mode:' \ + halt='use of emacs indent-tabs-mode: setting' \ + $(_sc_search_regexp) + +# Ensure that tests don't include a redundant fail=0. +sc_prohibit_fail_0: + @prohibit='$(begword)fail=0$(endword)' \ + halt='fail=0 initialization' \ + $(_sc_search_regexp) + +# Ensure that tests don't use `cmd ... && fail=1` as that hides crashes. +# The "exclude" expression allows common idioms like `test ... && fail=1` +# and the 2>... portion allows commands that redirect stderr and so probably +# independently check its contents and thus detect any crash messages. +sc_prohibit_and_fail_1: + @prohibit='&& fail=1' \ + exclude='(returns_|stat|kill|test |EGREP|grep|compare|2> *[^/])' \ + halt='&& fail=1 detected. Please use: returns_ 1 ... || fail=1' \ + in_vc_files='^tests/' \ + $(_sc_search_regexp) + +# Ensure that tests don't use `cmd ... || fail` as that's a noop. +sc_prohibit_or_fail: + @prohibit='\|\| fail$$' \ + exclude=':#' \ + halt='|| fail detected. Please use: || fail=1' \ + in_vc_files='^tests/' \ + $(_sc_search_regexp) + +# Ensure that env vars are not passed through returns_ as +# that was seen to fail on FreeBSD /bin/sh at least +sc_prohibit_env_returns: + @prohibit='=[^ ]* returns_ ' \ + exclude='_ returns_ ' \ + halt='Passing env vars to returns_ is non portable' \ + in_vc_files='^tests/' \ + $(_sc_search_regexp) + +# The mode part of a setfacl -m option argument must be three bytes long. +# I.e., an argument of user:bin:rw or user:bin:r will make Solaris 10's +# setfacl reject it with: "Unrecognized character found in mode field". +# Use hyphens to give it a length of 3: "...:rw-" or "...:r--". +sc_prohibit_short_facl_mode_spec: + @prohibit='$(begword)setfacl .*-m.*:.*:[rwx-]{1,2} ' \ + halt='setfacl mode string length < 3; extend with hyphen(s)' \ + $(_sc_search_regexp) + +# Ensure that "stdio--.h" is used where appropriate. +sc_require_stdio_safer: + @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then \ + files=$$(grep -El '$(begword)freopen ?\(' $$($(VC_LIST_EXCEPT)\ + | grep '\.[ch]$$')); \ + test -n "$$files" && grep -LE 'include "stdio--.h"' $$files \ + | grep . && \ + { echo '$(ME): the above files should use "stdio--.h"' \ + 1>&2; exit 1; } || :; \ + else :; \ + fi + +# Ensure that "stdlib--.h" is used where appropriate. +sc_require_stdlib_safer: + @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then \ + files=$$(grep -El '$(begword)mkstemp ?\(' $$($(VC_LIST_EXCEPT)\ + | grep '\.[ch]$$')); \ + test -n "$$files" && grep -LE 'include "stdlib--.h"' $$files \ + | grep . && \ + { echo '$(ME): the above files should use "stdlib--.h"' \ + 1>&2; exit 1; } || :; \ + else :; \ + fi + +sc_prohibit_perl_hash_quotes: + @prohibit="\{'[A-Z_]+' *[=}]" \ + halt="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}" \ + $(_sc_search_regexp) + +# Prefer xnanosleep over other less-precise sleep methods +sc_prohibit_sleep: + @prohibit='$(begword)(nano|u)?sleep \(' \ + halt='prefer xnanosleep over other sleep interfaces' \ + $(_sc_search_regexp) + +# Use print_ver_ (from init.cfg), not open-coded $VERBOSE check. +sc_prohibit_verbose_version: + @prohibit='test "\$$VERBOSE" = yes && .* --version' \ + halt='use the print_ver_ function instead...' \ + $(_sc_search_regexp) + +# Enforce print_ver_ tracking of dependencies +# Each coreutils specific program a test requires +# should be tagged by calling through env(1). +sc_env_test_dependencies: + @cd $(top_srcdir) && GIT_PAGER= git grep -E \ + "env ($$(build-aux/gen-lists-of-programs.sh --list-progs | \ + grep -vF '[' |paste -d'|' -s))" tests | \ + sed "s/\([^:]\):.*env \([^)' ]*\).*/\1 \2/" | uniq | \ + while read test prog; do \ + printf '%s' $$test | grep '\.pl$$' >/dev/null && continue; \ + grep "print_ver_.* $$prog" $$test >/dev/null \ + || echo $$test should call: print_ver_ $$prog; \ + done | grep . && exit 1 || : + +# Use framework_failure_, not the old name without the trailing underscore. +sc_prohibit_framework_failure: + @prohibit='$(begword)framework_''failure$(endword)' \ + halt='use framework_failure_ instead' \ + $(_sc_search_regexp) + +# Prohibit the use of `...` in tests/. Use $(...) instead. +sc_prohibit_test_backticks: + @prohibit='`' in_vc_files='^tests/' \ + halt='use $$(...), not `...` in tests/' \ + $(_sc_search_regexp) + +# Ensure that compare is used to check empty files +# so that the unexpected contents are displayed +sc_prohibit_test_empty: + @prohibit='test -s.*&&' in_vc_files='^tests/' \ + halt='use `compare /dev/null ...`, not `test -s ...` in tests/' \ + $(_sc_search_regexp) + +# Programs like sort, ls, expr use PROG_FAILURE in place of EXIT_FAILURE. +# Others, use the EXIT_CANCELED, EXIT_ENOENT, etc. macros defined in system.h. +# In those programs, ensure that EXIT_FAILURE is not used by mistake. +sc_some_programs_must_avoid_exit_failure: + @cd $(srcdir) \ + && grep -nw EXIT_FAILURE \ + $$(git grep -El '[^T]_FAILURE|EXIT_CANCELED' src/) \ + | grep -v '^src/system\.h:' \ + | grep -vE '= EXIT_FAILURE|return .* \?' | grep . \ + && { echo '$(ME): do not use EXIT_FAILURE in the above' \ + 1>&2; exit 1; } || : + +# Ensure that tests call the get_min_ulimit_v_ function if using ulimit -v +sc_prohibit_test_ulimit_without_require_: + @(git -C $(srcdir) grep -l get_min_ulimit_v_ tests; \ + git -C $(srcdir) grep -l 'ulimit -v' tests) \ + | sort | uniq -u | grep . && { echo "$(ME): the above test(s)"\ + " should match get_min_ulimit_v_ with ulimit -v" 1>&2; exit 1; } || : + +# Ensure that tests call the cleanup_ function if using background processes +sc_prohibit_test_background_without_cleanup_: + @(git -C $(srcdir) grep -El '( &$$|&[^&]*=\$$!)' tests; \ + git -C $(srcdir) grep -l 'cleanup_()' tests | sed p) \ + | sort | uniq -u | grep . && { echo "$(ME): the above test(s)"\ + " should use cleanup_ for background processes" 1>&2; exit 1; } || : + +# Ensure that tests call the print_ver_ function for programs which are +# actually used in that test. +sc_prohibit_test_calls_print_ver_with_irrelevant_argument: + @git -C $(srcdir) grep -w print_ver_ tests \ + | sed 's#:print_ver_##' \ + | { fail=0; \ + while read file name; do \ + for i in $$name; do \ + case "$$i" in install) i=ginstall;; esac; \ + grep -w "$$i" $$file|grep -vw print_ver_|grep . >/dev/null \ + || { fail=1; \ + echo "*** Test: $$file, offending: $$i." 1>&2; };\ + done; \ + done; \ + test $$fail = 0 || exit 1; \ + } || { echo "$(ME): the above test(s) call print_ver_ for" \ + "program(s) they don't use" 1>&2; exit 1; } + +# Exempt the contents of any usage function from the following. +_continued_string_col_1 = \ +s/^usage .*?\n}//ms;/\\\n\w/ and print ("$$ARGV\n"),$$e=1;END{$$e||=0;exit $$e} +# Ding any source file that has a continued string with an alphabetic in the +# first column of the following line. We prohibit them because they usually +# trigger false positives in tools that try to map an arbitrary line number +# to the enclosing function name. Of course, very many strings do precisely +# this, *when they are part of the usage function*. That is why we exempt +# the contents of any function named "usage". +sc_prohibit_continued_string_alpha_in_column_1: + @perl -0777 -ne '$(_continued_string_col_1)' \ + $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$') \ + || { echo '$(ME): continued string with word in first column' \ + 1>&2; exit 1; } || : +# Use this to list offending lines: +# git ls-files |grep '\.[ch]$' | xargs \ +# perl -n -0777 -e 's/^usage.*?\n}//ms;/\\\n\w/ and print "$ARGV\n"' \ +# | xargs grep -A1 '\\$'|grep '\.[ch][:-][_a-zA-Z]' + + +########################################################### +_p0 = \([^"'/]\|"\([^\"]\|[\].\)*"\|'\([^\']\|[\].\)*' +_pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\([^\']\|[\].\)*'\)* +_pre_anchored = ^\($(_pre)\) +_comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/ +# help font-lock mode: ' + +# A sed expression that removes ANSI C and ISO C99 comments. +# Derived from the one in GNU gettext's 'moopp' preprocessor. +_sed_remove_comments = \ +/[/][/*]/{ \ + ta; \ + :a; \ + s,$(_pre_anchored)//.*,\1,; \ + te; \ + s,$(_pre_anchored)/[*]\($(_comment_and_close),\1 ,; \ + ta; \ + /^$(_pre)[/][*]/{ \ + s,$(_pre_anchored)/[*].*,\1 ,; \ + tu; \ + :u; \ + n; \ + s,^\($(_comment_and_close),,; \ + tv; \ + s,^.*$$,,; \ + bu; \ + :v; \ + }; \ + :e; \ +} +# Quote all single quotes. +_sed_rm_comments_q = $(subst ','\'',$(_sed_remove_comments)) +# help font-lock mode: ' + +_space_before_paren_exempt =? \\n\\$$ +_space_before_paren_exempt = \ + (^ *\#|\\n\\$$|%s\(to %s|(date|group|character)\(s\)) +# Ensure that there is a space before each open parenthesis in C code. +sc_space_before_open_paren: + @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then \ + fail=0; \ + for c in $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$'); do \ + sed '$(_sed_rm_comments_q)' $$c 2>/dev/null \ + | grep -i '[[:alnum:]](' \ + | grep -vE '$(_space_before_paren_exempt)' \ + | grep . && { fail=1; echo "*** $$c"; }; \ + done; \ + test $$fail = 1 && \ + { echo '$(ME): the above files lack a space-before-open-paren' \ + 1>&2; exit 1; } || :; \ + else :; \ + fi + +# Similar to the gnulib maint.mk rule for sc_prohibit_strcmp +# Use STREQ_LEN or STRPREFIX rather than comparing strncmp == 0, or != 0. +sc_prohibit_strncmp: + @prohibit='^[^#].*str''ncmp *\(' \ + halt='use STREQ_LEN or STRPREFIX instead of str''ncmp' \ + $(_sc_search_regexp) + +# Enforce recommended preprocessor indentation style. +sc_preprocessor_indentation: + @if cppi --version >/dev/null 2>&1; then \ + $(VC_LIST_EXCEPT) | grep '\.[ch]$$' | xargs cppi -a -c \ + || { echo '$(ME): incorrect preprocessor indentation' 1>&2; \ + exit 1; }; \ + else \ + echo '$(ME): skipping test $@: cppi not installed' 1>&2; \ + fi + +# THANKS.in is a list of name/email pairs for people who are mentioned in +# commit logs (and generated ChangeLog), but who are not also listed as an +# author of a commit. Name/email pairs of commit authors are automatically +# extracted from the repository. As a very minor factorization, when +# someone who was initially listed only in THANKS.in later authors a commit, +# this rule detects that their pair may now be removed from THANKS.in. +sc_THANKS_in_duplicates: + @{ git -C $(srcdir) log --pretty=format:%aN | sort -u; \ + cut -b-36 $(srcdir)/THANKS.in \ + | sed '/^$$/,/^$$/!d;/^$$/d;s/ *$$//'; } \ + | sort | uniq -d | grep . \ + && { echo '$(ME): remove the above names from THANKS.in' \ + 1>&2; exit 1; } || : + +# Ensure the contributor list stays sorted. However, if the system's +# en_US.UTF-8 locale data is erroneous, give a diagnostic and skip +# this test. This affects OS X, up to at least 10.11.6. +# Use our sort as other implementations may result in a different order. +sc_THANKS_in_sorted: + @printf 'a\n.b\n'|LC_ALL=en_US.UTF-8 src/sort -c 2> /dev/null \ + && { \ + sed '/^$$/,/^$$/!d;/^$$/d' $(srcdir)/THANKS.in > $@.1 && \ + LC_ALL=en_US.UTF-8 src/sort -f -k1,1 $@.1 > $@.2 && \ + diff -u $@.1 $@.2; diff=$$?; \ + rm -f $@.1 $@.2; \ + test "$$diff" = 0 \ + || { echo '$(ME): THANKS.in is unsorted' 1>&2; exit 1; }; \ + } \ + || { echo '$(ME): this system has erroneous locale data;' \ + 'skipping $@' 1>&2; } + +# Look for developer diagnostics that are marked for translation. +# This won't find any for which devmsg's format string is on a separate line. +sc_marked_devdiagnostics: + @prohibit='$(begword)devmsg *\(.*_\(' \ + halt='found marked developer diagnostic(s)' \ + $(_sc_search_regexp) + +# Ensure we keep hex constants as 4 or 8 bytes for consistency +# and so that make src/fs-magic-compare works consistently +sc_fs-magic-compare: + @sed -n 's|.*/\* \(0x[0-9A-Fa-f]\{1,\}\) .*\*/|\1|p' \ + $(srcdir)/src/stat.c | grep -Ev '^0x([0-9A-F]{4}){1,2}$$' \ + && { echo '$(ME): Constants in src/stat.c should be 4 or 8' \ + 'upper-case chars' 1>&2; exit 1; } || : + +# Ensure gnulib generated files are ignored +# TODO: Perhaps augment gnulib-tool to do this in lib/.gitignore? +sc_gitignore_missing: + @{ sed -n '/^\/lib\/.*\.h$$/{p;p}' $(srcdir)/.gitignore; \ + find lib -name '*.in*' ! -name '*~' ! -name 'sys_*' | \ + sed 's|^|/|; s|_\(.*in\.h\)|/\1|; s/\.in//'; } | \ + sort | uniq -u | grep . && { echo '$(ME): Add above' \ + 'entries to .gitignore' >&2; exit 1; } || : + +# Flag redundant entries in .gitignore +# Disabled for now as too aggressive flagging +# entries like /lib/arg-nonnull.h +#sc_gitignore_redundant: +# @{ grep ^/lib $(srcdir)/.gitignore; \ +# sed 's|^|/lib|' $(srcdir)/lib/.gitignore; } | \ +# sort | uniq -d | grep . && { echo '$(ME): Remove above' \ +# 'entries from .gitignore' >&2; exit 1; } || : + +sc_prohibit-form-feed: + @prohibit=$$'\f' \ + in_vc_files='\.[chly]$$' \ + halt='Form Feed (^L) detected' \ + $(_sc_search_regexp) + +# Override the default Cc: used in generating an announcement. +announcement_Cc_ = $(translation_project_), \ + coreutils@gnu.org, coreutils-announce@gnu.org + +-include $(srcdir)/dist-check.mk + +update-copyright-env = \ + UPDATE_COPYRIGHT_FORCE=1 \ + UPDATE_COPYRIGHT_USE_INTERVALS=2 \ + UPDATE_COPYRIGHT_MAX_LINE_LENGTH=79 + +# List syntax-check exemptions. +exclude_file_name_regexp--sc_space_tab = \ + ^(tests/pr/|tests/misc/nl\.sh$$|gl/.*\.diff$$|man/help2man$$) +exclude_file_name_regexp--sc_bindtextdomain = \ + ^(gl/.*|lib/euidaccess-stat|src/make-prime-list|src/cksum)\.c$$ +exclude_file_name_regexp--sc_trailing_blank = \ + ^(tests/pr/|gl/.*\.diff$$|man/help2man) +exclude_file_name_regexp--sc_system_h_headers = \ + ^src/((system|copy|chown-core|find-mount-point)\.h|make-prime-list\.c)$$ + +_src = (false|lbracket|ls-(dir|ls|vdir)|tac-pipe|uname-(arch|uname)) +_gl_src = (xdecto.max|cl-strtold) +exclude_file_name_regexp--sc_require_config_h_first = \ + (^lib/buffer-lcm\.c|gl/lib/$(_gl_src)\.c|src/$(_src)\.c)$$ +exclude_file_name_regexp--sc_require_config_h = \ + $(exclude_file_name_regexp--sc_require_config_h_first) + +exclude_file_name_regexp--sc_po_check = ^(gl/|man/help2man) +exclude_file_name_regexp--sc_prohibit_always-defined_macros = \ + ^src/(seq|remove)\.c$$ +exclude_file_name_regexp--sc_prohibit_empty_lines_at_EOF = ^tests/pr/ +exclude_file_name_regexp--sc_program_name = \ + ^(gl/.*|lib/euidaccess-stat|src/make-prime-list)\.c$$ +exclude_file_name_regexp--sc_file_system = \ + NEWS|^(init\.cfg|src/df\.c|tests/df/df-P\.sh|tests/df/df-output\.sh)$$ +exclude_file_name_regexp--sc_prohibit_always_true_header_tests = \ + ^m4/stat-prog\.m4$$ +exclude_file_name_regexp--sc_prohibit_fail_0 = \ + (^.*/git-hooks/commit-msg|^tests/init\.sh|Makefile\.am|\.mk|.*\.texi)$$ +exclude_file_name_regexp--sc_prohibit_test_minus_ao = doc/.*\.texi$$ +exclude_file_name_regexp--sc_prohibit_atoi_atof = ^lib/euidaccess-stat\.c$$ + +# longlong.h is maintained elsewhere. +_ll = ^src/longlong\.h$$ +exclude_file_name_regexp--sc_useless_cpp_parens = $(_ll) +exclude_file_name_regexp--sc_space_before_open_paren = $(_ll) + +tbi_1 = ^tests/pr/|(\.mk|^man/help2man)$$ +tbi_2 = ^scripts/git-hooks/(pre-commit|pre-applypatch|applypatch-msg)$$ +tbi_3 = (GNU)?[Mm]akefile(\.am)?$$|$(_ll) +exclude_file_name_regexp--sc_prohibit_tab_based_indentation = \ + $(tbi_1)|$(tbi_2)|$(tbi_3) + +exclude_file_name_regexp--sc_preprocessor_indentation = \ + ^(gl/lib/rand-isaac\.[ch]|gl/tests/test-rand-isaac\.c)$$|$(_ll) +exclude_file_name_regexp--sc_prohibit_stat_st_blocks = \ + ^(src/system\.h|tests/du/2g\.sh)$$ + +exclude_file_name_regexp--sc_prohibit_continued_string_alpha_in_column_1 = \ + ^src/(system\.h|od\.c|printf\.c|getlimits\.c)$$ + +_cksum = ^tests/cksum/cksum-base64\.pl$$ +exclude_file_name_regexp--sc_prohibit_test_backticks = \ + ^tests/(local\.mk|(init|misc/stdbuf|factor/create-test)\.sh)$$|$(_cksum) + +# Exempt test.c, since it's nominally shared, and relatively static. +exclude_file_name_regexp--sc_prohibit_operator_at_end_of_line = \ + ^src/(ptx|test|head)\.c$$ + +exclude_file_name_regexp--sc_error_message_uppercase = ^src/factor\.c$$ +exclude_file_name_regexp--sc_prohibit_atoi_atof = ^src/make-prime-list\.c$$ + +# Exception here as we don't want __attribute elided on non GCC +exclude_file_name_regexp--sc_prohibit-gl-attributes = ^src/libstdbuf\.c$$ + +exclude_file_name_regexp--sc_prohibit_uppercase_id_est = \.diff$$ +exclude_file_name_regexp--sc_ensure_dblspace_after_dot_before_id_est = \.diff$$ +exclude_file_name_regexp--sc_ensure_comma_after_id_est = \.diff|$(_ll)$$ +exclude_file_name_regexp--sc_long_lines = \.diff$$|$(_ll)|$(_cksum) + +# `grep . -q` is not exactly equivalent to `grep . >/dev/null` +# and this difference is significant in the NEWS description +exclude_file_name_regexp--sc_unportable_grep_q = NEWS + +# Augment AM_CFLAGS to include our per-directory options: +AM_CFLAGS += $($(@D)_CFLAGS) + +src_CFLAGS = $(WARN_CFLAGS) +lib_CFLAGS = $(GNULIB_WARN_CFLAGS) +gnulib-tests_CFLAGS = $(GNULIB_TEST_WARN_CFLAGS) + +# Configuration to make the tight-scope syntax-check rule work with +# non-recursive make. +# Note _gl_TS_headers use _single line_ extern function declarations, +# while *_SOURCES use the _two line_ form. +export _gl_TS_headers = $(noinst_HEADERS) +# Add exceptions for --enable-single-binary renamed functions. +_gl_TS_unmarked_extern_functions = main usage +_gl_TS_unmarked_extern_functions += single_binary_main_.* _usage_.* +# Headers to search for single line extern _data_ declarations. +_gl_TS_other_headers = $(srcdir)/src/*.h src/*.h +# Tell the tight_scope rule about an exceptional "extern" variable. +# Normally, the rule would detect its declaration, but that uses a +# different name, __clz_tab. +_gl_TS_unmarked_extern_vars = factor_clz_tab +# Other tight_scope settings +_gl_TS_dir = . +_gl_TS_obj_files = src/*.$(OBJEXT) |