Commit | Line | Data |
---|---|---|
787c6bfe | 1 | ##Copyright (C) 1991, 1992 Free Software Foundation, Inc. |
1eb988b9 RP |
2 | |
3 | # Makefile for GDB documentation. | |
4 | # This file is part of GDB. | |
5 | ||
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. | |
10 | # | |
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. | |
15 | # | |
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. | |
19 | ||
dc341d8b RP |
20 | srcdir = . |
21 | ||
570e1733 RP |
22 | prefix = /usr/local |
23 | ||
787c6bfe | 24 | infodir = $(prefix)/info |
dc341d8b RP |
25 | |
26 | SHELL = /bin/sh | |
27 | ||
570e1733 RP |
28 | INSTALL = install -c |
29 | INSTALL_PROGRAM = $(INSTALL) | |
30 | INSTALL_DATA = $(INSTALL) | |
31 | ||
1eb988b9 | 32 | # main GDB source directory |
18fae2a8 | 33 | gdbdir = $(srcdir)/.. |
1eb988b9 RP |
34 | |
35 | # where to find texinfo; GDB dist should include a recent one | |
18fae2a8 | 36 | TEXIDIR=${gdbdir}/../texinfo |
1eb988b9 RP |
37 | |
38 | # where to find makeinfo, preferably one designed for texinfo-2 | |
39 | MAKEINFO=makeinfo | |
40 | ||
92b73793 RP |
41 | # where to find texi2roff, ditto |
42 | TEXI2ROFF=texi2roff | |
43 | ||
18fae2a8 RP |
44 | # Where is the source dir for the READLINE library doc? |
45 | # Traditionally readline is in .. or . | |
46 | READLINE_DIR = ${gdbdir}/../readline/doc | |
47 | ||
48 | SET_TEXINPUTS = TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$$TEXINPUTS | |
49 | ||
2685ead7 RP |
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. | |
1d7c3357 RP |
54 | DOC_CONFIG = all |
55 | ||
2685ead7 RP |
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 | |
68 | # for default: | |
69 | REFEDITS = | |
70 | ||
18fae2a8 RP |
71 | # Don Knuth's TeX formatter |
72 | TEX = tex | |
73 | ||
74 | # auxiliary program for sorting Texinfo indices | |
75 | TEXINDEX = texindex | |
1eb988b9 RP |
76 | |
77 | # Main GDB manual's source files | |
4af6d502 | 78 | SFILES_INCLUDED = gdb-cfg.texi $(srcdir)/remote.texi |
18fae2a8 RP |
79 | |
80 | SFILES_LOCAL = $(srcdir)/gdb.texinfo GDBvn.texi $(SFILES_INCLUDED) | |
1eb988b9 | 81 | |
18fae2a8 RP |
82 | SFILES_DOC = $(SFILES_LOCAL) \ |
83 | $(READLINE_DIR)/rluser.texinfo $(READLINE_DIR)/inc-hist.texi | |
92b73793 | 84 | |
4f98572e RP |
85 | #### Host, target, and site specific Makefile fragments come in here. |
86 | ### | |
87 | ||
e92ee469 RP |
88 | all install: |
89 | ||
612dbd4c | 90 | info: gdb.info gdbint.info stabs.info |
6a962504 | 91 | dvi: gdb.dvi refcard.dvi gdbint.dvi |
1041a570 | 92 | all-doc: gdb.info gdb.dvi refcard.dvi gdb-internals gdbint.dvi |
dc341d8b | 93 | |
570e1733 | 94 | install-info: info |
dc341d8b | 95 | for i in *.info* ; do \ |
570e1733 | 96 | $(INSTALL_DATA) $$i $(infodir)/$$i ; \ |
dc341d8b | 97 | done |
1eb988b9 | 98 | |
18fae2a8 | 99 | STAGESTUFF = *.info* gdb-all.texi GDBvn.texi |
332523bf RP |
100 | |
101 | # Copy the object files from a particular stage into a subdirectory. | |
102 | stage1: force | |
103 | -mkdir stage1 | |
104 | -mv $(STAGESTUFF) stage1 | |
105 | ||
106 | stage2: force | |
107 | -mkdir stage2 | |
108 | -mv $(STAGESTUFF) stage2 | |
109 | ||
110 | stage3: force | |
111 | -mkdir stage3 | |
112 | -mv $(STAGESTUFF) stage3 | |
113 | ||
114 | against=stage2 | |
115 | ||
116 | comparison: force | |
117 | for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done | |
118 | ||
119 | de-stage1: force | |
570e1733 RP |
120 | -(cd stage1 ; mv -f * ..) |
121 | -rmdir stage1 | |
332523bf RP |
122 | |
123 | de-stage2: force | |
570e1733 RP |
124 | -(cd stage2 ; mv -f * ..) |
125 | -rmdir stage2 | |
332523bf RP |
126 | |
127 | de-stage3: force | |
570e1733 RP |
128 | -(cd stage3 ; mv -f * ..) |
129 | -rmdir stage3 | |
332523bf | 130 | |
18fae2a8 RP |
131 | clean-info: |
132 | rm -f gdb.info* gdbint.info* stabs.info* | |
133 | ||
134 | clean-dvi: | |
023b6394 JK |
135 | rm -f gdb.dvi gdbint.dvi stabs.dvi sedref.dvi |
136 | ||
18fae2a8 RP |
137 | mostlyclean: clean-info clean-dvi |
138 | rm -f gdb.?? gdb.??? gdb.mm gdb.ms gdb.me | |
139 | rm -f links2roff | |
2685ead7 | 140 | rm -f refcard.ps lrefcard.ps refcard.log sedref.* *~ |
18fae2a8 RP |
141 | rm -f gdbint.?? gdbint.??? stabs.?? stabs.??? |
142 | ||
143 | clean: mostlyclean | |
144 | rm -f GDBvn.texi rluser.texinfo inc-hist.texi | |
145 | ||
146 | distclean: clean | |
147 | rm -f Makefile config.status | |
148 | ||
023b6394 JK |
149 | # GDBvn.texi and refcard.dvi are distributed, so they should not be |
150 | # removed by "clean" or "distclean". | |
b397d5b8 | 151 | realclean: distclean clean-dvi clean-info |
023b6394 | 152 | rm -f GDBvn.texi refcard.dvi |
18fae2a8 | 153 | |
2685ead7 RP |
154 | # GDB QUICK REFERENCE (dvi output) |
155 | refcard.dvi : refcard.tex $(REFEDITS) | |
156 | if [ -z "$(REFEDITS)" ]; then \ | |
b9b9f55a | 157 | cp $(srcdir)/refcard.tex sedref.tex ; \ |
2685ead7 RP |
158 | else \ |
159 | echo > tmp.sed ; \ | |
160 | for f in "$(REFEDITS)" ; do \ | |
161 | cat $(srcdir)/$$f >>tmp.sed ; done ; \ | |
162 | sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex ; \ | |
163 | fi | |
164 | $(SET_TEXINPUTS) $(TEX) sedref.tex | |
165 | mv sedref.dvi refcard.dvi | |
166 | rm -f sedref.log sedref.tex tmp.sed | |
167 | ||
168 | refcard.ps : refcard.dvi | |
169 | dvips -t landscape refcard.dvi -o | |
1eb988b9 | 170 | |
1eb988b9 | 171 | # File to record current GDB version number (copied from main dir Makefile.in) |
18fae2a8 | 172 | GDBvn.texi : ${gdbdir}/Makefile.in |
af08a43a JK |
173 | echo "@set GDBVN `sed <$(srcdir)/../Makefile.in -n 's/VERSION = //p'`" > ./GDBvn.new |
174 | mv GDBvn.new GDBvn.texi | |
175 | ||
176 | # Updated atomically | |
177 | .PRECIOUS: GDBvn.texi | |
18fae2a8 | 178 | |
1d7c3357 RP |
179 | # Choose configuration for GDB manual (normally `all'; normally not tied into |
180 | # `configure' script because most users prefer generic version of manual, | |
181 | # not one for their binary config---which may not be specifically | |
182 | # defined anyways). | |
c15024ee JK |
183 | gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi |
184 | ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \ | |
185 | ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \ | |
186 | cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi | |
1d7c3357 | 187 | |
18fae2a8 RP |
188 | # GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear |
189 | # If your texinfo or makeinfo don't support these, get a new texinfo release | |
190 | # | |
191 | # The nonsense with GDBvn.texi gets this to run with both Sun and GNU make. | |
192 | # Note that we can *generate* GDBvn.texi, but since we distribute one in the | |
cacf5942 RP |
193 | # source directory for the benefit of people who *don't* use this makefile, |
194 | # VPATH will often tell make not to bother building it, because the one | |
195 | # in the srcdir is up to date. (if not, then make should build one here). | |
787c6bfe | 196 | |
1eb988b9 | 197 | # GDB MANUAL: TeX dvi file |
18fae2a8 RP |
198 | gdb.dvi: ${SFILES_DOC} |
199 | if [ ! -f ./GDBvn.texi ]; then \ | |
200 | ln -s $(srcdir)/GDBvn.texi . || \ | |
201 | ln $(srcdir)/GDBvn.texi . || \ | |
202 | cp $(srcdir)/GDBvn.texi . ; else true; fi | |
203 | $(SET_TEXINPUTS) $(TEX) gdb.texinfo | |
204 | $(SET_TEXINPUTS) $(TEX) gdb.texinfo | |
205 | $(TEXINDEX) gdb.?? | |
206 | $(SET_TEXINPUTS) $(TEX) gdb.texinfo | |
207 | rm -f gdb.?? gdb.log gdb.aux gdb.toc gdb.??s | |
1eb988b9 RP |
208 | |
209 | # GDB MANUAL: info file | |
210 | # We're using texinfo2, and older makeinfo's may not be able to | |
18fae2a8 RP |
211 | # cope with all the markup. |
212 | gdb.info: ${SFILES_DOC} | |
213 | $(MAKEINFO) -I ${READLINE_DIR} -I $(srcdir) -o ./gdb.info gdb.texinfo | |
92b73793 RP |
214 | |
215 | # GDB MANUAL: roff translations | |
216 | # Try to use a recent texi2roff. v2 was put on prep in jan91. | |
217 | # If you want an index, see texi2roff doc for postprocessing | |
218 | # and add -i to texi2roff invocations below. | |
219 | # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete | |
cacf5942 | 220 | # corresponding -e lines when later texi2roff's are current) |
92b73793 RP |
221 | # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs. |
222 | # + @c's deleted explicitly because texi2roff sees texinfo commands in them | |
223 | # + @ (that's at-BLANK) not recognized by texi2roff, turned into blank | |
224 | # + @alphaenumerate is ridiculously new, turned into @enumerate | |
225 | ||
18fae2a8 RP |
226 | # texi2roff doesn't have a notion of include dirs, so we have to fake |
227 | # it out for gdb manual's include files---but only if not configured | |
228 | # in main sourcedir. | |
229 | links2roff: $(SFILES_INCLUDED) | |
1d7c3357 | 230 | if [ ! -f gdb.texinfo ]; then \ |
18fae2a8 RP |
231 | ln -s $(SFILES_INCLUDED) . || \ |
232 | ln $(SFILES_INCLUDED) . || \ | |
233 | cp $(SFILES_INCLUDED) . ; \ | |
234 | fi | |
235 | touch links2roff | |
236 | ||
237 | # "Readline" appendices. Get them also due to lack of includes, | |
238 | # regardless of whether or not configuring in main sourcedir. | |
239 | # @ftable removed due to bug in texi2roff-2; if your texi2roff | |
240 | # is newer, try just ln or cp | |
241 | rluser.texinfo: ${READLINE_DIR}/rluser.texinfo | |
242 | sed -e 's/^@ftable/@table/g' \ | |
5f92dab8 | 243 | -e 's/^@end ftable/@end table/g' \ |
18fae2a8 RP |
244 | ${READLINE_DIR}/rluser.texinfo > ./rluser.texinfo |
245 | ||
246 | inc-hist.texi: ${READLINE_DIR}/inc-hist.texi | |
247 | ln -s ${READLINE_DIR}/inc-hist.texi . || \ | |
248 | ln ${READLINE_DIR}/inc-hist.texi . || \ | |
249 | cp ${READLINE_DIR}/inc-hist.texi . | |
250 | ||
251 | # gdb manual suitable for [gtn]roff -me | |
252 | gdb.me: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi | |
92b73793 RP |
253 | sed -e '/\\input texinfo/d' \ |
254 | -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ | |
255 | -e '/^@ifinfo/,/^@end ifinfo/d' \ | |
50a39795 | 256 | -e '/^@c /d' \ |
92b73793 | 257 | -e 's/{.*,,/{/' \ |
92b73793 RP |
258 | -e 's/@ / /g' \ |
259 | -e 's/^@alphaenumerate/@enumerate/g' \ | |
260 | -e 's/^@end alphaenumerate/@end enumerate/g' \ | |
18fae2a8 RP |
261 | $(srcdir)/gdb.texinfo | \ |
262 | $(TEXI2ROFF) -me | \ | |
92b73793 | 263 | sed -e 's/---/\\(em/g' \ |
18fae2a8 | 264 | >gdb.me |
92b73793 | 265 | |
18fae2a8 RP |
266 | # gdb manual suitable for [gtn]roff -ms |
267 | gdb.ms: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi | |
92b73793 RP |
268 | sed -e '/\\input texinfo/d' \ |
269 | -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ | |
270 | -e '/^@ifinfo/,/^@end ifinfo/d' \ | |
50a39795 | 271 | -e '/^@c /d' \ |
92b73793 RP |
272 | -e 's/{.*,,/{/' \ |
273 | -e 's/@ / /g' \ | |
274 | -e 's/^@alphaenumerate/@enumerate/g' \ | |
275 | -e 's/^@end alphaenumerate/@end enumerate/g' \ | |
18fae2a8 RP |
276 | $(srcdir)/gdb.texinfo | \ |
277 | $(TEXI2ROFF) -ms | \ | |
92b73793 | 278 | sed -e 's/---/\\(em/g' \ |
18fae2a8 | 279 | >gdb.ms |
92b73793 | 280 | |
18fae2a8 RP |
281 | # gdb manual suitable for [tn]roff -mm |
282 | # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer, | |
283 | # try leaving them in | |
284 | gdb.mm: $(SFILES_LOCAL) links2roff rluser.texinfo inc-hist.texi | |
92b73793 RP |
285 | sed -e '/\\input texinfo/d' \ |
286 | -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \ | |
287 | -e '/^@ifinfo/,/^@end ifinfo/d' \ | |
50a39795 | 288 | -e '/^@c /d' \ |
92b73793 | 289 | -e 's/{.*,,/{/' \ |
18fae2a8 | 290 | -e '/@noindent/d' \ |
92b73793 RP |
291 | -e 's/@ / /g' \ |
292 | -e 's/^@alphaenumerate/@enumerate/g' \ | |
293 | -e 's/^@end alphaenumerate/@end enumerate/g' \ | |
18fae2a8 RP |
294 | $(srcdir)/gdb.texinfo | \ |
295 | $(TEXI2ROFF) -mm | \ | |
92b73793 | 296 | sed -e 's/---/\\(em/g' \ |
18fae2a8 | 297 | >gdb.mm |
1eb988b9 RP |
298 | |
299 | # GDB INTERNALS MANUAL: TeX dvi file | |
300 | gdbint.dvi : gdbint.texinfo | |
18fae2a8 RP |
301 | $(SET_TEXINPUTS) $(TEX) gdbint.texinfo |
302 | $(TEXINDEX) gdbint.?? | |
303 | $(SET_TEXINPUTS) $(TEX) gdbint.texinfo | |
1eb988b9 RP |
304 | rm -f gdbint.?? gdbint.aux gdbint.cps gdbint.fns gdbint.kys \ |
305 | gdbint.log gdbint.pgs gdbint.toc gdbint.tps gdbint.vrs | |
306 | ||
307 | # GDB INTERNALS MANUAL: info file | |
dc341d8b | 308 | gdb-internals: gdbint.info |
1eb988b9 | 309 | |
dc341d8b RP |
310 | gdbint.info: gdbint.texinfo |
311 | $(MAKEINFO) -o gdbint.info $(srcdir)/gdbint.texinfo | |
1eb988b9 | 312 | |
e505224d PB |
313 | stabs.info: stabs.texinfo |
314 | $(MAKEINFO) -o stabs.info $(srcdir)/stabs.texinfo | |
315 | ||
612dbd4c JG |
316 | # STABS DOCUMENTATION: TeX dvi file |
317 | stabs.dvi : stabs.texinfo | |
18fae2a8 RP |
318 | $(SET_TEXINPUTS) $(TEX) stabs.texinfo |
319 | $(TEXINDEX) stabs.?? | |
320 | $(SET_TEXINPUTS) $(TEX) stabs.texinfo | |
612dbd4c JG |
321 | rm -f stabs.?? stabs.aux stabs.cps stabs.fns stabs.kys \ |
322 | stabs.log stabs.pgs stabs.toc stabs.tps stabs.vrs | |
323 | ||
324 | stabs.ps: stabs.dvi | |
325 | dvips -o stabs.ps stabs | |
326 | ||
dc341d8b | 327 | force: |
1eb988b9 | 328 | |
dc341d8b RP |
329 | Makefile: $(srcdir)/Makefile.in $(host_makefile_frag) $(target_makefile_frag) |
330 | $(SHELL) ./config.status |