1 ##Copyright (C) 1991-1996, 1999-2000, 2002-2003, 2007-2012 Free Software
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
49 MAKEINFOFLAGS
= @MAKEINFOFLAGS@
50 MAKEINFO_EXTRA_FLAGS
= @MAKEINFO_EXTRA_FLAGS@
51 MAKEINFO_CMD
= $(MAKEINFO
) $(MAKEINFOFLAGS
) $(MAKEINFO_EXTRA_FLAGS
)
53 MAKEHTML
= $(MAKEINFO_CMD
) --html
56 # where to find texi2roff, ditto
59 # where to find texi2dvi, ditto
62 # Package version and bug-reporting URL.
63 PKGVERSION
= @PKGVERSION@
64 BUGURL_TEXI
= @REPORT_BUGS_TEXI@
66 # Where is the source dir for the READLINE library doc?
67 # Traditionally readline is in .. or .
68 READLINE_DIR
= ${gdbdir}/..
/readline
/doc
69 READLINE_TEXI_INCFLAG
= @READLINE_TEXI_INCFLAG@
71 # The GDB/MI docs come from a sibling directory ../mi
72 GDBMI_DIR
= ${gdbdir}/mi
75 TEXINPUTS
=${TEXIDIR}:.
:$(srcdir):$(READLINE_DIR
):$(GDBMI_DIR
):$$TEXINPUTS
77 # Files which should be generated via 'info' and installed by 'install-info'
78 INFO_DEPS
= gdb.
info gdbint.
info stabs.
info annotate.
info
80 # Files which should be generated via 'pdf' and installed by 'install-pdf'
81 PDFFILES
= gdb.pdf gdbint.pdf stabs.pdf refcard.pdf annotate.pdf
82 # Files which should be generated via 'html' and installed by 'install-html'
83 HTMLFILES
= gdb
/index.html gdbint
/index.html stabs
/index.html annotate
/index.html
84 HTMLFILES_INSTALL
= gdb gdbint stabs annotate
86 # There may be alternate predefined collections of switches to configure
87 # the GDB manual. Normally this is not done in synch with the software
88 # config system, since this choice tends to be independent; most people
89 # want a doc config of `all' for a generic manual, regardless of sw config.
92 # This list of sed edits will edit the GDB reference card
93 # for what fonts and what papersize to use.
94 # By default (NO edits applied), the refcard uses:
95 # - Computer Modern (CM) fonts
96 # - US letter paper (8.5x11in)
97 # List some of the following files for alternative fonts and paper:
98 # a4rc.sed use A4 paper (297 x 210 mm)
99 # psrc.sed use PostScript fonts (Karl Berry short TeX names)
100 # lpsrc.sed use PostScript fonts (full PostScript names in TeX)
101 # e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
102 # for A4, CM fonts: REFEDITS = a4rc.sed
103 # for US, PS fonts: REFEDITS = psrc.sed
107 # Don Knuth's TeX formatter
111 # Program to generate Postscript files from DVI files.
115 # Note that this unconditionally includes the readline texi files,
116 # even when --with-system-readline is used. This is harmless because
117 # these are only used as dependencies.
118 GDB_DOC_SOURCE_INCLUDES
= \
121 $(srcdir)/agentexpr.texi \
122 $(READLINE_DIR
)/rluser.texi \
123 $(READLINE_DIR
)/hsuser.texi
124 GDB_DOC_BUILD_INCLUDES
= \
128 $(srcdir)/gdb.texinfo \
129 $(GDB_DOC_SOURCE_INCLUDES
) \
130 $(GDB_DOC_BUILD_INCLUDES
)
133 GDBINT_DOC_SOURCE_INCLUDES
= \
135 $(srcdir)/observer.texi
136 GDBINT_DOC_BUILD_INCLUDES
= \
140 $(srcdir)/gdbint.texinfo \
141 $(GDBINT_DOC_SOURCE_INCLUDES
) \
142 $(GDBINT_DOC_BUILD_INCLUDES
)
144 # Stabs manual: All files
145 STABS_DOC_SOURCE_INCLUDES
= \
147 STABS_DOC_BUILD_INCLUDES
=
149 $(srcdir)/stabs.texinfo \
150 $(STABS_DOC_SOURCE_INCLUDES
) \
151 $(STABS_DOC_BUILD_INCLUDES
)
153 # Annotate migration document
154 ANNOTATE_DOC_SOURCE_INCLUDES
= \
156 ANNOTATE_DOC_BUILD_INCLUDES
= \
159 ANNOTATE_DOC_FILES
= \
160 $(srcdir)/annotate.texinfo \
161 $(ANNOTATE_DOC_SOURCE_INCLUDES
) \
162 $(ANNOTATE_DOC_BUILD_INCLUDES
)
164 #### Host, target, and site specific Makefile fragments come in here.
170 dvi: gdb.
dvi gdbint.
dvi stabs.
dvi refcard.
dvi annotate.
dvi
171 ps
: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
174 all-doc
: info dvi ps
# pdf
176 rm -f gdb-cfg.texi GDBvn.texi
178 install-info
: $(INFO_DEPS
)
179 $(SHELL
) $(srcdir)/..
/..
/mkinstalldirs
$(DESTDIR
)$(infodir)
180 @list
='$(INFO_DEPS)'; \
181 for file in
$$list; do \
182 if
test -f
$$file; then d
=.
; else d
=$(srcdir); fi
; \
183 for ifile in
`cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
184 if
test -f
$$d/$$ifile; then \
185 echo
" $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
186 $(INSTALL_DATA
) $$d/$$ifile $(DESTDIR
)$(infodir)/$$ifile; \
191 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
192 list
='$(INFO_DEPS)'; \
193 for file in
$$list; do \
194 echo
" install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
195 install-info
--info-dir
=$(DESTDIR
)$(infodir) $(DESTDIR
)$(infodir)/$$file ||
:;\
201 @if
$(SHELL
) -c
'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev
/null
2>&1; then \
204 list
='$(INFO_DEPS)'; \
205 for file in
$$list; do \
207 || install-info
--info-dir
=$(DESTDIR
)$(infodir) --remove
$$file; \
210 list
='$(INFO_DEPS)'; \
211 for file in
$$list; do \
212 (cd
$(DESTDIR
)$(infodir) && rm -f
$$file $$file-[0-9] $$file-[0-9][0-9]); \
215 html__strip_dir
= `echo $$p | sed -e 's|^.*/||'`;
217 install-html
: $(HTMLFILES
)
219 test -z
"$(htmldir)" ||
$(mkinstalldirs
) "$(DESTDIR)$(htmldir)"
220 @list
='$(HTMLFILES_INSTALL)'; for p in
$$list; do \
221 if
test -f
"$$p" ||
test -d
"$$p"; then d
=""; else d
="$(srcdir)/"; fi
; \
222 f
=$(html__strip_dir
) \
223 if
test -d
"$$d$$p"; then \
224 echo
" $(mkinstalldirs) '$(DESTDIR)$(htmldir)/$$f'"; \
225 $(mkinstalldirs
) "$(DESTDIR)$(htmldir)/$$f" || exit
1; \
226 echo
" $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \
227 $(INSTALL_DATA
) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f"; \
229 echo
" $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(htmldir)/$$f'"; \
230 $(INSTALL_DATA
) "$$d$$p" "$(DESTDIR)$(htmldir)/$$f"; \
234 pdf__strip_dir
= `echo $$p | sed -e 's|^.*/||'`;
236 install-pdf
: $(PDFFILES
)
238 test -z
"$(pdfdir)" ||
$(mkinstalldirs
) "$(DESTDIR)$(pdfdir)"
239 @list
='$(PDFFILES)'; for p in
$$list; do \
240 if
test -f
"$$p"; then d
=; else d
="$(srcdir)/"; fi
; \
241 f
=$(pdf__strip_dir
) \
242 echo
" $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/$$f'"; \
243 $(INSTALL_DATA
) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
246 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
*.ps
*.
dvi *.pdf
248 # Copy the object files from a particular stage into a subdirectory.
251 -mv
$(STAGESTUFF
) stage1
255 -mv
$(STAGESTUFF
) stage2
259 -mv
$(STAGESTUFF
) stage3
264 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
267 -(cd stage1
; mv
-f
* ..
)
271 -(cd stage2
; mv
-f
* ..
)
275 -(cd stage3
; mv
-f
* ..
)
278 # GDB QUICK REFERENCE (dvi output)
279 refcard.
dvi : refcard.
tex $(REFEDITS
)
281 for f in x
$(REFEDITS
) ; do \
282 test x
$$f = xx
&& continue
; \
283 cat
$(srcdir)/$$f >>tmp.sed
; \
285 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
286 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
287 mv sedref.
dvi refcard.
dvi
288 rm -f sedref.log sedref.
tex tmp.sed
290 refcard.ps
: refcard.
dvi
291 $(DVIPS
) -t landscape
-o
$@
$?
293 refcard.pdf
: refcard.
tex $(REFEDITS
)
295 for f in x
$(REFEDITS
) ; do \
296 test x
$$f = xx
&& continue
; \
297 cat
$(srcdir)/$$f >>tmp.sed
; \
299 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex
300 $(SET_TEXINPUTS
) $(PDFTEX
) sedref.
tex
301 mv sedref.pdf refcard.pdf
302 rm -f sedref.log sedref.
tex tmp.sed
304 # File to record current GDB version number (copied from main dir version.in)
305 GDBvn.texi
: ${gdbdir}/version.in
306 echo
"@set GDBVN `sed q $(srcdir)/../version.in`" > .
/GDBvn.new
307 if
[ -n
"$(PKGVERSION)" ]; then \
308 echo
"@set VERSION_PACKAGE $(PKGVERSION)" >> .
/GDBvn.new
; \
310 echo
"@set BUGURL $(BUGURL_TEXI)" >> .
/GDBvn.new
311 if
[ "$(BUGURL_TEXI)" = "@uref{http://www.gnu.org/software/gdb/bugs/}" ]; then \
312 echo
"@set BUGURL_DEFAULT" >> .
/GDBvn.new
; \
314 if
test -z
"$(READLINE_TEXI_INCFLAG)"; then \
315 echo
"@set SYSTEM_READLINE" >> .
/GDBvn.new
; \
317 mv GDBvn.new GDBvn.texi
320 .PRECIOUS
: GDBvn.texi
322 # Choose configuration for GDB manual (normally `all'; normally not tied into
323 # `configure' script because most users prefer generic version of manual,
324 # not one for their binary config---which may not be specifically
326 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
327 (test "$(LN_S)" = "ln -s" && \
328 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
) || \
329 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
330 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
332 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
333 # If your texinfo or makeinfo don't support these, get a new texinfo release
335 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
336 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
337 # source directory for the benefit of people who *don't* use this makefile,
338 # VPATH will often tell make not to bother building it, because the one
339 # in the srcdir is up to date. (if not, then make should build one here).
341 # Clean these up before each run. Avoids a catch 22 with not being
342 # able to re-generate these files (to fix a corruption) because these
343 # files contain a corruption.
344 GDB_TEX_TMPS
= gdb.aux gdb.cp
* gdb.fn
* gdb.ky
* gdb.log gdb.pg
* gdb.toc \
347 # GDB MANUAL: TeX dvi file
348 gdb.
dvi: ${GDB_DOC_FILES}
349 if
[ ! -f .
/GDBvn.texi
]; then \
350 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
351 ln
$(srcdir)/GDBvn.texi . || \
352 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
353 rm -f
$(GDB_TEX_TMPS
)
354 $(TEXI2DVI
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
355 $(srcdir)/gdb.texinfo
360 gdb.pdf
: ${GDB_DOC_FILES}
361 if
[ ! -f .
/GDBvn.texi
]; then \
362 (test "$(LN_S)" = "ln -s" && ln
-s
$(srcdir)/GDBvn.texi .
) || \
363 ln
$(srcdir)/GDBvn.texi . || \
364 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
365 rm -f
$(GDB_TEX_TMPS
)
366 $(TEXI2DVI
) --pdf
$(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
367 $(srcdir)/gdb.texinfo
369 # GDB MANUAL: info file
370 gdb.
info: ${GDB_DOC_FILES}
371 $(MAKEINFO_CMD
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) \
372 -o gdb.
info $(srcdir)/gdb.texinfo
374 # GDB MANUAL: roff translations
375 # Try to use a recent texi2roff. v2 was put on prep in jan91.
376 # If you want an index, see texi2roff doc for postprocessing
377 # and add -i to texi2roff invocations below.
378 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
379 # corresponding -e lines when later texi2roff's are current)
380 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
381 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
382 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
383 # + @alphaenumerate is ridiculously new, turned into @enumerate
385 # texi2roff doesn't have a notion of include dirs, so we have to fake
386 # it out for gdb manual's include files---but only if not configured
388 links2roff
: $(GDB_DOC_SOURCE_INCLUDES
)
389 if
[ ! -f gdb.texinfo
]; then \
390 (test "$(LN_S)" = "ln -s" && ln
-s
$(GDB_DOC_SOURCE_INCLUDES
) .
) || \
391 ln
$(GDB_DOC_SOURCE_INCLUDES
) . || \
392 cp
$(GDB_DOC_SOURCE_INCLUDES
) .
; \
396 # gdb manual suitable for [gtn]roff -me
397 gdb.me
: $(GDB_DOC_FILES
) links2roff
398 sed
-e
'/\\input texinfo/d' \
399 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
400 -e
'/^@ifinfo/,/^@end ifinfo/d' \
404 -e
's/^@alphaenumerate/@enumerate/g' \
405 -e
's/^@end alphaenumerate/@end enumerate/g' \
406 $(srcdir)/gdb.texinfo | \
408 sed
-e
's/---/\\(em/g' \
411 # gdb manual suitable for [gtn]roff -ms
412 gdb.ms
: $(GDB_DOC_FILES
) links2roff
413 sed
-e
'/\\input texinfo/d' \
414 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
415 -e
'/^@ifinfo/,/^@end ifinfo/d' \
419 -e
's/^@alphaenumerate/@enumerate/g' \
420 -e
's/^@end alphaenumerate/@end enumerate/g' \
421 $(srcdir)/gdb.texinfo | \
423 sed
-e
's/---/\\(em/g' \
426 # gdb manual suitable for [tn]roff -mm
427 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
428 # try leaving them in
429 gdb.mm
: $(GDB_DOC_FILES
) links2roff
430 sed
-e
'/\\input texinfo/d' \
431 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
432 -e
'/^@ifinfo/,/^@end ifinfo/d' \
437 -e
's/^@alphaenumerate/@enumerate/g' \
438 -e
's/^@end alphaenumerate/@end enumerate/g' \
439 $(srcdir)/gdb.texinfo | \
441 sed
-e
's/---/\\(em/g' \
444 # GDB MANUAL: HTML file
446 gdb
/index.html
: ${GDB_DOC_FILES}
447 $(MAKEHTML
) $(MAKEHTMLFLAGS
) $(READLINE_TEXI_INCFLAG
) -I
${GDBMI_DIR} -I
$(srcdir) $(srcdir)/gdb.texinfo
449 # Clean these up before each run. Avoids a catch 22 with not being
450 # able to re-generate these files (to fix a corruption) because these
451 # files contain a corruption.
452 GDBINT_TEX_TMPS
= gdbint.aux gdbint.cp
* gdbint.fn
* gdbint.ky
* \
453 gdbint.log gdbint.pg
* gdbint.toc gdbint.tp
* gdbint.vr
*
455 # GDB INTERNALS MANUAL: TeX dvi file
456 gdbint.
dvi: $(GDBINT_DOC_FILES
)
457 rm -f
$(GDBINT_TEX_TMPS
)
458 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/gdbint.texinfo
460 gdbint.ps
: gdbint.
dvi
463 gdbint.pdf
: $(GDBINT_DOC_FILES
)
464 rm -f
$(GDBINT_TEX_TMPS
)
465 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/gdbint.texinfo
467 # GDB INTERNALS MANUAL: info file
469 gdbint.
info: $(GDBINT_DOC_FILES
)
470 $(MAKEINFO_CMD
) -I
$(srcdir) -o gdbint.
info $(srcdir)/gdbint.texinfo
472 # GDB INTERNALS MANUAL: HTML file
474 gdbint
/index.html
: $(GDBINT_DOC_FILES
)
475 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/gdbint.texinfo
477 stabs.
info: $(STABS_DOC_FILES
)
478 $(MAKEINFO_CMD
) -I
$(srcdir) -o stabs.
info $(srcdir)/stabs.texinfo
480 # STABS DOCUMENTATION: HTML file
482 stabs
/index.html
: $(STABS_DOC_FILES
)
483 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/stabs.texinfo
485 # Clean these up before each run. Avoids a catch 22 with not being
486 # able to re-generate these files (to fix a corruption) because these
487 # files contain a corruption.
488 STABS_TEX_TMPS
= stabs.aux stabs.cp
* stabs.fn
* stabs.ky
* \
489 stabs.log stabs.pg
* stabs.toc stabs.tp
* stabs.vr
*
491 # STABS DOCUMENTATION: TeX dvi file
492 stabs.
dvi : $(STABS_DOC_FILES
)
493 rm -f
$(STABS_TEX_TMPS
)
494 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/stabs.texinfo
499 stabs.pdf
: $(STABS_DOC_FILES
)
500 rm -f
$(STABS_TEX_TMPS
)
501 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/stabs.texinfo
503 # Clean these up before each run. Avoids a catch 22 with not being
504 # able to re-generate these files (to fix a corruption) because these
505 # files contain a corruption.
506 ANNOTATE_TEX_TMPS
= annotate.aux annotate.cp
* annotate.fn
* annotate.ky
* \
507 annotate.log annotate.pg
* annotate.toc annotate.tp
* annotate.vr
*
509 # ANNOTATE DOCUMENTATION: TeX dvi file
510 annotate.
dvi : $(ANNOTATE_DOC_FILES
)
511 rm -f
$(ANNOTATE_TEX_TMPS
)
512 $(TEXI2DVI
) -I
$(srcdir) $(srcdir)/annotate.texinfo
514 annotate.ps
: annotate.
dvi
517 annotate.pdf
: $(ANNOTATE_DOC_FILES
)
518 rm -f
$(ANNOTATE_TEX_TMPS
)
519 $(TEXI2DVI
) --pdf
-I
$(srcdir) $(srcdir)/annotate.texinfo
521 annotate.
info: $(ANNOTATE_DOC_FILES
)
522 $(MAKEINFO_CMD
) -I
$(srcdir) -o annotate.
info $(srcdir)/annotate.texinfo
524 annotate
/index.html
: $(ANNOTATE_DOC_FILES
)
525 $(MAKEHTML
) $(MAKEHTMLFLAGS
) -I
$(srcdir) $(srcdir)/annotate.texinfo
529 Makefile
: Makefile.in
$(host_makefile_frag
) ..
/config.status
530 cd ..
&& $(SHELL
) .
/config.status doc
/Makefile
533 # The "least clean" level of cleaning. Get rid of files which are
534 # automatically generated files that are just intermediate files,
537 rm -f gdb.mm gdb.ms gdb.me links2roff
538 rm -f
$(GDB_TEX_TMPS
)
539 rm -f
$(GDBINT_TEX_TMPS
)
540 rm -f
$(STABS_TEX_TMPS
)
541 rm -f
$(ANNOTATE_TEX_TMPS
)
542 rm -f sedref.
dvi sedref.
tex tmp.sed
545 rm -f gdb-cfg.texi GDBvn.texi
550 # GDBvn.texi, the dvi files, the info files, and the postscript files,
551 # are all part of the distribution, so it should not be removed by
552 # "clean" or "distclean". Use maintainer-clean to remove them.
554 maintainer-clean
realclean: distclean
555 rm -f GDBvn.texi
*.
info* *.
dvi *.ps
*.html
*.pdf
557 install: install-info
559 uninstall: uninstall-info