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