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