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