top/maint.mk

   1 # -*-Makefile-*-
   2 # This Makefile fragment tries to be general-purpose enough to be
   3 # used by many projects via the gnulib maintainer-makefile module.
   4
   5 ## Copyright (C) 2001-2010 Free Software Foundation, Inc.
   6 ##
   7 ## This program is free software: you can redistribute it and/or modify
   8 ## it under the terms of the GNU General Public License as published by
   9 ## the Free Software Foundation, either version 3 of the License, or
  10 ## (at your option) any later version.
  11 ##
  12 ## This program is distributed in the hope that it will be useful,
  13 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 ## GNU General Public License for more details.
  16 ##
  17 ## You should have received a copy of the GNU General Public License
  18 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 # This is reported not to work with make-3.79.1
  21 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
  22 ME := maint.mk
  23
  24 # Override this in cfg.mk if you use a non-standard build-aux directory.
  25 build_aux ?= $(srcdir)/build-aux
  26
  27 # Do not save the original name or timestamp in the .tar.gz file.
  28 # Use --rsyncable if available.
  29 gzip_rsyncable := \
  30   $(shell gzip --help 2>/dev/null|grep rsyncable >/dev/null && echo --rsyncable)
  31 GZIP_ENV = '--no-name --best $(gzip_rsyncable)'
  32
  33 GIT = git
  34 VC = $(GIT)
  35 VC-tag = git tag -s -m '$(VERSION)' -u '$(gpg_key_ID)'
  36
  37 VC_LIST = $(build_aux)/vc-list-files -C $(srcdir)
  38
  39 # You can override this variable in cfg.mk to set your own regexp
  40 # matching files to ignore.
  41 VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$
  42
  43 # This is to preprocess robustly the output of $(VC_LIST), so that even
  44 # when $(srcdir) is a pathological name like "....", the leading sed command
  45 # removes only the intended prefix.
  46 _dot_escaped_srcdir = $(subst .,\.,$(srcdir))
  47
  48 # Post-process $(VC_LIST) output, prepending $(srcdir)/, but only
  49 # when $(srcdir) is not ".".
  50 ifeq ($(srcdir),.)
  51 _prepend_srcdir_prefix =
  52 else
  53 _prepend_srcdir_prefix = | sed 's|^|$(srcdir)/|'
  54 endif
  55
  56 # In order to be able to consistently filter "."-relative names,
  57 # (i.e., with no $(srcdir) prefix), this definition is careful to
  58 # remove any $(srcdir) prefix, and to restore what it removes.
  59 VC_LIST_EXCEPT = \
  60   $(VC_LIST) | sed 's|^$(_dot_escaped_srcdir)/||' \
  61         | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
  62           else grep -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \
  63         | grep -Ev -e '$(VC_LIST_ALWAYS_EXCLUDE_REGEX)' \
  64         $(_prepend_srcdir_prefix)
  65
  66 ifeq ($(origin prev_version_file), undefined)
  67   prev_version_file = $(srcdir)/.prev-version
  68 endif
  69
  70 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
  71 VERSION_REGEXP = $(subst .,\.,$(VERSION))
  72 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
  73
  74 ifeq ($(VC),$(GIT))
  75 this-vc-tag = v$(VERSION)
  76 this-vc-tag-regexp = v$(VERSION_REGEXP)
  77 else
  78 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
  79 tag-this-version = $(subst .,_,$(VERSION))
  80 this-vc-tag = $(tag-package)-$(tag-this-version)
  81 this-vc-tag-regexp = $(this-vc-tag)
  82 endif
  83 my_distdir = $(PACKAGE)-$(VERSION)
  84
  85 # Old releases are stored here.
  86 release_archive_dir ?= ../release
  87
  88 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
  89 # Use alpha.gnu.org for alpha and beta releases.
  90 # Use ftp.gnu.org for stable releases.
  91 gnu_ftp_host-alpha = alpha.gnu.org
  92 gnu_ftp_host-beta = alpha.gnu.org
  93 gnu_ftp_host-stable = ftp.gnu.org
  94 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
  95
  96 ifeq ($(gnu_rel_host),ftp.gnu.org)
  97 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
  98 else
  99 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
 100 endif
 101
 102 # Override this in cfg.mk if you are using a different format in your
 103 # NEWS file.
 104 today = $(shell date +%Y-%m-%d)
 105 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
 106
 107 # Prevent programs like 'sort' from considering distinct strings to be equal.
 108 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
 109 export LC_ALL = C
 110
 111 ## --------------- ##
 112 ## Sanity checks.  ##
 113 ## --------------- ##
 114
 115 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
 116
 117 # Collect the names of rules starting with `sc_'.
 118 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
 119                         $(srcdir)/$(ME) $(_cfg_mk)))
 120 .PHONY: $(syntax-check-rules)
 121
 122 local-checks-available = \
 123   $(syntax-check-rules)
 124 .PHONY: $(local-checks-available)
 125
 126 # Arrange to print the name of each syntax-checking rule just before running it.
 127 $(syntax-check-rules): %: %.m
 128 sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))
 129 .PHONY: $(sc_m_rules_)
 130 $(sc_m_rules_):
 131         @echo $(patsubst sc_%.m, %, $@)
 132
 133 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
 134
 135 syntax-check: $(local-check)
 136 #       @grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'         \
 137 #           $$(find -type f -name '*.[chly]') &&                        \
 138 #         { echo '$(ME): found conditional include' 1>&2;               \
 139 #           exit 1; } || :
 140
 141 #       grep -nE '^#  *include <(string|stdlib)\.h>'                    \
 142 #           $(srcdir)/{lib,src}/*.[chy] &&                              \
 143 #         { echo '$(ME): FIXME' 1>&2;                                   \
 144 #           exit 1; } || :
 145 # FIXME: don't allow `#include .strings\.h' anywhere
 146
 147 # _sc_search_regexp
 148 #
 149 # This macro searches for a given construct in the selected files and
 150 # then takes some action.
 151 #
 152 # Parameters (shell variables):
 153 #
 154 #  prohibit | require
 155 #
 156 #     Regular expression (ERE) denoting either a forbidden construct
 157 #     or a required construct.  Those arguments are exclusive.
 158 #
 159 #  in_vc_files | in_files
 160 #
 161 #     grep-E-style regexp denoting the files to check.  If no files
 162 #     are specified the default are all the files that are under
 163 #     version control.
 164 #
 165 #  containing | non_containing
 166 #
 167 #     Select the files (non) containing strings matching this regexp.
 168 #     If both arguments are specified then CONTAINING takes
 169 #     precedence.
 170 #
 171 #  with_grep_options
 172 #
 173 #     Extra options for grep.
 174 #
 175 #  ignore_case
 176 #
 177 #     Ignore case.
 178 #
 179 #  halt
 180 #
 181 #     Message to display before to halting execution.
 182
 183 # By default, _sc_search_regexp does not ignore case.
 184 export ignore_case =
 185 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
 186
 187 define _sc_say_and_exit
 188    dummy=; : so we do not need a semicolon before each use;             \
 189    { echo -e "$(ME): $$msg" 1>&2; exit 1; };
 190 endef
 191
 192 # _sc_search_regexp used to be named _prohibit_regexp.  However,
 193 # upgrading to the new definition and leaving the old name undefined
 194 # would usually convert each custom rule using $(_prohibit_regexp)
 195 # (usually defined in cfg.mk) into a no-op.  This definition ensures
 196 # that people know right away if they're still using the old name.
 197 # FIXME: remove in 2012.
 198 _prohibit_regexp = \
 199   $(error '*** you need to s/_prohibit_regexp/_sc_search_regexp/, and adapt')
 200
 201 define _sc_search_regexp
 202    dummy=; : so we do not need a semicolon before each use;             \
 203                                                                         \
 204    : Check arguments;                                                   \
 205    test -n "$$prohibit" && test -n "$$require"                          \
 206      && { msg='Cannot specify both prohibit and require'                \
 207           $(_sc_say_and_exit) } || :;                                   \
 208    test -z "$$prohibit" && test -z "$$require"                          \
 209      && { msg='Should specify either prohibit or require'               \
 210           $(_sc_say_and_exit) } || :;                                   \
 211    test -n "$$in_vc_files" && test -n "$$in_files"                      \
 212      && { msg='Cannot specify both in_vc_files and in_files'            \
 213           $(_sc_say_and_exit) } || :;                                   \
 214    test "x$$halt" != x                                                  \
 215      || { msg='halt not defined' $(_sc_say_and_exit) };                 \
 216                                                                         \
 217    : Filter by file name;                                               \
 218    if test -n "$$in_files"; then                                        \
 219      files=$$(find $(srcdir) | grep -E "$$in_files");                   \
 220    else                                                                 \
 221      files=$$($(VC_LIST_EXCEPT));                                       \
 222      if test -n "$$in_vc_files"; then                                   \
 223        files=$$(echo "$$files" | grep -E "$$in_vc_files");              \
 224      fi;                                                                \
 225    fi;                                                                  \
 226                                                                         \
 227    : Filter by content;                                                 \
 228    test -n "$$files" && test -n "$$containing"                          \
 229      && { files=$$(grep -l "$$containing" $$files); } || :;             \
 230    test -n "$$files" && test -n "$$non_containing"                      \
 231      && { files=$$(grep -vl "$$non_containing" $$files); } || :;        \
 232                                                                         \
 233    : Check for the construct;                                           \
 234    if test -n "$$files"; then                                           \
 235      if test -n "$$prohibit"; then                                      \
 236        grep $$with_grep_options $(_ignore_case) -nE "$$prohibit" $$files \
 237          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
 238      else                                                               \
 239        grep $$with_grep_options $(_ignore_case) -LE "$$require" $$files \
 240            | grep .                                                     \
 241          && { msg="$$halt" $(_sc_say_and_exit) } || :;                  \
 242      fi                                                                 \
 243    else :;                                                              \
 244    fi || :;
 245 endef
 246
 247 sc_avoid_if_before_free:
 248         @$(build_aux)/useless-if-before-free                            \
 249                 $(useless_free_options)                                 \
 250             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
 251           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
 252             exit 1; } || :
 253
 254 sc_cast_of_argument_to_free:
 255         @prohibit='\<free *\( *\(' halt='don'\''t cast free argument'   \
 256           $(_sc_search_regexp)
 257
 258 sc_cast_of_x_alloc_return_value:
 259         @prohibit='\*\) *x(m|c|re)alloc\>'                              \
 260         halt='don'\''t cast x*alloc return value'                       \
 261           $(_sc_search_regexp)
 262
 263 sc_cast_of_alloca_return_value:
 264         @prohibit='\*\) *alloca\>'                                      \
 265         halt='don'\''t cast alloca return value'                        \
 266           $(_sc_search_regexp)
 267
 268 sc_space_tab:
 269         @prohibit='[ ]  '                                               \
 270         halt='found SPACE-TAB sequence; remove the SPACE'               \
 271           $(_sc_search_regexp)
 272
 273 # Don't use *scanf or the old ato* functions in `real' code.
 274 # They provide no error checking mechanism.
 275 # Instead, use strto* functions.
 276 sc_prohibit_atoi_atof:
 277         @prohibit='\<([fs]?scanf|ato([filq]|ll)) *\('                           \
 278         halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q'   \
 279           $(_sc_search_regexp)
 280
 281 # Use STREQ rather than comparing strcmp == 0, or != 0.
 282 sc_prohibit_strcmp:
 283         @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *=='           \
 284             $$($(VC_LIST_EXCEPT))                                       \
 285           | grep -vE ':# *define STREQ\(' &&                            \
 286           { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
 287                 1>&2; exit 1; } || :
 288
 289 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
 290 # Convert all uses automatically, via these two commands:
 291 # git grep -l '\<exit *(1)' \
 292 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 293 #  | xargs --no-run-if-empty \
 294 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
 295 # git grep -l '\<exit *(0)' \
 296 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 297 #  | xargs --no-run-if-empty \
 298 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
 299 sc_prohibit_magic_number_exit:
 300         @prohibit='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'     \
 301         halt='use EXIT_* values rather than magic number'                       \
 302           $(_sc_search_regexp)
 303
 304 # Using EXIT_SUCCESS as the first argument to error is misleading,
 305 # since when that parameter is 0, error does not exit.  Use `0' instead.
 306 sc_error_exit_success:
 307         @prohibit='error *\(EXIT_SUCCESS,'                              \
 308         in_vc_files='\.[chly]$$'                                        \
 309         halt='found error (EXIT_SUCCESS'                                \
 310          $(_sc_search_regexp)
 311
 312 # `FATAL:' should be fully upper-cased in error messages
 313 # `WARNING:' should be fully upper-cased, or fully lower-cased
 314 sc_error_message_warn_fatal:
 315         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 316             | grep -E '"Warning|"Fatal|"fatal' &&                       \
 317           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
 318             exit 1; } || :
 319
 320 # Error messages should not start with a capital letter
 321 sc_error_message_uppercase:
 322         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 323             | grep -E '"[A-Z]'                                          \
 324             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
 325           { echo '$(ME): found capitalized error message' 1>&2;         \
 326             exit 1; } || :
 327
 328 # Error messages should not end with a period
 329 sc_error_message_period:
 330         @grep -nEA2 '[^rp]error *\(' $$($(VC_LIST_EXCEPT))              \
 331             | grep -E '[^."]\."' &&                                     \
 332           { echo '$(ME): found error message ending in period' 1>&2;    \
 333             exit 1; } || :
 334
 335 sc_file_system:
 336         @prohibit=file''system                                          \
 337         ignore_case=1                                                   \
 338         halt='found use of "file''system"; spell it "file system"'      \
 339           $(_sc_search_regexp)
 340
 341 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
 342 sc_prohibit_have_config_h:
 343         @prohibit='^# *if.*HAVE''_CONFIG_H'                             \
 344         halt='found use of HAVE''_CONFIG_H; remove'                     \
 345           $(_sc_search_regexp)
 346
 347 # Nearly all .c files must include <config.h>.  However, we also permit this
 348 # via inclusion of a package-specific header, if cfg.mk specified one.
 349 # config_h_header must be suitable for grep -E.
 350 config_h_header ?= <config\.h>
 351 sc_require_config_h:
 352         @require='^# *include $(config_h_header)'                       \
 353         in_vc_files='\.c$$'                                             \
 354         halt='the above files do not include <config.h>'                \
 355           $(_sc_search_regexp)
 356
 357 # You must include <config.h> before including any other header file.
 358 # This can possibly be via a package-specific header, if given by cfg.mk.
 359 sc_require_config_h_first:
 360         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 361           fail=0;                                                       \
 362           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
 363             grep '^# *include\>' $$i | sed 1q                           \
 364                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
 365               || { echo $$i; fail=1; };                                 \
 366           done;                                                         \
 367           test $$fail = 1 &&                                            \
 368             { echo '$(ME): the above files include some other header'   \
 369                 'before <config.h>' 1>&2; exit 1; } || :;               \
 370         else :;                                                         \
 371         fi
 372
 373 sc_prohibit_HAVE_MBRTOWC:
 374         @prohibit='\bHAVE_MBRTOWC\b'                                    \
 375         halt="do not use $$prohibit; it is always defined"              \
 376           $(_sc_search_regexp)
 377
 378 # To use this "command" macro, you must first define two shell variables:
 379 # h: the header, enclosed in <> or ""
 380 # re: a regular expression that matches IFF something provided by $h is used.
 381 define _sc_header_without_use
 382   dummy=; : so we do not need a semicolon before each use;              \
 383   h_esc=`echo "$$h"|sed 's/\./\\\\./g'`;                                \
 384   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
 385     files=$$(grep -l '^# *include '"$$h_esc"                            \
 386              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
 387     grep -LE "$$re" $$files | grep . &&                                 \
 388       { echo "$(ME): the above files include $$h but don't use it"      \
 389         1>&2; exit 1; } || :;                                           \
 390   else :;                                                               \
 391   fi
 392 endef
 393
 394 # Prohibit the inclusion of assert.h without an actual use of assert.
 395 sc_prohibit_assert_without_use:
 396         @h='<assert.h>' re='\<assert *\(' $(_sc_header_without_use)
 397
 398 # Prohibit the inclusion of close-stream.h without an actual use.
 399 sc_prohibit_close_stream_without_use:
 400         @h='"close-stream.h"' re='\<close_stream *\(' $(_sc_header_without_use)
 401
 402 # Prohibit the inclusion of getopt.h without an actual use.
 403 sc_prohibit_getopt_without_use:
 404         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_sc_header_without_use)
 405
 406 # Don't include quotearg.h unless you use one of its functions.
 407 sc_prohibit_quotearg_without_use:
 408         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_sc_header_without_use)
 409
 410 # Don't include quote.h unless you use one of its functions.
 411 sc_prohibit_quote_without_use:
 412         @h='"quote.h"' re='\<quote(_n)? *\(' $(_sc_header_without_use)
 413
 414 # Don't include this header unless you use one of its functions.
 415 sc_prohibit_long_options_without_use:
 416         @h='"long-options.h"' re='\<parse_long_options *\(' \
 417           $(_sc_header_without_use)
 418
 419 # Don't include this header unless you use one of its functions.
 420 sc_prohibit_inttostr_without_use:
 421         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
 422           $(_sc_header_without_use)
 423
 424 # Don't include this header unless you use one of its functions.
 425 sc_prohibit_ignore_value_without_use:
 426         @h='"ignore-value.h"' re='\<ignore_(value|ptr) *\(' \
 427           $(_sc_header_without_use)
 428
 429 # Don't include this header unless you use one of its functions.
 430 sc_prohibit_error_without_use:
 431         @h='"error.h"' \
 432         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
 433           $(_sc_header_without_use)
 434
 435 # Don't include xalloc.h unless you use one of its functions.
 436 # Consider these symbols:
 437 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
 438 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h
 439 # Divide into two sets on case, and filter each through this:
 440 # | sort | perl -MRegexp::Assemble -le \
 441 #  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
 442 # Note this was produced by the above:
 443 # _xa1 = \
 444 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
 445 # But we can do better, in at least two ways:
 446 # 1) take advantage of two "dup"-suffixed strings:
 447 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
 448 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
 449 # "char|[cmz]"
 450 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 451 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 452 _xa2 = X([CZ]|N?M)ALLOC
 453 sc_prohibit_xalloc_without_use:
 454         @h='"xalloc.h"' \
 455         re='\<($(_xa1)|$(_xa2)) *\('\
 456           $(_sc_header_without_use)
 457
 458 # Extract function names:
 459 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h
 460 _hash_re = \
 461 clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning
 462 _hash_fn = \<($(_hash_re)) *\(
 463 _hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>
 464 sc_prohibit_hash_without_use:
 465         @h='"hash.h"' \
 466         re='$(_hash_fn)|$(_hash_struct)'\
 467           $(_sc_header_without_use)
 468
 469 sc_prohibit_hash_pjw_without_use:
 470         @h='"hash-pjw.h"' \
 471         re='\<hash_pjw *\(' \
 472           $(_sc_header_without_use)
 473
 474 sc_prohibit_safe_read_without_use:
 475         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
 476           $(_sc_header_without_use)
 477
 478 sc_prohibit_argmatch_without_use:
 479         @h='"argmatch.h"' \
 480         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
 481           $(_sc_header_without_use)
 482
 483 sc_prohibit_canonicalize_without_use:
 484         @h='"canonicalize.h"' \
 485         re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
 486           $(_sc_header_without_use)
 487
 488 sc_prohibit_root_dev_ino_without_use:
 489         @h='"root-dev-ino.h"' \
 490         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
 491           $(_sc_header_without_use)
 492
 493 sc_prohibit_openat_without_use:
 494         @h='"openat.h"' \
 495         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
 496           $(_sc_header_without_use)
 497
 498 # Prohibit the inclusion of c-ctype.h without an actual use.
 499 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
 500 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
 501 sc_prohibit_c_ctype_without_use:
 502         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' \
 503           $(_sc_header_without_use)
 504
 505 _empty =
 506 _sp = $(_empty) $(_empty)
 507 # The following list was generated by running:
 508 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
 509 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
 510 _sig_functions = \
 511   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
 512   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
 513   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
 514   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
 515 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
 516 # The following were extracted from "man signal.h" manually.
 517 _sig_types_and_consts =                                                 \
 518   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
 519   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
 520   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
 521   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
 522   sigstack sigval stack_t ucontext_t
 523 # generated via this:
 524 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
 525 _sig_names =                                                            \
 526   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
 527   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
 528   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
 529   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
 530   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
 531   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
 532   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
 533   SIGXCPU SIGXFSZ
 534 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
 535
 536 # Prohibit the inclusion of signal.h without an actual use.
 537 sc_prohibit_signal_without_use:
 538         @h='<signal.h>'                                                 \
 539         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
 540           $(_sc_header_without_use)
 541
 542 # Get the list of symbol names with this:
 543 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/intprops.h|grep -v '^s'|fmt
 544 _intprops_names =                                                       \
 545   TYPE_IS_INTEGER TYPE_TWOS_COMPLEMENT TYPE_ONES_COMPLEMENT             \
 546   TYPE_SIGNED_MAGNITUDE TYPE_SIGNED TYPE_MINIMUM TYPE_MAXIMUM           \
 547   INT_STRLEN_BOUND INT_BUFSIZE_BOUND
 548 _intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))
 549 # Prohibit the inclusion of intprops.h without an actual use.
 550 sc_prohibit_intprops_without_use:
 551         @h='"intprops.h"'                                               \
 552         re='\<($(_intprops_syms_re)) *\('                               \
 553           $(_sc_header_without_use)
 554
 555 sc_obsolete_symbols:
 556         @prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                     \
 557         halt='do not use HAVE''_FCNTL_H or O'_NDELAY                    \
 558           $(_sc_search_regexp)
 559
 560 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 561
 562 # Each nonempty ChangeLog line must start with a year number, or a TAB.
 563 sc_changelog:
 564         @prohibit='^[^12        ]'                                      \
 565         in_vc_files='^ChangeLog$$'                                      \
 566         halt='found unexpected prefix in a ChangeLog'                   \
 567           $(_sc_search_regexp)
 568
 569 # Ensure that each .c file containing a "main" function also
 570 # calls set_program_name.
 571 sc_program_name:
 572         @require='set_program_name *\(m?argv\[0\]\);'                   \
 573         in_vc_files='\.c$$'                                             \
 574         containing='^main *('                                           \
 575         halt='the above files do not call set_program_name'             \
 576           $(_sc_search_regexp)
 577
 578 # Require that the final line of each test-lib.sh-using test be this one:
 579 # Exit $fail
 580 # Note: this test requires GNU grep's --label= option.
 581 Exit_witness_file ?= tests/test-lib.sh
 582 Exit_base := $(notdir $(Exit_witness_file))
 583 sc_require_test_exit_idiom:
 584         @if test -f $(srcdir)/$(Exit_witness_file); then                \
 585           die=0;                                                        \
 586           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
 587                 $$($(VC_LIST) tests)); do                               \
 588             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
 589               && : || { die=1; echo $$i; }                              \
 590           done;                                                         \
 591           test $$die = 1 &&                                             \
 592             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
 593               echo 1>&2 'Exit something';                               \
 594               exit 1; } || :;                                           \
 595         fi
 596
 597 sc_the_the:
 598         @prohibit='\<the ''the\>'                                       \
 599         ignore_case=1                                                   \
 600         halt='found use of "the ''the";'                                \
 601           $(_sc_search_regexp)
 602
 603 sc_trailing_blank:
 604         @prohibit='[     ]$$'                                           \
 605         halt='found trailing blank(s)'                                  \
 606           $(_sc_search_regexp)
 607
 608 # Match lines like the following, but where there is only one space
 609 # between the options and the description:
 610 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
 611 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
 612 sc_two_space_separator_in_usage:
 613         @prohibit='^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
 614         halt='help2man requires at least two spaces between an option and its description'\
 615           $(_sc_search_regexp)
 616
 617 # Look for diagnostics that aren't marked for translation.
 618 # This won't find any for which error's format string is on a separate line.
 619 sc_unmarked_diagnostics:
 620         @grep -nE                                                       \
 621             '\<error *\([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))      \
 622           | grep -v '_''(' &&                                           \
 623           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
 624             exit 1; } || :
 625
 626 # Avoid useless parentheses like those in this example:
 627 # #if defined (SYMBOL) || defined (SYM2)
 628 sc_useless_cpp_parens:
 629         @prohibit='^# *if .*defined *\('                                \
 630         halt='found useless parentheses in cpp directive'               \
 631           $(_sc_search_regexp)
 632
 633 # Require the latest GPL.
 634 sc_GPL_version:
 635         @prohibit='either ''version [^3]'                               \
 636         halt='GPL vN, N!=3'                                             \
 637           $(_sc_search_regexp)
 638
 639 # Require the latest GFDL.  Two regexp, since some .texi files end up
 640 # line wrapping between 'Free Documentation License,' and 'Version'.
 641 _GFDL_regexp = (Free ''Documentation.*Version 1\.[^3]|Version 1\.[^3] or any)
 642 sc_GFDL_version:
 643         @prohibit='$(_GFDL_regexp)'                                     \
 644         halt='GFDL vN, N!=3'                                            \
 645           $(_sc_search_regexp)
 646
 647 # Don't use Texinfo @acronym{} as it is not a good idea.
 648 sc_texinfo_acronym:
 649         @prohibit='@acronym{'                                           \
 650         in_vc_files='\.texi$$'                                          \
 651         halt='found use of Texinfo @acronym{}'                          \
 652           $(_sc_search_regexp)
 653
 654 cvs_keywords = \
 655   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
 656
 657 sc_prohibit_cvs_keyword:
 658         @prohibit='\$$($(cvs_keywords))\$$'                             \
 659         halt='do not use CVS keyword expansion'                         \
 660           $(_sc_search_regexp)
 661
 662 # The following tail+perl pipeline would be more concise, and would
 663 # produce slightly better output (including counts) if written as
 664 #   perl -ln -0777 -e '/\n(\n+)$/ and print "$ARGV: ".length $1' ...
 665 # but that would be far less efficient, reading the entire contents
 666 # of each file, rather than just the last few bytes of each.
 667 #
 668 # This is a perl script that operates on the output of
 669 # tail -n1 TWO_OR_MORE_FILES
 670 # Print the name of each file that ends in two or more newline bytes.
 671 # Exit nonzero if at least one such file is found, otherwise, exit 0.
 672 #
 673 # Use this if you want to remove trailing empty lines from selected files:
 674 #   perl -pi -0777 -e 's/\n\n+$/\n/' files...
 675 #
 676 detect_empty_lines_at_EOF_ =                                            \
 677   /^==> ([^\n]+) <==\n\n\n/m and (print "$$1\n"), $$fail = 1;           \
 678   END { exit defined $$fail }
 679 sc_prohibit_empty_lines_at_EOF:
 680         @tail -n1 $$($(VC_LIST_EXCEPT)) /dev/null                       \
 681             | perl -00 -ne '$(detect_empty_lines_at_EOF_)'              \
 682           || { echo '$(ME): the above files end with empty line(s)'     \
 683                 1>&2; exit 1; } || :;                                   \
 684
 685 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
 686 # This is a bit of a kludge, since it prevents use of the string
 687 # even in comments, but for now it does the job with no false positives.
 688 sc_prohibit_stat_st_blocks:
 689         @prohibit='[.>]st_blocks'                                       \
 690         halt='do not use st_blocks; use ST_NBLOCKS'                     \
 691           $(_sc_search_regexp)
 692
 693 # Make sure we don't define any S_IS* macros in src/*.c files.
 694 # They're already defined via gnulib's sys/stat.h replacement.
 695 sc_prohibit_S_IS_definition:
 696         @prohibit='^ *# *define  *S_IS'                                 \
 697         halt='do not define S_IS* macros; include <sys/stat.h>'         \
 698           $(_sc_search_regexp)
 699
 700 _ptm1 = use "test C1 && test C2", not "test C1 -''a C2"
 701 _ptm2 = use "test C1 || test C2", not "test C1 -''o C2"
 702 # Using test's -a and -o operators is not portable.
 703 # We prefer test over [, since the latter is spelled [[ in configure.ac.
 704 sc_prohibit_test_minus_ao:
 705         @prohibit='(\<test| \[+) .+ -[ao] '                             \
 706         halt='$(_ptm1); $(_ptm2)'                                       \
 707           $(_sc_search_regexp)
 708
 709 # Each program that uses proper_name_utf8 must link with one of the
 710 # ICONV libraries.  Otherwise, some ICONV library must appear in LDADD.
 711 # The perl -0777 invocation below extracts the possibly-multi-line
 712 # definition of LDADD from the appropriate Makefile.am and exits 0
 713 # when it contains "ICONV".
 714 sc_proper_name_utf8_requires_ICONV:
 715         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
 716         if test "x$$progs" != x; then                                   \
 717           fail=0;                                                       \
 718           for p in $$progs; do                                          \
 719             dir=$$(dirname "$$p");                                      \
 720             perl -0777                                                  \
 721               -ne 'exit !(/^LDADD =(.+?[^\\]\n)/ms && $$1 =~ /ICONV/)'  \
 722               $$dir/Makefile.am && continue;                            \
 723             base=$$(basename "$$p" .c);                                 \
 724             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
 725               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
 726           done;                                                         \
 727           test $$fail = 1 &&                                            \
 728             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
 729               exit 1; } || :;                                           \
 730         fi
 731
 732 # Warn about "c0nst struct Foo const foo[]",
 733 # but not about "char const *const foo" or "#define const const".
 734 sc_redundant_const:
 735         @prohibit='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'          \
 736         halt='redundant "const" in declarations'                        \
 737           $(_sc_search_regexp)
 738
 739 sc_const_long_option:
 740         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
 741           | grep -Ev 'const struct option|struct option const' && {     \
 742               echo 1>&2 '$(ME): add "const" to the above declarations'; \
 743               exit 1; } || :
 744
 745 NEWS_hash =                                                             \
 746   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
 747        $(srcdir)/NEWS                                                   \
 748      | perl -0777 -pe                                                   \
 749         's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms'       \
 750      | md5sum -                                                         \
 751      | sed 's/ .*//')
 752
 753 # Ensure that we don't accidentally insert an entry into an old NEWS block.
 754 sc_immutable_NEWS:
 755         @if test -f $(srcdir)/NEWS; then                                \
 756           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
 757             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
 758         fi
 759
 760 # Update the hash stored above.  Do this after each release and
 761 # for any corrections to old entries.
 762 update-NEWS-hash: NEWS
 763         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
 764           $(srcdir)/cfg.mk
 765
 766 # Ensure that we use only the standard $(VAR) notation,
 767 # not @...@ in Makefile.am, now that we can rely on automake
 768 # to emit a definition for each substituted variable.
 769 # We use perl rather than "grep -nE ..." to exempt a single
 770 # use of an @...@-delimited variable name in src/Makefile.am.
 771 # Allow the package to add exceptions via a hook in cfg.mk;
 772 # for example, @PRAGMA_SYSTEM_HEADER@ can be permitted by
 773 # setting this to ' && !/PRAGMA_SYSTEM_HEADER/'.
 774 _makefile_at_at_check_exceptions ?=
 775 sc_makefile_at_at_check:
 776         @perl -ne '/\@[A-Z_0-9]+\@/'$(_makefile_at_at_check_exceptions) \
 777           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
 778             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
 779           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
 780
 781 news-check: NEWS
 782         if head $(srcdir)/NEWS | grep -E $(news-check-regexp)           \
 783             >/dev/null; then                                            \
 784           :;                                                            \
 785         else                                                            \
 786           echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2;      \
 787           exit 1;                                                       \
 788         fi
 789
 790 sc_makefile_TAB_only_indentation:
 791         @prohibit='^    [ ]{8}'                                         \
 792         in_vc_files='akefile|\.mk$$'                                    \
 793         halt='found TAB-8-space indentation'                            \
 794           $(_sc_search_regexp)
 795
 796 sc_m4_quote_check:
 797         @prohibit='(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
 798         in_vc_files='(^configure\.ac|\.m4)$$'                           \
 799         halt='quote the first arg to AC_DEF*'                           \
 800           $(_sc_search_regexp)
 801
 802 fix_po_file_diag = \
 803 'you have changed the set of files with translatable diagnostics;\n\
 804 apply the above patch\n'
 805
 806 # Verify that all source files using _() are listed in po/POTFILES.in.
 807 po_file = po/POTFILES.in
 808 sc_po_check:
 809         @if test -f $(po_file); then                                    \
 810           grep -E -v '^(#|$$)' $(po_file)                               \
 811             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
 812           files=;                                                       \
 813           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
 814             test -r $$file || continue;                                 \
 815             case $$file in                                              \
 816               *.m4|*.mk) continue ;;                                    \
 817               *.?|*.??) ;;                                              \
 818               *) continue;;                                             \
 819             esac;                                                       \
 820             case $$file in                                              \
 821             *.[ch])                                                     \
 822               base=`expr " $$file" : ' \(.*\)\..'`;                     \
 823               { test -f $$base.l || test -f $$base.y; } && continue;;   \
 824             esac;                                                       \
 825             files="$$files $$file";                                     \
 826           done;                                                         \
 827           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
 828             | sort -u > $@-2;                                           \
 829           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
 830             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
 831           rm -f $@-1 $@-2;                                              \
 832         fi
 833
 834 # Sometimes it is useful to change the PATH environment variable
 835 # in Makefiles.  When doing so, it's better not to use the Unix-centric
 836 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
 837 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
 838 sc_makefile_path_separator_check:
 839         @prohibit='PATH[=].*:'                                          \
 840         in_vc_files='akefile|\.mk$$'                                    \
 841         halt=$(msg)                                                     \
 842           $(_sc_search_regexp)
 843
 844 # Check that `make alpha' will not fail at the end of the process.
 845 writable-files:
 846         if test -d $(release_archive_dir); then :; else                 \
 847           for file in $(distdir).tar.gz                                 \
 848                       $(release_archive_dir)/$(distdir).tar.gz; do      \
 849             test -e $$file || continue;                                 \
 850             test -w $$file                                              \
 851               || { echo ERROR: $$file is not writable; fail=1; };       \
 852           done;                                                         \
 853           test "$$fail" && exit 1 || : ;                                \
 854         fi
 855
 856 v_etc_file = lib/version-etc.c
 857 sample-test = tests/sample-test
 858 texi = doc/$(PACKAGE).texi
 859 # Make sure that the copyright date in $(v_etc_file) is up to date.
 860 # Do the same for the $(sample-test) and the main doc/.texi file.
 861 sc_copyright_check:
 862         @require='enum { COPYRIGHT_YEAR = '$$(date +%Y)' };'            \
 863         in_files=$(v_etc_file)                                          \
 864         halt='out of date copyright in $(v_etc_file); update it'        \
 865           $(_sc_search_regexp)
 866         @require='# Copyright \(C\) '$$(date +%Y)' Free'                \
 867         in_vc_files=$(sample-test)                                      \
 868         halt='out of date copyright in $(sample-test); update it'       \
 869           $(_sc_search_regexp)
 870         @require='Copyright @copyright\{\} .*'$$(date +%Y)' Free'       \
 871         in_vc_files=$(texi)                                             \
 872         halt='out of date copyright in $(texi); update it'              \
 873           $(_sc_search_regexp)
 874
 875 # If tests/help-version exists and seems to be new enough, assume that its
 876 # use of init.sh and path_prepend_ is correct, and ensure that every other
 877 # use of init.sh is identical.
 878 # This is useful because help-version cross-checks prog --version
 879 # with $(VERSION), which verifies that its path_prepend_ invocation
 880 # sets PATH correctly.  This is an inexpensive way to ensure that
 881 # the other init.sh-using tests also get it right.
 882 _hv_file ?= $(srcdir)/tests/help-version
 883 _hv_regex ?= ^ *\. [^ ]*/init\.sh
 884 sc_cross_check_PATH_usage_in_tests:
 885         @if test -f $(_hv_file); then                                   \
 886           if grep -l 'VERSION mismatch' $(_hv_file) >/dev/null          \
 887               && grep -lE '$(_hv_regex)' $(_hv_file) >/dev/null; then   \
 888             good=$$(grep -E '$(_hv_regex)' < $(_hv_file));              \
 889             grep -LFx "$$good"                                          \
 890                   $$(grep -lE '$(_hv_regex)' $$($(VC_LIST_EXCEPT)))     \
 891                 | grep . &&                                             \
 892               { echo "$(ME): the above files use path_prepend_ inconsistently" \
 893                   1>&2; exit 1; } || :;                                 \
 894           fi;                                                           \
 895         else                                                            \
 896           echo "$@: skipped: no such file: $(_hv_file)";                \
 897         fi
 898
 899 # #if HAVE_... will evaluate to false for any non numeric string.
 900 # That would be flagged by using -Wundef, however gnulib currently
 901 # tests many undefined macros, and so we can't enable that option.
 902 # So at least preclude common boolean strings as macro values.
 903 sc_Wundef_boolean:
 904         @prohibit='^#define.*(yes|no|true|false)$$'                     \
 905         in_files='$(CONFIG_INCLUDE)'                                    \
 906         halt='Use 0 or 1 for macro values'                              \
 907           $(_sc_search_regexp)
 908
 909 sc_vulnerable_makefile_CVE-2009-4029:
 910         @prohibit='perm -777 -exec chmod a\+rwx|chmod 777 \$$\(distdir\)' \
 911         in_files=$$(find $(srcdir) -name Makefile.in)                   \
 912         halt='the above files are vulnerable; beware of running\n'\
 913 '"make dist*" rules, and upgrade to fixed automake\n'\
 914 'see http://bugzilla.redhat.com/542609 for details'                     \
 915           $(_sc_search_regexp)
 916
 917 vc-diff-check:
 918         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
 919         if test -s vc-diffs; then                               \
 920           cat vc-diffs;                                         \
 921           echo "Some files are locally modified:" 1>&2;         \
 922           exit 1;                                               \
 923         else                                                    \
 924           rm vc-diffs;                                          \
 925         fi
 926
 927 rel-files = $(DIST_ARCHIVES)
 928
 929 gnulib_dir ?= $(srcdir)/gnulib
 930 gnulib-version = $$(cd $(gnulib_dir) && git describe)
 931 bootstrap-tools ?= autoconf,automake,gnulib
 932
 933 # If it's not already specified, derive the GPG key ID from
 934 # the signed tag we've just applied to mark this release.
 935 gpg_key_ID ?= \
 936   $$(git cat-file tag v$(VERSION) > .ann-sig \
 937      && gpgv .ann-sig - < /dev/null 2>&1 \
 938           | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
 939
 940 announcement: NEWS ChangeLog $(rel-files)
 941         @$(build_aux)/announce-gen                                      \
 942             --release-type=$(RELEASE_TYPE)                              \
 943             --package=$(PACKAGE)                                        \
 944             --prev=$(PREV_VERSION)                                      \
 945             --curr=$(VERSION)                                           \
 946             --gpg-key-id=$(gpg_key_ID)                                  \
 947             --news=$(srcdir)/NEWS                                       \
 948             --bootstrap-tools=$(bootstrap-tools)                        \
 949             --gnulib-version=$(gnulib-version)                          \
 950             --no-print-checksums                                        \
 951             $(addprefix --url-dir=, $(url_dir_list))
 952
 953 ## ---------------- ##
 954 ## Updating files.  ##
 955 ## ---------------- ##
 956
 957 ftp-gnu = ftp://ftp.gnu.org/gnu
 958 www-gnu = http://www.gnu.org
 959
 960 upload_dest_dir_ ?= $(PACKAGE)
 961 emit_upload_commands:
 962         @echo =====================================
 963         @echo =====================================
 964         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
 965         @echo "    --to $(gnu_rel_host):$(upload_dest_dir_) \\"
 966         @echo "  $(rel-files)"
 967         @echo '# send the ~/announce-$(my_distdir) e-mail'
 968         @echo =====================================
 969         @echo =====================================
 970
 971 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
 972 define emit-commit-log
 973   printf '%s\n' 'post-release administrivia' '' \
 974     '* NEWS: Add header line for next release.' \
 975     '* .prev-version: Record previous version.' \
 976     '* cfg.mk (old_NEWS_hash): Auto-update.'
 977 endef
 978
 979 .PHONY: no-submodule-changes
 980 no-submodule-changes:
 981         if test -d $(srcdir)/.git; then                                 \
 982           diff=$$(cd $(srcdir) && git submodule -q foreach              \
 983                   git diff-index --name-only HEAD)                      \
 984             || exit 1;                                                  \
 985           case $$diff in '') ;;                                         \
 986             *) echo '$(ME): submodule files are locally modified:';     \
 987                 echo "$$diff"; exit 1;; esac;                           \
 988         else                                                            \
 989           : ;                                                           \
 990         fi
 991
 992 .PHONY: alpha beta stable
 993 ALL_RECURSIVE_TARGETS += alpha beta stable
 994 alpha beta stable: $(local-check) writable-files no-submodule-changes
 995         test $@ = stable                                                \
 996           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$'         \
 997                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
 998           || :
 999         $(MAKE) vc-diff-check
