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 VC_LIST_EXCEPT = \
  40   $(VC_LIST) | if test -f $(srcdir)/.x-$@; then grep -vEf $(srcdir)/.x-$@; \
  41                else grep -Ev "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi
  42
  43 ifeq ($(origin prev_version_file), undefined)
  44   prev_version_file = $(srcdir)/.prev-version
  45 endif
  46
  47 PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)
  48 VERSION_REGEXP = $(subst .,\.,$(VERSION))
  49 PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))
  50
  51 ifeq ($(VC),$(GIT))
  52 this-vc-tag = v$(VERSION)
  53 this-vc-tag-regexp = v$(VERSION_REGEXP)
  54 else
  55 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
  56 tag-this-version = $(subst .,_,$(VERSION))
  57 this-vc-tag = $(tag-package)-$(tag-this-version)
  58 this-vc-tag-regexp = $(this-vc-tag)
  59 endif
  60 my_distdir = $(PACKAGE)-$(VERSION)
  61
  62 # Old releases are stored here.
  63 release_archive_dir ?= ../release
  64
  65 # Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.
  66 # Use alpha.gnu.org for alpha and beta releases.
  67 # Use ftp.gnu.org for stable releases.
  68 gnu_ftp_host-alpha = alpha.gnu.org
  69 gnu_ftp_host-beta = alpha.gnu.org
  70 gnu_ftp_host-stable = ftp.gnu.org
  71 gnu_rel_host ?= $(gnu_ftp_host-$(RELEASE_TYPE))
  72
  73 ifeq ($(gnu_rel_host),ftp.gnu.org)
  74 url_dir_list ?= http://ftpmirror.gnu.org/$(PACKAGE)
  75 else
  76 url_dir_list ?= ftp://$(gnu_rel_host)/gnu/$(PACKAGE)
  77 endif
  78
  79 # Override this in cfg.mk if you are using a different format in your
  80 # NEWS file.
  81 today = $(shell date +%Y-%m-%d)
  82 news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'
  83
  84 # Prevent programs like 'sort' from considering distinct strings to be equal.
  85 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
  86 export LC_ALL = C
  87
  88 ## --------------- ##
  89 ## Sanity checks.  ##
  90 ## --------------- ##
  91
  92 _cfg_mk := $(shell test -f $(srcdir)/cfg.mk && echo '$(srcdir)/cfg.mk')
  93
  94 # Collect the names of rules starting with `sc_'.
  95 syntax-check-rules := $(sort $(shell sed -n 's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' \
  96                         $(srcdir)/$(ME) $(_cfg_mk)))
  97 .PHONY: $(syntax-check-rules)
  98
  99 local-checks-available = \
 100   $(syntax-check-rules)
 101 .PHONY: $(local-checks-available)
 102
 103 # Arrange to print the name of each syntax-checking rule just before running it.
 104 $(syntax-check-rules): %: %.m
 105 $(patsubst %, %.m, $(syntax-check-rules)):
 106         @echo $(patsubst sc_%.m, %, $@)
 107
 108 local-check := $(filter-out $(local-checks-to-skip), $(local-checks-available))
 109
 110 syntax-check: $(local-check)
 111 #       @grep -nE '#  *include <(limits|std(def|arg|bool))\.h>'         \
 112 #           $$(find -type f -name '*.[chly]') &&                        \
 113 #         { echo '$(ME): found conditional include' 1>&2;               \
 114 #           exit 1; } || :
 115
 116 #       grep -nE '^#  *include <(string|stdlib)\.h>'                    \
 117 #           $(srcdir)/{lib,src}/*.[chy] &&                              \
 118 #         { echo '$(ME): FIXME' 1>&2;                                   \
 119 #           exit 1; } || :
 120 # FIXME: don't allow `#include .strings\.h' anywhere
 121
 122 # By default, _prohibit_regexp does not ignore case.
 123 export ignore_case =
 124 _ignore_case = $$(test -n "$$ignore_case" && echo -i || :)
 125
 126 # There are many rules below that prohibit constructs in this package.
 127 # If the offending construct can be matched with a grep-E-style regexp,
 128 # use this macro.  The shell variables "re" and "msg" must be defined.
 129 define _prohibit_regexp
 130   dummy=; : so we do not need a semicolon before each use;              \
 131   test "x$$re" != x || { echo '$(ME): re not defined' 1>&2; exit 1; };  \
 132   test "x$$msg" != x || { echo '$(ME): msg not defined' 1>&2; exit 1; };\
 133   grep $(_ignore_case) -nE "$$re" $$($(VC_LIST_EXCEPT)) &&              \
 134     { echo '$(ME): '"$$msg" 1>&2; exit 1; } || :
 135 endef
 136
 137 sc_avoid_if_before_free:
 138         @$(build_aux)/useless-if-before-free                            \
 139                 $(useless_free_options)                                 \
 140             $$($(VC_LIST_EXCEPT) | grep -v useless-if-before-free) &&   \
 141           { echo '$(ME): found useless "if" before "free" above' 1>&2;  \
 142             exit 1; } || :
 143
 144 sc_cast_of_argument_to_free:
 145         @re='\<free *\( *\(' msg='don'\''t cast free argument'          \
 146           $(_prohibit_regexp)
 147
 148 sc_cast_of_x_alloc_return_value:
 149         @re='\*\) *x(m|c|re)alloc\>'                                    \
 150         msg='don'\''t cast x*alloc return value'                        \
 151           $(_prohibit_regexp)
 152
 153 sc_cast_of_alloca_return_value:
 154         @re='\*\) *alloca\>' msg='don'\''t cast alloca return value'    \
 155           $(_prohibit_regexp)
 156
 157 sc_space_tab:
 158         @re='[ ]        ' msg='found SPACE-TAB sequence; remove the SPACE' \
 159           $(_prohibit_regexp)
 160
 161 # Don't use *scanf or the old ato* functions in `real' code.
 162 # They provide no error checking mechanism.
 163 # Instead, use strto* functions.
 164 sc_prohibit_atoi_atof:
 165         @re='\<([fs]?scanf|ato([filq]|ll)) *\('                         \
 166         msg='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q' \
 167           $(_prohibit_regexp)
 168
 169 # Use STREQ rather than comparing strcmp == 0, or != 0.
 170 sc_prohibit_strcmp:
 171         @grep -nE '! *str''cmp *\(|\<str''cmp *\([^)]+\) *=='           \
 172             $$($(VC_LIST_EXCEPT))                                       \
 173           | grep -vE ':# *define STREQ\(' &&                            \
 174           { echo '$(ME): use STREQ in place of the above uses of str''cmp' \
 175                 1>&2; exit 1; } || :
 176
 177 # Pass EXIT_*, not number, to usage, exit, and error (when exiting)
 178 # Convert all uses automatically, via these two commands:
 179 # git grep -l '\<exit *(1)' \
 180 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 181 #  | xargs --no-run-if-empty \
 182 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'
 183 # git grep -l '\<exit *(0)' \
 184 #  | grep -vEf .x-sc_prohibit_magic_number_exit \
 185 #  | xargs --no-run-if-empty \
 186 #      perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'
 187 sc_prohibit_magic_number_exit:
 188         @re='(^|[^.])\<(usage|exit) ?\([0-9]|\<error ?\([1-9][0-9]*,'   \
 189         msg='use EXIT_* values rather than magic number'                \
 190           $(_prohibit_regexp)
 191
 192 # Using EXIT_SUCCESS as the first argument to error is misleading,
 193 # since when that parameter is 0, error does not exit.  Use `0' instead.
 194 sc_error_exit_success:
 195         @grep -nE 'error \(EXIT_SUCCESS,'                               \
 196             $$($(VC_LIST_EXCEPT) | grep -E '\.[chly]$$') &&             \
 197           { echo '$(ME): found error (EXIT_SUCCESS' 1>&2; exit 1; } || :
 198
 199 # `FATAL:' should be fully upper-cased in error messages
 200 # `WARNING:' should be fully upper-cased, or fully lower-cased
 201 sc_error_message_warn_fatal:
 202         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 203             | grep -E '"Warning|"Fatal|"fatal' &&                       \
 204           { echo '$(ME): use FATAL, WARNING or warning' 1>&2;           \
 205             exit 1; } || :
 206
 207 # Error messages should not start with a capital letter
 208 sc_error_message_uppercase:
 209         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 210             | grep -E '"[A-Z]'                                          \
 211             | grep -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX' &&           \
 212           { echo '$(ME): found capitalized error message' 1>&2;         \
 213             exit 1; } || :
 214
 215 # Error messages should not end with a period
 216 sc_error_message_period:
 217         @grep -nEA2 '[^rp]error \(' $$($(VC_LIST_EXCEPT))               \
 218             | grep -E '[^."]\."' &&                                     \
 219           { echo '$(ME): found error message ending in period' 1>&2;    \
 220             exit 1; } || :
 221
 222 sc_file_system:
 223         @re=file''system ignore_case=1                                  \
 224         msg='found use of "file''system"; spell it "file system"'       \
 225           $(_prohibit_regexp)
 226
 227 # Don't use cpp tests of this symbol.  All code assumes config.h is included.
 228 sc_prohibit_have_config_h:
 229         @grep -n '^# *if.*HAVE''_CONFIG_H' $$($(VC_LIST_EXCEPT)) &&     \
 230           { echo '$(ME): found use of HAVE''_CONFIG_H; remove'          \
 231                 1>&2; exit 1; } || :
 232
 233 # Nearly all .c files must include <config.h>.  However, we also permit this
 234 # via inclusion of a package-specific header, if cfg.mk specified one.
 235 # config_h_header must be suitable for grep -E.
 236 config_h_header ?= <config\.h>
 237 sc_require_config_h:
 238         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 239           grep -EL '^# *include $(config_h_header)'                     \
 240                 $$($(VC_LIST_EXCEPT) | grep '\.c$$')                    \
 241               | grep . &&                                               \
 242           { echo '$(ME): the above files do not include <config.h>'     \
 243                 1>&2; exit 1; } || :;                                   \
 244         else :;                                                         \
 245         fi
 246
 247 # You must include <config.h> before including any other header file.
 248 # This can possibly be via a package-specific header, if given by cfg.mk.
 249 sc_require_config_h_first:
 250         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 251           fail=0;                                                       \
 252           for i in $$($(VC_LIST_EXCEPT) | grep '\.c$$'); do             \
 253             grep '^# *include\>' $$i | sed 1q                           \
 254                 | grep -E '^# *include $(config_h_header)' > /dev/null  \
 255               || { echo $$i; fail=1; };                                 \
 256           done;                                                         \
 257           test $$fail = 1 &&                                            \
 258             { echo '$(ME): the above files include some other header'   \
 259                 'before <config.h>' 1>&2; exit 1; } || :;               \
 260         else :;                                                         \
 261         fi
 262
 263 sc_prohibit_HAVE_MBRTOWC:
 264         @re='\bHAVE_MBRTOWC\b' msg="do not use $$re; it is always defined" \
 265           $(_prohibit_regexp)
 266
 267 # To use this "command" macro, you must first define two shell variables:
 268 # h: the header, enclosed in <> or ""
 269 # re: a regular expression that matches IFF something provided by $h is used.
 270 define _header_without_use
 271   dummy=; : so we do not need a semicolon before each use;              \
 272   h_esc=`echo "$$h"|sed 's/\./\\\\./g'`;                                \
 273   if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then              \
 274     files=$$(grep -l '^# *include '"$$h_esc"                            \
 275              $$($(VC_LIST_EXCEPT) | grep '\.c$$')) &&                   \
 276     grep -LE "$$re" $$files | grep . &&                                 \
 277       { echo "$(ME): the above files include $$h but don't use it"      \
 278         1>&2; exit 1; } || :;                                           \
 279   else :;                                                               \
 280   fi
 281 endef
 282
 283 # Prohibit the inclusion of assert.h without an actual use of assert.
 284 sc_prohibit_assert_without_use:
 285         @h='<assert.h>' re='\<assert *\(' $(_header_without_use)
 286
 287 # Prohibit the inclusion of close-stream.h without an actual use.
 288 sc_prohibit_close_stream_without_use:
 289         @h='"close-stream.h"' re='\<close_stream *\(' $(_header_without_use)
 290
 291 # Prohibit the inclusion of getopt.h without an actual use.
 292 sc_prohibit_getopt_without_use:
 293         @h='<getopt.h>' re='\<getopt(_long)? *\(' $(_header_without_use)
 294
 295 # Don't include quotearg.h unless you use one of its functions.
 296 sc_prohibit_quotearg_without_use:
 297         @h='"quotearg.h"' re='\<quotearg(_[^ ]+)? *\(' $(_header_without_use)
 298
 299 # Don't include quote.h unless you use one of its functions.
 300 sc_prohibit_quote_without_use:
 301         @h='"quote.h"' re='\<quote(_n)? *\(' $(_header_without_use)
 302
 303 # Don't include this header unless you use one of its functions.
 304 sc_prohibit_long_options_without_use:
 305         @h='"long-options.h"' re='\<parse_long_options *\(' \
 306           $(_header_without_use)
 307
 308 # Don't include this header unless you use one of its functions.
 309 sc_prohibit_inttostr_without_use:
 310         @h='"inttostr.h"' re='\<(off|[iu]max|uint)tostr *\(' \
 311           $(_header_without_use)
 312
 313 # Don't include this header unless you use one of its functions.
 314 sc_prohibit_error_without_use:
 315         @h='"error.h"' \
 316         re='\<error(_at_line|_print_progname|_one_per_line|_message_count)? *\('\
 317           $(_header_without_use)
 318
 319 # Don't include xalloc.h unless you use one of its functions.
 320 # Consider these symbols:
 321 # perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';
 322 # perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) \(/ and print $1' lib/xalloc.h
 323 # Divide into two sets on case, and filter each through this:
 324 # | sort | perl -MRegexp::Assemble -le \
 325 #  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'
 326 # Note this was produced by the above:
 327 # _xa1 = \
 328 #x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)
 329 # But we can do better, in at least two ways:
 330 # 1) take advantage of two "dup"-suffixed strings:
 331 # x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)
 332 # 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable
 333 # "char|[cmz]"
 334 # x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 335 _xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)
 336 _xa2 = X([CZ]|N?M)ALLOC
 337 sc_prohibit_xalloc_without_use:
 338         @h='"xalloc.h"' \
 339         re='\<($(_xa1)|$(_xa2)) *\('\
 340           $(_header_without_use)
 341
 342 sc_prohibit_safe_read_without_use:
 343         @h='"safe-read.h"' re='(\<SAFE_READ_ERROR\>|\<safe_read *\()' \
 344           $(_header_without_use)
 345
 346 sc_prohibit_argmatch_without_use:
 347         @h='"argmatch.h"' \
 348         re='(\<(ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<argmatch(_exit_fn|_(in)?valid) *\()' \
 349           $(_header_without_use)
 350
 351 sc_prohibit_canonicalize_without_use:
 352         @h='"canonicalize.h"' \
 353         re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode)' \
 354           $(_header_without_use)
 355
 356 sc_prohibit_root_dev_ino_without_use:
 357         @h='"root-dev-ino.h"' \
 358         re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\<get_root_dev_ino *\()' \
 359           $(_header_without_use)
 360
 361 sc_prohibit_openat_without_use:
 362         @h='"openat.h"' \
 363         re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat)\>' \
 364           $(_header_without_use)
 365
 366 # Prohibit the inclusion of c-ctype.h without an actual use.
 367 ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\
 368 |isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper
 369 sc_prohibit_c_ctype_without_use:
 370         @h='[<"]c-ctype.h[">]' re='\<c_($(ctype_re)) *\(' $(_header_without_use)
 371
 372 _empty =
 373 _sp = $(_empty) $(_empty)
 374 # The following list was generated by running:
 375 # man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \
 376 #   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt
 377 _sig_functions = \
 378   bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \
 379   sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \
 380   siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \
 381   sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo
 382 _sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))
 383 # The following were extracted from "man signal.h" manually.
 384 _sig_types_and_consts =                                                 \
 385   MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK           \
 386   SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL            \
 387   SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE    \
 388   SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t  \
 389   sigstack sigval stack_t ucontext_t
 390 # generated via this:
 391 # perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70
 392 _sig_names =                                                            \
 393   SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT      \
 394   SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL       \
 395   SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP  \
 396   SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR      \
 397   SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS   \
 398   SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1        \
 399   SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW       \
 400   SIGXCPU SIGXFSZ
 401 _sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))
 402
 403 # Prohibit the inclusion of signal.h without an actual use.
 404 sc_prohibit_signal_without_use:
 405         @h='<signal.h>'                                                 \
 406         re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'          \
 407           $(_header_without_use)
 408
 409 sc_obsolete_symbols:
 410         @re='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'                           \
 411         msg='do not use HAVE''_FCNTL_H or O'_NDELAY                     \
 412           $(_prohibit_regexp)
 413
 414 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
 415
 416 # Each nonempty ChangeLog line must start with a year number, or a TAB.
 417 sc_changelog:
 418         @if $(VC_LIST_EXCEPT) | grep -l '^ChangeLog$$' >/dev/null; then \
 419           grep -n '^[^12        ]'                                      \
 420             $$($(VC_LIST_EXCEPT) | grep '^ChangeLog$$') &&              \
 421           { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
 422             exit 1; } || :;                                             \
 423         fi
 424
 425 # Ensure that each .c file containing a "main" function also
 426 # calls set_program_name.
 427 sc_program_name:
 428         @if $(VC_LIST_EXCEPT) | grep -l '\.c$$' > /dev/null; then       \
 429           files=$$(grep -l '^main *(' $$($(VC_LIST_EXCEPT) | grep '\.c$$')); \
 430           grep -LE 'set_program_name *\(m?argv\[0\]\);' $$files         \
 431               | grep . &&                                               \
 432           { echo '$(ME): the above files do not call set_program_name'  \
 433                 1>&2; exit 1; } || :;                                   \
 434         else :;                                                         \
 435         fi
 436
 437 # Require that the final line of each test-lib.sh-using test be this one:
 438 # Exit $fail
 439 # Note: this test requires GNU grep's --label= option.
 440 Exit_witness_file ?= tests/test-lib.sh
 441 Exit_base := $(notdir $(Exit_witness_file))
 442 sc_require_test_exit_idiom:
 443         @if test -f $(srcdir)/$(Exit_witness_file); then                \
 444           die=0;                                                        \
 445           for i in $$(grep -l -F 'srcdir/$(Exit_base)'                  \
 446                 $$($(VC_LIST) tests)); do                               \
 447             tail -n1 $$i | grep '^Exit .' > /dev/null                   \
 448               && : || { die=1; echo $$i; }                              \
 449           done;                                                         \
 450           test $$die = 1 &&                                             \
 451             { echo 1>&2 '$(ME): the final line in each of the above is not:'; \
 452               echo 1>&2 'Exit something';                               \
 453               exit 1; } || :;                                           \
 454         fi
 455
 456 sc_the_the:
 457         @re='\<the ''the\>'                                             \
 458         ignore_case=1 msg='found use of "the ''the";'                   \
 459           $(_prohibit_regexp)
 460
 461 sc_trailing_blank:
 462         @re='[   ]$$'                                                   \
 463         msg='found trailing blank(s)'                                   \
 464           $(_prohibit_regexp)
 465
 466 # Match lines like the following, but where there is only one space
 467 # between the options and the description:
 468 #   -D, --all-repeated[=delimit-method]  print all duplicate lines\n
 469 longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?
 470 sc_two_space_separator_in_usage:
 471         @grep -nE '^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'         \
 472             $$($(VC_LIST_EXCEPT)) &&                                    \
 473           { echo "$(ME): help2man requires at least two spaces between"; \
 474             echo "$(ME): an option and its description";                \
 475                 1>&2; exit 1; } || :
 476
 477 # Look for diagnostics that aren't marked for translation.
 478 # This won't find any for which error's format string is on a separate line.
 479 sc_unmarked_diagnostics:
 480         @grep -nE                                                       \
 481             '\<error \([^"]*"[^"]*[a-z]{3}' $$($(VC_LIST_EXCEPT))       \
 482           | grep -v '_''(' &&                                           \
 483           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
 484             exit 1; } || :
 485
 486 # Avoid useless parentheses like those in this example:
 487 # #if defined (SYMBOL) || defined (SYM2)
 488 sc_useless_cpp_parens:
 489         @grep -n '^# *if .*defined *(' $$($(VC_LIST_EXCEPT)) &&         \
 490           { echo '$(ME): found useless parentheses in cpp directive'    \
 491                 1>&2; exit 1; } || :
 492
 493 # Require the latest GPL.
 494 sc_GPL_version:
 495         @re='either ''version [^3]' msg='GPL vN, N!=3'                  \
 496           $(_prohibit_regexp)
 497
 498 cvs_keywords = \
 499   Author|Date|Header|Id|Name|Locker|Log|RCSfile|Revision|Source|State
 500
 501 sc_prohibit_cvs_keyword:
 502         @re='\$$($(cvs_keywords))\$$'                                   \
 503             msg='do not use CVS keyword expansion'                      \
 504           $(_prohibit_regexp)
 505
 506 # Make sure we don't use st_blocks.  Use ST_NBLOCKS instead.
 507 # This is a bit of a kludge, since it prevents use of the string
 508 # even in comments, but for now it does the job with no false positives.
 509 sc_prohibit_stat_st_blocks:
 510         @re='[.>]st_blocks' msg='do not use st_blocks; use ST_NBLOCKS'  \
 511           $(_prohibit_regexp)
 512
 513 # Make sure we don't define any S_IS* macros in src/*.c files.
 514 # They're already defined via gnulib's sys/stat.h replacement.
 515 sc_prohibit_S_IS_definition:
 516         @re='^ *# *define  *S_IS'                                       \
 517         msg='do not define S_IS* macros; include <sys/stat.h>'          \
 518           $(_prohibit_regexp)
 519
 520 # Each program that uses proper_name_utf8 must link with
 521 # one of the ICONV libraries.
 522 sc_proper_name_utf8_requires_ICONV:
 523         @progs=$$(grep -l 'proper_name_utf8 ''("' $$($(VC_LIST_EXCEPT)));\
 524         if test "x$$progs" != x; then                                   \
 525           fail=0;                                                       \
 526           for p in $$progs; do                                          \
 527             dir=$$(dirname "$$p");                                      \
 528             base=$$(basename "$$p" .c);                                 \
 529             grep "$${base}_LDADD.*ICONV)" $$dir/Makefile.am > /dev/null \
 530               || { fail=1; echo 1>&2 "$(ME): $$p uses proper_name_utf8"; }; \
 531           done;                                                         \
 532           test $$fail = 1 &&                                            \
 533             { echo 1>&2 '$(ME): the above do not link with any ICONV library'; \
 534               exit 1; } || :;                                           \
 535         fi
 536
 537 # Warn about "c0nst struct Foo const foo[]",
 538 # but not about "char const *const foo" or "#define const const".
 539 sc_redundant_const:
 540         @re='\bconst\b[[:space:][:alnum:]]{2,}\bconst\b'                \
 541         msg='redundant "const" in declarations'                         \
 542           $(_prohibit_regexp)
 543
 544 sc_const_long_option:
 545         @grep '^ *static.*struct option ' $$($(VC_LIST_EXCEPT))         \
 546           | grep -Ev 'const struct option|struct option const' && {     \
 547               echo 1>&2 '$(ME): add "const" to the above declarations'; \
 548               exit 1; } || :
 549
 550 NEWS_hash =                                                             \
 551   $$(sed -n '/^\*.* $(PREV_VERSION_REGEXP) ([0-9-]*)/,$$p'              \
 552        $(srcdir)/NEWS                                                   \
 553      | perl -0777 -pe                                                   \
 554         's/^Copyright.+?Free\sSoftware\sFoundation,\sInc\.\n//ms'       \
 555      | md5sum -                                                         \
 556      | sed 's/ .*//')
 557
 558 # Ensure that we don't accidentally insert an entry into an old NEWS block.
 559 sc_immutable_NEWS:
 560         @if test -f $(srcdir)/NEWS; then                                \
 561           test "$(NEWS_hash)" = '$(old_NEWS_hash)' && : ||              \
 562             { echo '$(ME): you have modified old NEWS' 1>&2; exit 1; }; \
 563         fi
 564
 565 # Update the hash stored above.  Do this after each release and
 566 # for any corrections to old entries.
 567 update-NEWS-hash: NEWS
 568         perl -pi -e 's/^(old_NEWS_hash[ \t]+:?=[ \t]+).*/$${1}'"$(NEWS_hash)/" \
 569           $(srcdir)/cfg.mk
 570
 571 # Ensure that we use only the standard $(VAR) notation,
 572 # not @...@ in Makefile.am, now that we can rely on automake
 573 # to emit a definition for each substituted variable.
 574 # We use perl rather than "grep -nE ..." to exempt a single
 575 # use of an @...@-delimited variable name in src/Makefile.am.
 576 sc_makefile_check:
 577         @perl -ne '/\@[A-Z_0-9]+\@/ && !/^cu_install_program =/'        \
 578           -e 'and (print "$$ARGV:$$.: $$_"), $$m=1; END {exit !$$m}'    \
 579             $$($(VC_LIST_EXCEPT) | grep -E '(^|/)Makefile\.am$$')       \
 580           && { echo '$(ME): use $$(...), not @...@' 1>&2; exit 1; } || :
 581
 582 news-check: NEWS
 583         if head $(srcdir)/NEWS | grep -E $(news-check-regexp)           \
 584             >/dev/null; then                                            \
 585           :;                                                            \
 586         else                                                            \
 587           echo 'NEWS: $$(news-check-regexp) failed to match' 1>&2;      \
 588           exit 1;                                                       \
 589         fi
 590
 591 sc_makefile_TAB_only_indentation:
 592         @grep -nE '^    [ ]{8}'                                         \
 593             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
 594           && { echo '$(ME): found TAB-8-space indentation' 1>&2;        \
 595                exit 1; } || :
 596
 597 sc_m4_quote_check:
 598         @grep -nE '(AC_DEFINE(_UNQUOTED)?|AC_DEFUN)\([^[]'              \
 599             $$($(VC_LIST_EXCEPT) | grep -E '(^configure\.ac|\.m4)$$')   \
 600           && { echo '$(ME): quote the first arg to AC_DEF*' 1>&2;       \
 601                exit 1; } || :
 602
 603 fix_po_file_diag = \
 604 'you have changed the set of files with translatable diagnostics;\n\
 605 apply the above patch\n'
 606
 607 # Verify that all source files using _() are listed in po/POTFILES.in.
 608 po_file = po/POTFILES.in
 609 sc_po_check:
 610         @if test -f $(po_file); then                                    \
 611           grep -E -v '^(#|$$)' $(po_file)                               \
 612             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
 613           files=;                                                       \
 614           for file in $$($(VC_LIST_EXCEPT)) lib/*.[ch]; do              \
 615             test -r $$file || continue;                                 \
 616             case $$file in                                              \
 617               *.m4|*.mk) continue ;;                                    \
 618               *.?|*.??) ;;                                              \
 619               *) continue;;                                             \
 620             esac;                                                       \
 621             case $$file in                                              \
 622             *.[ch])                                                     \
 623               base=`expr " $$file" : ' \(.*\)\..'`;                     \
 624               { test -f $$base.l || test -f $$base.y; } && continue;;   \
 625             esac;                                                       \
 626             files="$$files $$file";                                     \
 627           done;                                                         \
 628           grep -E -l '\b(N?_|gettext *)\([^)"]*("|$$)' $$files          \
 629             | sort -u > $@-2;                                           \
 630           diff -u -L $(po_file) -L $(po_file) $@-1 $@-2                 \
 631             || { printf '$(ME): '$(fix_po_file_diag) 1>&2; exit 1; };   \
 632           rm -f $@-1 $@-2;                                              \
 633         fi
 634
 635 # Sometimes it is useful to change the PATH environment variable
 636 # in Makefiles.  When doing so, it's better not to use the Unix-centric
 637 # path separator of `:', but rather the automake-provided `$(PATH_SEPARATOR)'.
 638 msg = '$(ME): Do not use `:'\'' above; use $$(PATH_SEPARATOR) instead'
 639 sc_makefile_path_separator_check:
 640         @grep -nE 'PATH[=].*:'                                          \
 641             $$($(VC_LIST_EXCEPT) | grep -E 'akefile|\.mk$$')            \
 642           && { echo $(msg) 1>&2; exit 1; } || :
 643
 644 # Check that `make alpha' will not fail at the end of the process.
 645 writable-files:
 646         if test -d $(release_archive_dir); then :; else                 \
 647           for file in $(distdir).tar.gz                                 \
 648                       $(release_archive_dir)/$(distdir).tar.gz; do      \
 649             test -e $$file || continue;                                 \
 650             test -w $$file                                              \
 651               || { echo ERROR: $$file is not writable; fail=1; };       \
 652           done;                                                         \
 653           test "$$fail" && exit 1 || : ;                                \
 654         fi
 655
 656 v_etc_file = lib/version-etc.c
 657 sample-test = tests/sample-test
 658 texi = doc/$(PACKAGE).texi
 659 # Make sure that the copyright date in $(v_etc_file) is up to date.
 660 # Do the same for the $(sample-test) and the main doc/.texi file.
 661 sc_copyright_check:
 662         @if test -f $(v_etc_file); then                                 \
 663           grep 'enum { COPYRIGHT_YEAR = '$$(date +%Y)' };' $(v_etc_file) \
 664             >/dev/null                                                  \
 665           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
 666                exit 1; };                                               \
 667         fi
 668         @if test -f $(sample-test); then                                \
 669           grep '# Copyright (C) '$$(date +%Y)' Free' $(sample-test)     \
 670             >/dev/null                                                  \
 671           || { echo 'out of date copyright in $(sample-test); update it' 1>&2; \
 672                exit 1; };                                               \
 673         fi
 674         @if test -f $(texi); then                                       \
 675           grep 'Copyright @copyright{} .*'$$(date +%Y)' Free' $(texi)   \
 676             >/dev/null                                                  \
 677           || { echo 'out of date copyright in $(texi); update it' 1>&2; \
 678                exit 1; };                                               \
 679         fi
 680
 681 vc-diff-check:
 682         (unset CDPATH; cd $(srcdir) && $(VC) diff) > vc-diffs || :
 683         if test -s vc-diffs; then                               \
 684           cat vc-diffs;                                         \
 685           echo "Some files are locally modified:" 1>&2;         \
 686           exit 1;                                               \
 687         else                                                    \
 688           rm vc-diffs;                                          \
 689         fi
 690
 691 rel-files = $(DIST_ARCHIVES)
 692
 693 gnulib_dir ?= $(srcdir)/gnulib
 694 gnulib-version = $$(cd $(gnulib_dir) && git describe)
 695 bootstrap-tools ?= autoconf,automake,gnulib
 696
 697 # If it's not already specified, derive the GPG key ID from
 698 # the signed tag we've just applied to mark this release.
 699 gpg_key_ID ?= \
 700   $$(git cat-file tag v$(VERSION) > .ann-sig \
 701      && gpgv .ann-sig - < /dev/null 2>&1 \
 702           | sed -n '/.*key ID \([0-9A-F]*\)/s//\1/p'; rm -f .ann-sig)
 703
 704 announcement: NEWS ChangeLog $(rel-files)
 705         @$(build_aux)/announce-gen                                      \
 706             --release-type=$(RELEASE_TYPE)                              \
 707             --package=$(PACKAGE)                                        \
 708             --prev=$(PREV_VERSION)                                      \
 709             --curr=$(VERSION)                                           \
 710             --gpg-key-id=$(gpg_key_ID)                                  \
 711             --news=$(srcdir)/NEWS                                       \
 712             --bootstrap-tools=$(bootstrap-tools)                        \
 713             --gnulib-version=$(gnulib-version)                          \
 714             --no-print-checksums                                        \
 715             $(addprefix --url-dir=, $(url_dir_list))
 716
 717 ## ---------------- ##
 718 ## Updating files.  ##
 719 ## ---------------- ##
 720
 721 ftp-gnu = ftp://ftp.gnu.org/gnu
 722 www-gnu = http://www.gnu.org
 723
 724 emit_upload_commands:
 725         @echo =====================================
 726         @echo =====================================
 727         @echo "$(build_aux)/gnupload $(GNUPLOADFLAGS) \\"
 728         @echo "    --to $(gnu_rel_host):$(PACKAGE) \\"
 729         @echo "  $(rel-files)"
 730         @echo '# send the ~/announce-$(my_distdir) e-mail'
 731         @echo =====================================
 732         @echo =====================================
 733
 734 noteworthy = * Noteworthy changes in release ?.? (????-??-??) [?]
 735 define emit-commit-log
 736   printf '%s\n' 'post-release administrivia' '' \
 737     '* NEWS: Add header line for next release.' \
 738     '* .prev-version: Record previous version.' \
 739     '* cfg.mk (old_NEWS_hash): Auto-update.'
 740 endef
 741
 742 .PHONY: no-submodule-changes
 743 no-submodule-changes:
 744         if test -d $(srcdir)/.git; then                                 \
 745           diff=$$(cd $(srcdir) && git submodule -q foreach              \
 746                   git diff-index --name-only HEAD)                      \
 747             || exit 1;                                                  \
 748           case $$diff in '') ;;                                         \
 749             *) echo '$(ME): submodule files are locally modified:';     \
 750                 echo "$$diff"; exit 1;; esac;                           \
 751         else                                                            \
 752           : ;                                                           \
 753         fi
 754
 755 .PHONY: alpha beta stable
 756 ALL_RECURSIVE_TARGETS += alpha beta stable
 757 alpha beta stable: $(local-check) writable-files no-submodule-changes
 758         test $@ = stable                                                \
 759           && { echo $(VERSION) | grep -E '^[0-9]+(\.[0-9]+)+$$'         \
 760                || { echo "invalid version string: $(VERSION)" 1>&2; exit 1;};}\
 761           || :
 762         $(MAKE) vc-diff-check
 763         $(MAKE) news-check
 764         $(MAKE) distcheck
 765         $(MAKE) dist XZ_OPT=-9ev
 766         $(MAKE) $(release-prep-hook) RELEASE_TYPE=$@
 767         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
 768
 769 # Override this in cfg.mk if you follow different procedures.
 770 release-prep-hook ?= release-prep
 771
 772 .PHONY: release-prep
 773 release-prep:
 774         case $$RELEASE_TYPE in alpha|beta|stable) ;; \
 775           *) echo "invalid RELEASE_TYPE: $$RELEASE_TYPE" 1>&2; exit 1;; esac
 776         $(MAKE) -s announcement > ~/announce-$(my_distdir)
 777         if test -d $(release_archive_dir); then                 \
 778           ln $(rel-files) $(release_archive_dir);               \
 779           chmod a-w $(rel-files);                               \
 780         fi
 781         echo $(VERSION) > $(prev_version_file)
 782         $(MAKE) update-NEWS-hash
 783         perl -pi -e '$$. == 3 and print "$(noteworthy)\n\n\n"' NEWS
 784         $(emit-commit-log) > .ci-msg
 785         $(VC) commit -F .ci-msg -a
 786         rm .ci-msg
 787
 788 .PHONY: web-manual
 789 web-manual:
 790         @test -z "$(manual_title)" \
 791           && { echo define manual_title in cfg.mk 1>&2; exit 1; } || :
 792         @cd '$(srcdir)/doc'; \
 793           $(SHELL) ../build-aux/gendocs.sh -o '$(abs_builddir)/doc/manual' \
 794              --email $(PACKAGE_BUGREPORT) $(PACKAGE) \
 795             "$(PACKAGE_NAME) - $(manual_title)"
 796         @echo " *** Upload the doc/manual directory to web-cvs."
 797
 798 # Code Coverage
 799
 800 init-coverage:
 801         $(MAKE) $(AM_MAKEFLAGS) clean
 802         lcov --directory . --zerocounters
 803
 804 COVERAGE_CCOPTS ?= "-g --coverage"
 805 COVERAGE_OUT ?= doc/coverage
 806
 807 build-coverage:
 808         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS)
 809         $(MAKE) $(AM_MAKEFLAGS) CFLAGS=$(COVERAGE_CCOPTS) CXXFLAGS=$(COVERAGE_CCOPTS) check
 810         mkdir -p $(COVERAGE_OUT)
 811         lcov --directory . --output-file $(COVERAGE_OUT)/$(PACKAGE).info \
 812                 --capture
 813
 814 gen-coverage:
 815         genhtml --output-directory $(COVERAGE_OUT) \
 816                 $(COVERAGE_OUT)/$(PACKAGE).info \
 817                 --highlight --frames --legend \
 818                 --title "$(PACKAGE_NAME)"
 819
 820 coverage: init-coverage build-coverage gen-coverage
 821
 822 # Update gettext files.
 823 PACKAGE ?= $(shell basename $(PWD))
 824 PO_DOMAIN ?= $(PACKAGE)
 825 POURL = http://translationproject.org/latest/$(PO_DOMAIN)/
 826 PODIR ?= po
 827 refresh-po:
 828         rm -f $(PODIR)/*.po && \
 829         echo "$(ME): getting translations into po (please ignore the robots.txt ERROR 404)..." && \
 830         wget --no-verbose --directory-prefix $(PODIR) --no-directories --recursive --level 1 --accept .po --accept .po.1 $(POURL) && \
 831         echo 'en@boldquot' > $(PODIR)/LINGUAS && \
 832         echo 'en@quot' >> $(PODIR)/LINGUAS && \
 833         ls $(PODIR)/*.po | sed 's/\.po//' | sed 's,$(PODIR)/,,' | sort >> $(PODIR)/LINGUAS
 834
 835 INDENT_SOURCES ?= $(C_SOURCES)
 836 .PHONY: indent
 837 indent:
 838         indent $(INDENT_SOURCES)
 839
 840 # If you want to set UPDATE_COPYRIGHT_* environment variables,
 841 # put the assignments in this variable.
 842 update-copyright-env ?=
 843
 844 # Run this rule once per year (usually early in January)
 845 # to update all FSF copyright year lists in your project.
 846 # If you have an additional project-specific rule,
 847 # add it in cfg.mk along with a line 'update-copyright: prereq'.
 848 # By default, exclude all variants of COPYING; you can also
 849 # add exemptions (such as ChangeLog..* for rotated change logs)
 850 # in the file .x-update-copyright.
 851 .PHONY: update-copyright
 852 update-copyright:
 853         grep -l -w Copyright                                             \
 854           $$(export VC_LIST_EXCEPT_DEFAULT=COPYING && $(VC_LIST_EXCEPT)) \
 855           | $(update-copyright-env) xargs $(build_aux)/$@