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 = 9518f4930d702a9fa6ac6b9fd06cca94
  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 headers_with_interesting_macro_defs = \
 110   exit.h        \
 111   fcntl_.h      \
 112   fnmatch_.h    \
 113   intprops.h    \
 114   inttypes_.h   \
 115   lchown.h      \
 116   openat.h      \
 117   stat-macros.h \
 118   stdint_.h
 119
 120 # Create a list of regular expressions matching the names
 121 # of macros that are guaranteed by parts of gnulib to be defined.
 122 .re-defmac:
 123         @(cd $(srcdir)/lib;                                             \
 124           for f in $(headers_with_interesting_macro_defs); do           \
 125             test -f $$f &&                                              \
 126               sed -n '/^# *define \([^_ (][^ (]*\)[ (].*/s//\1/p' $$f;  \
 127            done;                                                        \
 128          ) | sort -u                                                    \
 129            | grep -Ev 'ATTRIBUTE_NORETURN|SIZE_MAX'                     \
 130            | sed 's/^/^# *define /'                                     \
 131           > $@-t
 132         @mv $@-t $@
 133
 134 # Don't define macros that we already get from gnulib header files.
 135 sc_always_defined_macros: .re-defmac
 136         @if test -f $(srcdir)/src/system.h; then                        \
 137           trap 'rc=$$?; rm -f .re-defmac; exit $$rc' 0 1 2 3 15;        \
 138           grep -f .re-defmac $$($(VC_LIST))                             \
 139             && { echo '$(ME): define the above via some gnulib .h file' \
 140                   1>&2;  exit 1; } || :;                                \
 141         fi
 142
 143 # Create a list of regular expressions matching the names
 144 # of files included from system.h.  Exclude a couple.
 145 .re-list:
 146         @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \
 147           | grep -Ev 'sys/(param|file)\.h' \
 148           | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
 149           > $@-t
 150         @mv $@-t $@
 151
 152 # Files in src/ should not include directly any of
 153 # the headers already included via system.h.
 154 sc_system_h_headers: .re-list
 155         @if test -f $(srcdir)/src/system.h; then                        \
 156           trap 'rc=$$?; rm -f .re-list; exit $$rc' 0 1 2 3 15;          \
 157           grep -nE -f .re-list                                          \
 158               $$($(VC_LIST_EXCEPT) | grep '^src/')                      \
 159             && { echo '$(ME): the above are already included via system.h'\
 160                   1>&2;  exit 1; } || :;                                \
 161         fi
 162
 163 sc_sun_os_names:
 164         @grep -nEi \
 165             'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
 166             $$($(VC_LIST_EXCEPT)) &&                                    \
 167           { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;  \
 168             exit 1; } || :
 169
 170 ALL_RECURSIVE_TARGETS += sc_tight_scope
 171 sc_tight_scope:
 172         @$(MAKE) -s -C src $@
 173
 174 ALL_RECURSIVE_TARGETS += sc_check-AUTHORS
 175 sc_check-AUTHORS:
 176         @$(MAKE) -s -C src $@
 177
 178 # Option descriptions should not start with a capital letter
 179 # One could grep source directly as follows:
 180 # grep -E " {2,6}-.*[^.]  [A-Z][a-z]" $$($(VC_LIST_EXCEPT) | grep '\.c$$')
 181 # but that would miss descriptions not on the same line as the -option.
 182 ALL_RECURSIVE_TARGETS += sc_option_desc_uppercase
 183 sc_option_desc_uppercase:
 184         @$(MAKE) -s -C src all_programs
 185         @$(MAKE) -s -C man $@
 186
 187 # Ensure all man/*.[1x] files are present
 188 ALL_RECURSIVE_TARGETS += sc_man_file_correlation
 189 sc_man_file_correlation:
 190         @$(MAKE) -s -C src all_programs
 191         @$(MAKE) -s -C man $@
 192
 193 # Perl-based tests used to exec perl from a #!/bin/sh script.
 194 # Now they all start with #!/usr/bin/perl and the portability
 195 # infrastructure is in tests/Makefile.am.  Make sure no old-style
 196 # script sneaks back in.
 197 sc_no_exec_perl_coreutils:
 198         @if test -f $(srcdir)/tests/Coreutils.pm; then                  \
 199           grep '^exec  *\$$PERL.*MCoreutils' $$($(VC_LIST) tests) &&    \
 200             { echo 1>&2 '$(ME): found anachronistic Perl-based tests';  \
 201               exit 1; } || :;                                           \
 202         fi
 203
 204 # Don't use "readlink" or "readlinkat" directly
 205 sc_prohibit_readlink:
 206         @prohibit='\<readlink(at)? \('                                  \
 207         halt='do not use readlink(at); use via xreadlink or areadlink*' \
 208           $(_sc_search_regexp)
 209
 210 # Don't use address of "stat" or "lstat" functions
 211 sc_prohibit_stat_macro_address:
 212         @prohibit='\<l?stat '':|&l?stat\>'                              \
 213         halt='stat() and lstat() may be function-like macros'           \
 214           $(_sc_search_regexp)
 215
 216 # Ensure that date's --help output stays in sync with the info
 217 # documentation for GNU strftime.  The only exception is %N,
 218 # which date accepts but GNU strftime does not.
 219 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
 220 sc_strftime_check:
 221         @if test -f $(srcdir)/src/date.c; then                          \
 222           grep '^  %.  ' $(srcdir)/src/date.c | sort                    \
 223             | $(extract_char) > $@-src;                                 \
 224           { echo N;                                                     \
 225             info libc date calendar format 2>/dev/null|grep '^    `%.'\'\
 226               | $(extract_char); } | sort > $@-info;                    \
 227           diff -u $@-src $@-info || exit 1;                             \
 228           rm -f $@-src $@-info;                                         \
 229         fi
 230
 231 # Indent only with spaces.
 232 sc_prohibit_tab_based_indentation:
 233         @prohibit='^ *  '                                               \
 234         halt='TAB in indentation; use only spaces'                      \
 235           $(_sc_search_regexp)
 236
 237 # Don't use "indent-tabs-mode: nil" anymore.  No longer needed.
 238 sc_prohibit_emacs__indent_tabs_mode__setting:
 239         @prohibit='^( *[*#] *)?indent-tabs-mode:'                       \
 240         halt='use of emacs indent-tabs-mode: setting'                   \
 241           $(_sc_search_regexp)
 242
 243 # Ensure that each file that contains fail=1 also contains fail=0.
 244 # Otherwise, setting file=1 in the environment would make tests fail unexpectedly.
 245 sc_prohibit_fail_0:
 246         @prohibit='\<fail=0\>'                                          \
 247         halt='fail=0 initialization'                                    \
 248           $(_sc_search_regexp)
 249
 250 # Ensure that "stdio--.h" is used where appropriate.
 251 sc_require_stdio_safer:
 252         @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then    \
 253           files=$$(grep -l '\bfreopen \?(' $$($(VC_LIST_EXCEPT)         \
 254               | grep '\.[ch]$$'));                                      \
 255           test -n "$$files" && grep -LE 'include "stdio--.h"' $$files   \
 256               | grep . &&                                               \
 257           { echo '$(ME): the above files should use "stdio--.h"'        \
 258                 1>&2; exit 1; } || :;                                   \
 259         else :;                                                         \
 260         fi
 261
 262 # Prefer xnanosleep over other less-precise sleep methods
 263 sc_prohibit_sleep:
 264         @prohibit='\<(nano|u)?sleep \('                                 \
 265         halt='prefer xnanosleep over other sleep interfaces'            \
 266           $(_sc_search_regexp)
 267
 268 ###########################################################
 269 _p0 = \([^"'/]\|"\([^\"]\|[\].\)*"\|'\([^\']\|[\].\)*'
 270 _pre = $(_p0)\|[/][^"'/*]\|[/]"\([^\"]\|[\].\)*"\|[/]'\([^\']\|[\].\)*'\)*
 271 _pre_anchored = ^\($(_pre)\)
 272 _comment_and_close = [^*]\|[*][^/*]\)*[*][*]*/
 273 # help font-lock mode: '
 274
 275 # A sed expression that removes ANSI C and ISO C99 comments.
 276 # Derived from the one in GNU gettext's 'moopp' preprocessor.
 277 _sed_remove_comments =                                  \
 278 /[/][/*]/{                                              \
 279   ta;                                                   \
 280   :a;                                                   \
 281   s,$(_pre_anchored)//.*,\1,;                           \
 282   te;                                                   \
 283   s,$(_pre_anchored)/[*]\($(_comment_and_close),\1 ,;   \
 284   ta;                                                   \
 285   /^$(_pre)[/][*]/{                                     \
 286     s,$(_pre_anchored)/[*].*,\1 ,;                      \
 287     tu;                                                 \
 288     :u;                                                 \
 289     n;                                                  \
 290     s,^\($(_comment_and_close),,;                       \
 291     tv;                                                 \
 292     s,^.*$$,,;                                          \
 293     bu;                                                 \
 294     :v;                                                 \
 295   };                                                    \
 296   :e;                                                   \
 297 }
 298 # Quote all single quotes.
 299 _sed_rm_comments_q = $(subst ','\'',$(_sed_remove_comments))
 300 # help font-lock mode: '
 301
 302 _space_before_paren_exempt =? \\n\\$$
 303 _space_before_paren_exempt = \
 304   (^ *\#|\\n\\$$|%s\(to %s|(date|group|character)\(s\))
 305 # Ensure that there is a space before each open parenthesis in C code.
 306 sc_space_before_open_paren:
 307         @if $(VC_LIST_EXCEPT) | grep -l '\.[ch]$$' > /dev/null; then    \
 308           fail=0;                                                       \
 309           for c in $$($(VC_LIST_EXCEPT) | grep '\.[ch]$$'); do          \
 310             sed '$(_sed_rm_comments_q)' $$c 2>/dev/null                 \
 311               | grep -i '[[:alnum:]]('                                  \
 312               | grep -vE '$(_space_before_paren_exempt)'                \
 313               | grep . && { fail=1; echo "*** $$c"; };                  \
 314           done;                                                         \
 315           test $$fail = 1 &&                                            \
 316             { echo '$(ME): the above files lack a space-before-open-paren' \
 317                 1>&2; exit 1; } || :;                                   \
 318         else :;                                                         \
 319         fi
 320
 321 include $(srcdir)/dist-check.mk
 322
 323 update-copyright-env = \
 324   UPDATE_COPYRIGHT_USE_INTERVALS=1 \
 325   UPDATE_COPYRIGHT_MAX_LINE_LENGTH=79