remove obsolete comment
[platform/upstream/coreutils.git] / Makefile.maint
1 # -*-Makefile-*-
2 # This Makefile fragment is shared between the coreutils,
3 # CPPI, Bison, and Autoconf.
4
5 ## Copyright (C) 2001-2004 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 2, or (at your option)
10 ## 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, write to the Free Software
19 ## Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20 ## 02111-1307, USA.
21
22 # This is reported not to work with make-3.79.1
23 # ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
24 ME := Makefile.maint
25
26 # Do not save the original name or timestamp in the .tar.gz file.
27 GZIP_ENV = '--no-name --best'
28
29 CVS = cvs
30
31 ifeq ($(origin prev_version_file), undefined)
32   prev_version_file = .prev-version
33 endif
34
35 PREV_VERSION := $(shell cat $(prev_version_file))
36
37 tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')
38 tag-this-version = $(subst .,_,$(VERSION))
39 this-cvs-tag = $(tag-package)-$(tag-this-version)
40 my_distdir = $(PACKAGE)-$(VERSION)
41
42 # Old releases are stored here.
43 # Used for diffs and xdeltas.
44 release_archive_dir ?= ../release
45
46 # Prevent programs like 'sort' from considering distinct strings to be equal.
47 # Doing it here saves us from having to set LC_ALL elsewhere in this file.
48 export LC_ALL = C
49
50
51
52 ## --------------- ##
53 ## Sanity checks.  ##
54 ## --------------- ##
55
56 # Checks that don't require cvs.
57 # Run `changelog-check' last, as previous test may reveal problems requiring
58 # new ChangeLog entries.
59 local-checks-available = \
60   po-check copyright-check writable-files m4-check author_mark_check \
61   changelog-check strftime-check syntax-check makefile_path_separator_check \
62   makefile-check
63 .PHONY: $(local-checks-available)
64
65 local-check = $(filter-out $(local-checks-to-skip), $(local-checks-available))
66
67 .PHONY: $(syntax-check-rules)
68 syntax-check-rules = \
69   sc_cast_of_argument_to_free \
70   sc_cast_of_x_alloc_return_value \
71   sc_cast_of_alloca_return_value \
72   sc_changelog \
73   sc_error_exit_success \
74   sc_prohibit_atoi_atof \
75   sc_space_tab \
76   sc_sun_os_names \
77   sc_system_h_headers \
78   sc_unmarked_diagnostics
79
80 syntax-check: $(syntax-check-rules)
81 #       @grep -E '#  *include <(limits|std(def|arg|bool))\.h>'          \
82 #           $$(find -type f -name '*.[chly]') &&                        \
83 #         { echo '$(ME): found conditional include' 1>&2;               \
84 #           exit 1; } || :
85
86 #       grep -E '^#  *include <(string|stdlib)\.h>'                     \
87 #           $(srcdir)/{lib,src}/*.[chy] &&                              \
88 #         { echo '$(ME): FIXME' 1>&2;                                   \
89 #           exit 1; } || :
90 # FIXME: don't allow `#include .strings\.h' anywhere
91
92 # Look for diagnostics that aren't marked for translation.
93 # This won't find any for which error's format string is on a separate line.
94 sc_unmarked_diagnostics:
95         @grep --exclude=$(srcdir)/src/shred.c -E                        \
96             '\<error \([^"]*"[^"]*[a-z]{3}' $(srcdir)/{lib,src}/*.c     \
97           | grep -v '_(' &&                                             \
98           { echo '$(ME): found unmarked diagnostic(s)' 1>&2;            \
99             exit 1; } || :
100
101 sc_cast_of_argument_to_free:
102         @grep -E '\<free \(\(' $(srcdir)/{lib,src}/*.[chly] &&          \
103           { echo '$(ME): don'\''t cast free argument' 1>&2;             \
104             exit 1; } || :
105
106 sc_cast_of_x_alloc_return_value:
107         @grep -E --exclude=$(srcdir)/lib/regex.c                        \
108             '\*\) *x(m|c|re)alloc\>'                            \
109             $(srcdir)/{lib,src}/*.[chy] &&                              \
110           { echo '$(ME): don'\''t cast x*alloc return value' 1>&2;      \
111             exit 1; } || :
112
113 sc_cast_of_alloca_return_value:
114         @grep -E '\*\) *alloca\>'                                       \
115             $(srcdir)/src/*.[chy] &&                                    \
116           { echo '$(ME): don'\''t cast alloca return value' 1>&2;       \
117             exit 1; } || :
118
119 sc_space_tab:
120         @( cvsu --list ) > /dev/null 2>&1 || : &&                       \
121           grep '[ ]     '                                               \
122              $$(cvsu --list | grep -vEf .x-$@ ) &&                      \
123           { echo '$(ME): found SPACE-TAB sequence; remove the SPACE'    \
124                 1>&2; exit 1; } || :
125
126 # Don't use atoi, atof, atol, atoll, or atoq in `real' code.
127 # They provide no error checking mechanism.
128 # Instead, use strto* functions.
129 sc_prohibit_atoi_atof:
130         @( cvsu --list ) > /dev/null 2>&1 || : &&                       \
131           grep -E '\<(ato[filq]|atoll)\>'                               \
132              $$(cvsu --list | grep -vEf .x-$@ ) &&                      \
133           { echo '$(ME): do not use atof, atoi, atol, atoll, or atoq'   \
134                 1>&2; exit 1; } || :
135
136 # Using EXIT_SUCCESS as the first argument to error is misleading,
137 # since when that parameter is 0, error does not exit.  Use `0' instead.
138 sc_error_exit_success:
139         @grep -F 'error (EXIT_SUCCESS,'                                 \
140             $$(find -type f -name '*.[chly]') &&                        \
141           { echo '$(ME): found error (EXIT_SUCCESS' 1>&2;               \
142             exit 1; } || :
143
144 # FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ
145
146 # Each nonempty line must start with a year number, or a TAB.
147 sc_changelog:
148         @grep '^[^12    ]' $$(find . -name ChangeLog -maxdepth 2) &&    \
149           { echo '$(ME): found unexpected prefix in a ChangeLog' 1>&2;  \
150             exit 1; } || :
151
152 header_regexp = \
153   alloca\
154   |closeout\
155   |ctype\
156   |dirent\
157   |errno\
158   |exitfail\
159   |fcntl\
160   |inttypes\
161   |limits\
162   |locale\
163   |pathmax\
164   |std(lib|bool)\
165   |string\
166   |sys/(stat|dir|time)\
167   |time\
168   |unistd\
169   |utime\
170   |version-etc\
171   |xalloc
172 h_re := $(shell echo '$(header_regexp)'|tr -d ' ')
173
174 # Files in src/ should not include directly any of
175 # the headers already included via system.h.
176 # Get list of candidates with this:
177 # grep -h include src/sys*.h|sed 's/.*include //'|sort -
178 sc_system_h_headers:
179         @if test -f $(srcdir)/src/sys2.h; then                          \
180           ( cvsu --list ) > /dev/null 2>&1 || : &&                      \
181           grep -E '^# *include ["<]($(h_re))\.h[">]'                    \
182               $$(cvsu --list src | grep -Ev 'sys(2|tem)\.h$$')          \
183             && { echo '$(ME): the above are already included via system.h'\
184                   1>&2; exit 1; } || :; \
185         fi
186
187 sc_sun_os_names:
188         @( cvsu --list ) > /dev/null 2>&1 || : && \
189         grep -Ei \
190             'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
191           $$(cvsu --list | grep -vEf .x-$@ ) &&                 \
192           { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;  \
193             exit 1; } || :
194
195 # Ensure that date's --help output stays in sync with the info
196 # documentation for GNU strftime.  The only exception is %N,
197 # which date accepts but GNU strftime does not.
198 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
199 strftime-check:
200         if test -f $(srcdir)/src/date.c; then                           \
201           grep '^  %.  ' $(srcdir)/src/date.c | sort                    \
202             | $(extract_char) > $@-src;                                 \
203           { echo N;                                                     \
204             info libc date calendar format | grep '^    `%.'\'          \
205               | $(extract_char); } | sort > $@-info;                    \
206           diff -u $@-src $@-info || exit 1;                             \
207           rm -f $@-src $@-info;                                         \
208         fi
209
210 # Ensure that we use only the standard $(VAR) notation,
211 # not @...@ in Makefile.am, now that we can rely on automake
212 # to emit a definition for each substituted variable.
213 makefile-check:
214         grep -E '@[A-Z_0-9]+@' `find . -name Makefile.am` \
215           && { echo 'Makefile.maint: use $(...), not @...@' 1>&2; exit 1; } || :
216
217 news-date-check: NEWS
218         today=`date +%Y-%m-%d`; \
219         if head NEWS | grep '^\*.*'$$today >/dev/null; then \
220           :; \
221         else \
222           echo "today's date is not in NEWS" 1>&2; \
223           exit 1; \
224         fi
225
226 changelog-check:
227         if head ChangeLog | grep 'Version $(VERSION)' >/dev/null; then \
228           :; \
229         else \
230           echo "$(VERSION) not in ChangeLog" 1>&2; \
231           exit 1; \
232         fi
233
234 m4-check:
235         @grep 'AC_DEFUN([^[]' m4/*.m4 \
236           && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
237                exit 1; } || :
238
239 # Verify that all source files using _() are listed in po/POTFILES.in.
240 # FIXME: don't hard-code src/false.c below; use a more general mechanism.
241 po-check:
242         ( cvsu --list ) > /dev/null 2>&1 || : &&                        \
243         if test -f po/POTFILES.in; then                                 \
244           grep -E -v '^(#|$$)' po/POTFILES.in                           \
245             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
246           files=;                                                       \
247           for file in $$(cvsu --list lib src | grep '\.[chly]$$'); do   \
248             case $$file in                                              \
249             *.[ch])                                                     \
250               base=`expr " $$file" : ' \(.*\)\..'`;                     \
251               { test -f $$base.l || test -f $$base.y; } && continue;;   \
252             esac;                                                       \
253             files="$$files $$file";                                     \
254           done;                                                         \
255           grep -E -l '\bN?_\([^)"]*("|$$)' $$files | sort > $@-2;       \
256           diff -u $@-1 $@-2 || exit 1;                                  \
257           rm -f $@-1 $@-2;                                              \
258         fi
259
260 # In a definition of #define AUTHORS "... and ..." where the RHS contains
261 # the English word `and', the string must be marked with `N_ (...)' so that
262 # gettext recognizes it as a string requiring translation.
263 author_mark_check:
264         @grep '^# *define AUTHORS "[^"]* and ' src/*.c |grep -v ' N_ (' && \
265           { echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
266             exit 1; } || :
267
268 # Sometimes it is useful to change the PATH environment variable
269 # in Makefiles.  When doing so, it's better not to use the Unix-centric
270 # path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
271 # It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
272 # and there probably aren't many projects with so many Makefile.am files
273 # that we'd have to worry about limits on command line length.
274 msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
275 makefile_path_separator_check:
276         @grep 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
277           && { echo $(msg) 1>&2; exit 1; } || :
278
279 # Check that `make alpha' will not fail at the end of the process.
280 writable-files:
281         if test -d $(release_archive_dir); then :; else                 \
282           mkdir $(release_archive_dir);                                 \
283         fi
284         for file in $(distdir).tar.gz $(xd-delta)                       \
285                     $(release_archive_dir)/$(distdir).tar.gz            \
286                     $(release_archive_dir)/$(xd-delta); do              \
287           test -e $$file || continue;                                   \
288           test -w $$file                                                \
289             || { echo ERROR: $$file is not writable; fail=1; };         \
290         done;                                                           \
291         test "$$fail" && exit 1 || :
292
293 v_etc_file = lib/version-etc.c
294 # Make sure that the copyright date in $(v_etc_file) is up to date.
295 copyright-check:
296         @if test -f $(v_etc_file); then \
297           grep '"Copyright (C) $(shell date +%Y) Free' $(v_etc_file) \
298             >/dev/null \
299           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
300                exit 1; }; \
301         fi
302
303
304 # Sanity checks with the CVS repository.
305 cvs-tag-check:
306         echo $(this-cvs-tag); \
307         if $(CVS) -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
308           echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
309           exit 1; \
310         else :; fi
311
312 cvs-diff-check:
313         if $(CVS) diff >cvs-diffs; then                         \
314           rm cvs-diffs;                                         \
315         else                                                    \
316           echo "Some files are locally modified:" 1>&2;         \
317           cat cvs-diffs;                                        \
318           exit 1;                                               \
319         fi
320
321 cvs-check: cvs-diff-check cvs-tag-check
322
323 maintainer-distcheck: changelog-check
324         $(MAKE) distcheck
325         $(MAKE) my-distcheck
326
327
328 # Tag before making distribution.  Also, don't make a distribution if
329 # checks fail.  Also, make sure the NEWS file is up-to-date.
330 # FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
331 cvs-dist: $(local-check) cvs-check maintainer-distcheck
332         $(CVS) update po
333         $(CVS) tag -c $(this-cvs-tag)
334         $(MAKE) dist
335
336 # Use this to make sure we don't run these programs when building
337 # from a virgin tgz file, below.
338 null_AM_MAKEFLAGS = \
339   ACLOCAL=false \
340   AUTOCONF=false \
341   AUTOMAKE=false \
342   AUTOHEADER=false \
343   MAKEINFO=false
344
345 # Detect format-string/arg-list mismatches that would normally be obscured
346 # by the use of _().  The --disable-nls effectively defines away that macro,
347 # and building with CFLAGS='-Wformat -Werror' causes any format warning to be
348 # treated as a failure.
349 TMPDIR ?= /tmp
350 t=$(TMPDIR)/$(PACKAGE)/test
351 my-distcheck: $(local-check)
352         -rm -rf $(t)
353         mkdir -p $(t)
354         GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
355         cd $(t)/$(distdir) \
356           && ./configure --disable-nls \
357           && $(MAKE) CFLAGS='-Wformat -Werror' \
358               AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)' \
359           && $(MAKE) dvi \
360           && $(MAKE) check \
361           && $(MAKE) distclean
362         (cd $(t) && mv $(distdir) $(distdir).old \
363           && $(AMTAR) -zxf - ) < $(distdir).tar.gz
364         diff -ur $(t)/$(distdir).old $(t)/$(distdir)
365         -rm -rf $(t)
366         @echo "========================"; \
367         echo "$(distdir).tar.gz is ready for distribution"; \
368         echo "========================"
369
370 WGET = wget
371 WGETFLAGS = -C off
372
373 tgz-md5 = $(shell md5sum < $(my_distdir).tar.gz|sed 's/  -//')
374 tgz-sha1 = $(shell sha1sum < $(my_distdir).tar.gz|sed 's/  -//')
375 bz2-md5 = $(shell md5sum < $(my_distdir).tar.bz2|sed 's/  -//')
376 bz2-sha1 = $(shell sha1sum < $(my_distdir).tar.bz2|sed 's/  -//')
377 xdelta-md5 = $(shell md5sum < $(xd-delta)|sed 's/  -//')
378 xdelta-sha1 = $(shell sha1sum < $(xd-delta)|sed 's/  -//')
379 tgz-size = $(shell du --human $(my_distdir).tar.gz|sed 's/\([MkK]\).*/ \1B/')
380 bz2-size = $(shell du --human $(my_distdir).tar.bz2|sed 's/\([MkK]\).*/ \1B/')
381 xd-size = $(shell du --human $(xd-delta)|sed 's/\([MkK]\).*/ \1B/')
382
383 rel-check:
384         tarz=/tmp/rel-check-tarz-$$$$; \
385         md5_tmp=/tmp/rel-check-md5-$$$$; \
386         set -e; \
387         trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
388         $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
389         echo "$(md5)  -" > $$md5_tmp; \
390         md5sum -c $$md5_tmp < $$tarz
391
392 prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
393 xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
394
395 rel-files = $(xd-delta) $(DIST_ARCHIVES)
396 announcement: NEWS ChangeLog $(rel-files)
397         @./announce-gen                                                 \
398             --release-type=$(RELEASE_TYPE)                              \
399             --package=$(PACKAGE)                                        \
400             --prev=$(PREV_VERSION)                                      \
401             --curr=$(VERSION)                                           \
402             --release-archive-directory=$(release_archive_dir)          \
403             --news=NEWS                                                 \
404             $(addprefix --url-dir=, $(url_dir_list))                    \
405
406
407 ## ---------------- ##
408 ## Updating files.  ##
409 ## ---------------- ##
410
411 ftp-gnu = ftp://ftp.gnu.org/gnu
412 www-gnu = http://www.gnu.org
413
414 # Use mv, if you don't have/want move-if-change.
415 move_if_change ?= move-if-change
416
417
418 # --------------------- #
419 # Updating everything.  #
420 # --------------------- #
421
422 .PHONY: update
423 local_updates ?= wget-update cvs-update po-update
424 update: $(local_updates)
425
426
427 # ------------------- #
428 # Updating PO files.  #
429 # ------------------- #
430
431 po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
432 .PHONY: do-po-update po-update
433 do-po-update:
434         tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
435         rm -rf $$tmppo && \
436         mkdir $$tmppo && \
437         (cd $$tmppo && \
438           $(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
439         cp $$tmppo/*.po po
440         cd po && $(MAKE) update-po
441         $(MAKE) po-check
442
443 po-update:
444         if test -d "po"; then \
445           $(MAKE) do-po-update; \
446         fi
447
448 # -------------------------- #
449 # Updating GNU build tools.  #
450 # -------------------------- #
451
452 # The following pseudo table associates a local directory and a URL
453 # with each of the files that belongs to some other package and is
454 # regularly updated from the specified URL.
455 wget_files ?= \
456   $(srcdir)/config/config.guess \
457   $(srcdir)/config/config.sub \
458   $(srcdir)/config/texinfo.tex \
459   $(srcdir)/src/ansi2knr.c
460
461 get-targets = $(patsubst %, get-%, $(wget_files))
462
463 config.guess-url_prefix = $(ftp-gnu)/config/
464 config.sub-url_prefix = $(ftp-gnu)/config/
465
466 ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
467
468 texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
469
470 standards.texi-url_prefix = $(www-gnu)/prep/
471 make-stds.texi-url_prefix = $(standards.texi-url_prefix)
472
473 target = $(patsubst get-%, %, $@)
474 url = $($(notdir $(target))-url_prefix)$(notdir $(target))
475
476 .PHONY: $(get-targets)
477 $(get-targets):
478         $(WGET) $(WGETFLAGS) $(url) -O $(target).t \
479           && $(move_if_change) $(target).t $(target)
480
481 cvs_files ?= \
482   $(srcdir)/config/depcomp \
483   $(srcdir)/config/install-sh \
484   $(srcdir)/config/missing \
485   $(srcdir)/config/mkinstalldirs \
486   $(srcdir)/src/ansi2knr.c
487 automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
488 .PHONY: wget-update
489 wget-update: $(get-targets)
490
491 .PHONY: cvs-update
492 cvs-update:
493         fail=;                                                          \
494         for f in $(cvs_files); do                                       \
495           test -f $$f || { echo "*** skipping $$f" 1>&2; continue; };   \
496           cvs diff $$f > /dev/null                                      \
497             || { echo "*** $$f is locally modified; skipping it" 1>&2;  \
498                  fail=yes; continue; };                                 \
499           file=$$(basename $$f);                                        \
500           echo checking out $$file...;                                  \
501           $(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t   \
502             && $(move_if_change) $$f.t $$f;                             \
503         done;                                                           \
504         test "$$fail" && exit 1
505
506 emit_upload_commands:
507         @echo =====================================
508         @echo =====================================
509         @echo "$(srcdir)/gnupload $(GNUPLOADFLAGS) \\"
510         @echo "    --to fetish.sf.net:fetish-ftp \\"
511         @echo "    --to $(gnu_rel_host):coreutils \\"
512         @echo "  $(rel-files)"
513         @echo '# send the /tmp/announcement e-mail'
514         @echo =====================================
515         @echo =====================================
516
517 $(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
518         xdelta delta -9 $^ $@ || :
519
520 .PHONY: alpha beta major
521 alpha beta major: news-date-check $(local-check)
522         $(MAKE) cvs-dist
523         $(MAKE) $(xd-delta)
524         $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
525         ln $(rel-files) $(release_archive_dir)
526         chmod a-w $(rel-files)
527         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
528         echo $(VERSION) > $(prev_version_file)
529         $(CVS) ci -m. $(prev_version_file)