Small doc fix
[automake/plouj.git] / Makefile.am
blob7fc1fd9d4c5720e8ca74038f218c89825a4345ad
1 ## Process this file with automake to create Makefile.in
3 ## Makefile for Automake.
5 ## Copyright (C) 1995, 1996, 1997, 1998, 1999, 2001, 2002, 2003, 2004,
6 ## 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
8 ## This program is free software; you can redistribute it and/or modify
9 ## it under the terms of the GNU General Public License as published by
10 ## the Free Software Foundation; either version 3, or (at your option)
11 ## any later version.
13 ## This program is distributed in the hope that it will be useful,
14 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 ## GNU General Public License for more details.
18 ## You should have received a copy of the GNU General Public License
19 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
21 ## lib goes first, because it builds Config.pm, used by aclocal and
22 ## automake (run in doc, tests, and in the rebuild rules.)
23 ## `.' goes before doc and tests, because the latter two directories
24 ## run aclocal and automake.
25 SUBDIRS = lib . doc m4 tests
27 bin_SCRIPTS = automake aclocal
29 CLEANFILES = $(bin_SCRIPTS)
30 AUTOMAKESOURCES = automake.in aclocal.in
32 TAGS_FILES = $(AUTOMAKESOURCES)
34 EXTRA_DIST = \
35   ChangeLog.96 \
36   ChangeLog.98 \
37   ChangeLog.00 \
38   ChangeLog.01 \
39   ChangeLog.02 \
40   ChangeLog.03 \
41   ChangeLog.04 \
42   $(AUTOMAKESOURCES)
44 ## Make versioned links.  We only run the transform on the root name;
45 ## then we make a versioned link with the transformed base name.  This
46 ## seemed like the most reasonable approach.
47 install-exec-hook:
48         @$(POST_INSTALL)
49         @for p in $(bin_SCRIPTS); do \
50           f="`echo $$p|sed '$(transform)'`"; \
51           fv="$$f-$(APIVERSION)"; \
52           rm -f $(DESTDIR)$(bindir)/$$fv; \
53           echo " $(LN) $(DESTDIR)$(bindir)/$$f $(DESTDIR)$(bindir)/$$fv"; \
54           $(LN) $(DESTDIR)$(bindir)/$$f $(DESTDIR)$(bindir)/$$fv; \
55         done
57 uninstall-hook:
58         @for p in $(bin_SCRIPTS); do \
59           f="`echo $$p|sed '$(transform)'`"; \
60           fv="$$f-$(APIVERSION)"; \
61           rm -f $(DESTDIR)$(bindir)/$$fv; \
62         done
65 ## We can't use configure to do the substitution here; we must do it
66 ## by hand.  We use a funny notation here to avoid configure
67 ## substitutions in our text.
68 do_subst = sed \
69   -e 's,[@]APIVERSION[@],$(APIVERSION),g' \
70   -e 's,[@]PACKAGE[@],$(PACKAGE),g' \
71   -e 's,[@]PATH_SEPARATOR[@],$(PATH_SEPARATOR),g' \
72   -e 's,[@]PERL[@],$(PERL),g' \
73   -e 's,[@]SHELL[@],$(SHELL),g' \
74   -e 's,[@]VERSION[@],$(VERSION),g' \
75   -e 's,[@]configure_input[@],Generated from $@.in; do not edit by hand.,g' \
76   -e 's,[@]datadir[@],$(datadir),g'
78 ## These files depend on Makefile so they are rebuilt if $(VERSION),
79 ## $(datadir) or other do_subst'ituted variables change.
80 ## Use chmod a-w to prevent people from editing the wrong file by accident.
81 automake: automake.in
82 aclocal: aclocal.in
83 automake aclocal: Makefile
84         rm -f $@ $@.tmp
85         $(do_subst) $(srcdir)/$@.in >$@.tmp
86         chmod +x $@.tmp
87         chmod a-w $@.tmp
88         mv -f $@.tmp $@
90 ## The master location for INSTALL is lib/INSTALL.
91 ## This is where `make fetch' will install new versions.
92 ## Make sure we also update this copy.
93 INSTALL: lib/INSTALL
94         cp $(srcdir)/lib/INSTALL $@
96 ################################################################
98 ## Everything past here is useful to the maintainer, but probably not
99 ## to anybody else
102 # Ensure tests are world-executable
103 dist-hook:
104         cd $(distdir)/tests && chmod a+rx *.test
106 # Some simple checks, and then ordinary check.  These are only really
107 # guaranteed to work on my machine.
108 maintainer-check: automake aclocal
109 ## This check avoids accidental configure substitutions in the source.
110 ## There are exactly 6 lines that should be modified.  This works out
111 ## to 22 lines of diffs.
112         @if test `diff $(srcdir)/automake.in automake | wc -l` -ne 22; then \
113           echo "found too many diffs between automake.in and automake"; 1>&2; \
114           diff -c $(srcdir)/automake.in automake; \
115           exit 1; \
116         fi
117 ## Syntax check with default Perl (on my machine, Perl 5).
118         perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w automake
119         perllibdir="./lib$(PATH_SEPARATOR)$(srcdir)/lib" $(PERL) -c -w aclocal
120 ## expect no instances of '${...}'.  However, $${...} is ok, since that
121 ## is a shell construct, not a Makefile construct.
122         @if grep -F '$${' $(srcdir)/lib/am/[a-z]*.am | \
123                grep -F -v '$$$$'; then \
124           echo "Found too many uses of '\$${' in the lines above." 1>&2; \
125           exit 1;                               \
126         else :; fi
127 ## Make sure `rm' is called with `-f'.
128         @if grep -v '^#' $(srcdir)/lib/am/[a-z]*.am $(srcdir)/tests/*.test | \
129             grep -E '\<rm ([^-]|\-[^f ]*\>)'; then \
130           echo "Suspicious 'rm' invocation." 1>&2; \
131           exit 1;                               \
132         else :; fi
133 ## Never use something like `for file in $(FILES)', this doesn't work
134 ## if FILES is empty or if it contains shell meta characters (e.g. $ is
135 ## commonly used in Java filenames).
136         @if grep 'for .* in \$$(' $(srcdir)/lib/am/[a-z]*.am; then \
137           echo 'Use "list=$$(mumble); for var in $$$$list".' 1>&2 ; \
138           exit 1; \
139         else :; fi
140 ## Make sure all invocations of mkinstalldirs are correct.
141         @if grep -n 'mkinstalldirs' $(srcdir)/lib/am/[a-z]*.am | \
142               grep -F -v '$$(mkinstalldirs)'; then \
143           echo "Found incorrect use of mkinstalldirs in the lines above" 1>&2; \
144           exit 1; \
145         else :; fi
146 ## Make sure all calls to PRE/NORMAL/POST_INSTALL/UNINSTALL
147         @if grep -E -n '\((PRE|NORMAL|POST)_(|UN)INSTALL\)' \
148                  $(srcdir)/lib/am/[a-z]*.am | \
149               grep -v ':##' | grep -v ':        @\$$('; then \
150           echo "Found incorrect use of PRE/NORMAL/POST_INSTALL/UNINSTALL in the lines above" 1>&2; \
151           exit 1; \
152         else :; fi
153 ## We never want to use "undef", only "delete", but for $/.
154         @if grep -n -w 'undef ' $(srcdir)/automake.in | \
155               grep -F -v 'undef $$/'; then \
156           echo "Found undef in automake.in; use delete instead" 1>&2; \
157           exit 1; \
158         fi
159 ## We never want split (/ /,...), only split (' ', ...).
160         @if grep -n 'split (/ /' $(srcdir)/automake.in; then \
161           echo "Found bad split in the lines above." 1>&2; \
162           exit 1; \
163         fi
164 ## Look for cd within backquotes
165         @if grep -n '^[^#]*` *cd ' $(srcdir)/automake.in \
166               $(srcdir)/lib/am/*.am; then \
167           echo "Consider using $$$$(am__cd) in the line above." 1>&2; \
168           exit 1; \
169         fi
170 ## Using @_ in a scalar context is most probably a programming error.
171         @if grep -Hn '[^@_A-Za-z0-9][_A-Za-z0-9]*[^) ] *= *@_' $(srcdir)/automake.in; then \
172           echo "Using @_ in a scalar context in the lines above." 1>&2; \
173           exit 1; \
174         fi
175 ## Forbid using parens with `local' to ease counting.
176         @if grep '^[ \t]*local *(' $(srcdir)/automake.in; then \
177           echo "Don't use \`local' with parens: use several \`local' above." >&2; \
178           exit 1; \
179         fi
180 ## Allow only `local $_' in Automake.
181         @if grep -v '^[ \t]*local \$$_;' $(srcdir)/automake.in | \
182                 grep '^[ \t]*local [^*]'; then \
183           echo "Please avoid \`local'." 1>&2; \
184           exit 1; \
185         fi
186 ## Don't let AMDEP_TRUE substitution appear in automake.in.
187         @if grep '@AMDEP''_TRUE@' $(srcdir)/automake.in; then \
188           echo "Don't put AMDEP_TRUE substitution in automake.in" 1>&2; \
189           exit 1; \
190         fi
191 ## Tests should never call make directly.
192         @if grep '^[^#].*(MAKE) ' $(srcdir)/lib/am/*.am $(srcdir)/automake.in |\
193                 grep -v 'AM_MAKEFLAGS'; then \
194           echo 'Use $$(MAKE) $$(AM_MAKEFLAGS).' 1>&2; \
195           exit 1; \
196         fi
197 ## Tests should never call make directly.
198         @if grep -v '^#' $(srcdir)/tests/*.test | grep ':[      ]*make'; then \
199           echo 'Do not run "make" in the above tests.  Use "$$MAKE" instead.' 1>&2; \
200           exit 1; \
201         fi
202 ## Tests should never call autoconf directly.
203         @if grep -v '^#' $(srcdir)/tests/*.test | grep ':[      ]*autoconf'; then \
204           echo 'Do not run "autoconf" in the above tests.  Use "$$AUTOCONF" instead.' 1>&2; \
205           exit 1; \
206         fi
207 ## Tests should never call autoupdate directly.
208         @if grep -v '^#' $(srcdir)/tests/*.test | grep ':[      ]*autoupdate'; then \
209           echo 'Do not run "autoupdate" in the above tests.  Use "$$AUTOUPDATE" instead.' 1>&2; \
210           exit 1; \
211         fi
212 ## Tests should never call automake directly.
213         @if grep -v '^#' $(srcdir)/tests/*.test | grep -E ':[   ]*automake([^:]|$$)'; then \
214           echo 'Do not run "automake" in the above tests.  Use "$$AUTOMAKE" instead.' 1>&2;  \
215           exit 1; \
216         fi
217 ## Use AUTOMAKE_fails when appropriate
218         @if grep -v '^#' $(srcdir)/tests/*.test | grep '\$$AUTOMAKE.*&&.*exit'; then \
219           echo 'Use AUTOMAKE_fails + grep to catch automake failures in the above tests.' 1>&2;  \
220           exit 1; \
221         fi
222 ## Tests should never call aclocal directly.
223         @if grep -v '^#' $(srcdir)/tests/*.test | grep ':[      ]*aclocal'; then \
224           echo 'Do not run "aclocal" in the above tests.  Use "$$ACLOCAL" instead.' 1>&2;  \
225           exit 1; \
226         fi
227 ## Tests should never call perl directly.
228         @if grep -v '^#' $(srcdir)/tests/*.test | grep ':[      ]*perl'; then \
229           echo 'Do not run "perl" in the above tests.  Use "$$PERL" instead.' 1>&2; \
230           exit 1; \
231         fi
232 ## Setting `required' after sourcing `./defs' is a bug.
233         @for file in $(srcdir)/tests/*.test; do \
234           if out=`sed -n '/defs/,$${/required=/p;}' $$file`; test -n "$$out"; then \
235             echo 'Do not set "required" after sourcing "defs" in '"$$file: $$out" 1>&2; \
236             exit 1; \
237           fi; \
238         done
239 ## Overriding a Makefile macro on the command line is not portable when
240 ## recursive targets are used.  Better use an envvar.  SHELL is an exception,
241 ## POSIX says it can't come from the environment.
242         @if grep -E '\$$MAKE .*(SHELL=.*=|=.*SHELL=)' $(srcdir)/tests/*.test; then \
243           echo 'Rewrite "$$MAKE foo=bar SHELL=$$SHELL" as "foo=bar $$MAKE -e SHELL=$$SHELL"' 1>&2; \
244           echo ' in the above lines, it is more portable.' 1>&2; \
245           exit 1; \
246         fi
247         @if grep -v SHELL $(srcdir)/tests/*.test | grep '\$$MAKE .*=' ; then \
248           echo 'Rewrite "$$MAKE foo=bar" as "foo=bar $$MAKE -e" in the above lines,' 1>&2; \
249           echo 'it is more portable.' 1>&2; \
250           exit 1; \
251         fi
252         @if grep 'SHELL=.*\$$MAKE' $(srcdir)/tests/*.test; then \
253           echo '$$MAKE ignores the SHELL envvar, use "$$MAKE SHELL=$$SHELL" in' 1>&2; \
254           echo 'the above lines.' 1>&2; \
255           exit 1; \
256         fi
257 ## Never use `sleep 1' to create files with different timestamps.
258 ## Use `$sleep' instead.  Some filesystems (e.g., Windows') have only
259 ## a 2sec resolution.
260         @if grep -E '\bsleep +[12345]\b' $(srcdir)/tests/*.test; then \
261           echo 'Do not use "sleep x" in the above tests.  Use "$$sleep" instead.' 1>&2; \
262           exit 1; \
263         fi
264 ## fgrep and egrep are not required by POSIX.
265         @if grep -E '\b[ef]grep\b' $(srcdir)/tests/*.test ; then \
266           echo 'Do not use egrep or fgrep in test cases.  Use $$FGREP or $$EGREP.' 1>&2; \
267           exit 1; \
268         fi
269         @if grep -E '\b[ef]grep\b' $(srcdir)/lib/am/*.am $(srcdir)/m4/*.m4; then \
270           echo 'Do not use egrep or fgrep in the above files, they are not portable.' 1>&2; \
271           exit 1; \
272         fi
273         @if grep 'mkdir_p' $(srcdir)/automake.in \
274               $(srcdir)/lib/am/*.am $(srcdir)/tests/*.test; then \
275           echo 'Do not use mkdir_p in the above files, use MKDIR_P.' 1>&2; \
276           exit 1; \
277         fi
278 ## Try to make sure all @...@ substitutions are covered by our
279 ## substitution rule.
280         @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' aclocal | wc -l` -ne 0; then \
281           echo "Unresolved @...@ substitution in aclocal" 1>&2; \
282           exit 1; \
283         fi
284         @if test `grep -E '^[^#]*@[A-Za-z_0-9]+@' automake | wc -l` -ne 0; then \
285           echo "Unresolved @...@ substitution in automake" 1>&2; \
286           exit 1; \
287         fi; \
288         if grep -E "[^\'\"]\\\$$\(DESTDIR" $(srcdir)/lib/am/*.am; then \
289           echo 'Suspicious unquoted DESTDIR uses.' 1>&2 ; \
290           exit 1; \
291         fi
292         @if grep '      ' $(srcdir)/doc/automake.texi; then \
293           echo 'Do not use tabs in the manual.' 1>&2; \
294           exit 1; \
295         fi
296         @if grep -E '([^@]|^)@([         ][^@]|$$)' $(srcdir)/doc/automake.texi; \
297         then \
298           echo 'Unescaped @.' 1>&2; \
299           exit 1; \
300         fi
303 git-dist: maintainer-check
304 ## Make sure clcommit exists (we use it at the end of git-dist).
305         @if (clcommit --version)>/dev/null 2>/dev/null; then :; else \
306           echo "Get clcommit from module cvs-utils on Savannah."; \
307           exit 1; \
308         fi
309 ## Make sure the NEWS file is up-to-date.
310         @if sed 1q $(srcdir)/NEWS | grep -e "$(VERSION)" > /dev/null; then :; else \
311           echo "NEWS not updated; not releasing" 1>&2; \
312           exit 1;                               \
313         fi
314 ## Build the distribution
315         $(MAKE) distcheck
316 ## Finally, if anything was successful, commit the last changes and tag
317 ## the release in the repository.  We don't use RCS keywords so it's OK
318 ## to distribute the files before they were committed.
319         cd $(srcdir) && clcommit && \
320           git tag -s `echo "Release-$(VERSION)" | sed 's/\./-/g'`
322 git-release: git-dist
323         case $(VERSION) in \
324           *[a-z]) dest=alpha;; \
325           *)      dest=ftp;; \
326         esac; \
327         $(srcdir)/lib/gnupload $(GNUPLOADFLAGS) \
328           --to sources.redhat.com:~ftp/pub/automake \
329           --to $$dest.gnu.org:automake $(DIST_ARCHIVES)
331 cvs-diff:
332         thisver=`echo "Release-$(VERSION)" | sed 's/\./-/g'`; \
333         if test -z "$$OLDVERSION"; then \
334           prevno=`echo "$(VERSION)" - 0.01 | bc | sed 's/^\./0./'`; \
335         else prevno="$$OLDVERSION"; fi; \
336         prevver=Release-`echo $$prevno | sed 's/\./-/g'`; \
337         cvs -f rdiff -c -r $$prevver -r $$thisver $(PACKAGE) \
338             > $(PACKAGE)-$$prevno-$(VERSION).diff
340 git-diff:
341         thisver=`echo "Release-$(VERSION)" | sed 's/\./-/g'`; \
342         if test -z "$$OLDVERSION"; then \
343           prevno=`echo "$(VERSION)" - 0.01 | bc | sed 's/^\./0./'`; \
344         else prevno="$$OLDVERSION"; fi; \
345         prevver=Release-`echo $$prevno | sed 's/\./-/g'`; \
346         git diff $$prevver $$thisver $(PACKAGE) \
347             > $(PACKAGE)-$$prevno-$(VERSION).diff
349 ## Check our path lengths.
350 path-check: distdir
351         (cd $(distdir) && \
352 ## FIXME there's got to be a better way!  pathchk should take the list
353 ## of files on stdin, at least.
354           find . -print | xargs pathchk -p); \
355           status=$$?; \
356           chmod -R a+w $(distdir) > /dev/null 2>&1; rm -rf $(distdir); \
357           exit $$status
359 ## Program to use to fetch files.
360 WGET = wget
361 WGET_SV_CVS = $(WGET) http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/
362 WGET_SV_GIT_CF = $(WGET) 'http://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;hb=HEAD;f='
363 WGET_SV_GIT_AC = $(WGET) 'http://git.savannah.gnu.org/gitweb/?p=autoconf.git;a=blob_plain;hb=HEAD;f='
364 WGET_SV_GIT_GL = $(WGET) 'http://git.savannah.gnu.org/gitweb/?p=gnulib.git;a=blob_plain;hb=HEAD;f='
365 WGET_GCC = $(WGET) 'http://gcc.gnu.org/viewcvs/*checkout*/trunk/'
367 ## Files that we fetch and which we compare against.
368 ## FIXME should be a lot more here
369 FETCHFILES = \
370 INSTALL \
371 config-ml.in \
372 config.guess \
373 config.sub \
374 symlink-tree \
375 texinfo.tex
377 ## Fetch the latest versions of files we care about.
378 fetch:
379         rm -rf Fetchdir > /dev/null 2>&1
380         mkdir Fetchdir
381 ## If a get fails then that is a problem.
382         (cd Fetchdir && \
383         $(WGET_SV_GIT_CF)config.guess -O config.guess && \
384         $(WGET_SV_GIT_CF)config.sub -O config.sub && \
385         $(WGET_SV_CVS)texinfo/texinfo/doc/texinfo.tex -O texinfo.tex && \
386         $(WGET_SV_GIT_GL)doc/INSTALL -O INSTALL && \
387         $(WGET_GCC)config-ml.in -O config-ml.in && \
388         $(WGET_GCC)symlink-tree -O symlink-tree)
389 ## Don't exit after test because we want to give as many errors as
390 ## possible.
391         @stat=0; for file in $(FETCHFILES); do \
392           if diff -u $(srcdir)/lib/$$file Fetchdir/$$file \
393                   >>Fetchdir/update.patch 2>/dev/null; then :; \
394           else \
395             stat=1; \
396             echo "Updating $(srcdir)/lib/$$file..."; \
397             cp Fetchdir/$$file $(srcdir)/lib/$$file; \
398           fi; \
399         done; \
400         test $$stat = 0 || \
401           echo "See Fetchdir/update.patch for a log of the changes."; \
402         exit $$stat