(.re-list): New rule/file, to replace hard-coded list of header file names.
[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 # Create a list of regular expressions matching the names
169 # of files included from system.h.  Exclude a couple.
170 .re-list:
171         @sed -n '/^# *include /s///p' $(srcdir)/src/system.h \
172           | grep -Ev 'sys/(param|file)\.h' \
173           | sed 's/ .*//;;s/^["<]/^# *include [<"]/;s/\.h[">]$$/\\.h[">]/' \
174           > $@-t
175         @mv $@-t $@
176
177 # Files in src/ should not include directly any of
178 # the headers already included via system.h.
179 sc_system_h_headers: .re-list
180         @if test -f $(srcdir)/src/system.h; then                        \
181           ( cvsu --list ) > /dev/null 2>&1 || exit 0;                   \
182           trap 'rm -f .re-list' 0 1 2 3 15;                             \
183           grep -E -f .re-list                                           \
184               $$(cvsu --list src | grep -Ev 'system\.h$$')              \
185             && { echo '$(ME): the above are already included via system.h'\
186                   1>&2;  exit 1; } || :;                                \
187         fi
188
189 sc_sun_os_names:
190         @( cvsu --list ) > /dev/null 2>&1 || : && \
191         grep -Ei \
192             'solaris[^[:alnum:]]*2\.(7|8|9|[1-9][0-9])|sunos[^[:alnum:]][6-9]' \
193           $$(cvsu --list | grep -vEf .x-$@ ) &&                         \
194           { echo '$(ME): found misuse of Sun OS version numbers' 1>&2;  \
195             exit 1; } || :
196
197 # Ensure that date's --help output stays in sync with the info
198 # documentation for GNU strftime.  The only exception is %N,
199 # which date accepts but GNU strftime does not.
200 extract_char = sed 's/^[^%][^%]*%\(.\).*/\1/'
201 strftime-check:
202         if test -f $(srcdir)/src/date.c; then                           \
203           grep '^  %.  ' $(srcdir)/src/date.c | sort                    \
204             | $(extract_char) > $@-src;                                 \
205           { echo N;                                                     \
206             info libc date calendar format | grep '^    `%.'\'          \
207               | $(extract_char); } | sort > $@-info;                    \
208           diff -u $@-src $@-info || exit 1;                             \
209           rm -f $@-src $@-info;                                         \
210         fi
211
212 # Ensure that we use only the standard $(VAR) notation,
213 # not @...@ in Makefile.am, now that we can rely on automake
214 # to emit a definition for each substituted variable.
215 makefile-check:
216         grep -E '@[A-Z_0-9]+@' `find . -name Makefile.am` \
217           && { echo 'Makefile.maint: use $(...), not @...@' 1>&2; exit 1; } || :
218
219 news-date-check: NEWS
220         today=`date +%Y-%m-%d`; \
221         if head NEWS | grep '^\*.*'$$today >/dev/null; then \
222           :; \
223         else \
224           echo "today's date is not in NEWS" 1>&2; \
225           exit 1; \
226         fi
227
228 changelog-check:
229         if head ChangeLog | grep 'Version $(VERSION)' >/dev/null; then \
230           :; \
231         else \
232           echo "$(VERSION) not in ChangeLog" 1>&2; \
233           exit 1; \
234         fi
235
236 m4-check:
237         @grep 'AC_DEFUN([^[]' m4/*.m4 \
238           && { echo 'Makefile.maint: quote the first arg to AC_DEFUN' 1>&2; \
239                exit 1; } || :
240
241 # Verify that all source files using _() are listed in po/POTFILES.in.
242 # FIXME: don't hard-code src/false.c below; use a more general mechanism.
243 po-check:
244         ( cvsu --list ) > /dev/null 2>&1 || : &&                        \
245         if test -f po/POTFILES.in; then                                 \
246           grep -E -v '^(#|$$)' po/POTFILES.in                           \
247             | grep -v '^src/false\.c$$' | sort > $@-1;                  \
248           files=;                                                       \
249           for file in $$(cvsu --list lib src | grep '\.[chly]$$'); do   \
250             case $$file in                                              \
251             *.[ch])                                                     \
252               base=`expr " $$file" : ' \(.*\)\..'`;                     \
253               { test -f $$base.l || test -f $$base.y; } && continue;;   \
254             esac;                                                       \
255             files="$$files $$file";                                     \
256           done;                                                         \
257           grep -E -l '\bN?_\([^)"]*("|$$)' $$files | sort > $@-2;       \
258           diff -u $@-1 $@-2 || exit 1;                                  \
259           rm -f $@-1 $@-2;                                              \
260         fi
261
262 # In a definition of #define AUTHORS "... and ..." where the RHS contains
263 # the English word `and', the string must be marked with `N_ (...)' so that
264 # gettext recognizes it as a string requiring translation.
265 author_mark_check:
266         @grep '^# *define AUTHORS "[^"]* and ' src/*.c |grep -v ' N_ (' && \
267           { echo 'Makefile.maint: enclose the above strings in N_ (...)' 1>&2; \
268             exit 1; } || :
269
270 # Sometimes it is useful to change the PATH environment variable
271 # in Makefiles.  When doing so, it's better not to use the Unix-centric
272 # path separator of `:', but rather the automake-provided `@PATH_SEPARATOR@'.
273 # It'd be better to use `find -print0 ...|xargs -0 ...', but less portable,
274 # and there probably aren't many projects with so many Makefile.am files
275 # that we'd have to worry about limits on command line length.
276 msg = 'Makefile.maint: Do not use `:'\'' above; use @PATH_SEPARATOR@ instead'
277 makefile_path_separator_check:
278         @grep 'PATH=.*:' `find $(srcdir) -name Makefile.am` \
279           && { echo $(msg) 1>&2; exit 1; } || :
280
281 # Check that `make alpha' will not fail at the end of the process.
282 writable-files:
283         if test -d $(release_archive_dir); then :; else                 \
284           mkdir $(release_archive_dir);                                 \
285         fi
286         for file in $(distdir).tar.gz $(xd-delta)                       \
287                     $(release_archive_dir)/$(distdir).tar.gz            \
288                     $(release_archive_dir)/$(xd-delta); do              \
289           test -e $$file || continue;                                   \
290           test -w $$file                                                \
291             || { echo ERROR: $$file is not writable; fail=1; };         \
292         done;                                                           \
293         test "$$fail" && exit 1 || :
294
295 v_etc_file = lib/version-etc.c
296 # Make sure that the copyright date in $(v_etc_file) is up to date.
297 copyright-check:
298         @if test -f $(v_etc_file); then \
299           grep '"Copyright (C) $(shell date +%Y) Free' $(v_etc_file) \
300             >/dev/null \
301           || { echo 'out of date copyright in $(v_etc_file); update it' 1>&2; \
302                exit 1; }; \
303         fi
304
305
306 # Sanity checks with the CVS repository.
307 cvs-tag-check:
308         echo $(this-cvs-tag); \
309         if $(CVS) -n log -h README | grep -e $(this-cvs-tag): >/dev/null; then \
310           echo "$(this-cvs-tag) as already been used; not tagging" 1>&2; \
311           exit 1; \
312         else :; fi
313
314 cvs-diff-check:
315         if $(CVS) diff >cvs-diffs; then                         \
316           rm cvs-diffs;                                         \
317         else                                                    \
318           echo "Some files are locally modified:" 1>&2;         \
319           cat cvs-diffs;                                        \
320           exit 1;                                               \
321         fi
322
323 cvs-check: cvs-diff-check cvs-tag-check
324
325 maintainer-distcheck: changelog-check
326         $(MAKE) distcheck
327         $(MAKE) my-distcheck
328
329
330 # Tag before making distribution.  Also, don't make a distribution if
331 # checks fail.  Also, make sure the NEWS file is up-to-date.
332 # FIXME: use dist-hook/my-dist like distcheck-hook/my-distcheck.
333 cvs-dist: $(local-check) cvs-check maintainer-distcheck
334         $(CVS) update po
335         $(CVS) tag -c $(this-cvs-tag)
336         $(MAKE) dist
337
338 # Use this to make sure we don't run these programs when building
339 # from a virgin tgz file, below.
340 null_AM_MAKEFLAGS = \
341   ACLOCAL=false \
342   AUTOCONF=false \
343   AUTOMAKE=false \
344   AUTOHEADER=false \
345   MAKEINFO=false
346
347 # Detect format-string/arg-list mismatches that would normally be obscured
348 # by the use of _().  The --disable-nls effectively defines away that macro,
349 # and building with CFLAGS='-Wformat -Werror' causes any format warning to be
350 # treated as a failure.
351 TMPDIR ?= /tmp
352 t=$(TMPDIR)/$(PACKAGE)/test
353 my-distcheck: $(local-check)
354         -rm -rf $(t)
355         mkdir -p $(t)
356         GZIP=$(GZIP_ENV) $(AMTAR) -C $(t) -zxf $(distdir).tar.gz
357         cd $(t)/$(distdir)                              \
358           && ./configure --disable-nls                  \
359           && $(MAKE) CFLAGS='-Wformat -Werror'          \
360               AM_MAKEFLAGS='$(null_AM_MAKEFLAGS)'       \
361           && $(MAKE) dvi                                \
362           && $(MAKE) check                              \
363           && $(MAKE) distclean
364         (cd $(t) && mv $(distdir) $(distdir).old        \
365           && $(AMTAR) -zxf - ) < $(distdir).tar.gz
366         diff -ur $(t)/$(distdir).old $(t)/$(distdir)
367         -rm -rf $(t)
368         @echo "========================"; \
369         echo "$(distdir).tar.gz is ready for distribution"; \
370         echo "========================"
371
372 WGET = wget
373 WGETFLAGS = -C off
374
375 tgz-md5 = $(shell md5sum < $(my_distdir).tar.gz|sed 's/  -//')
376 tgz-sha1 = $(shell sha1sum < $(my_distdir).tar.gz|sed 's/  -//')
377 bz2-md5 = $(shell md5sum < $(my_distdir).tar.bz2|sed 's/  -//')
378 bz2-sha1 = $(shell sha1sum < $(my_distdir).tar.bz2|sed 's/  -//')
379 xdelta-md5 = $(shell md5sum < $(xd-delta)|sed 's/  -//')
380 xdelta-sha1 = $(shell sha1sum < $(xd-delta)|sed 's/  -//')
381 tgz-size = $(shell du --human $(my_distdir).tar.gz|sed 's/\([MkK]\).*/ \1B/')
382 bz2-size = $(shell du --human $(my_distdir).tar.bz2|sed 's/\([MkK]\).*/ \1B/')
383 xd-size = $(shell du --human $(xd-delta)|sed 's/\([MkK]\).*/ \1B/')
384
385 rel-check:
386         tarz=/tmp/rel-check-tarz-$$$$; \
387         md5_tmp=/tmp/rel-check-md5-$$$$; \
388         set -e; \
389         trap 'status=$$?; rm -f $$tarz $$md5_tmp; exit $$status' 0 1 2 3 15; \
390         $(WGET) $(WGETFLAGS) -q --output-document=$$tarz $(url); \
391         echo "$(md5)  -" > $$md5_tmp; \
392         md5sum -c $$md5_tmp < $$tarz
393
394 prev-tgz = $(PACKAGE)-$(PREV_VERSION).tar.gz
395 xd-delta = $(PACKAGE)-$(PREV_VERSION)-$(VERSION).xdelta
396
397 rel-files = $(xd-delta) $(DIST_ARCHIVES)
398 announcement: NEWS ChangeLog $(rel-files)
399         @./announce-gen                                                 \
400             --release-type=$(RELEASE_TYPE)                              \
401             --package=$(PACKAGE)                                        \
402             --prev=$(PREV_VERSION)                                      \
403             --curr=$(VERSION)                                           \
404             --release-archive-directory=$(release_archive_dir)          \
405             --news=NEWS                                                 \
406             $(addprefix --url-dir=, $(url_dir_list))                    \
407
408
409 ## ---------------- ##
410 ## Updating files.  ##
411 ## ---------------- ##
412
413 ftp-gnu = ftp://ftp.gnu.org/gnu
414 www-gnu = http://www.gnu.org
415
416 # Use mv, if you don't have/want move-if-change.
417 move_if_change ?= move-if-change
418
419
420 # --------------------- #
421 # Updating everything.  #
422 # --------------------- #
423
424 .PHONY: update
425 local_updates ?= wget-update cvs-update po-update
426 update: $(local_updates)
427
428
429 # ------------------- #
430 # Updating PO files.  #
431 # ------------------- #
432
433 po_repo = http://www.iro.umontreal.ca/contrib/po/maint/$(PACKAGE)
434 .PHONY: do-po-update po-update
435 do-po-update:
436         tmppo=/tmp/$(PACKAGE)-$(VERSION)-po &&\
437         rm -rf $$tmppo && \
438         mkdir $$tmppo && \
439         (cd $$tmppo && \
440           $(WGET) $(WGETFLAGS) -r -l1 -nd --no-parent -A '*.po' $(po_repo)) &&\
441         cp $$tmppo/*.po po
442         cd po && $(MAKE) update-po
443         $(MAKE) po-check
444
445 po-update:
446         if test -d "po"; then \
447           $(MAKE) do-po-update; \
448         fi
449
450 # -------------------------- #
451 # Updating GNU build tools.  #
452 # -------------------------- #
453
454 # The following pseudo table associates a local directory and a URL
455 # with each of the files that belongs to some other package and is
456 # regularly updated from the specified URL.
457 wget_files ?= \
458   $(srcdir)/config/config.guess \
459   $(srcdir)/config/config.sub \
460   $(srcdir)/config/texinfo.tex \
461   $(srcdir)/src/ansi2knr.c
462
463 get-targets = $(patsubst %, get-%, $(wget_files))
464
465 config.guess-url_prefix = $(ftp-gnu)/config/
466 config.sub-url_prefix = $(ftp-gnu)/config/
467
468 ansi2knr.c-url_prefix = ftp://ftp.cs.wisc.edu/ghost/
469
470 texinfo.tex-url_prefix = $(ftp-gnu)/texinfo/
471
472 standards.texi-url_prefix = $(www-gnu)/prep/
473 make-stds.texi-url_prefix = $(standards.texi-url_prefix)
474
475 target = $(patsubst get-%, %, $@)
476 url = $($(notdir $(target))-url_prefix)$(notdir $(target))
477
478 .PHONY: $(get-targets)
479 $(get-targets):
480         $(WGET) $(WGETFLAGS) $(url) -O $(target).t \
481           && $(move_if_change) $(target).t $(target)
482
483 cvs_files ?= \
484   $(srcdir)/config/depcomp \
485   $(srcdir)/config/install-sh \
486   $(srcdir)/config/missing \
487   $(srcdir)/config/mkinstalldirs \
488   $(srcdir)/src/ansi2knr.c
489 automake_repo=:pserver:anoncvs:anoncvs@sources.redhat.com:/cvs/automake
490 .PHONY: wget-update
491 wget-update: $(get-targets)
492
493 .PHONY: cvs-update
494 cvs-update:
495         fail=;                                                          \
496         for f in $(cvs_files); do                                       \
497           test -f $$f || { echo "*** skipping $$f" 1>&2; continue; };   \
498           cvs diff $$f > /dev/null                                      \
499             || { echo "*** $$f is locally modified; skipping it" 1>&2;  \
500                  fail=yes; continue; };                                 \
501           file=$$(basename $$f);                                        \
502           echo checking out $$file...;                                  \
503           $(CVS) -d $(automake_repo) co -p automake/lib/$$file> $$f.t   \
504             && $(move_if_change) $$f.t $$f;                             \
505         done;                                                           \
506         test "$$fail" && exit 1
507
508 emit_upload_commands:
509         @echo =====================================
510         @echo =====================================
511         @echo "$(srcdir)/gnupload $(GNUPLOADFLAGS) \\"
512         @echo "    --to fetish.sf.net:fetish-ftp \\"
513         @echo "    --to $(gnu_rel_host):coreutils \\"
514         @echo "  $(rel-files)"
515         @echo '# send the /tmp/announcement e-mail'
516         @echo =====================================
517         @echo =====================================
518
519 $(xd-delta): $(release_archive_dir)/$(prev-tgz) $(distdir).tar.gz
520         xdelta delta -9 $^ $@ || :
521
522 .PHONY: alpha beta major
523 alpha beta major: news-date-check $(local-check)
524         $(MAKE) cvs-dist
525         $(MAKE) $(xd-delta)
526         $(MAKE) -s announcement RELEASE_TYPE=$@ > /tmp/announce-$(my_distdir)
527         ln $(rel-files) $(release_archive_dir)
528         chmod a-w $(rel-files)
529         $(MAKE) -s emit_upload_commands RELEASE_TYPE=$@
530         echo $(VERSION) > $(prev_version_file)
531         $(CVS) ci -m. $(prev_version_file)