1 ##Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003,
2 ##2007, 2008, 2009, 2010, 2011 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 3 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, see <http://www.gnu.org/licenses/>.
26 datarootdir
= @datarootdir@
36 INSTALL_PROGRAM
= @INSTALL_PROGRAM@
37 INSTALL_DATA
= @INSTALL_DATA@
39 mkinstalldirs
= $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
41 # main GDB source directory
44 # where to find texinfo; GDB dist should include a recent one
45 TEXIDIR
=${gdbdir}/..
/texinfo
47 # where to find makeinfo, preferably one designed for texinfo-2
50 MAKEHTML
= $(MAKEINFO
) --html
53 # where to find texi2roff, ditto
56 # where to find texi2dvi, ditto
59 # Package version and bug-reporting URL.
60 PKGVERSION
= @PKGVERSION@
61 BUGURL_TEXI
= @REPORT_BUGS_TEXI@
63 # Where is the source dir for the READLINE library doc?
64 # Traditionally readline is in .. or .
65 READLINE_DIR
= ${gdbdir}/..
/readline
/doc
66 READLINE_TEXI_INCFLAG
= @READLINE_TEXI_INCFLAG@
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
79 # Files which should be generated via 'html' and installed by 'install-html'
80 HTMLFILES
= gdb
/index.html gdbint
/index.html stabs
/index.html annotate
/index.html
81 HTMLFILES_INSTALL
= gdb gdbint stabs annotate
83 # There may be alternate predefined collections of switches to configure
84 # the GDB manual. Normally this is not done in synch with the software
85 # config system, since this choice tends to be independent; most people
86 # want a doc config of `all' for a generic manual, regardless of sw config.
89 # This list of sed edits will edit the GDB reference card
90 # for what fonts and what papersize to use.
91 # By default (NO edits applied), the refcard uses:
92 # - Computer Modern (CM) fonts
93 # - US letter paper (8.5x11in)
94 # List some of the following files for alternative fonts and paper:
95 # a4rc.sed use A4 paper (297 x 210 mm)
96 # psrc.sed use PostScript fonts (Karl Berry short TeX names)
97 # lpsrc.sed use PostScript fonts (full PostScript names in TeX)
98 # e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
99 # for A4, CM fonts: REFEDITS = a4rc.sed
100 # for US, PS fonts: REFEDITS = psrc.sed
104 # Don Knuth's TeX formatter
108 # Program to generate Postscript files from DVI files.
112 # Note that this unconditionally includes the readline texi files,
113 # even when --with-system-readline is used. This is harmless because
114 # these are only used as dependencies.
115 GDB_DOC_SOURCE_INCLUDES
= \
118 $(srcdir)/agentexpr.texi \
119 $(READLINE_DIR
)/rluser.texi \
120 $(READLINE_DIR
)/inc-hist.texinfo
121 GDB_DOC_BUILD_INCLUDES
= \
125 $(srcdir)/gdb.texinfo \
126 $(GDB_DOC_SOURCE_INCLUDES
) \
127 $(GDB_DOC_BUILD_INCLUDES
)
130 GDBINT_DOC_SOURCE_INCLUDES
= \
132 $(srcdir)/observer.texi
133 GDBINT_DOC_BUILD_INCLUDES
= \
137 $(srcdir)/gdbint.texinfo \
138 $(GDBINT_DOC_SOURCE_INCLUDES
) \
139 $(GDBINT_DOC_BUILD_INCLUDES
)
141 # Stabs manual: All files
142 STABS_DOC_SOURCE_INCLUDES
= \
144 STABS_DOC_BUILD_INCLUDES
=
146 $(srcdir)/stabs.texinfo \
147 $(STABS_DOC_SOURCE_INCLUDES
) \
148 $(STABS_DOC_BUILD_INCLUDES
)
150 # Annotate migration document
151 ANNOTATE_DOC_SOURCE_INCLUDES
= \
153 ANNOTATE_DOC_BUILD_INCLUDES
= \
156 ANNOTATE_DOC_FILES
= \
157 $(srcdir)/annotate.texinfo \
158 $(ANNOTATE_DOC_SOURCE_INCLUDES
) \
159 $(ANNOTATE_DOC_BUILD_INCLUDES
)
161 #### Host, target, and site specific Makefile fragments come in here.
167 dvi: gdb.
dvi gdbint.
dvi stabs.
dvi refcard.
dvi annotate.
dvi
168 ps
: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
171 all-doc
: info dvi ps
# pdf
173 rm -f gdb-cfg.texi GDBvn.texi
175 install-info
: $(INFO_DEPS
)
176 $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
$(DESTDIR
)$(infodir)
177 @list
='$(INFO_DEPS)'; \
178 for file in
$$list; do \
179 if
test -f
$$file; then d
=.
; else d
=$(srcdir); fi
; \
180 for ifile in
`cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
181 if
test -f
$$d/$$ifile; then \
182 echo
" $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
183 $(INSTALL_DATA
) $$d/$$ifile $(DESTDIR
)$(infodir)/$$ifile; \
188 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
189 list
='$(INFO_DEPS)'; \
190 for file in
$$list; do \
191 echo
" install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
192 install-info
--info-dir
=$(DESTDIR
)$(infodir) $(DESTDIR
)$(infodir)/$$file ||
:;\
198 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
201 list
='$(INFO_DEPS)'; \
202 for file in
$$list; do \
204 || install-info
--info-dir
=$(DESTDIR
)$(infodir) --remove
$$file; \
207 list
='$(INFO_DEPS)'; \
208 for file in
$$list; do \
209 (cd
$(DESTDIR
)$(infodir) && rm -f
$$file $$file-[0-9] $$file-[0-9][0-9]); \
212 html__strip_dir
= `echo $$p | sed -e 's|^.*/||'`;
214 install-html
: $(HTMLFILES
)
216 test -z
"$(htmldir)" ||
$(mkinstalldirs
) "$(DESTDIR)$(htmldir)"
217 @list
='$(HTMLFILES_INSTALL)'; for p in
$$list; do \
218 if
test -f
"$$p" ||
test -d
"$$p"; then d
=""; else d
="$(srcdir)/"; fi
; \
219 f
=$(html__strip_dir
) \
220 if
test -d
"$$d$$p"; then \
221 echo
" $(mkinstalldirs) '$(DESTDIR)$(htmldir)/$$f'"; \
222 $(mkinstalldirs
) "$(DESTDIR)$(htmldir)/$$f" || exit
1; \
223 echo
" $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \
224 $(INSTALL_DATA
) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f"; \
226 echo
" $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(htmldir)/$$f'"; \
227 $(INSTALL_DATA
) "$$d$$p" "$(DESTDIR)$(htmldir)/$$f"; \
231 pdf__strip_dir
= `echo $$p | sed -e 's|^.*/||'`;
233 install-pdf
: $(PDFFILES
)
235 test -z
"$(pdfdir)" ||
$(mkinstalldirs
) "$(DESTDIR)$(pdfdir)"
236 @list
='$(PDFFILES)'; for p in
$$list; do \
237 if
test -f
"$$p"; then d
=; else d
="$(srcdir)/"; fi
; \
238 f
=$(pdf__strip_dir
) \
239 echo
" $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/$$f'"; \
240 $(INSTALL_DATA
) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
243 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
*.ps
*.
dvi *.pdf
245 # Copy the object files from a particular stage into a subdirectory.
248 -mv
$(STAGESTUFF
) stage1
252 -mv
$(STAGESTUFF
) stage2
256 -mv
$(STAGESTUFF
) stage3
261 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
264 -(cd stage1
; mv
-f
* ..
)
268 -(cd stage2
; mv
-f
* ..
)
272 -(cd stage3
; mv
-f
* ..
)
275 # GDB QUICK REFERENCE (dvi output)
276 refcard.
dvi : refcard.
tex $(REFEDITS
)
278 for f in x
$(REFEDITS
) ; do \
279 test x
$$f = xx
&& continue
; \
280 cat
$(srcdir)/$$f >>tmp.sed
; \
282 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
283 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
284 mv sedref.
dvi refcard.
dvi
285 rm -f sedref.log sedref.
tex tmp.sed
287 refcard.ps
: refcard.
dvi
288 $(DVIPS
) -t landscape
-o
$@
$?
290 refcard.pdf
: refcard.
tex $(REFEDITS
)
292 for f in x
$(REFEDITS
) ; do \
293 test x
$$f = xx
&& continue
; \
294 cat
$(srcdir)/$$f >>tmp.sed
; \
296 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
297 $(SET_TEXINPUTS
) $(PDFTEX
) sedref.
tex
298 mv sedref.pdf refcard.pdf
299 rm -f sedref.log sedref.
tex tmp.sed
301 # File to record current GDB version number (copied from main dir version.in)
302 GDBvn.texi
: ${gdbdir}/version.in
303 echo
"@set GDBVN `sed q $(srcdir)/../version.in`" > .
/GDBvn.new
304 if
[ -n
"$(PKGVERSION)" ]; then \
305 echo
"@set VERSION_PACKAGE $(PKGVERSION)" >> .
/GDBvn.new
; \
307 echo
"@set BUGURL $(BUGURL_TEXI)" >> .
/GDBvn.new
308 if
[ "$(BUGURL_TEXI)" = "@uref{http://www.gnu.org/software/gdb/bugs/}" ]; then \
309 echo
"@set BUGURL_DEFAULT" >> .
/GDBvn.new
; \
311 if
test -z
"$(READLINE_TEXI_INCFLAG)"; then \
312 echo
"@set SYSTEM_READLINE" >> .
/GDBvn.new
; \
314 mv GDBvn.new GDBvn.texi
317 .PRECIOUS
: GDBvn.texi
319 # Choose configuration for GDB manual (normally `all'; normally not tied into
320 # `configure' script because most users prefer generic version of manual,
321 # not one for their binary config---which may not be specifically
323 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
324 (test "$(LN_S)" = "ln -s" && \
325 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
) || \
326 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
327 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
329 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
330 # If your texinfo or makeinfo don't support these, get a new texinfo release
332 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
333 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
334 # source directory for the benefit of people who *don't* use this makefile,
335 # VPATH will often tell make not to bother building it, because the one
336 # in the srcdir is up to date. (if not, then make should build one here).
338 # Clean these up before each run. Avoids a catch 22 with not being
339 # able to re-generate these files (to fix a corruption) because these
340 # files contain a corruption.
341 GDB_TEX_TMPS
= gdb.aux gdb.cp
* gdb.fn
* gdb.ky
* gdb.log gdb.pg
* gdb.toc \
344 # GDB MANUAL: TeX dvi file
345 gdb.
dvi: ${GDB_DOC_FILES}
346 if
[ ! -f .
/GDBvn.texi
]; then \
347 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
348 ln
$(srcdir)/GDBvn.texi . || \
349 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
350 rm -f
$(GDB_TEX_TMPS
)
351 $(TEXI2DVI
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
352 $(srcdir)/gdb.texinfo
357 gdb.pdf
: ${GDB_DOC_FILES}
358 if
[ ! -f .
/GDBvn.texi
]; then \
359 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
360 ln
$(srcdir)/GDBvn.texi . || \
361 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
362 rm -f
$(GDB_TEX_TMPS
)
363 $(TEXI2DVI
) --pdf
$(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
364 $(srcdir)/gdb.texinfo
366 # GDB MANUAL: info file
367 gdb.
info: ${GDB_DOC_FILES}
368 $(MAKEINFO
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
369 -o gdb.
info $(srcdir)/gdb.texinfo
371 # GDB MANUAL: roff translations
372 # Try to use a recent texi2roff. v2 was put on prep in jan91.
373 # If you want an index, see texi2roff doc for postprocessing
374 # and add -i to texi2roff invocations below.
375 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
376 # corresponding -e lines when later texi2roff's are current)
377 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
378 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
379 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
380 # + @alphaenumerate is ridiculously new, turned into @enumerate
382 # texi2roff doesn't have a notion of include dirs, so we have to fake
383 # it out for gdb manual's include files---but only if not configured
385 links2roff
: $(GDB_DOC_SOURCE_INCLUDES
)
386 if
[ ! -f gdb.texinfo
]; then \
387 (test "$(LN_S)" = "ln -s" && ln
-s
$(GDB_DOC_SOURCE_INCLUDES
) .
) || \
388 ln
$(GDB_DOC_SOURCE_INCLUDES
) . || \
389 cp
$(GDB_DOC_SOURCE_INCLUDES
) .
; \
393 # gdb manual suitable for [gtn]roff -me
394 gdb.me
: $(GDB_DOC_FILES
) links2roff
395 sed
-e
'/\\input texinfo/d' \
396 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
397 -e
'/^@ifinfo/,/^@end ifinfo/d' \
401 -e
's/^@alphaenumerate/@enumerate/g' \
402 -e
's/^@end alphaenumerate/@end enumerate/g' \
403 $(srcdir)/gdb.texinfo | \
405 sed
-e
's/---/\\(em/g' \
408 # gdb manual suitable for [gtn]roff -ms
409 gdb.ms
: $(GDB_DOC_FILES
) links2roff
410 sed
-e
'/\\input texinfo/d' \
411 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
412 -e
'/^@ifinfo/,/^@end ifinfo/d' \
416 -e
's/^@alphaenumerate/@enumerate/g' \
417 -e
's/^@end alphaenumerate/@end enumerate/g' \
418 $(srcdir)/gdb.texinfo | \
420 sed
-e
's/---/\\(em/g' \
423 # gdb manual suitable for [tn]roff -mm
424 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
425 # try leaving them in
426 gdb.mm
: $(GDB_DOC_FILES
) links2roff
427 sed
-e
'/\\input texinfo/d' \
428 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
429 -e
'/^@ifinfo/,/^@end ifinfo/d' \
434 -e
's/^@alphaenumerate/@enumerate/g' \
435 -e
's/^@end alphaenumerate/@end enumerate/g' \
436 $(srcdir)/gdb.texinfo | \
438 sed
-e
's/---/\\(em/g' \
441 # GDB MANUAL: HTML file
443 gdb
/index.html
: ${GDB_DOC_FILES}
444 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) $(srcdir)/gdb.texinfo
446 # Clean these up before each run. Avoids a catch 22 with not being
447 # able to re-generate these files (to fix a corruption) because these
448 # files contain a corruption.
449 GDBINT_TEX_TMPS
= gdbint.aux gdbint.cp
* gdbint.fn
* gdbint.ky
* \
450 gdbint.log gdbint.pg
* gdbint.toc gdbint.tp
* gdbint.vr
*
452 # GDB INTERNALS MANUAL: TeX dvi file
453 gdbint.
dvi: $(GDBINT_DOC_FILES
)
454 rm -f
$(GDBINT_TEX_TMPS
)
455 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/gdbint.texinfo
457 gdbint.ps
: gdbint.
dvi
460 gdbint.pdf
: $(GDBINT_DOC_FILES
)
461 rm -f
$(GDBINT_TEX_TMPS
)
462 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/gdbint.texinfo
464 # GDB INTERNALS MANUAL: info file
466 gdbint.
info: $(GDBINT_DOC_FILES
)
467 $(MAKEINFO
) -I
$(srcdir) -o gdbint.
info $(srcdir)/gdbint.texinfo
469 # GDB INTERNALS MANUAL: HTML file
471 gdbint
/index.html
: $(GDBINT_DOC_FILES
)
472 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/gdbint.texinfo
474 stabs.
info: $(STABS_DOC_FILES
)
475 $(MAKEINFO
) -I
$(srcdir) -o stabs.
info $(srcdir)/stabs.texinfo
477 # STABS DOCUMENTATION: HTML file
479 stabs
/index.html
: $(STABS_DOC_FILES
)
480 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/stabs.texinfo
482 # Clean these up before each run. Avoids a catch 22 with not being
483 # able to re-generate these files (to fix a corruption) because these
484 # files contain a corruption.
485 STABS_TEX_TMPS
= stabs.aux stabs.cp
* stabs.fn
* stabs.ky
* \
486 stabs.log stabs.pg
* stabs.toc stabs.tp
* stabs.vr
*
488 # STABS DOCUMENTATION: TeX dvi file
489 stabs.
dvi : $(STABS_DOC_FILES
)
490 rm -f
$(STABS_TEX_TMPS
)
491 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/stabs.texinfo
496 stabs.pdf
: $(STABS_DOC_FILES
)
497 rm -f
$(STABS_TEX_TMPS
)
498 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/stabs.texinfo
500 # Clean these up before each run. Avoids a catch 22 with not being
501 # able to re-generate these files (to fix a corruption) because these
502 # files contain a corruption.
503 ANNOTATE_TEX_TMPS
= annotate.aux annotate.cp
* annotate.fn
* annotate.ky
* \
504 annotate.log annotate.pg
* annotate.toc annotate.tp
* annotate.vr
*
506 # ANNOTATE DOCUMENTATION: TeX dvi file
507 annotate.
dvi : $(ANNOTATE_DOC_FILES
)
508 rm -f
$(ANNOTATE_TEX_TMPS
)
509 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/annotate.texinfo
511 annotate.ps
: annotate.
dvi
514 annotate.pdf
: $(ANNOTATE_DOC_FILES
)
515 rm -f
$(ANNOTATE_TEX_TMPS
)
516 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/annotate.texinfo
518 annotate.
info: $(ANNOTATE_DOC_FILES
)
519 $(MAKEINFO
) -I
$(srcdir) -o annotate.
info $(srcdir)/annotate.texinfo
521 annotate
/index.html
: $(ANNOTATE_DOC_FILES
)
522 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/annotate.texinfo
526 Makefile
: Makefile.in
$(host_makefile_frag
) ..
/config.status
527 cd ..
&& $(SHELL
) .
/config.status doc
/Makefile
530 # The "least clean" level of cleaning. Get rid of files which are
531 # automatically generated files that are just intermediate files,
534 rm -f gdb.mm gdb.ms gdb.me links2roff
535 rm -f
$(GDB_TEX_TMPS
)
536 rm -f
$(GDBINT_TEX_TMPS
)
537 rm -f
$(STABS_TEX_TMPS
)
538 rm -f
$(ANNOTATE_TEX_TMPS
)
539 rm -f sedref.
dvi sedref.
tex tmp.sed
542 rm -f gdb-cfg.texi GDBvn.texi
547 # GDBvn.texi, the dvi files, the info files, and the postscript files,
548 # are all part of the distribution, so it should not be removed by
549 # "clean" or "distclean". Use maintainer-clean to remove them.
551 maintainer-clean
realclean: distclean
552 rm -f GDBvn.texi
*.
info* *.
dvi *.ps
*.html
*.pdf
554 install: install-info
556 uninstall: uninstall-info