1 ##Copyright (C) 1991, 1992 Free Software Foundation, Inc.
3 # Makefile for GDB documentation.
4 # This file is part of GDB.
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 infodir = $(prefix)/info
29 INSTALL_PROGRAM
= $(INSTALL
)
30 INSTALL_DATA
= $(INSTALL
)
32 # main GDB source directory
35 # where to find texinfo; GDB dist should include a recent one
36 TEXIDIR
=${gdbdir}/..
/texinfo
38 # where to find makeinfo, preferably one designed for texinfo-2
41 # where to find texi2roff, ditto
44 # Where is the source dir for the READLINE library doc?
45 # Traditionally readline is in .. or .
46 READLINE_DIR
= ${gdbdir}/..
/readline
/doc
48 SET_TEXINPUTS
= TEXINPUTS
=${TEXIDIR}:.
:$(srcdir):$(READLINE_DIR
):$$TEXINPUTS
50 # There may be alternate predefined collections of switches to configure
51 # the GDB manual. Normally this is not done in synch with the software
52 # config system, since this choice tends to be independent; most people
53 # want a doc config of `all' for a generic manual, regardless of sw config.
56 # This list of sed edits will edit the GDB reference card
57 # for what fonts and what papersize to use.
58 # By default (NO edits applied), the refcard uses:
59 # - Computer Modern (CM) fonts
60 # - US letter paper (8.5x11in)
61 # List some of the following files for alternative fonts and paper:
62 # a4rc.sed use A4 paper (297 x 210 mm)
63 # psrc.sed use PostScript fonts (Karl Berry short TeX names)
64 # lpsrc.sed use PostScript fonts (full PostScript names in TeX)
65 # e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
66 # for A4, CM fonts: REFEDITS = a4rc.sed
67 # for US, PS fonts: REFEDITS = psrc.sed
71 # Don Knuth's TeX formatter
74 # auxiliary program for sorting Texinfo indices
77 # Main GDB manual's source files
78 SFILES_INCLUDED
= gdb-cfg.texi
$(srcdir)/gdbinv-s.texi
80 SFILES_LOCAL
= $(srcdir)/gdb.texinfo GDBvn.texi
$(SFILES_INCLUDED
)
82 SFILES_DOC
= $(SFILES_LOCAL
) \
83 $(READLINE_DIR
)/rluser.texinfo
$(READLINE_DIR
)/inc-hist.texi
85 #### Host, target, and site specific Makefile fragments come in here.
90 info: gdb.
info gdbint.
info stabs.
info
91 dvi: gdb.
dvi refcard.
dvi gdbint.
dvi
92 all-doc
: gdb.
info gdb.
dvi refcard.
dvi gdb-internals gdbint.
dvi
95 for i in
*.
info* ; do \
96 $(INSTALL_DATA
) $$i $(infodir)/$$i ; \
99 STAGESTUFF
= *.
info* gdb-all.texi GDBvn.texi
101 # Copy the object files from a particular stage into a subdirectory.
104 -mv
$(STAGESTUFF
) stage1
108 -mv
$(STAGESTUFF
) stage2
112 -mv
$(STAGESTUFF
) stage3
117 for i in
$(STAGESTUFF
) ; do cmp
$$i $(against
)/$$i ; done
120 -(cd stage1
; mv
-f
* ..
)
124 -(cd stage2
; mv
-f
* ..
)
128 -(cd stage3
; mv
-f
* ..
)
132 rm -f gdb.
info* gdbint.
info* stabs.
info*
135 rm -f gdb.
dvi refcard.
dvi gdbint.
dvi stabs.
dvi sedref.
dvi
137 mostlyclean: clean-info clean-dvi
138 rm -f gdb.?? gdb.??? gdb.mm gdb.ms gdb.me
140 rm -f refcard.ps lrefcard.ps refcard.log sedref.
* *~
141 rm -f gdbint.?? gdbint.??? stabs.?? stabs.???
144 rm -f GDBvn.texi rluser.texinfo inc-hist.texi
147 rm -f Makefile config.status
149 realclean: distclean clean-dvi clean-info
151 # GDB QUICK REFERENCE (dvi output)
152 refcard.
dvi : refcard.
tex $(REFEDITS
)
153 if
[ -z
"$(REFEDITS)" ]; then \
154 cp refcard.
tex sedref.
tex ; \
157 for f in
"$(REFEDITS)" ; do \
158 cat
$(srcdir)/$$f >>tmp.sed
; done
; \
159 sed
-f tmp.sed
$(srcdir)/refcard.
tex >sedref.
tex ; \
161 $(SET_TEXINPUTS
) $(TEX
) sedref.
tex
162 mv sedref.
dvi refcard.
dvi
163 rm -f sedref.log sedref.
tex tmp.sed
165 refcard.ps
: refcard.
dvi
166 dvips
-t landscape refcard.
dvi -o
168 # File to record current GDB version number (copied from main dir Makefile.in)
169 GDBvn.texi
: ${gdbdir}/Makefile.in
170 echo
"@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/VERSION = //p'`" > .
/GDBvn.new
171 mv GDBvn.new GDBvn.texi
174 .PRECIOUS
: GDBvn.texi
176 # Choose configuration for GDB manual (normally `all'; normally not tied into
177 # `configure' script because most users prefer generic version of manual,
178 # not one for their binary config---which may not be specifically
180 gdb-cfg.texi
: ${srcdir}/${DOC_CONFIG}-cfg.texi
181 ln
-s
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
182 ln
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
183 cp
${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
185 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
186 # If your texinfo or makeinfo don't support these, get a new texinfo release
188 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
189 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
190 # source directory for the benefit of people who *don't* use this makefile,
191 # VPATH will often tell make not to bother building it, because the one
192 # in the srcdir is up to date. (if not, then make should build one here).
194 # GDB MANUAL: TeX dvi file
195 gdb.
dvi: ${SFILES_DOC}
196 if
[ ! -f .
/GDBvn.texi
]; then \
197 ln
-s
$(srcdir)/GDBvn.texi . || \
198 ln
$(srcdir)/GDBvn.texi . || \
199 cp
$(srcdir)/GDBvn.texi .
; else true
; fi
200 $(SET_TEXINPUTS
) $(TEX
) gdb.texinfo
201 $(SET_TEXINPUTS
) $(TEX
) gdb.texinfo
203 $(SET_TEXINPUTS
) $(TEX
) gdb.texinfo
204 rm -f gdb.?? gdb.log gdb.aux gdb.toc gdb.??s
206 # GDB MANUAL: info file
207 # We're using texinfo2, and older makeinfo's may not be able to
208 # cope with all the markup.
209 gdb.
info: ${SFILES_DOC}
210 $(MAKEINFO
) -I
${READLINE_DIR} -I
$(srcdir) -o .
/gdb.
info gdb.texinfo
212 # GDB MANUAL: roff translations
213 # Try to use a recent texi2roff. v2 was put on prep in jan91.
214 # If you want an index, see texi2roff doc for postprocessing
215 # and add -i to texi2roff invocations below.
216 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
217 # corresponding -e lines when later texi2roff's are current)
218 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
219 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
220 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
221 # + @alphaenumerate is ridiculously new, turned into @enumerate
223 # texi2roff doesn't have a notion of include dirs, so we have to fake
224 # it out for gdb manual's include files---but only if not configured
226 links2roff
: $(SFILES_INCLUDED
)
227 if
[ ! -f gdb.texinfo
]; then \
228 ln
-s
$(SFILES_INCLUDED
) . || \
229 ln
$(SFILES_INCLUDED
) . || \
230 cp
$(SFILES_INCLUDED
) .
; \
234 # "Readline" appendices. Get them also due to lack of includes,
235 # regardless of whether or not configuring in main sourcedir.
236 # @ftable removed due to bug in texi2roff-2; if your texi2roff
237 # is newer, try just ln or cp
238 rluser.texinfo
: ${READLINE_DIR}/rluser.texinfo
239 sed
-e
's/^@ftable/@table/g' \
240 -e
's/^@end ftable/@end table/g' \
241 ${READLINE_DIR}/rluser.texinfo
> .
/rluser.texinfo
243 inc-hist.texi
: ${READLINE_DIR}/inc-hist.texi
244 ln
-s
${READLINE_DIR}/inc-hist.texi . || \
245 ln
${READLINE_DIR}/inc-hist.texi . || \
246 cp
${READLINE_DIR}/inc-hist.texi .
248 # gdb manual suitable for [gtn]roff -me
249 gdb.me
: $(SFILES_LOCAL
) links2roff rluser.texinfo inc-hist.texi
250 sed
-e
'/\\input texinfo/d' \
251 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
252 -e
'/^@ifinfo/,/^@end ifinfo/d' \
256 -e
's/^@alphaenumerate/@enumerate/g' \
257 -e
's/^@end alphaenumerate/@end enumerate/g' \
258 $(srcdir)/gdb.texinfo | \
260 sed
-e
's/---/\\(em/g' \
263 # gdb manual suitable for [gtn]roff -ms
264 gdb.ms
: $(SFILES_LOCAL
) links2roff rluser.texinfo inc-hist.texi
265 sed
-e
'/\\input texinfo/d' \
266 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
267 -e
'/^@ifinfo/,/^@end ifinfo/d' \
271 -e
's/^@alphaenumerate/@enumerate/g' \
272 -e
's/^@end alphaenumerate/@end enumerate/g' \
273 $(srcdir)/gdb.texinfo | \
275 sed
-e
's/---/\\(em/g' \
278 # gdb manual suitable for [tn]roff -mm
279 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
280 # try leaving them in
281 gdb.mm
: $(SFILES_LOCAL
) links2roff rluser.texinfo inc-hist.texi
282 sed
-e
'/\\input texinfo/d' \
283 -e
'/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
284 -e
'/^@ifinfo/,/^@end ifinfo/d' \
289 -e
's/^@alphaenumerate/@enumerate/g' \
290 -e
's/^@end alphaenumerate/@end enumerate/g' \
291 $(srcdir)/gdb.texinfo | \
293 sed
-e
's/---/\\(em/g' \
296 # GDB INTERNALS MANUAL: TeX dvi file
297 gdbint.
dvi : gdbint.texinfo
298 $(SET_TEXINPUTS
) $(TEX
) gdbint.texinfo
299 $(TEXINDEX
) gdbint.??
300 $(SET_TEXINPUTS
) $(TEX
) gdbint.texinfo
301 rm -f gdbint.?? gdbint.aux gdbint.cps gdbint.fns gdbint.kys \
302 gdbint.log gdbint.pgs gdbint.toc gdbint.tps gdbint.vrs
304 # GDB INTERNALS MANUAL: info file
305 gdb-internals
: gdbint.
info
307 gdbint.
info: gdbint.texinfo
308 $(MAKEINFO
) -o gdbint.
info $(srcdir)/gdbint.texinfo
310 stabs.
info: stabs.texinfo
311 $(MAKEINFO
) -o stabs.
info $(srcdir)/stabs.texinfo
313 # STABS DOCUMENTATION: TeX dvi file
314 stabs.
dvi : stabs.texinfo
315 $(SET_TEXINPUTS
) $(TEX
) stabs.texinfo
317 $(SET_TEXINPUTS
) $(TEX
) stabs.texinfo
318 rm -f stabs.?? stabs.aux stabs.cps stabs.fns stabs.kys \
319 stabs.log stabs.pgs stabs.toc stabs.tps stabs.vrs
322 dvips
-o stabs.ps stabs
326 Makefile
: $(srcdir)/Makefile.in
$(host_makefile_frag
) $(target_makefile_frag
)
327 $(SHELL
) .
/config.status