cfg.mk

   1 # Customize maint.mk                           -*- makefile -*-
   2 # Copyright (C) 2003-2010 Free Software Foundation, Inc.
   3
   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.
   8
   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.
  13
  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/>.
  16
  17 # Used in maint.mk's web-manual rule
  18 manual_title = Core GNU utilities
  19
  20 # Tests not to run as part of "make distcheck".
  21 local-checks-to-skip = \
  22   sc_texinfo_acronym
  23
  24 # Tools used to bootstrap this package, used for "announcement".
  25 bootstrap-tools = autoconf,automake,gnulib,bison
  26
  27 # Now that we have better tests, make this the default.
  28 export VERBOSE = yes
  29
  30 old_NEWS_hash = e2a254a0d4c81397994ea10a15663ac3
  31
  32 # Add an exemption for sc_makefile_at_at_check.
  33 _makefile_at_at_check_exceptions = ' && !/^cu_install_program =/'
  34
  35 # Our help-version script is in a slightly different location.
  36 _hv_file ?= $(srcdir)/tests/misc/help-version
  37
  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; } || :
  51
  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;                                               \
  66         fi
  67 endif
  68
  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; } || :
  77
  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; } || :;                                          \
  94         fi
  95
  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; } || :;
 108
 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 $@
 117
 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
 124
 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; } || :;                                \
 135         fi
 136
 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; } || :
 143
 144 ALL_RECURSIVE_TARGETS += sc_tight_scope
 145 sc_tight_scope:
 146         @$(MAKE) -s -C src $@
 147
 148 ALL_RECURSIVE_TARGETS += sc_check-AUTHORS
 149 sc_check-AUTHORS:
 150         @$(MAKE) -s -C src $@
 151
 152 # Option descriptions should not start with a capital letter
 153 # One could grep source directly as follows:
 154 # grep -E " {2,6}-.*[^.]  [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
 155 # but that would miss descriptions not on the same line as the -option.
 156 ALL_RECURSIVE_TARGETS += sc_option_desc_uppercase
 157 sc_option_desc_uppercase:
 158         @$(MAKE) -s -C src all_programs
 159         @$(MAKE) -s -C man $@
 160
 161 # Ensure all man/*.[1x] files are present
 162 ALL_RECURSIVE_TARGETS += sc_man_file_correlation
 163 sc_man_file_correlation:
 164         @$(MAKE) -s -C src all_programs
 165         @$(MAKE) -s -C man $@
 166
 167 # Ensure that the end of each release's section is marked by two empty lines.
 168 sc_NEWS_two_empty_lines:
 169         @sed -n 4,/Noteworthy/p $(srcdir)/NEWS                          \
 170             | perl -n0e '/(^|\n)\n\n\* Noteworthy/ or exit 1'           \
 171           || { echo '$(ME): use two empty lines to separate NEWS sections' \
 172                  1>&2; exit 1; } || :;                                  \
 173
 174 # Perl-based tests used to exec perl from a #!/bin/sh script.
 175 # Now they all start with #!/usr/bin/perl and the portability
 176 # infrastructure is in tests/Makefile.am.  Make sure no old-style
 177 # script sneaks back in.
 178 sc_no_exec_perl_coreutils:
 179         @if test -f $(srcdir)/tests/Coreutils.pm; then                  \
 180           grep '^exec  *\$$PERL.*MCoreutils' $$($(VC_LIST) tests) &&    \
 181             { echo 1>&2 '$(ME): found anachronistic Perl-based tests';  \
 182               exit 1; } || :;                                           \
 183         fi
 184
 185 # Don't use "readlink" or "readlinkat" directly
 186 sc_prohibit_readlink:
 187         @prohibit='\<readlink(at)? \('                                  \
 188         halt='do not use readlink(at); use via xreadlink or areadlink*' \
 189           $(_sc_search_regexp)
 190
 191 # Don't use address of "stat" or "lstat" functions
 192 sc_prohibit_stat_macro_address:
 193         @prohibit='\<l?stat '':|&l?stat\>'                              \
 194         halt='stat() and lstat() may be function-like macros'           \
 195           $(_sc_search_regexp)
 196
 197 # Ensure that date's --help output stays in sync with the info
 198 # documentation for GNU strftime.  The only exception is %N,
 199 # which date accepts but GNU strftime does not.
 200 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
 201 sc_strftime_check:
 202         @if test -f $(srcdir)/src/date.c; then                          \
 203           grep '^  %.  ' $(srcdir)/src/date.c | sort                    \
 204             | $(extract_char) > $@-src;                                 \
 205           { echo N;                                                     \
 206             info libc date calendar format 2>/dev/null|grep '^    `%.'\'\
 207               | $(extract_char); } | sort > $@-info;                    \
 208           diff -u $@-src $@-info || exit 1;                             \
 209           rm -f $@-src $@-info;                                         \
 210         fi
 211
 212 # Indent only with spaces.
 213 sc_prohibit_tab_based_indentation:
 214         @prohibit='^ *  '                                               \
 215         halt='TAB in indentation; use only spaces'                      \
 216           $(_sc_search_regexp)
 217
 218 # Don't use "indent-tabs-mode: nil" anymore.  No longer needed.
 219 sc_prohibit_emacs__indent_tabs_mode__setting:
 220         @prohibit='^( *[*#] *)?indent-tabs-mode:'                       \
 221         halt='use of emacs indent-tabs-mode: setting'                   \
 222           $(_sc_search_regexp)
 223
 224 # Ensure that each file that contains fail=1 also contains fail=0.
 225 # Otherwise, setting file=1 in the environment would make tests fail unexpectedly.
 226 sc_prohibit_fail_0:
 227         @prohibit='\<fail=0\>'                                          \
 228         halt='fail=0 initialization'                                    \
 229           $(_sc_search_regexp)
 230
 231 # Ensure that "stdio--.h" is used where appropriate.
 232 sc_require_stdio_safer:
 233         @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then    \
 234           files=$$(grep -l '\bfreopen \?(' $$($(VC_LIST_EXCEPT)         \
 235               | grep '\.[ch]$$'));                                      \
 236           test -n "$$files" && grep -LE 'include "stdio--.h"' $$files   \
 237               | grep . &&                                               \
 238           { echo '$(ME): the above files should use "stdio--.h"'        \
 239                 1>&2; exit 1; } || :;                                   \
 240         else :;                                                         \
 241         fi
 242
 243 sc_prohibit_perl_hash_quotes:
 244         @prohibit="\{'[A-Z_]+' *[=}]"                                   \
 245         halt="in Perl code, write \$$hash{KEY}, not \$$hash{'K''EY'}"   \
 246           $(_sc_search_regexp)
 247
 248 # Prefer xnanosleep over other less-precise sleep methods
 249 sc_prohibit_sleep:
 250         @prohibit='\<(nano|u)?sleep \('                                 \
 251         halt='prefer xnanosleep over other sleep interfaces'            \
 252           $(_sc_search_regexp)
 253
 254 # Use print_ver_ (from init.cfg), not open-coded $VERBOSE check.
 255 sc_prohibit_verbose_version:
 256         @prohibit='test "\$$VERBOSE" = yes && .* --version'             \
 257         halt='use the print_ver_ function instead...'                   \
 258           $(_sc_search_regexp)
 259
 260 ###########################################################
 261 _p0 = \([^"'/]\|"\([^\"]\|[\].\)*"\|'\([^\']\|[\].\)*'
 262 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\([^\']\|[\].\)*'\)*
 263 _pre_anchored = ^\($(_pre)\)
 264 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
 265 # help font-lock mode: '
 266
 267 # A sed expression that removes ANSI C and ISO C99 comments.
 268 # Derived from the one in GNU gettext's 'moopp' preprocessor.
 269 _sed_remove_comments =                                  \
 270 /[/][/*]/{                                              \
 271   ta;                                                   \
 272   :a;                                                   \
 273   s,$(_pre_anchored)//.*,\1,;                           \
 274   te;                                                   \
 275   s,$(_pre_anchored)/[*]\($(_comment_and_close),\1 ,;   \
 276   ta;                                                   \
 277   /^$(_pre)[/][*]/{                                     \
 278     s,$(_pre_anchored)/[*].*,\1 ,;                      \
 279     tu;                                                 \
 280     :u;                                                 \
 281     n;                                                  \
 282     s,^\($(_comment_and_close),,;                       \
 283     tv;                                                 \
 284     s,^.*$$,,;                                          \
 285     bu;                                                 \
 286     :v;                                                 \
 287   };                                                    \
 288   :e;                                                   \
 289 }
 290 # Quote all single quotes.
 291 _sed_rm_comments_q = $(subst ','\'',$(_sed_remove_comments))
 292 # help font-lock mode: '
 293
 294 _space_before_paren_exempt =? \\n\\$$
 295 _space_before_paren_exempt = \
 296   (^ *\#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
 297 # Ensure that there is a space before each open parenthesis in C code.
 298 sc_space_before_open_paren:
 299         @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then    \
 300           fail=0;                                                       \
 301           for c in $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$'); do          \
 302             sed '$(_sed_rm_comments_q)' $$c 2>/dev/null                 \
 303               | grep -i '[[:alnum:]]('                                  \
 304               | grep -vE '$(_space_before_paren_exempt)'                \
 305               | grep . && { fail=1; echo "*** $$c"; };                  \
 306           done;                                                         \
 307           test $$fail = 1 &&                                            \
 308             { echo '$(ME): the above files lack a space-before-open-paren' \
 309                 1>&2; exit 1; } || :;                                   \
 310         else :;                                                         \
 311         fi
 312
 313 # Override the default Cc: used in generating an announcement.
 314 announcement_Cc_ = $(translation_project_), \
 315   coreutils@gnu.org, coreutils-announce@gnu.org
 316
 317 include $(srcdir)/dist-check.mk
 318
 319 update-copyright-env = \
 320   UPDATE_COPYRIGHT_USE_INTERVALS=1 \
 321   UPDATE_COPYRIGHT_MAX_LINE_LENGTH=79