1000         $(MAKE) news-check
1001         $(MAKE) distcheck
1002         $(MAKE) dist XZ_OPT=-9ev
1003         $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
1004         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
1005
1006 # Override this in cfg.mk if you follow different procedures.
1007 release-prep-hook ?= release-prep
1008
1009 .PHONY: release-prep
1010 release-prep:
1011         case $$RELEASE_TYPE in alpha|beta|stable) ;; \
1012           *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
1013         $(MAKE) -s announcement > ~/announce-$(my_distdir)
1014         if test -d $(release_archive_dir); then                 \
1015           ln $(rel-files) $(release_archive_dir);               \
1016           chmod a-w $(rel-files);                               \
1017         fi
1018         echo $(VERSION) > $(prev_version_file)
1019         $(MAKE) update-NEWS-hash
1020         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
1021         $(emit-commit-log) > .ci-msg
1022         $(VC) commit -F .ci-msg -a
1023         rm .ci-msg
1024
1025 .PHONY: web-manual
1026 web-manual:
1027         @test -z "$(manual_title)" \
1028           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
1029         @cd '$(srcdir)/doc'; \
1030           $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
1031              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
1032             "$(PACKAGE_NAME) - $(manual_title)"
1033         @echo " *** Upload the doc/manual directory to web-cvs."
1034
1035 # Code Coverage
1036
1037 init-coverage:
1038         $(MAKE) $(AM_MAKEFLAGS) clean
1039         lcov --directory . --zerocounters
1040
1041 COVERAGE_CCOPTS ?= "-g --coverage"
1042 COVERAGE_OUT ?= doc/coverage
1043
1044 build-coverage:
1045         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
1046         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
1047         mkdir -p $(COVERAGE_OUT)
1048         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
1049                 --capture
1050
1051 gen-coverage:
1052         genhtml --output-directory $(COVERAGE_OUT) \
1053                 $(COVERAGE_OUT)/$(PACKAGE).info \
1054                 --highlight --frames --legend \
1055                 --title "$(PACKAGE_NAME)"
1056
1057 coverage: init-coverage build-coverage gen-coverage
1058
1059 # Update gettext files.
1060 PACKAGE ?= $(shell basename $(PWD))
1061 PO_DOMAIN ?= $(PACKAGE)
1062 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
1063 PODIR ?= po
1064 refresh-po:
1065         rm -f $(PODIR)/*.po && \
1066         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
1067         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
1068         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
1069         echo 'en@quot' >> $(PODIR)/LINGUAS && \
1070         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
1071
1072 INDENT_SOURCES ?= $(C_SOURCES)
1073 .PHONY: indent
1074 indent:
1075         indent $(INDENT_SOURCES)
1076
1077 # If you want to set UPDATE_COPYRIGHT_* environment variables,
1078 # put the assignments in this variable.
1079 update-copyright-env ?=
1080
1081 # Run this rule once per year (usually early in January)
1082 # to update all FSF copyright year lists in your project.
1083 # If you have an additional project-specific rule,
1084 # add it in cfg.mk along with a line 'update-copyright: prereq'.
1085 # By default, exclude all variants of COPYING; you can also
1086 # add exemptions (such as ChangeLog..* for rotated change logs)
1087 # in the file .x-update-copyright.
1088 .PHONY: update-copyright
1089 update-copyright:
1090         grep -l -w Copyright                                             \
1091           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
1092           | $(update-copyright-env) xargs $(build_aux)/$@