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