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
52 # Don Knuth's TeX formatter
55 # auxiliary program for sorting Texinfo indices
58 # Main GDB manual's source files
59 SFILES_INCLUDED = gdb-config.texi $(srcdir)/gdbinv-s.texi
61 SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED)
63 SFILES_DOC = $(SFILES_LOCAL) \
64 $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texi
66 #### Host, target, and site specific Makefile fragments come in here.
71 info: gdb.info gdbint.info stabs.info
72 dvi: gdb.dvi refcard.dvi gdbint.dvi
73 all-doc: gdb.info gdb.dvi refcard.dvi gdb-internals gdbint.dvi
76 -parent=`echo $(infodir)|sed -e 's@/[^/]*$$@@'`; \
77 if [ -d $$parent ] ; then true ; else mkdir $$parent ; fi
78 -if [ -d $(infodir) ] ; then true ; else mkdir $(infodir) ; fi
79 for i in *.info* ; do \
80 $(INSTALL_DATA) $$i $(infodir)/$$i ; \
83 STAGESTUFF = *.info* gdb-all.texi GDBvn.texi
85 # Copy the object files from a particular stage into a subdirectory.
88 -mv $(STAGESTUFF) stage1
92 -mv $(STAGESTUFF) stage2
96 -mv $(STAGESTUFF) stage3
101 for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
104 -(cd stage1 ; mv -f * ..)
108 -(cd stage2 ; mv -f * ..)
112 -(cd stage3 ; mv -f * ..)
116 rm -f gdb.info* gdbint.info* stabs.info*
119 rm -f gdb.dvi refcard.dvi gdbint.dvi stabs.dvi psref.dvi
121 mostlyclean: clean-info clean-dvi
122 rm -f gdb.?? gdb.??? gdb.mm gdb.ms gdb.me
124 rm -f refcard.ps lrefcard.ps refcard.log psref.* *~
125 rm -f gdbint.?? gdbint.??? stabs.?? stabs.???
128 rm -f GDBvn.texi rluser.texinfo inc-hist.texi
131 rm -f Makefile config.status
136 # GDB QUICK REFERENCE (TeX dvi file, CM fonts)
137 refcard.dvi : $(srcdir)/refcard.tex
138 $(SET_TEXINPUTS) $(TEX) refcard.tex; rm -f refcard.log
141 # GDB QUICK REFERENCE (PostScript output, common PS fonts)
142 refcard.ps : $(srcdir)/refcard.tex $(srcdir)/psrc.sed
143 sed -f $(srcdir)/psrc.sed $(srcdir)/refcard.tex >psref.tex
144 $(SET_TEXINPUTS) $(TEX) psref.tex
145 dvips -t landscape psref -o; mv psref.ps refcard.ps
146 rm -f psref.dvi psref.log psref.tex
148 # GDB QUICK REFERENCE (PostScript output, common PS fonts w/long names)
149 lrefcard.ps : $(srcdir)/refcard.tex $(srcdir)/lpsrc.sed
150 sed -f $(srcdir)/lpsrc.sed $(srcdir)/refcard.tex >psref.tex
151 $(SET_TEXINPUTS) $(TEX) psref.tex
152 dvips -t landscape psref -o; mv psref.ps lrefcard.ps
153 rm -f psref.dvi psref.log psref.tex
155 # File to record current GDB version number (copied from main dir Makefile.in)
156 GDBvn.texi : ${gdbdir}/Makefile.in
157 echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/VERSION = //p'`" > ./GDBvn.texi
159 # Choose configuration for GDB manual (normally `all'; normally not tied into
160 # `configure' script because most users prefer generic version of manual,
161 # not one for their binary config---which may not be specifically
163 gdb-config.texi: ${srcdir}/${DOC_CONFIG}-config.texi
164 ln -s ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
165 ln ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi || \
166 cp ${srcdir}/${DOC_CONFIG}-config.texi gdb-config.texi
168 # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
169 # If your texinfo or makeinfo don't support these, get a new texinfo release
171 # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
172 # Note that we can *generate* GDBvn.texi, but since we distribute one in the
173 # source directory for the benefit of people who *don't* use this makefile,
174 # VPATH will often tell make not to bother building it, because the one
175 # in the srcdir is up to date. (if not, then make should build one here).
177 # GDB MANUAL: TeX dvi file
178 gdb.dvi: ${SFILES_DOC}
179 if [ ! -f ./GDBvn.texi ]; then \
180 ln -s $(srcdir)/GDBvn.texi . || \
181 ln $(srcdir)/GDBvn.texi . || \
182 cp $(srcdir)/GDBvn.texi . ; else true; fi
183 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
184 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
186 $(SET_TEXINPUTS) $(TEX) gdb.texinfo
187 rm -f gdb.?? gdb.log gdb.aux gdb.toc gdb.??s
189 # GDB MANUAL: info file
190 # We're using texinfo2, and older makeinfo's may not be able to
191 # cope with all the markup.
192 gdb.info: ${SFILES_DOC}
193 $(MAKEINFO) -I ${READLINE_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo
195 # GDB MANUAL: roff translations
196 # Try to use a recent texi2roff. v2 was put on prep in jan91.
197 # If you want an index, see texi2roff doc for postprocessing
198 # and add -i to texi2roff invocations below.
199 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
200 # corresponding -e lines when later texi2roff's are current)
201 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
202 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
203 # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
204 # + @alphaenumerate is ridiculously new, turned into @enumerate
206 # texi2roff doesn't have a notion of include dirs, so we have to fake
207 # it out for gdb manual's include files---but only if not configured
209 links2roff: $(SFILES_INCLUDED)
210 if [ ! -f gdb.texinfo ]; then \
211 ln -s $(SFILES_INCLUDED) . || \
212 ln $(SFILES_INCLUDED) . || \
213 cp $(SFILES_INCLUDED) . ; \
217 # "Readline" appendices. Get them also due to lack of includes,
218 # regardless of whether or not configuring in main sourcedir.
219 # @ftable removed due to bug in texi2roff-2; if your texi2roff
220 # is newer, try just ln or cp
221 rluser.texinfo: ${READLINE_DIR}/rluser.texinfo
222 sed -e 's/^@ftable/@table/g' \
223 -e 's/^@end ftable/@end table/g' \
224 ${READLINE_DIR}/rluser.texinfo > ./rluser.texinfo
226 inc-hist.texi: ${READLINE_DIR}/inc-hist.texi
227 ln -s ${READLINE_DIR}/inc-hist.texi . || \
228 ln ${READLINE_DIR}/inc-hist.texi . || \
229 cp ${READLINE_DIR}/inc-hist.texi .
231 # gdb manual suitable for [gtn]roff -me
232 gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi
233 sed -e '/\\input texinfo/d' \
234 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
235 -e '/^@ifinfo/,/^@end ifinfo/d' \
239 -e 's/^@alphaenumerate/@enumerate/g' \
240 -e 's/^@end alphaenumerate/@end enumerate/g' \
241 $(srcdir)/gdb.texinfo | \
243 sed -e 's/---/\\(em/g' \
246 # gdb manual suitable for [gtn]roff -ms
247 gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi
248 sed -e '/\\input texinfo/d' \
249 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
250 -e '/^@ifinfo/,/^@end ifinfo/d' \
254 -e 's/^@alphaenumerate/@enumerate/g' \
255 -e 's/^@end alphaenumerate/@end enumerate/g' \
256 $(srcdir)/gdb.texinfo | \
258 sed -e 's/---/\\(em/g' \
261 # gdb manual suitable for [tn]roff -mm
262 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
263 # try leaving them in
264 gdb.mm: $(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' \
272 -e 's/^@alphaenumerate/@enumerate/g' \
273 -e 's/^@end alphaenumerate/@end enumerate/g' \
274 $(srcdir)/gdb.texinfo | \
276 sed -e 's/---/\\(em/g' \
279 # GDB INTERNALS MANUAL: TeX dvi file
280 gdbint.dvi : gdbint.texinfo
281 $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
282 $(TEXINDEX) gdbint.??
283 $(SET_TEXINPUTS) $(TEX) gdbint.texinfo
284 rm -f gdbint.?? gdbint.aux gdbint.cps gdbint.fns gdbint.kys \
285 gdbint.log gdbint.pgs gdbint.toc gdbint.tps gdbint.vrs
287 # GDB INTERNALS MANUAL: info file
288 gdb-internals: gdbint.info
290 gdbint.info: gdbint.texinfo
291 $(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo
293 stabs.info: stabs.texinfo
294 $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo
296 # STABS DOCUMENTATION: TeX dvi file
297 stabs.dvi : stabs.texinfo
298 $(SET_TEXINPUTS) $(TEX) stabs.texinfo
300 $(SET_TEXINPUTS) $(TEX) stabs.texinfo
301 rm -f stabs.?? stabs.aux stabs.cps stabs.fns stabs.kys \
302 stabs.log stabs.pgs stabs.toc stabs.tps stabs.vrs
305 dvips -o stabs.ps stabs
309 Makefile: $(srcdir)/Makefile.in $(host_makefile_frag) $(target_makefile_frag)
310 $(SHELL) ./config.status