Fix typos.
[kopensolaris-gnu/glibc.git] / manual / Makefile
1 # Copyright (C) 1992-1999, 2000, 2001 Free Software Foundation, Inc.
2 # This file is part of the GNU C Library.
3
4 # The GNU C Library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License, or (at your option) any later version.
8
9 # The GNU C Library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 # Lesser General Public License for more details.
13
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with the GNU C Library; if not, write to the Free
16 # Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
17 # 02111-1307 USA.
18
19 # Makefile for the GNU C Library manual.
20
21 subdir := manual
22 export subdir := $(subdir)
23
24 # Allow override
25 INSTALL_INFO = install-info
26
27 .PHONY: all dvi pdf info html
28 all: dvi
29 dvi: libc.dvi
30 pdf: libc.pdf
31
32 # Get glibc's configuration info.
33 ifneq (,$(wildcard ../Makeconfig))
34 include ../Makeconfig
35 else
36 MAKEINFO = makeinfo
37 TEXI2DVI = texi2dvi
38 AWK = gawk
39 endif
40
41 TEXI2PDF = texi2dvi --pdf
42
43 ifneq ($(strip $(MAKEINFO)),:)
44 all: info
45 info: libc.info dir-add.info
46 endif
47
48 # scripts we use
49 ifndef move-if-change
50 move-if-change = ./move-if-change
51 endif
52 mkinstalldirs = $(..)scripts/mkinstalldirs
53
54 chapters = $(addsuffix .texi, \
55                        intro errno memory ctype string charset locale   \
56                        message search pattern io stdio llio filesys     \
57                        pipe socket terminal syslog math arith time      \
58                        resource setjmp signal startup process job nss   \
59                        users sysinfo conf crypt debug)
60 add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
61 appendices = lang.texi header.texi install.texi maint.texi contrib.texi \
62              freemanuals.texi
63
64 -include texis
65 texis: texis.awk $(chapters) $(add-chapters) $(appendices) lesser.texi fdl.texi
66         $(AWK) -f $^ > $@.T
67         mv -f $@.T $@
68
69 nonexamples = $(filter-out $(add-chapters) %.c.texi, $(texis))
70 examples = $(filter-out $(foreach d, $(add-ons), ../$d/%.c.texi), \
71                         $(filter %.c.texi, $(texis)))
72
73 # Kludge: implicit rule so Make knows the one command does it all.
74 chapters.% top-menu.%: libc-texinfo.sh $(texis) Makefile
75         AWK=$(AWK) $(SHELL) $< '$(chapters)' '$(add-chapters)' '$(appendices)'
76
77 libc.dvi libc.pdf libc.info: chapters.texi top-menu.texi libm-err.texi
78 libc.dvi libc.pdf: texinfo.tex
79
80 html: libc/index.html
81 libc/index.html: chapters.texi top-menu.texi libm-err.texi
82         $(MAKEINFO) --html libc.texinfo
83
84 # Generate the summary from the Texinfo source files for each chapter.
85 summary.texi: stamp-summary ;
86 stamp-summary: summary.awk $(filter-out summary.texi, $(texis))
87         $(AWK) -f $^ | sort -t'\f' -df +0 -1 | tr '\014' '\012' > summary-tmp
88         $(move-if-change) summary-tmp summary.texi
89         touch $@
90
91 # Generate a file which can be added to the `dir' content to provide direct
92 # access to the documentation of the function, variables, and other
93 # definitions.
94 dir-add.info: xtract-typefun.awk $(texis)
95         (echo "INFO-DIR-SECTION GNU C library functions";               \
96          echo "START-INFO-DIR-ENTRY";                                   \
97          $(AWK) -f $^ | sort;                                           \
98          echo "END-INFO-DIR-ENTRY") > $@.new
99         mv -f $@.new $@
100
101 # The table with the math errors is generated.
102 libm-err.texi: stamp-libm-err
103 stamp-libm-err: libm-err-tab.pl $(wildcard $(foreach dir,$(sysdirs),\
104                                                      $(dir)/libm-test-ulps))
105         pwd=`pwd`; \
106         $(PERL) $< $$pwd/.. > libm-err-tmp
107         $(move-if-change) libm-err-tmp libm-err.texi
108         touch $@
109
110 # Generate Texinfo files from the C source for the example programs.
111 %.c.texi: examples/%.c
112         sed -e 's,[{}],@&,g'                            \
113             -e 's,/\*\(@.*\)\*/,\1,g'                   \
114             -e 's,/\*  *,/* @r{,g' -e 's,  *\*/,} */,'  \
115             -e 's/\(@[a-z][a-z]*\)@{\([^}]*\)@}/\1{\2}/g'\
116             $< | expand > $@.new
117         mv -f $@.new $@
118
119 %.info: %.texinfo
120         LANGUAGE=C LC_ALL=C $(MAKEINFO) $<
121
122 %.dvi: %.texinfo
123         $(TEXI2DVI) $<
124
125 %.pdf: %.texinfo
126         $(TEXI2PDF) $<
127
128 # Distribution.
129 minimal-dist = summary.awk texis.awk tsort.awk libc-texinfo.sh libc.texinfo \
130                libm-err.texi stamp-libm-err                                 \
131                $(filter-out summary.texi, $(nonexamples))                   \
132                $(patsubst %.c.texi,examples/%.c, $(examples))
133
134 doc-only-dist = Makefile COPYING.LIB
135 distribute = $(minimal-dist) $(examples) stdio-fp.c     \
136              libc.info* libc.?? libc.??s texinfo.tex    \
137              xtract-typefun.awk dir-add.info dir libm-err-tab.pl
138 export distribute := $(distribute)
139
140 tar-it = tar chovf $@ $^
141
142 manual.tar: $(doc-only-dist) $(minimal-dist) ; $(tar-it)
143 mandist.tar: $(doc-only-dist) $(distribute) ; $(tar-it)
144
145 edition := $(shell sed -n 's/^@set EDITION \([0-9][0-9.]*\)[^0-9.]*.*$$/\1/p' \
146                        libc.texinfo)
147
148 glibc-doc-$(edition).tar: $(doc-only-dist) $(distribute)
149         @rm -f glibc-doc-$(edition)
150         ln -s . glibc-doc-$(edition)
151         tar chovf $@ $(addprefix glibc-doc-$(edition)/,$^)
152         rm -f glibc-doc-$(edition)
153
154 %.Z: %
155         compress -c $< > $@.new
156         mv -f $@.new $@
157 %.gz: %
158         gzip -9 -c $< > $@.new
159         mv -f $@.new $@
160 %.uu: %
161         uuencode $< < $< > $@.new
162         mv -f $@.new $@
163
164 .PHONY: mostlyclean distclean realclean clean
165 mostlyclean:
166         -rm -f libc.dvi libc.pdf libc.tmp libc.info* dir-add.info
167         -rm -f $(objpfx)stubs $(objpfx)distinfo
168         -rm -f $(foreach o,$(object-suffixes-for-libc),$(objpfx)stamp$o)
169 clean: mostlyclean
170 distclean: clean
171 indices = cp fn pg tp vr ky
172 realclean: distclean
173         -rm -f texis summary.texi stamp-summary *.c.texi
174         -rm -f $(foreach index,$(indices),libc.$(index) libc.$(index)s)
175         -rm -f libc.log libc.aux libc.toc dir-add.texinfo
176         -rm -f top-menu.texi chapters.texi
177
178 .PHONY: install subdir_install installdirs install-data
179 install-data subdir_install: install
180 ifneq ($(strip $(MAKEINFO)),:)
181 # There are two variants of install-info out there.  The GNU version
182 # knows about the INFO-DIR-SECTION tag, the Debian version doesn't.
183 ifneq ($(OLD_DEBIAN_INSTALL_INFO),yes)
184 install: $(inst_infodir)/libc.info dir-add.info
185         @if $(SHELL) -c '$(INSTALL_INFO) --version' >/dev/null 2>&1; then \
186          test -f $(inst_infodir)/dir || $(INSTALL_DATA) dir $(inst_infodir);\
187          $(INSTALL_INFO) --info-dir=$(inst_infodir) $(inst_infodir)/libc.info;\
188          $(INSTALL_INFO) --info-dir=$(inst_infodir) dir-add.info;\
189         else : ; fi
190 else
191 install: $(inst_infodir)/libc.info dir-add.info
192         @if $(SHELL) -c '$(INSTALL_INFO) --version' >/dev/null 2>&1; then \
193           test -f $(inst_infodir)/dir || $(INSTALL_DATA) dir $(inst_infodir);\
194          $(INSTALL_INFO) --info-dir=$(inst_infodir) \
195              --section '^GNU Libraries:' 'GNU Libraries:' \
196              $(inst_infodir)/libc.info;\
197          $(INSTALL_INFO) --info-dir=$(inst_infodir) \
198              --section '^GNU C Library functions:' 'GNU C Library functions:' \
199              dir-add.info;\
200         else : ; fi
201 endif
202 endif
203 # Catchall implicit rule for other installation targets from the parent.
204 install-%: ;
205
206 $(inst_infodir)/libc.info: libc.info installdirs
207         for file in $<*; do \
208           $(INSTALL_DATA) $$file $(@D)/$$file; \
209         done
210
211 installdirs:
212         $(mkinstalldirs) $(inst_infodir)
213
214 .PHONY: dist
215 dist: # glibc-doc-$(edition).tar.gz
216
217 ifneq (,$(wildcard ../Make-dist))
218 dist: ../Make-dist
219         $(MAKE) -f $< $(Make-dist-args)
220 endif
221
222 ifndef ETAGS
223 ETAGS = etags -T
224 endif
225 TAGS: $(minimal-dist)
226         $(ETAGS) -o $@ $^
227 \f
228 # The parent makefile sometimes invokes us with targets `subdir_REAL-TARGET'.
229 subdir_%: % ;
230 # For targets we don't define, do nothing.
231 subdir_%: ;
232
233 # These are targets that each glibc subdirectory is expected to understand.
234 # ../Rules defines them for code subdirectories; for us, they are no-ops.
235 # None of these should be `subdir_TARGET'; those targets are transformed
236 # by the implicit rule above into `TARGET' deps.
237 glibc-targets   := lib objects objs others tests lint.out \
238                    echo-headers echo-distinfo
239 .PHONY: $(glibc-targets)
240 $(glibc-targets):
241
242 # Create stamp files if they don't exist, so the parent makefile's rules for
243 # updating the library archives are happy with us, and never think we have
244 # changed the library.
245 lib: $(foreach o,$(object-suffixes-for-libc),$(objpfx)stamp$o)
246 ifdef objpfx
247 .PHONY: stubs
248 stubs: $(objpfx)stubs
249 endif
250 $(objpfx)stubs ../po/manual.pot $(objpfx)stamp%:
251         $(make-target-directory)
252         touch $@
253
254 # Make the target directory if it doesn't exist, using the `mkinstalldirs'
255 # script that does `mkdir -p' even if `mkdir' doesn't support that flag.
256 define make-target-directory
257 $(addprefix $(mkinstalldirs) ,\
258             $(filter-out $(wildcard $(@D:%/=%)),$(@D:%/=%)))
259 endef
260
261 # The top-level glibc Makefile expects subdir_install to update the stubs file.
262 subdir_install: stubs
263 \f
264 # Get rid of these variables if they came from the parent.
265 routines =
266 aux =
267 sources =
268 objects =
269 headers =