1 ##Copyright 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003
2 ##Free Software Foundation, Inc.
4 # Makefile for GDB documentation.
5 # This file is part of GDB.
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.
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.
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.
27 htmldir
= $(prefix)/html
34 INSTALL_PROGRAM
= @INSTALL_PROGRAM@
35 INSTALL_DATA
= @INSTALL_DATA@
37 # main GDB source directory
40 # where to find texinfo; GDB dist should include a recent one
41 TEXIDIR
=${gdbdir}/..
/texinfo
43 # where to find makeinfo, preferably one designed for texinfo-2
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
51 MAKEHTMLFLAGS
= -menu
-split_chapter
53 # where to find texi2roff, ditto
56 # where to find texi2dvi, ditto
59 # Where is the source dir for the READLINE library doc?
60 # Traditionally readline is in .. or .
61 READLINE_DIR
= ${gdbdir}/..
/readline
/doc
63 # The GDB/MI docs come from a sibling directory ../mi
64 GDBMI_DIR
= ${gdbdir}/mi
67 TEXINPUTS
=${TEXIDIR}:.
:$(srcdir):$(READLINE_DIR
):$(GDBMI_DIR
):$$TEXINPUTS
69 # Files which should be generated via 'info' and installed by 'install-info'
70 INFO_DEPS
= gdb.
info gdbint.
info stabs.
info
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.
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
93 # Don Knuth's TeX formatter
96 # Program to generate Postscript files from DVI files.
100 GDB_DOC_SOURCE_INCLUDES
= \
103 $(srcdir)/agentexpr.texi \
104 $(READLINE_DIR
)/rluser.texinfo \
105 $(READLINE_DIR
)/inc-hist.texinfo
106 GDB_DOC_BUILD_INCLUDES
= \
110 $(srcdir)/gdb.texinfo \
111 $(GDB_DOC_SOURCE_INCLUDES
) \
112 $(GDB_DOC_BUILD_INCLUDES
)
115 GDBINT_DOC_SOURCE_INCLUDES
= \
117 $(srcdir)/observer.texi
118 GDBINT_DOC_BUILD_INCLUDES
= \
122 $(srcdir)/gdbint.texinfo \
123 $(GDBINT_DOC_SOURCE_INCLUDES
) \
124 $(GDBINT_DOC_BUILD_INCLUDES
)
126 # Stabs manual: All files
127 STABS_DOC_SOURCE_INCLUDES
=
128 STABS_DOC_BUILD_INCLUDES
=
130 $(srcdir)/stabs.texinfo \
131 $(STABS_DOC_SOURCE_INCLUDES
) \
132 $(STABS_DOC_BUILD_INCLUDES
)
134 #### Host, target, and site specific Makefile fragments come in here.
140 dvi: gdb.
dvi gdbint.
dvi stabs.
dvi refcard.
dvi
141 ps
: gdb.ps gdbint.ps stabs.ps refcard.ps
142 html
: gdb_toc.html gdbint_toc.html stabs_toc.html
143 pdf
: gdb.pdf gdbint.pdf stabs.pdf
144 all-doc
: info dvi ps
# pdf
147 install-info
: $(INFO_DEPS
)
148 $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
$(infodir)
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; \
160 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
161 list
='$(INFO_DEPS)'; \
162 for file in
$$list; do \
163 echo
" install-info --info-dir=$(infodir) $(infodir)/$$file";\
164 install-info
--info-dir
=$(infodir) $(infodir)/$$file ||
:;\
170 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
173 list
='$(INFO_DEPS)'; \
174 for file in
$$list; do \
176 || install-info
--info-dir
=$(DESTDIR
)$(infodir) --remove
$$file; \
179 list
='$(INFO_DEPS)'; \
180 for file in
$$list; do \
181 (cd
$(DESTDIR
)$(infodir) && rm -f
$$file $$file-[0-9] $$file-[0-9][0-9]); \
185 for i in
*.html
; do \
186 $(INSTALL_DATA
) $$i $(htmldir
)/$$i ; \
189 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
*.ps
*.
dvi *.pdf
191 # Copy the object files from a particular stage into a subdirectory.
194 -mv
$(STAGESTUFF
) stage1
198 -mv
$(STAGESTUFF
) stage2
202 -mv
$(STAGESTUFF
) stage3
207 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
210 -(cd stage1
; mv
-f
* ..
)
214 -(cd stage2
; mv
-f
* ..
)
218 -(cd stage3
; mv
-f
* ..
)
221 # GDB QUICK REFERENCE (dvi output)
222 refcard.
dvi : refcard.
tex $(REFEDITS
)
224 for f in x
$(REFEDITS
) ; do \
225 test x
$$f = xx
&& continue
; \
226 cat
$(srcdir)/$$f >>tmp.sed
; \
228 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
229 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
230 mv sedref.
dvi refcard.
dvi
231 rm -f sedref.log sedref.
tex tmp.sed
233 refcard.ps
: refcard.
dvi
234 $(DVIPS
) -t landscape
-o
$@
$?
236 # File to record current GDB version number (copied from main dir version.in)
237 GDBvn.texi
: ${gdbdir}/version.in
238 echo
"@set GDBVN `sed q $(srcdir)/../version.in`" > .
/GDBvn.new
239 mv GDBvn.new GDBvn.texi
242 .PRECIOUS
: GDBvn.texi
244 # Choose configuration for GDB manual (normally `all'; normally not tied into
245 # `configure' script because most users prefer generic version of manual,
246 # not one for their binary config---which may not be specifically
248 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
249 (test "$(LN_S)" = "ln -s" && \
250 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
) || \
251 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
252 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
254 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
255 # If your texinfo or makeinfo don't support these, get a new texinfo release
257 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
258 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
259 # source directory for the benefit of people who *don't* use this makefile,
260 # VPATH will often tell make not to bother building it, because the one
261 # in the srcdir is up to date. (if not, then make should build one here).
263 # Clean these up before each run. Avoids a catch 22 with not being
264 # able to re-generate these files (to fix a corruption) because these
265 # files contain a corruption.
266 GDB_TEX_TMPS
= gdb.aux gdb.cp
* gdb.fn
* gdb.ky
* gdb.log gdb.pg
* gdb.toc \
269 # GDB MANUAL: TeX dvi file
270 gdb.
dvi: ${GDB_DOC_FILES}
271 if
[ ! -f .
/GDBvn.texi
]; then \
272 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
273 ln
$(srcdir)/GDBvn.texi . || \
274 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
275 rm -f
$(GDB_TEX_TMPS
)
276 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdb.texinfo
281 gdb.pdf
: ${GDB_DOC_FILES}
282 if
[ ! -f .
/GDBvn.texi
]; then \
283 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
284 ln
$(srcdir)/GDBvn.texi . || \
285 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
286 rm -f
$(GDB_TEX_TMPS
)
287 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdb.texinfo
289 # GDB MANUAL: info file
290 gdb.
info: ${GDB_DOC_FILES}
291 $(MAKEINFO
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) \
292 -o gdb.
info $(srcdir)/gdb.texinfo
294 # GDB MANUAL: roff translations
295 # Try to use a recent texi2roff. v2 was put on prep in jan91.
296 # If you want an index, see texi2roff doc for postprocessing
297 # and add -i to texi2roff invocations below.
298 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
299 # corresponding -e lines when later texi2roff's are current)
300 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
301 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
302 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
303 # + @alphaenumerate is ridiculously new, turned into @enumerate
305 # texi2roff doesn't have a notion of include dirs, so we have to fake
306 # it out for gdb manual's include files---but only if not configured
308 links2roff
: $(GDB_DOC_SOURCE_INCLUDES
)
309 if
[ ! -f gdb.texinfo
]; then \
310 (test "$(LN_S)" = "ln -s" && ln
-s
$(GDB_DOC_SOURCE_INCLUDES
) .
) || \
311 ln
$(GDB_DOC_SOURCE_INCLUDES
) . || \
312 cp
$(GDB_DOC_SOURCE_INCLUDES
) .
; \
316 # gdb manual suitable for [gtn]roff -me
317 gdb.me
: $(GDB_DOC_FILES
) links2roff
318 sed
-e
'/\\input texinfo/d' \
319 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
320 -e
'/^@ifinfo/,/^@end ifinfo/d' \
324 -e
's/^@alphaenumerate/@enumerate/g' \
325 -e
's/^@end alphaenumerate/@end enumerate/g' \
326 $(srcdir)/gdb.texinfo | \
328 sed
-e
's/---/\\(em/g' \
331 # gdb manual suitable for [gtn]roff -ms
332 gdb.ms
: $(GDB_DOC_FILES
) links2roff
333 sed
-e
'/\\input texinfo/d' \
334 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
335 -e
'/^@ifinfo/,/^@end ifinfo/d' \
339 -e
's/^@alphaenumerate/@enumerate/g' \
340 -e
's/^@end alphaenumerate/@end enumerate/g' \
341 $(srcdir)/gdb.texinfo | \
343 sed
-e
's/---/\\(em/g' \
346 # gdb manual suitable for [tn]roff -mm
347 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
348 # try leaving them in
349 gdb.mm
: $(GDB_DOC_FILES
) links2roff
350 sed
-e
'/\\input texinfo/d' \
351 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
352 -e
'/^@ifinfo/,/^@end ifinfo/d' \
357 -e
's/^@alphaenumerate/@enumerate/g' \
358 -e
's/^@end alphaenumerate/@end enumerate/g' \
359 $(srcdir)/gdb.texinfo | \
361 sed
-e
's/---/\\(em/g' \
364 # GDB MANUAL: HTML file
366 gdb_toc.html
: ${GDB_DOC_FILES}
367 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) $(srcdir)/gdb.texinfo
369 # Clean these up before each run. Avoids a catch 22 with not being
370 # able to re-generate these files (to fix a corruption) because these
371 # files contain a corruption.
372 GDBINT_TEX_TMPS
= gdbint.aux gdbint.cp
* gdbint.fn
* gdbint.ky
* \
373 gdbint.log gdbint.pg
* gdbint.toc gdbint.tp
* gdbint.vr
*
375 # GDB INTERNALS MANUAL: TeX dvi file
376 gdbint.
dvi: $(GDBINT_DOC_FILES
)
377 rm -f
$(GDBINT_TEX_TMPS
)
378 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdbint.texinfo
380 gdbint.ps
: gdbint.
dvi
383 gdbint.pdf
: $(GDBINT_DOC_FILES
)
384 rm -f
$(GDBINT_TEX_TMPS
)
385 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdbint.texinfo
387 # GDB INTERNALS MANUAL: info file
389 gdbint.
info: $(GDBINT_DOC_FILES
)
390 $(MAKEINFO
) -I
$(srcdir) -o gdbint.
info $(srcdir)/gdbint.texinfo
392 # GDB INTERNALS MANUAL: HTML file
394 gdbint_toc.html
: $(GDBINT_DOC_FILES
)
395 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/gdbint.texinfo
397 stabs.
info: $(STABS_DOC_FILES
)
398 $(MAKEINFO
) -o stabs.
info $(srcdir)/stabs.texinfo
400 # STABS DOCUMENTATION: HTML file
402 stabs_toc.html
: $(STABS_DOC_FILES
)
403 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/stabs.texinfo
405 # Clean these up before each run. Avoids a catch 22 with not being
406 # able to re-generate these files (to fix a corruption) because these
407 # files contain a corruption.
408 STABS_TEX_TMPS
= stabs.aux stabs.cp
* stabs.fn
* stabs.ky
* \
409 stabs.log stabs.pg
* stabs.toc stabs.tp
* stabs.vr
*
411 # STABS DOCUMENTATION: TeX dvi file
412 stabs.
dvi : $(STABS_DOC_FILES
)
413 rm -f
$(STABS_TEX_TMPS
)
414 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/stabs.texinfo
419 stabs.pdf
: $(STABS_DOC_FILES
)
420 rm -f
$(STABS_TEX_TMPS
)
421 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/stabs.texinfo
425 Makefile
: Makefile.in
$(host_makefile_frag
) $(target_makefile_frag
) config.status
426 $(SHELL
) .
/config.status
429 # The "least clean" level of cleaning. Get rid of files which are
430 # automatically generated files that are just intermediate files,
433 rm -f gdb.mm gdb.ms gdb.me links2roff
434 rm -f
$(GDB_TEX_TMPS
)
435 rm -f
$(GDBINT_TEX_TMPS
)
436 rm -f
$(STABS_TEX_TMPS
)
437 rm -f sedref.
dvi sedref.
tex tmp.sed
443 rm -f Makefile config.status config.log
445 # GDBvn.texi, the dvi files, the info files, and the postscript files,
446 # are all part of the distribution, so it should not be removed by
447 # "clean" or "distclean". Use maintainer-clean to remove them.
449 maintainer-clean
realclean: distclean
450 rm -f GDBvn.texi
*.
info* *.
dvi *.ps
*.html
*.pdf
452 install: install-info
454 uninstall: uninstall-info