maint: update all copyright year number ranges
[platform/upstream/coreutils.git] / cfg.mk
diff --git a/cfg.mk b/cfg.mk
index 9e45daf..fbc64b4 100644 (file)
--- a/cfg.mk
+++ b/cfg.mk
@@ -1,5 +1,5 @@
 # Customize maint.mk                           -*- makefile -*-
-# Copyright (C) 2003-2012 Free Software Foundation, Inc.
+# Copyright (C) 2003-2013 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
@@ -23,7 +23,7 @@ url_dir_list = http://ftp.gnu.org/gnu/$(PACKAGE)
 
 # Tests not to run as part of "make distcheck".
 local-checks-to-skip = \
-  sc_texinfo_acronym
+  sc_proper_name_utf8_requires_ICONV
 
 # Tools used to bootstrap this package, used for "announcement".
 bootstrap-tools = autoconf,automake,gnulib,bison
@@ -31,7 +31,21 @@ bootstrap-tools = autoconf,automake,gnulib,bison
 # Now that we have better tests, make this the default.
 export VERBOSE = yes
 
-old_NEWS_hash = f2fae8556f651da99e503a1d1a841f83
+# 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 = b93e7e43dd35f32961c354e41211b86e
 
 # Add an exemption for sc_makefile_at_at_check.
 _makefile_at_at_check_exceptions = ' && !/^cu_install_program =/'
@@ -70,7 +84,7 @@ ifneq ($(wildcard $(dd_c)),)
        fi
 endif
 
-# Many m4 macros names once began with `jm_'.
+# 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:
@@ -81,21 +95,25 @@ sc_prohibit_jm_in_m4:
 
 # Ensure that each root-requiring test is run via the "check-root" rule.
 sc_root_tests:
