2003-05-10 H.J. Lu <hongjiu.lu@intel.com>
[deliverable/binutils-gdb.git] / gdb / doc / Makefile.in
CommitLineData
be298bcc 1##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002
b6ba6518 2##Free Software Foundation, Inc.
c906108c
SS
3
4# Makefile for GDB documentation.
5# This file is part of GDB.
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 of the License, or
10# (at your option) 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 02111-1307, USA.
20
21srcdir = @srcdir@
22VPATH = @srcdir@
23
24prefix = @prefix@
25
26infodir = @infodir@
085dd6e6 27htmldir = $(prefix)/html
c906108c
SS
28
29SHELL = @SHELL@
30
39ec5655
EZ
31LN_S = @LN_S@
32
c906108c
SS
33INSTALL = @INSTALL@
34INSTALL_PROGRAM = @INSTALL_PROGRAM@
35INSTALL_DATA = @INSTALL_DATA@
36
37# main GDB source directory
38gdbdir = $(srcdir)/..
39
40# where to find texinfo; GDB dist should include a recent one
41TEXIDIR=${gdbdir}/../texinfo
42
43# where to find makeinfo, preferably one designed for texinfo-2
44MAKEINFO=makeinfo
45
6d2ebf8b
SS
46# Note that texinfo 4.0's makeinfo --html can only generate a
47# single file, which would be too large, so continue to use
48# texi2html. -sts 2000-03-28
49
085dd6e6 50MAKEHTML = texi2html
f4846649 51MAKEHTMLFLAGS = -menu -split_chapter
085dd6e6 52
c906108c
SS
53# where to find texi2roff, ditto
54TEXI2ROFF=texi2roff
55
be298bcc
AC
56# where to find texi2dvi, ditto
57TEXI2DVI=texi2dvi
58
c906108c
SS
59# Where is the source dir for the READLINE library doc?
60# Traditionally readline is in .. or .
61READLINE_DIR = ${gdbdir}/../readline/doc
62
7162c0ca
EZ
63# The GDB/MI docs come from a sibling directory ../mi
64GDBMI_DIR = ${gdbdir}/mi
65
66SET_TEXINPUTS = \
67 TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS
c906108c 68
63ac3005
EZ
69# Files which should be generated via 'info' and installed by 'install-info'
70INFO_DEPS = gdb.info gdbint.info stabs.info
71
c906108c
SS
72# There may be alternate predefined collections of switches to configure
73# the GDB manual. Normally this is not done in synch with the software
74# config system, since this choice tends to be independent; most people
75# want a doc config of `all' for a generic manual, regardless of sw config.
76DOC_CONFIG = all
77
78# This list of sed edits will edit the GDB reference card
79# for what fonts and what papersize to use.
80# By default (NO edits applied), the refcard uses:
81# - Computer Modern (CM) fonts
82# - US letter paper (8.5x11in)
83# List some of the following files for alternative fonts and paper:
84# a4rc.sed use A4 paper (297 x 210 mm)
85# psrc.sed use PostScript fonts (Karl Berry short TeX names)
86# lpsrc.sed use PostScript fonts (full PostScript names in TeX)
87# e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
88# for A4, CM fonts: REFEDITS = a4rc.sed
89# for US, PS fonts: REFEDITS = psrc.sed
90# for default:
91REFEDITS =
92
93# Don Knuth's TeX formatter
94TEX = tex
95
c906108c
SS
96# Program to generate Postscript files from DVI files.
97DVIPS = dvips
98
b0787093
AC
99# Main GDB manual
100GDB_DOC_SOURCE_INCLUDES = \
aab4e0ec 101 $(srcdir)/fdl.texi \
b0787093 102 $(srcdir)/gpl.texi \
b0787093
AC
103 $(READLINE_DIR)/rluser.texinfo \
104 $(READLINE_DIR)/inc-hist.texinfo
105GDB_DOC_BUILD_INCLUDES = \
106 gdb-cfg.texi \
107 GDBvn.texi
108GDB_DOC_FILES = \
109 $(srcdir)/gdb.texinfo \
110 $(GDB_DOC_SOURCE_INCLUDES) \
111 $(GDB_DOC_BUILD_INCLUDES)
112
113# Internals Manual
114GDBINT_DOC_SOURCE_INCLUDES = \
bcd7e15f
JB
115 $(srcdir)/fdl.texi \
116 $(srcdir)/observer.texi
b0787093
AC
117GDBINT_DOC_BUILD_INCLUDES = \
118 gdb-cfg.texi \
119 GDBvn.texi
120GDBINT_DOC_FILES = \
121 $(srcdir)/gdbint.texinfo \
122 $(GDBINT_DOC_SOURCE_INCLUDES) \
123 $(GDBINT_DOC_BUILD_INCLUDES)
124
125# Stabs manual: All files
126STABS_DOC_SOURCE_INCLUDES =
127STABS_DOC_BUILD_INCLUDES =
128STABS_DOC_FILES = \
129 $(srcdir)/stabs.texinfo \
130 $(STABS_DOC_SOURCE_INCLUDES) \
131 $(STABS_DOC_BUILD_INCLUDES)
c906108c
SS
132
133#### Host, target, and site specific Makefile fragments come in here.
134###
135
35db0260 136all:
c906108c 137
63ac3005 138info: $(INFO_DEPS)
c906108c
SS
139dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
140ps: gdb.ps gdbint.ps stabs.ps refcard.ps
085dd6e6 141html: gdb_toc.html gdbint_toc.html stabs_toc.html
449f3b6c
AC
142pdf: gdb.pdf gdbint.pdf stabs.pdf
143all-doc: info dvi ps # pdf
3555de01 144diststuff: info
c906108c 145
63ac3005 146install-info: $(INFO_DEPS)
9ef47d30 147 $(SHELL) $(srcdir)/../../mkinstalldirs $(infodir)
63ac3005
EZ
148 @list='$(INFO_DEPS)'; \
149 for file in $$list; do \
150 if test -f $$file; then d=.; else d=$(srcdir); fi; \
151 for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
152 if test -f $$d/$$ifile; then \
153 echo " $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile"; \
154 $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile; \
155 else : ; fi; \
156 done; \
157 done
c166cdc7 158 $(POST_INSTALL)
d3229ae3 159 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
63ac3005 160 list='$(INFO_DEPS)'; \
d3229ae3
EZ
161 for file in $$list; do \
162 echo " install-info --info-dir=$(infodir) $(infodir)/$$file";\
163 install-info --info-dir=$(infodir) $(infodir)/$$file || :;\
164 done; \
165 else : ; fi
c906108c 166
c166cdc7
EZ
167uninstall-info:
168 $(PRE_UNINSTALL)
169 @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
170 ii=yes; \
171 else ii=; fi; \
172 list='$(INFO_DEPS)'; \
173 for file in $$list; do \
174 test -z "$$ii" \
175 || install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \
176 done
177 $(NORMAL_UNINSTALL)
178 list='$(INFO_DEPS)'; \
179 for file in $$list; do \
180 (cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \
181 done
182
085dd6e6
JM
183install-html: html
184 for i in *.html ; do \
185 $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
186 done
187
449f3b6c 188STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
c906108c
SS
189
190# Copy the object files from a particular stage into a subdirectory.
191stage1: force
192 -mkdir stage1
193 -mv $(STAGESTUFF) stage1
194
195stage2: force
196 -mkdir stage2
197 -mv $(STAGESTUFF) stage2
198
199stage3: force
200 -mkdir stage3
201 -mv $(STAGESTUFF) stage3
202
203against=stage2
204
205comparison: force
206 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
207
208de-stage1: force
209 -(cd stage1 ; mv -f * ..)
210 -rmdir stage1
211
212de-stage2: force
213 -(cd stage2 ; mv -f * ..)
214 -rmdir stage2
215
216de-stage3: force
217 -(cd stage3 ; mv -f * ..)
218 -rmdir stage3
219
c906108c
SS
220# GDB QUICK REFERENCE (dvi output)
221refcard.dvi : refcard.tex $(REFEDITS)
dfa249fb
AC
222 echo > tmp.sed
223 for f in x $(REFEDITS) ; do \
224 test x$$f = xx && continue ; \
225 cat $(srcdir)/$$f >>tmp.sed ; \
226 done
227 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
c906108c
SS
228 $(SET_TEXINPUTS) $(TEX) sedref.tex
229 mv sedref.dvi refcard.dvi
230 rm -f sedref.log sedref.tex tmp.sed
231
232refcard.ps : refcard.dvi
233 $(DVIPS) -t landscape -o $@ $?
234
05a54c4f
AC
235# File to record current GDB version number (copied from main dir version.in)
236GDBvn.texi : ${gdbdir}/version.in
9ba8d803 237 echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new
c906108c
SS
238 mv GDBvn.new GDBvn.texi
239
240# Updated atomically
241.PRECIOUS: GDBvn.texi
242
243# Choose configuration for GDB manual (normally `all'; normally not tied into
244# `configure' script because most users prefer generic version of manual,
245# not one for their binary config---which may not be specifically
246# defined anyways).
247gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
44e2be90 248 (test "$(LN_S)" = "ln -s" && \
39ec5655 249 ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
c906108c
SS
250 ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
251 cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
252
253# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
254# If your texinfo or makeinfo don't support these, get a new texinfo release
255#
256# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
257# Note that we can *generate* GDBvn.texi, but since we distribute one in the
258# source directory for the benefit of people who *don't* use this makefile,
259# VPATH will often tell make not to bother building it, because the one
260# in the srcdir is up to date. (if not, then make should build one here).
261
46d8b1c3
AC
262# Clean these up before each run. Avoids a catch 22 with not being
263# able to re-generate these files (to fix a corruption) because these
264# files contain a corruption.
b0787093
AC
265GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
266 gdb.tp* gdb.vr*
267
c906108c 268# GDB MANUAL: TeX dvi file
b0787093 269gdb.dvi: ${GDB_DOC_FILES}
c906108c 270 if [ ! -f ./GDBvn.texi ]; then \
44e2be90 271 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
c906108c
SS
272 ln $(srcdir)/GDBvn.texi . || \
273 cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093 274 rm -f $(GDB_TEX_TMPS)
be298bcc 275 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo
c906108c
SS
276
277gdb.ps: gdb.dvi
278 $(DVIPS) -o $@ $?
279
b0787093 280gdb.pdf: ${GDB_DOC_FILES}
449f3b6c 281 if [ ! -f ./GDBvn.texi ]; then \
44e2be90 282 (test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
449f3b6c
AC
283 ln $(srcdir)/GDBvn.texi . || \
284 cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093 285 rm -f $(GDB_TEX_TMPS)
be298bcc 286 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo
449f3b6c 287
c906108c 288# GDB MANUAL: info file
b0787093 289gdb.info: ${GDB_DOC_FILES}
a7b40f07
AC
290 $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
291 -o gdb.info $(srcdir)/gdb.texinfo
c906108c
SS
292
293# GDB MANUAL: roff translations
294# Try to use a recent texi2roff. v2 was put on prep in jan91.
295# If you want an index, see texi2roff doc for postprocessing
296# and add -i to texi2roff invocations below.
297# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
298# corresponding -e lines when later texi2roff's are current)
299# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
300# + @c's deleted explicitly because texi2roff sees texinfo commands in them
301# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
302# + @alphaenumerate is ridiculously new, turned into @enumerate
303
304# texi2roff doesn't have a notion of include dirs, so we have to fake
305# it out for gdb manual's include files---but only if not configured
306# in main sourcedir.
b0787093 307links2roff: $(GDB_DOC_SOURCE_INCLUDES)
c906108c 308 if [ ! -f gdb.texinfo ]; then \
44e2be90 309 (test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
b0787093
AC
310 ln $(GDB_DOC_SOURCE_INCLUDES) . || \
311 cp $(GDB_DOC_SOURCE_INCLUDES) . ; \
c906108c
SS
312 fi
313 touch links2roff
314
c906108c 315# gdb manual suitable for [gtn]roff -me
b0787093 316gdb.me: $(GDB_DOC_FILES) links2roff
c906108c
SS
317 sed -e '/\\input texinfo/d' \
318 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
319 -e '/^@ifinfo/,/^@end ifinfo/d' \
320 -e '/^@c /d' \
321 -e 's/{.*,,/{/' \
322 -e 's/@ / /g' \
323 -e 's/^@alphaenumerate/@enumerate/g' \
324 -e 's/^@end alphaenumerate/@end enumerate/g' \
325 $(srcdir)/gdb.texinfo | \
326 $(TEXI2ROFF) -me | \
327 sed -e 's/---/\\(em/g' \
328 >gdb.me
329
330# gdb manual suitable for [gtn]roff -ms
b0787093 331gdb.ms: $(GDB_DOC_FILES) links2roff
c906108c
SS
332 sed -e '/\\input texinfo/d' \
333 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
334 -e '/^@ifinfo/,/^@end ifinfo/d' \
335 -e '/^@c /d' \
336 -e 's/{.*,,/{/' \
337 -e 's/@ / /g' \
338 -e 's/^@alphaenumerate/@enumerate/g' \
339 -e 's/^@end alphaenumerate/@end enumerate/g' \
340 $(srcdir)/gdb.texinfo | \
341 $(TEXI2ROFF) -ms | \
342 sed -e 's/---/\\(em/g' \
343 >gdb.ms
344
345# gdb manual suitable for [tn]roff -mm
346# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
347# try leaving them in
b0787093 348gdb.mm: $(GDB_DOC_FILES) links2roff
c906108c
SS
349 sed -e '/\\input texinfo/d' \
350 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
351 -e '/^@ifinfo/,/^@end ifinfo/d' \
352 -e '/^@c /d' \
353 -e 's/{.*,,/{/' \
354 -e '/@noindent/d' \
355 -e 's/@ / /g' \
356 -e 's/^@alphaenumerate/@enumerate/g' \
357 -e 's/^@end alphaenumerate/@end enumerate/g' \
358 $(srcdir)/gdb.texinfo | \
359 $(TEXI2ROFF) -mm | \
360 sed -e 's/---/\\(em/g' \
361 >gdb.mm
362
085dd6e6
JM
363# GDB MANUAL: HTML file
364
b0787093 365gdb_toc.html: ${GDB_DOC_FILES}
7162c0ca 366 $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
085dd6e6 367
46d8b1c3
AC
368# Clean these up before each run. Avoids a catch 22 with not being
369# able to re-generate these files (to fix a corruption) because these
370# files contain a corruption.
b0787093
AC
371GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
372 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
373
c906108c 374# GDB INTERNALS MANUAL: TeX dvi file
b0787093
AC
375gdbint.dvi: $(GDBINT_DOC_FILES)
376 rm -f $(GDBINT_TEX_TMPS)
be298bcc 377 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo
c906108c
SS
378
379gdbint.ps : gdbint.dvi
380 $(DVIPS) -o $@ $?
381
b0787093
AC
382gdbint.pdf: $(GDBINT_DOC_FILES)
383 rm -f $(GDBINT_TEX_TMPS)
be298bcc 384 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo
449f3b6c 385
c906108c
SS
386# GDB INTERNALS MANUAL: info file
387
b0787093 388gdbint.info: $(GDBINT_DOC_FILES)
aab4e0ec 389 $(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo
c906108c 390
085dd6e6
JM
391# GDB INTERNALS MANUAL: HTML file
392
b0787093 393gdbint_toc.html: $(GDBINT_DOC_FILES)
085dd6e6
JM
394 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
395
b0787093 396stabs.info: $(STABS_DOC_FILES)
c906108c
SS
397 $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
398
085dd6e6
JM
399# STABS DOCUMENTATION: HTML file
400
b0787093 401stabs_toc.html: $(STABS_DOC_FILES)
085dd6e6
JM
402 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
403
46d8b1c3
AC
404# Clean these up before each run. Avoids a catch 22 with not being
405# able to re-generate these files (to fix a corruption) because these
406# files contain a corruption.
b0787093
AC
407STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
408 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
409
c906108c 410# STABS DOCUMENTATION: TeX dvi file
b0787093
AC
411stabs.dvi : $(STABS_DOC_FILES)
412 rm -f $(STABS_TEX_TMPS)
be298bcc 413 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo
c906108c
SS
414
415stabs.ps: stabs.dvi
416 $(DVIPS) -o $@ $?
417
b0787093
AC
418stabs.pdf: $(STABS_DOC_FILES)
419 rm -f $(STABS_TEX_TMPS)
be298bcc 420 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo
449f3b6c 421
c906108c
SS
422force:
423
424Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
425 $(SHELL) ./config.status
46d8b1c3
AC
426
427
428# The "least clean" level of cleaning. Get rid of files which are
429# automatically generated files that are just intermediate files,
430
431mostlyclean:
432 rm -f gdb.mm gdb.ms gdb.me links2roff
433 rm -f $(GDB_TEX_TMPS)
434 rm -f $(GDBINT_TEX_TMPS)
435 rm -f $(STABS_TEX_TMPS)
436 rm -f sedref.dvi sedref.tex tmp.sed
437
438clean: mostlyclean
439 rm -f gdb-cfg.texi
440
441distclean: clean
d7f4a264 442 rm -f Makefile config.status config.log
46d8b1c3
AC
443
444# GDBvn.texi, the dvi files, the info files, and the postscript files,
445# are all part of the distribution, so it should not be removed by
446# "clean" or "distclean". Use maintainer-clean to remove them.
447
448maintainer-clean realclean: distclean
449 rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf
450
35db0260 451install: install-info
c166cdc7
EZ
452
453uninstall: uninstall-info
This page took 0.367834 seconds and 4 git commands to generate.