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