-       @if test -d tests \
-             && grep check-root tests/Makefile.am>/dev/null 2>&1; then \
-       t1=sc-root.expected; t2=sc-root.actual;                         \
-       grep -nl '^ *require_root_$$'                                   \
-         $$($(VC_LIST) tests) |sed s,tests/,, |sort > $$t1;            \
-       sed -n '/^root_tests =[  ]*\\$$/,/[^\]$$/p'                     \
-         $(srcdir)/tests/Makefile.am                                   \
-           | sed 's/^  *//;/^root_tests =/d'                           \
-           | tr -s '\012\\' '  ' | fmt -1 | sort > $$t2;               \
-       diff -u $$t1 $$t2 || diff=1 || diff=;                           \
+       @t1=sc-root.expected; t2=sc-root.actual;                        \
+       grep -nl '^ *require_root_$$' `$(VC_LIST) 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;                                                \
-       test "$$diff"                                                   \
-         && { echo 'tests/Makefile.am: missing check-root action'>&2;  \
-              exit 1; } || :;                                          \
-       fi
+       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$$'   \
+           | $(EGREP) "$$test_extensions_rx\$$";                       \
+       } | sort | uniq -u | grep . && exit 1; :
 
 # Create a list of regular expressions matching the names
 # of files included from system.h.  Exclude a couple.
@@ -132,9 +150,56 @@ sc_sun_os_names:
          { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;  \
            exit 1; } || :
 
-ALL_RECURSIVE_TARGETS += sc_check-AUTHORS
-sc_check-AUTHORS:
-       @$(MAKE) -s -C src _sc_check-AUTHORS
+# 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/cat --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 -pi -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)
+
+# Each program with a non-ASCII author name must link with LIBICONV.
+sc_check-I18N-AUTHORS:
+       @cd $(srcdir)/src &&                                            \
+         for i in $$(git grep -l -w proper_name_utf8 *.c|sed 's/\.c//'); do \
+           grep -E "^src_$${i}_LDADD"' .?= .*\$$\(LIBICONV\)' local.mk \
+               > /dev/null                                             \
+             || { echo "$(ME): link rules for $$i do not include"      \
+                   '$$(LIBICONV)' 1>&2; exit 1; };                     \
+         done
+
+# Ensure %j is not used for intmax_t as it's not universally supported.
+# There are issues on HPUX for example.  But note that %ju was used between
+# coreutils 8.13 (2011-10) and 8.20 (2012-10) without any reported issue,
+# and the particular issue this check is associated with was for %*jx.
+# So we may be able to relax this restriction soon.
+sc_prohibit-j-printf-format:
+       @cd $(srcdir)/src && GIT_PAGER= git grep -n '%[0*]*j[udx]' *.c  \
+         && { echo '$(ME): Use PRI*MAX instead of %j' 1>&2; exit 1; }  \
+         || :
 
 # Look for lines longer than 80 characters, except omit:
 # - program-generated long lines in diff headers,
@@ -143,7 +208,7 @@ sc_check-AUTHORS:
 LINE_LEN_MAX = 80
 FILTER_LONG_LINES =                                            \
   /^[^:]*\.diff:[^:]*:@@ / d;                                  \
-  \|^[^:]*tests/misc/sha[0-9]*sum[-:]| d;                      \
+  \|^[^:]*tests/misc/sha[0-9]*sum.*\.pl[-:]| d;                        \
   \|^[^:]*tests/pr/|{ \|^[^:]*tests/pr/pr-tests:| !d; };
 sc_long_lines:
        @files=$$($(VC_LIST_EXCEPT))                                    \
@@ -153,20 +218,49 @@ sc_long_lines:
          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
+# 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.
-ALL_RECURSIVE_TARGETS += sc_option_desc_uppercase
-sc_option_desc_uppercase:
-       @$(MAKE) -s -C src all_programs
-       @$(MAKE) -s -C man $@
-
-# Ensure all man/*.[1x] files are present
-ALL_RECURSIVE_TARGETS += sc_man_file_correlation
-sc_man_file_correlation:
-       @$(MAKE) -s -C src all_programs
-       @$(MAKE) -s -C man $@
+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; } || :
+
+# 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
+
+# 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 that the end of each release's section is marked by two empty lines.
 sc_NEWS_two_empty_lines:
@@ -175,16 +269,17 @@ sc_NEWS_two_empty_lines:
          || { echo '$(ME): use two empty lines to separate NEWS sections' \
                 1>&2; exit 1; } || :
 
-# Perl-based tests used to exec perl from a #!/bin/sh script.
-# Now they all start with #!/usr/bin/perl and the portability
-# infrastructure is in tests/Makefile.am.  Make sure no old-style
-# script sneaks back in.
-sc_no_exec_perl_coreutils:
-       @if test -f $(srcdir)/tests/Coreutils.pm; then                  \
-         grep '^exec  *\$$PERL.*MCoreutils' $$($(VC_LIST) tests) &&    \
-           { echo 1>&2 '$(ME): found anachronistic Perl-based tests';  \
-             exit 1; } || :;                                           \
-       fi
+# 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)
 
 # Don't use "readlink" or "readlinkat" directly
 sc_prohibit_readlink:
@@ -237,9 +332,7 @@ sc_prohibit_emacs__indent_tabs_mode__setting:
        halt='use of emacs indent-tabs-mode: setting'                   \
          $(_sc_search_regexp)
 
-# Ensure that each file that contains fail=1 also contains fail=0.
-# Otherwise, setting file=1 in the environment would make tests fail
-# unexpectedly.
+# Ensure that tests don't include a redundant fail=0.
 sc_prohibit_fail_0:
        @prohibit='\<fail=0\>'                                          \
        halt='fail=0 initialization'                                    \
@@ -289,6 +382,60 @@ sc_prohibit_framework_failure:
        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)
+
+# 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:
+       @grep -nw EXIT_FAILURE                                          \
+           $$(git grep -El '[^T]_FAILURE|EXIT_CANCELED' src)           \
+         | grep -vE '= EXIT_FAILURE|exit \(.* \?' | grep .             \
+           && { echo '$(ME): do not use EXIT_FAILURE in the above'     \
+                 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 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 -q .    \
+                   || { 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)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\([^\']\|[\].\)*'\)*
@@ -361,6 +508,19 @@ sc_preprocessor_indentation:
          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 log --pretty=format:%aN | sort -u;                       \
+           cut -b-36 THANKS.in | sed '/^$$/d;s/  *$$//'; }             \
+         | sort | uniq -d | grep .                                     \
+           && { echo '$(ME): remove the above names from THANKS.in'    \
+                 1>&2; exit 1; } || :
+
 # Override the default Cc: used in generating an announcement.
 announcement_Cc_ = $(translation_project_), \
   coreutils@gnu.org, coreutils-announce@gnu.org
@@ -368,18 +528,18 @@ announcement_Cc_ = $(translation_project_), \
 -include $(srcdir)/dist-check.mk
 
 update-copyright-env = \
-  UPDATE_COPYRIGHT_USE_INTERVALS=1 \
+  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$$|gl/.*\.diff$$)
-exclude_file_name_regexp--sc_bindtextdomain = ^(gl/.*|lib/euidaccess-stat)\.c$$
-exclude_file_name_regexp--sc_unmarked_diagnostics =    ^build-aux/cvsu$$
-exclude_file_name_regexp--sc_error_message_uppercase = ^build-aux/cvsu$$
+  ^(tests/pr/|tests/misc/nl\.sh$$|gl/.*\.diff$$)
+exclude_file_name_regexp--sc_bindtextdomain = \
+  ^(gl/.*|lib/euidaccess-stat|src/make-prime-list)\.c$$
 exclude_file_name_regexp--sc_trailing_blank = ^tests/pr/
 exclude_file_name_regexp--sc_system_h_headers = \
-  ^src/((system|copy)\.h|libstdbuf\.c)$$
+  ^src/((system|copy)\.h|libstdbuf\.c|make-prime-list\.c)$$
 
 _src = (false|lbracket|ls-(dir|ls|vdir)|tac-pipe|uname-(arch|uname))
 exclude_file_name_regexp--sc_require_config_h_first = \
@@ -391,21 +551,61 @@ exclude_file_name_regexp--sc_po_check = ^gl/
 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)\.c$$
+exclude_file_name_regexp--sc_program_name = \
+  ^(gl/.*|lib/euidaccess-stat|src/make-prime-list)\.c$$
 exclude_file_name_regexp--sc_file_system = \
-  NEWS|^(tests/init\.cfg|src/df\.c|tests/misc/df-P)$$
+  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 = \
-  (^scripts/git-hooks/commit-msg|^tests/init\.sh|Makefile\.am|\.mk)$$
+  (^.*/git-hooks/commit-msg|^tests/init\.sh|Makefile\.am|\.mk|.*\.texi)$$
 exclude_file_name_regexp--sc_prohibit_atoi_atof = ^lib/euidaccess-stat\.c$$
 
-tbi_1 = ^tests/pr/|(^gl/lib/reg.*\.c\.diff|Makefile(\.am)?|\.mk|^man/help2man)$$
+# longlong.h is maintained elsewhere.
+_ll = ^src/longlong\.h$$
+exclude_file_name_regexp--sc_useless_cpp_parens = $(_ll)
+exclude_file_name_regexp--sc_long_lines = $(_ll)
+exclude_file_name_regexp--sc_space_before_open_paren = $(_ll)
+
+tbi_1 = ^tests/pr/|(^gl/lib/reg.*\.c\.diff|\.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_1)|$(tbi_2)|$(tbi_3)
 
 exclude_file_name_regexp--sc_preprocessor_indentation = \
-  ^(gl/lib/rand-isaac\.[ch]|gl/tests/test-rand-isaac\.c)$$
+  ^(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)$$
+  ^(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)$$
+
+exclude_file_name_regexp--sc_prohibit_test_backticks = \
+  ^tests/(local\.mk|(init|misc/stdbuf|factor/create-test)\.sh)$$
+
+# 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$$
+
+# 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.
+export _gl_TS_headers = $(srcdir)/cfg.mk
+_gl_TS_dir = .
+_gl_TS_obj_files = src/*.$(OBJEXT)
+_gl_TS_other_headers = 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