1 # Make coreutils documentation. -*-Makefile-*-
3 # Copyright (C) 1995-2012 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 parse-datetime.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 && \
37 's/.*\(DEFAULT_PASSES\)[ =]* \([0-9]*\).*/@set SHRED_\1 \2/p'\
38 $(top_srcdir)/src/shred.c; } > t-$@ \
41 MAINTAINERCLEANFILES = constants.texi
43 $(DVIS): $(EXTRA_DIST)
44 $(INFO_DEPS): $(EXTRA_DIST)
46 # Extended regular expressions to match word starts and ends.
47 _W = (^|[^A-Za-z0-9_])
48 W_ = ([^A-Za-z0-9_]|$$)
57 sc-exponent-grouping \
61 .PHONY: $(syntax_checks) check-texinfo
63 # List words/regexps here that should not appear in the texinfo documentation.
64 check-texinfo: $(syntax_checks)
66 grep '@url{' $(srcdir)/*.texi && fail=1; \
67 grep '\$$@"' $(srcdir)/*.texi && fail=1; \
68 grep -n '[^[:punct:]]@footnote' $(srcdir)/*.texi && fail=1; \
69 grep -n filename $(srcdir)/*.texi \
70 | $(EGREP) -v 'setfilename|[{]filename[}]' \
75 $(AM_V_GEN)$(EGREP) -i '$(_W)builtins?$(W_)' $(srcdir)/*.texi \
80 $(EGREP) -i '$(_W)path(name)?s?$(W_)' $(srcdir)/*.texi \
82 'PATH=|path search|search path|@vindex PATH$$|@env[{]PATH[}]' \
86 # Use "time zone", not "timezone".
88 $(AM_V_GEN)$(EGREP) timezone $(srcdir)/*.texi && exit 1 || :
90 # Check for insufficient exponent grouping, e.g.,
91 # @math{2^64} should be @math{2^{64}}.
93 $(AM_V_GEN)$(EGREP) '\{.*\^[0-9][0-9]' $(srcdir)/*.texi && exit 1 || :
95 # E.g., use @sc{nul}, not NUL.
96 sc-use-small-caps-NUL:
97 $(AM_V_GEN)$(EGREP) '$(_W)NUL$(W_)' $(srcdir)/*.texi && exit 1 || :
101 $(AM_V_GEN)$(EGREP) '$(_W)IO$(W_)' $(srcdir)/*.texi && exit 1 || :
103 # I prefer nonzero over non-zero.
105 $(AM_V_GEN)$(EGREP) non-zero $(srcdir)/*.texi && exit 1 || :
107 # Use "zeros", not "zeroes" (nothing wrong with "zeroes"; just be consistent).
109 $(AM_V_GEN)$(EGREP) -i '$(_W)zeroes$(W_)' $(srcdir)/*.texi \
112 # ME = $(subdir)/$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
115 # The quantity inside @var{...} should not contain upper case letters.
116 # The leading backslash exemption is to permit in-macro uses like
117 # @var{\varName\} where the upper case letter is part of a parameter name.
118 find_upper_case_var = \
120 while (/\@var{(.+?)}/g) \
123 $$v =~ /[A-Z]/ && $$v !~ /^\\/ and (print "$$ARGV:$$.:$$_"), $$m = 1 \
125 END {$$m and (warn "$(ME): do not use upper case in \@var{...}\n"), exit 1}'
127 $(AM_V_GEN)$(PERL) -e 1 || { echo $@: skipping test; exit 0; }; \
128 $(PERL) -lne $(find_upper_case_var) $(srcdir)/*.texi