2002-11-26 Elena Zannoni <ezannoni@redhat.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
AC
101 $(srcdir)/annotate.texi \
102 $(srcdir)/fdl.texi \
b0787093
AC
103 $(srcdir)/gpl.texi \
104 $(GDBMI_DIR)/gdbmi.texinfo \
105 $(READLINE_DIR)/rluser.texinfo \
106 $(READLINE_DIR)/inc-hist.texinfo
107GDB_DOC_BUILD_INCLUDES = \
108 gdb-cfg.texi \
109 GDBvn.texi
110GDB_DOC_FILES = \
111 $(srcdir)/gdb.texinfo \
112 $(GDB_DOC_SOURCE_INCLUDES) \
113 $(GDB_DOC_BUILD_INCLUDES)
114
115# Internals Manual
116GDBINT_DOC_SOURCE_INCLUDES = \
117 $(srcdir)/fdl.texi
118GDBINT_DOC_BUILD_INCLUDES = \
119 gdb-cfg.texi \
120 GDBvn.texi
121GDBINT_DOC_FILES = \
122 $(srcdir)/gdbint.texinfo \
123 $(GDBINT_DOC_SOURCE_INCLUDES) \
124 $(GDBINT_DOC_BUILD_INCLUDES)
125
126# Stabs manual: All files
127STABS_DOC_SOURCE_INCLUDES =
128STABS_DOC_BUILD_INCLUDES =
129STABS_DOC_FILES = \
130 $(srcdir)/stabs.texinfo \
131 $(STABS_DOC_SOURCE_INCLUDES) \
132 $(STABS_DOC_BUILD_INCLUDES)
c906108c
SS
133
134#### Host, target, and site specific Makefile fragments come in here.
135###
136
35db0260 137all:
c906108c 138
63ac3005 139info: $(INFO_DEPS)
c906108c
SS
140dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi
141ps: gdb.ps gdbint.ps stabs.ps refcard.ps
085dd6e6 142html: gdb_toc.html gdbint_toc.html stabs_toc.html
449f3b6c
AC
143pdf: gdb.pdf gdbint.pdf stabs.pdf
144all-doc: info dvi ps # pdf
3555de01 145diststuff: info
c906108c 146
63ac3005 147install-info: $(INFO_DEPS)
9ef47d30 148 $(SHELL) $(srcdir)/../../mkinstalldirs $(infodir)
63ac3005
EZ
149 @list='$(INFO_DEPS)'; \
150 for file in $$list; do \
151 if test -f $$file; then d=.; else d=$(srcdir); fi; \
152 for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
153 if test -f $$d/$$ifile; then \
154 echo " $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile"; \
155 $(INSTALL_DATA) $$d/$$ifile $(infodir)/$$ifile; \
156 else : ; fi; \
157 done; \
158 done
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
085dd6e6
JM
167install-html: html
168 for i in *.html ; do \
169 $(INSTALL_DATA) $$i $(htmldir)/$$i ; \
170 done
171
449f3b6c 172STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf
c906108c
SS
173
174# Copy the object files from a particular stage into a subdirectory.
175stage1: force
176 -mkdir stage1
177 -mv $(STAGESTUFF) stage1
178
179stage2: force
180 -mkdir stage2
181 -mv $(STAGESTUFF) stage2
182
183stage3: force
184 -mkdir stage3
185 -mv $(STAGESTUFF) stage3
186
187against=stage2
188
189comparison: force
190 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
191
192de-stage1: force
193 -(cd stage1 ; mv -f * ..)
194 -rmdir stage1
195
196de-stage2: force
197 -(cd stage2 ; mv -f * ..)
198 -rmdir stage2
199
200de-stage3: force
201 -(cd stage3 ; mv -f * ..)
202 -rmdir stage3
203
c906108c
SS
204# GDB QUICK REFERENCE (dvi output)
205refcard.dvi : refcard.tex $(REFEDITS)
dfa249fb
AC
206 echo > tmp.sed
207 for f in x $(REFEDITS) ; do \
208 test x$$f = xx && continue ; \
209 cat $(srcdir)/$$f >>tmp.sed ; \
210 done
211 sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
c906108c
SS
212 $(SET_TEXINPUTS) $(TEX) sedref.tex
213 mv sedref.dvi refcard.dvi
214 rm -f sedref.log sedref.tex tmp.sed
215
216refcard.ps : refcard.dvi
217 $(DVIPS) -t landscape -o $@ $?
218
05a54c4f
AC
219# File to record current GDB version number (copied from main dir version.in)
220GDBvn.texi : ${gdbdir}/version.in
9ba8d803 221 echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new
c906108c
SS
222 mv GDBvn.new GDBvn.texi
223
224# Updated atomically
225.PRECIOUS: GDBvn.texi
226
227# Choose configuration for GDB manual (normally `all'; normally not tied into
228# `configure' script because most users prefer generic version of manual,
229# not one for their binary config---which may not be specifically
230# defined anyways).
231gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
39ec5655
EZ
232 (test "$$LN_S" = "ln -s" && \
233 ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
c906108c
SS
234 ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
235 cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
236
237# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
238# If your texinfo or makeinfo don't support these, get a new texinfo release
239#
240# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
241# Note that we can *generate* GDBvn.texi, but since we distribute one in the
242# source directory for the benefit of people who *don't* use this makefile,
243# VPATH will often tell make not to bother building it, because the one
244# in the srcdir is up to date. (if not, then make should build one here).
245
46d8b1c3
AC
246# Clean these up before each run. Avoids a catch 22 with not being
247# able to re-generate these files (to fix a corruption) because these
248# files contain a corruption.
b0787093
AC
249GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
250 gdb.tp* gdb.vr*
251
c906108c 252# GDB MANUAL: TeX dvi file
b0787093 253gdb.dvi: ${GDB_DOC_FILES}
c906108c 254 if [ ! -f ./GDBvn.texi ]; then \
39ec5655 255 (test "$$LN_S" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
c906108c
SS
256 ln $(srcdir)/GDBvn.texi . || \
257 cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093 258 rm -f $(GDB_TEX_TMPS)
be298bcc 259 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo
c906108c
SS
260
261gdb.ps: gdb.dvi
262 $(DVIPS) -o $@ $?
263
b0787093 264gdb.pdf: ${GDB_DOC_FILES}
449f3b6c
AC
265 if [ ! -f ./GDBvn.texi ]; then \
266 (test "$$LN_S" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
267 ln $(srcdir)/GDBvn.texi . || \
268 cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093 269 rm -f $(GDB_TEX_TMPS)
be298bcc 270 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo
449f3b6c 271
c906108c 272# GDB MANUAL: info file
b0787093 273gdb.info: ${GDB_DOC_FILES}
a7b40f07
AC
274 $(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
275 -o gdb.info $(srcdir)/gdb.texinfo
c906108c
SS
276
277# GDB MANUAL: roff translations
278# Try to use a recent texi2roff. v2 was put on prep in jan91.
279# If you want an index, see texi2roff doc for postprocessing
280# and add -i to texi2roff invocations below.
281# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
282# corresponding -e lines when later texi2roff's are current)
283# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
284# + @c's deleted explicitly because texi2roff sees texinfo commands in them
285# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
286# + @alphaenumerate is ridiculously new, turned into @enumerate
287
288# texi2roff doesn't have a notion of include dirs, so we have to fake
289# it out for gdb manual's include files---but only if not configured
290# in main sourcedir.
b0787093 291links2roff: $(GDB_DOC_SOURCE_INCLUDES)
c906108c 292 if [ ! -f gdb.texinfo ]; then \
b0787093
AC
293 (test "$$LN_S" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
294 ln $(GDB_DOC_SOURCE_INCLUDES) . || \
295 cp $(GDB_DOC_SOURCE_INCLUDES) . ; \
c906108c
SS
296 fi
297 touch links2roff
298
c906108c 299# gdb manual suitable for [gtn]roff -me
b0787093 300gdb.me: $(GDB_DOC_FILES) links2roff
c906108c
SS
301 sed -e '/\\input texinfo/d' \
302 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
303 -e '/^@ifinfo/,/^@end ifinfo/d' \
304 -e '/^@c /d' \
305 -e 's/{.*,,/{/' \
306 -e 's/@ / /g' \
307 -e 's/^@alphaenumerate/@enumerate/g' \
308 -e 's/^@end alphaenumerate/@end enumerate/g' \
309 $(srcdir)/gdb.texinfo | \
310 $(TEXI2ROFF) -me | \
311 sed -e 's/---/\\(em/g' \
312 >gdb.me
313
314# gdb manual suitable for [gtn]roff -ms
b0787093 315gdb.ms: $(GDB_DOC_FILES) links2roff
c906108c
SS
316 sed -e '/\\input texinfo/d' \
317 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
318 -e '/^@ifinfo/,/^@end ifinfo/d' \
319 -e '/^@c /d' \
320 -e 's/{.*,,/{/' \
321 -e 's/@ / /g' \
322 -e 's/^@alphaenumerate/@enumerate/g' \
323 -e 's/^@end alphaenumerate/@end enumerate/g' \
324 $(srcdir)/gdb.texinfo | \
325 $(TEXI2ROFF) -ms | \
326 sed -e 's/---/\\(em/g' \
327 >gdb.ms
328
329# gdb manual suitable for [tn]roff -mm
330# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
331# try leaving them in
b0787093 332gdb.mm: $(GDB_DOC_FILES) links2roff
c906108c
SS
333 sed -e '/\\input texinfo/d' \
334 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
335 -e '/^@ifinfo/,/^@end ifinfo/d' \
336 -e '/^@c /d' \
337 -e 's/{.*,,/{/' \
338 -e '/@noindent/d' \
339 -e 's/@ / /g' \
340 -e 's/^@alphaenumerate/@enumerate/g' \
341 -e 's/^@end alphaenumerate/@end enumerate/g' \
342 $(srcdir)/gdb.texinfo | \
343 $(TEXI2ROFF) -mm | \
344 sed -e 's/---/\\(em/g' \
345 >gdb.mm
346
085dd6e6
JM
347# GDB MANUAL: HTML file
348
b0787093 349gdb_toc.html: ${GDB_DOC_FILES}
7162c0ca 350 $(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
085dd6e6 351
46d8b1c3
AC
352# Clean these up before each run. Avoids a catch 22 with not being
353# able to re-generate these files (to fix a corruption) because these
354# files contain a corruption.
b0787093
AC
355GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
356 gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
357
c906108c 358# GDB INTERNALS MANUAL: TeX dvi file
b0787093
AC
359gdbint.dvi: $(GDBINT_DOC_FILES)
360 rm -f $(GDBINT_TEX_TMPS)
be298bcc 361 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo
c906108c
SS
362
363gdbint.ps : gdbint.dvi
364 $(DVIPS) -o $@ $?
365
b0787093
AC
366gdbint.pdf: $(GDBINT_DOC_FILES)
367 rm -f $(GDBINT_TEX_TMPS)
be298bcc 368 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo
449f3b6c 369
c906108c
SS
370# GDB INTERNALS MANUAL: info file
371
b0787093 372gdbint.info: $(GDBINT_DOC_FILES)
aab4e0ec 373 $(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo
c906108c 374
085dd6e6
JM
375# GDB INTERNALS MANUAL: HTML file
376
b0787093 377gdbint_toc.html: $(GDBINT_DOC_FILES)
085dd6e6
JM
378 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
379
b0787093 380stabs.info: $(STABS_DOC_FILES)
c906108c
SS
381 $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
382
085dd6e6
JM
383# STABS DOCUMENTATION: HTML file
384
b0787093 385stabs_toc.html: $(STABS_DOC_FILES)
085dd6e6
JM
386 $(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
387
46d8b1c3
AC
388# Clean these up before each run. Avoids a catch 22 with not being
389# able to re-generate these files (to fix a corruption) because these
390# files contain a corruption.
b0787093
AC
391STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
392 stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
393
c906108c 394# STABS DOCUMENTATION: TeX dvi file
b0787093
AC
395stabs.dvi : $(STABS_DOC_FILES)
396 rm -f $(STABS_TEX_TMPS)
be298bcc 397 $(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo
c906108c
SS
398
399stabs.ps: stabs.dvi
400 $(DVIPS) -o $@ $?
401
b0787093
AC
402stabs.pdf: $(STABS_DOC_FILES)
403 rm -f $(STABS_TEX_TMPS)
be298bcc 404 $(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo
449f3b6c 405
c906108c
SS
406force:
407
408Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
409 $(SHELL) ./config.status
46d8b1c3
AC
410
411
412# The "least clean" level of cleaning. Get rid of files which are
413# automatically generated files that are just intermediate files,
414
415mostlyclean:
416 rm -f gdb.mm gdb.ms gdb.me links2roff
417 rm -f $(GDB_TEX_TMPS)
418 rm -f $(GDBINT_TEX_TMPS)
419 rm -f $(STABS_TEX_TMPS)
420 rm -f sedref.dvi sedref.tex tmp.sed
421
422clean: mostlyclean
423 rm -f gdb-cfg.texi
424
425distclean: clean
426 rm -f Makefile config.status
427
428# GDBvn.texi, the dvi files, the info files, and the postscript files,
429# are all part of the distribution, so it should not be removed by
430# "clean" or "distclean". Use maintainer-clean to remove them.
431
432maintainer-clean realclean: distclean
433 rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf
434
35db0260 435install: install-info
This page took 0.288473 seconds and 4 git commands to generate.