1 ##Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003,
2 ##2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 pdfdir
= $(prefix)/share
/doc
/gdb
28 htmldir
= $(prefix)/html
35 INSTALL_PROGRAM
= @INSTALL_PROGRAM@
36 INSTALL_DATA
= @INSTALL_DATA@
38 mkinstalldirs
= $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
40 # main GDB source directory
43 # where to find texinfo; GDB dist should include a recent one
44 TEXIDIR
=${gdbdir}/..
/texinfo
46 # where to find makeinfo, preferably one designed for texinfo-2
49 # Note that texinfo 4.0's makeinfo --html can only generate a
50 # single file, which would be too large, so continue to use
51 # texi2html. -sts 2000-03-28
52 # Contrary to documentation, the current directory is not
53 # searched by texi2html, so specify it explicitly.
56 MAKEHTMLFLAGS
= -menu
-split_chapter
-I .
58 # where to find texi2roff, ditto
61 # where to find texi2dvi, ditto
64 # Where is the source dir for the READLINE library doc?
65 # Traditionally readline is in .. or .
66 READLINE_DIR
= ${gdbdir}/..
/readline
/doc
68 # The GDB/MI docs come from a sibling directory ../mi
69 GDBMI_DIR
= ${gdbdir}/mi
72 TEXINPUTS
=${TEXIDIR}:.
:$(srcdir):$(READLINE_DIR
):$(GDBMI_DIR
):$$TEXINPUTS
74 # Files which should be generated via 'info' and installed by 'install-info'
75 INFO_DEPS
= gdb.
info gdbint.
info stabs.
info annotate.
info
77 # Files which should be generated via 'pdf' and installed by 'install-pdf'
78 PDFFILES
= gdb.pdf gdbint.pdf stabs.pdf refcard.pdf annotate.pdf
80 # There may be alternate predefined collections of switches to configure
81 # the GDB manual. Normally this is not done in synch with the software
82 # config system, since this choice tends to be independent; most people
83 # want a doc config of `all' for a generic manual, regardless of sw config.
86 # This list of sed edits will edit the GDB reference card
87 # for what fonts and what papersize to use.
88 # By default (NO edits applied), the refcard uses:
89 # - Computer Modern (CM) fonts
90 # - US letter paper (8.5x11in)
91 # List some of the following files for alternative fonts and paper:
92 # a4rc.sed use A4 paper (297 x 210 mm)
93 # psrc.sed use PostScript fonts (Karl Berry short TeX names)
94 # lpsrc.sed use PostScript fonts (full PostScript names in TeX)
95 # e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
96 # for A4, CM fonts: REFEDITS = a4rc.sed
97 # for US, PS fonts: REFEDITS = psrc.sed
101 # Don Knuth's TeX formatter
105 # Program to generate Postscript files from DVI files.
109 GDB_DOC_SOURCE_INCLUDES
= \
112 $(srcdir)/agentexpr.texi \
113 $(READLINE_DIR
)/rluser.texi \
114 $(READLINE_DIR
)/inc-hist.texinfo
115 GDB_DOC_BUILD_INCLUDES
= \
119 $(srcdir)/gdb.texinfo \
120 $(GDB_DOC_SOURCE_INCLUDES
) \
121 $(GDB_DOC_BUILD_INCLUDES
)
124 GDBINT_DOC_SOURCE_INCLUDES
= \
126 $(srcdir)/observer.texi
127 GDBINT_DOC_BUILD_INCLUDES
= \
131 $(srcdir)/gdbint.texinfo \
132 $(GDBINT_DOC_SOURCE_INCLUDES
) \
133 $(GDBINT_DOC_BUILD_INCLUDES
)
135 # Stabs manual: All files
136 STABS_DOC_SOURCE_INCLUDES
= \
138 STABS_DOC_BUILD_INCLUDES
=
140 $(srcdir)/stabs.texinfo \
141 $(STABS_DOC_SOURCE_INCLUDES
) \
142 $(STABS_DOC_BUILD_INCLUDES
)
144 # Annotate migration document
145 ANNOTATE_DOC_SOURCE_INCLUDES
= \
147 ANNOTATE_DOC_BUILD_INCLUDES
= \
149 ANNOTATE_DOC_FILES
= \
150 $(srcdir)/annotate.texinfo \
151 $(ANNOTATE_DOC_SOURCE_INCLUDES
) \
152 $(ANNOTATE_DOC_BUILD_INCLUDES
)
154 #### Host, target, and site specific Makefile fragments come in here.
160 dvi: gdb.
dvi gdbint.
dvi stabs.
dvi refcard.
dvi annotate.
dvi
161 ps
: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
162 html
: gdb_toc.html gdbint_toc.html stabs_toc.html annotate_toc.html
164 all-doc
: info dvi ps
# pdf
167 install-info
: $(INFO_DEPS
)
168 $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
$(DESTDIR
)$(infodir)
169 @list
='$(INFO_DEPS)'; \
170 for file in
$$list; do \
171 if
test -f
$$file; then d
=.
; else d
=$(srcdir); fi
; \
172 for ifile in
`cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
173 if
test -f
$$d/$$ifile; then \
174 echo
" $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
175 $(INSTALL_DATA
) $$d/$$ifile $(DESTDIR
)$(infodir)/$$ifile; \
180 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
181 list
='$(INFO_DEPS)'; \
182 for file in
$$list; do \
183 echo
" install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
184 install-info
--info-dir
=$(DESTDIR
)$(infodir) $(DESTDIR
)$(infodir)/$$file ||
:;\
190 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
193 list
='$(INFO_DEPS)'; \
194 for file in
$$list; do \
196 || install-info
--info-dir
=$(DESTDIR
)$(infodir) --remove
$$file; \
199 list
='$(INFO_DEPS)'; \
200 for file in
$$list; do \
201 (cd
$(DESTDIR
)$(infodir) && rm -f
$$file $$file-[0-9] $$file-[0-9][0-9]); \
205 for i in
*.html
; do \
206 $(INSTALL_DATA
) $$i $(DESTDIR
)$(htmldir
)/$$i ; \
209 pdf__strip_dir
= `echo $$p | sed -e 's|^.*/||'`;
211 install-pdf
: $(PDFFILES
)
213 test -z
"$(pdfdir)" ||
$(mkinstalldirs
) "$(DESTDIR)$(pdfdir)"
214 @list
='$(PDFFILES)'; for p in
$$list; do \
215 if
test -f
"$$p"; then d
=; else d
="$(srcdir)/"; fi
; \
216 f
=$(pdf__strip_dir
) \
217 echo
" $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/$$f'"; \
218 $(INSTALL_DATA
) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
221 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
*.ps
*.
dvi *.pdf
223 # Copy the object files from a particular stage into a subdirectory.
226 -mv
$(STAGESTUFF
) stage1
230 -mv
$(STAGESTUFF
) stage2
234 -mv
$(STAGESTUFF
) stage3
239 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
242 -(cd stage1
; mv
-f
* ..
)
246 -(cd stage2
; mv
-f
* ..
)
250 -(cd stage3
; mv
-f
* ..
)
253 # GDB QUICK REFERENCE (dvi output)
254 refcard.
dvi : refcard.
tex $(REFEDITS
)
256 for f in x
$(REFEDITS
) ; do \
257 test x
$$f = xx
&& continue
; \
258 cat
$(srcdir)/$$f >>tmp.sed
; \
260 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
261 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
262 mv sedref.
dvi refcard.
dvi
263 rm -f sedref.log sedref.
tex tmp.sed
265 refcard.ps
: refcard.
dvi
266 $(DVIPS
) -t landscape
-o
$@
$?
268 refcard.pdf
: refcard.
tex $(REFEDITS
)
270 for f in x
$(REFEDITS
) ; do \
271 test x
$$f = xx
&& continue
; \
272 cat
$(srcdir)/$$f >>tmp.sed
; \
274 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
275 $(SET_TEXINPUTS
) $(PDFTEX
) sedref.
tex
276 mv sedref.pdf refcard.pdf
277 rm -f sedref.log sedref.
tex tmp.sed
279 # File to record current GDB version number (copied from main dir version.in)
280 GDBvn.texi
: ${gdbdir}/version.in
281 echo
"@set GDBVN `sed q $(srcdir)/../version.in`" > .
/GDBvn.new
282 mv GDBvn.new GDBvn.texi
285 .PRECIOUS
: GDBvn.texi
287 # Choose configuration for GDB manual (normally `all'; normally not tied into
288 # `configure' script because most users prefer generic version of manual,
289 # not one for their binary config---which may not be specifically
291 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
292 (test "$(LN_S)" = "ln -s" && \
293 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
) || \
294 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
295 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
297 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
298 # If your texinfo or makeinfo don't support these, get a new texinfo release
300 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
301 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
302 # source directory for the benefit of people who *don't* use this makefile,
303 # VPATH will often tell make not to bother building it, because the one
304 # in the srcdir is up to date. (if not, then make should build one here).
306 # Clean these up before each run. Avoids a catch 22 with not being
307 # able to re-generate these files (to fix a corruption) because these
308 # files contain a corruption.
309 GDB_TEX_TMPS
= gdb.aux gdb.cp
* gdb.fn
* gdb.ky
* gdb.log gdb.pg
* gdb.toc \
312 # GDB MANUAL: TeX dvi file
313 gdb.
dvi: ${GDB_DOC_FILES}
314 if
[ ! -f .
/GDBvn.texi
]; then \
315 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
316 ln
$(srcdir)/GDBvn.texi . || \
317 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
318 rm -f
$(GDB_TEX_TMPS
)
319 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdb.texinfo
324 gdb.pdf
: ${GDB_DOC_FILES}
325 if
[ ! -f .
/GDBvn.texi
]; then \
326 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
327 ln
$(srcdir)/GDBvn.texi . || \
328 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
329 rm -f
$(GDB_TEX_TMPS
)
330 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdb.texinfo
332 # GDB MANUAL: info file
333 gdb.
info: ${GDB_DOC_FILES}
334 $(MAKEINFO
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) \
335 -o gdb.
info $(srcdir)/gdb.texinfo
337 # GDB MANUAL: roff translations
338 # Try to use a recent texi2roff. v2 was put on prep in jan91.
339 # If you want an index, see texi2roff doc for postprocessing
340 # and add -i to texi2roff invocations below.
341 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
342 # corresponding -e lines when later texi2roff's are current)
343 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
344 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
345 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
346 # + @alphaenumerate is ridiculously new, turned into @enumerate
348 # texi2roff doesn't have a notion of include dirs, so we have to fake
349 # it out for gdb manual's include files---but only if not configured
351 links2roff
: $(GDB_DOC_SOURCE_INCLUDES
)
352 if
[ ! -f gdb.texinfo
]; then \
353 (test "$(LN_S)" = "ln -s" && ln
-s
$(GDB_DOC_SOURCE_INCLUDES
) .
) || \
354 ln
$(GDB_DOC_SOURCE_INCLUDES
) . || \
355 cp
$(GDB_DOC_SOURCE_INCLUDES
) .
; \
359 # gdb manual suitable for [gtn]roff -me
360 gdb.me
: $(GDB_DOC_FILES
) links2roff
361 sed
-e
'/\\input texinfo/d' \
362 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
363 -e
'/^@ifinfo/,/^@end ifinfo/d' \
367 -e
's/^@alphaenumerate/@enumerate/g' \
368 -e
's/^@end alphaenumerate/@end enumerate/g' \
369 $(srcdir)/gdb.texinfo | \
371 sed
-e
's/---/\\(em/g' \
374 # gdb manual suitable for [gtn]roff -ms
375 gdb.ms
: $(GDB_DOC_FILES
) links2roff
376 sed
-e
'/\\input texinfo/d' \
377 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
378 -e
'/^@ifinfo/,/^@end ifinfo/d' \
382 -e
's/^@alphaenumerate/@enumerate/g' \
383 -e
's/^@end alphaenumerate/@end enumerate/g' \
384 $(srcdir)/gdb.texinfo | \
386 sed
-e
's/---/\\(em/g' \
389 # gdb manual suitable for [tn]roff -mm
390 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
391 # try leaving them in
392 gdb.mm
: $(GDB_DOC_FILES
) links2roff
393 sed
-e
'/\\input texinfo/d' \
394 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
395 -e
'/^@ifinfo/,/^@end ifinfo/d' \
400 -e
's/^@alphaenumerate/@enumerate/g' \
401 -e
's/^@end alphaenumerate/@end enumerate/g' \
402 $(srcdir)/gdb.texinfo | \
404 sed
-e
's/---/\\(em/g' \
407 # GDB MANUAL: HTML file
409 gdb_toc.html
: ${GDB_DOC_FILES}
410 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
${READLINE_DIR} -I
${GDBMI_DIR} -I
$(srcdir) $(srcdir)/gdb.texinfo
412 # Clean these up before each run. Avoids a catch 22 with not being
413 # able to re-generate these files (to fix a corruption) because these
414 # files contain a corruption.
415 GDBINT_TEX_TMPS
= gdbint.aux gdbint.cp
* gdbint.fn
* gdbint.ky
* \
416 gdbint.log gdbint.pg
* gdbint.toc gdbint.tp
* gdbint.vr
*
418 # GDB INTERNALS MANUAL: TeX dvi file
419 gdbint.
dvi: $(GDBINT_DOC_FILES
)
420 rm -f
$(GDBINT_TEX_TMPS
)
421 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/gdbint.texinfo
423 gdbint.ps
: gdbint.
dvi
426 gdbint.pdf
: $(GDBINT_DOC_FILES
)
427 rm -f
$(GDBINT_TEX_TMPS
)
428 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/gdbint.texinfo
430 # GDB INTERNALS MANUAL: info file
432 gdbint.
info: $(GDBINT_DOC_FILES
)
433 $(MAKEINFO
) -I
$(srcdir) -o gdbint.
info $(srcdir)/gdbint.texinfo
435 # GDB INTERNALS MANUAL: HTML file
437 gdbint_toc.html
: $(GDBINT_DOC_FILES
)
438 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/gdbint.texinfo
440 stabs.
info: $(STABS_DOC_FILES
)
441 $(MAKEINFO
) -I
$(srcdir) -o stabs.
info $(srcdir)/stabs.texinfo
443 # STABS DOCUMENTATION: HTML file
445 stabs_toc.html
: $(STABS_DOC_FILES
)
446 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/stabs.texinfo
448 # Clean these up before each run. Avoids a catch 22 with not being
449 # able to re-generate these files (to fix a corruption) because these
450 # files contain a corruption.
451 STABS_TEX_TMPS
= stabs.aux stabs.cp
* stabs.fn
* stabs.ky
* \
452 stabs.log stabs.pg
* stabs.toc stabs.tp
* stabs.vr
*
454 # STABS DOCUMENTATION: TeX dvi file
455 stabs.
dvi : $(STABS_DOC_FILES
)
456 rm -f
$(STABS_TEX_TMPS
)
457 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/stabs.texinfo
462 stabs.pdf
: $(STABS_DOC_FILES
)
463 rm -f
$(STABS_TEX_TMPS
)
464 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/stabs.texinfo
466 # Clean these up before each run. Avoids a catch 22 with not being
467 # able to re-generate these files (to fix a corruption) because these
468 # files contain a corruption.
469 ANNOTATE_TEX_TMPS
= annotate.aux annotate.cp
* annotate.fn
* annotate.ky
* \
470 annotate.log annotate.pg
* annotate.toc annotate.tp
* annotate.vr
*
472 # ANNOTATE DOCUMENTATION: TeX dvi file
473 annotate.
dvi : $(ANNOTATE_DOC_FILES
)
474 rm -f
$(ANNOTATE_TEX_TMPS
)
475 $(SET_TEXINPUTS
) $(TEXI2DVI
) $(srcdir)/annotate.texinfo
477 annotate.ps
: annotate.
dvi
480 annotate.pdf
: $(ANNOTATE_DOC_FILES
)
481 rm -f
$(ANNOTATE_TEX_TMPS
)
482 $(SET_TEXINPUTS
) $(TEXI2DVI
) --pdf
$(srcdir)/annotate.texinfo
484 annotate.
info: $(ANNOTATE_DOC_FILES
)
485 $(MAKEINFO
) -I
$(srcdir) -o annotate.
info $(srcdir)/annotate.texinfo
487 annotate_toc.html
: $(ANNOTATE_DOC_FILES
)
488 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(srcdir)/annotate.texinfo
492 Makefile
: Makefile.in
$(host_makefile_frag
) config.status
493 $(SHELL
) .
/config.status
496 # The "least clean" level of cleaning. Get rid of files which are
497 # automatically generated files that are just intermediate files,
500 rm -f gdb.mm gdb.ms gdb.me links2roff
501 rm -f
$(GDB_TEX_TMPS
)
502 rm -f
$(GDBINT_TEX_TMPS
)
503 rm -f
$(STABS_TEX_TMPS
)
504 rm -f
$(ANNOTATE_TEX_TMPS
)
505 rm -f sedref.
dvi sedref.
tex tmp.sed
511 rm -f Makefile config.status config.log
513 # GDBvn.texi, the dvi files, the info files, and the postscript files,
514 # are all part of the distribution, so it should not be removed by
515 # "clean" or "distclean". Use maintainer-clean to remove them.
517 maintainer-clean
realclean: distclean
518 rm -f GDBvn.texi
*.
info* *.
dvi *.ps
*.html
*.pdf
520 install: install-info
522 uninstall: uninstall-info