1 # Make coreutils documentation. -*-Makefile-*-
3 # Copyright (C) 1995-1998, 2001-2010 Free Software Foundation, Inc.
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 info_TEXINFOS = coreutils.texi
20 EXTRA_DIST = perm.texi getdate.texi constants.texi fdl.texi
22 # The following is necessary if the package name is 8 characters or longer.
23 # If the info documentation would be split into 10 or more separate files,
24 # then this is necessary even if the package name is 7 characters long.
26 # Tell makeinfo to put everything in a single info file: <package>.info.
27 # Otherwise, it would also generate files with names like <package>.info-[123],
28 # and those names all map to one 14-byte name (<package>.info-) on some crufty
30 AM_MAKEINFOFLAGS = --no-split
32 constants.texi: $(top_srcdir)/src/tail.c $(top_srcdir)/src/shred.c
33 $(AM_V_GEN)LC_ALL=C; export LC_ALL; \
34 { sed -n -e 's/^#define \(DEFAULT_MAX[_A-Z]*\) \(.*\)/@set \1 \2/p' \
35 $(top_srcdir)/src/tail.c && \
36 sed -n -e 's/.*\(DEFAULT_PASSES\)[ =]* \([0-9]*\).*/@set SHRED_\1 \2/p'\
37 $(top_srcdir)/src/shred.c; } > t-$@ \
40 MAINTAINERCLEANFILES = constants.texi
42 $(DVIS): $(EXTRA_DIST)
43 $(INFO_DEPS): $(EXTRA_DIST)
45 # Extended regular expressions to match word starts and ends.
46 _W = (^|[^A-Za-z0-9_])
47 W_ = ([^A-Za-z0-9_]|$$)
56 sc-exponent-grouping \
60 .PHONY: $(syntax_checks) check-texinfo
62 # List words/regexps here that should not appear in the texinfo documentation.
63 check-texinfo: $(syntax_checks)
65 grep '@url{' $(srcdir)/*.texi && fail=1; \
66 grep '\$$@"' $(srcdir)/*.texi && fail=1; \
67 grep -n '[^[:punct:]]@footnote' $(srcdir)/*.texi && fail=1; \
68 grep -n filename $(srcdir)/*.texi \
69 | $(EGREP) -v 'setfilename|[{]filename[}]' \
71 $(PERL) -e 1 2> /dev/null && { $(PERL) -ne \
72 '/\bPOSIX\b/ && !/\@acronym{POSIX}/ && !/^\* / || /{posix}/ and print,exit 1' \
73 $(srcdir)/*.texi 2> /dev/null || fail=1; }; \
77 $(AM_V_GEN)$(EGREP) -i '$(_W)builtins?$(W_)' $(srcdir)/*.texi \
82 $(EGREP) -i '$(_W)path(name)?s?$(W_)' $(srcdir)/*.texi \
84 'PATH=|path search|search path|@vindex PATH$$|@env[{]PATH[}]' \
88 # Use `time zone', not `timezone'.
90 $(AM_V_GEN)$(EGREP) timezone $(srcdir)/*.texi && exit 1 || :
92 # Check for insufficient exponent grouping, e.g.,
93 # @math{2^64} should be @math{2^{64}}.
95 $(AM_V_GEN)$(EGREP) '\{.*\^[0-9][0-9]' $(srcdir)/*.texi && exit 1 || :
97 # E.g., use @sc{nul}, not NUL.
98 sc-use-small-caps-NUL:
99 $(AM_V_GEN)$(EGREP) '$(_W)NUL$(W_)' $(srcdir)/*.texi && exit 1 || :
103 $(AM_V_GEN)$(EGREP) '$(_W)IO$(W_)' $(srcdir)/*.texi && exit 1 || :
105 # I prefer nonzero over non-zero.
107 $(AM_V_GEN)$(EGREP) non-zero $(srcdir)/*.texi && exit 1 || :
109 # Use `zeros', not `zeroes' (nothing wrong with `zeroes'. just be consistent).
111 $(AM_V_GEN)$(EGREP) -i '$(_W)zeroes$(W_)' $(srcdir)/*.texi && exit 1 || :
113 # ME = $(subdir)/$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
116 # The quantity inside @var{...} should not contain upper case letters.
117 # The leading backslash exemption is to permit in-macro uses like
118 # @var{\varName\} where the upper case letter is part of a parameter name.
119 find_upper_case_var = \
121 while (/\@var{(.+?)}/g) \
124 $$v =~ /[A-Z]/ && $$v !~ /^\\/ and (print "$$ARGV:$$.:$$_"), $$m = 1 \
126 END {$$m and (warn "$(ME): do not use upper case in \@var{...}\n"), exit 1}'
128 $(AM_V_GEN)$(PERL) -e 1 \
129 && $(PERL) -lne $(find_upper_case_var) $(srcdir)/*.texi