[thirdparty/binutils-gdb.git] / gdb / doc / Makefile.in

##Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003,
##2007 Free Software Foundation, Inc.

# Makefile for GDB documentation.
# This file is part of GDB.

# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
# 
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

srcdir = @srcdir@
VPATH = @srcdir@

prefix = @prefix@

infodir = @infodir@
htmldir = $(prefix)/html

SHELL = @SHELL@

LN_S = @LN_S@

INSTALL = @INSTALL@
INSTALL_PROGRAM = @INSTALL_PROGRAM@
INSTALL_DATA = @INSTALL_DATA@

# main GDB source directory
gdbdir = $(srcdir)/..

# where to find texinfo; GDB dist should include a recent one
TEXIDIR=${gdbdir}/../texinfo

# where to find makeinfo, preferably one designed for texinfo-2
MAKEINFO=makeinfo

# Note that texinfo 4.0's makeinfo --html can only generate a
# single file, which would be too large, so continue to use
# texi2html. -sts 2000-03-28

MAKEHTML = texi2html
MAKEHTMLFLAGS = -menu -split_chapter

# where to find texi2roff, ditto
TEXI2ROFF=texi2roff

# where to find texi2dvi, ditto
TEXI2DVI=texi2dvi

# Where is the source dir for the READLINE library doc?  
# Traditionally readline is in .. or .
READLINE_DIR = ${gdbdir}/../readline/doc

# The GDB/MI docs come from a sibling directory ../mi
GDBMI_DIR = ${gdbdir}/mi

SET_TEXINPUTS = \
   TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS

# Files which should be generated via 'info' and installed by 'install-info'
INFO_DEPS = gdb.info gdbint.info stabs.info annotate.info

# There may be alternate predefined collections of switches to configure
# the GDB manual.  Normally this is not done in synch with the software
# config system, since this choice tends to be independent; most people
# want a doc config of `all' for a generic manual, regardless of sw config.
DOC_CONFIG = all

# This list of sed edits will edit the GDB reference card
# for what fonts and what papersize to use.
# By default (NO edits applied), the refcard uses:
#    - Computer Modern (CM) fonts
#    - US letter paper (8.5x11in)
# List some of the following files for alternative fonts and paper:
#  a4rc.sed     use A4 paper (297 x 210 mm)
#  psrc.sed     use PostScript fonts (Karl Berry short TeX names)
# lpsrc.sed     use PostScript fonts (full PostScript names in TeX)
# e.g. for A4, Postscript:  REFEDITS = a4rc.sed psrc.sed
#      for A4, CM fonts:    REFEDITS = a4rc.sed
#      for US, PS fonts:    REFEDITS = psrc.sed
#      for default:
REFEDITS =

# Don Knuth's TeX formatter
TEX = tex

# Program to generate Postscript files from DVI files.
DVIPS = dvips

# Main GDB manual
GDB_DOC_SOURCE_INCLUDES = \
	$(srcdir)/fdl.texi \
	$(srcdir)/gpl.texi \
	$(srcdir)/agentexpr.texi \
	$(READLINE_DIR)/rluser.texi \
	$(READLINE_DIR)/inc-hist.texinfo
GDB_DOC_BUILD_INCLUDES = \
	gdb-cfg.texi \
	GDBvn.texi
GDB_DOC_FILES = \
	$(srcdir)/gdb.texinfo \
	$(GDB_DOC_SOURCE_INCLUDES) \
	$(GDB_DOC_BUILD_INCLUDES)

# Internals Manual
GDBINT_DOC_SOURCE_INCLUDES = \
	$(srcdir)/fdl.texi \
	$(srcdir)/observer.texi
GDBINT_DOC_BUILD_INCLUDES = \
	gdb-cfg.texi \
	GDBvn.texi
GDBINT_DOC_FILES = \
	$(srcdir)/gdbint.texinfo \
	$(GDBINT_DOC_SOURCE_INCLUDES) \
	$(GDBINT_DOC_BUILD_INCLUDES)

# Stabs manual: All files
STABS_DOC_SOURCE_INCLUDES = \
	$(srcdir)/fdl.texi
STABS_DOC_BUILD_INCLUDES =
STABS_DOC_FILES = \
	$(srcdir)/stabs.texinfo \
	$(STABS_DOC_SOURCE_INCLUDES) \
	$(STABS_DOC_BUILD_INCLUDES)

# Annotate migration document
ANNOTATE_DOC_SOURCE_INCLUDES = \
	$(srcdir)/fdl.texi
ANNOTATE_DOC_BUILD_INCLUDES = \
	gdb-cfg.texi
ANNOTATE_DOC_FILES = \
	$(srcdir)/annotate.texinfo \
	$(ANNOTATE_DOC_SOURCE_INCLUDES) \
	$(ANNOTATE_DOC_BUILD_INCLUDES)

#### Host, target, and site specific Makefile fragments come in here.
###

all:

info: $(INFO_DEPS)
dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi annotate.dvi
ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
html: gdb_toc.html gdbint_toc.html stabs_toc.html annotate_toc.html
pdf: gdb.pdf gdbint.pdf stabs.pdf annotate.pdf
all-doc: info dvi ps # pdf
diststuff: info

install-info: $(INFO_DEPS)
	$(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(infodir)
	@list='$(INFO_DEPS)'; \
	for file in $$list; do \
	  if test -f $$file; then d=.; else d=$(srcdir); fi; \
	  for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
	    if test -f $$d/$$ifile; then \
	      echo " $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
	      $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile; \
	    else : ; fi; \
	  done; \
	done
	$(POST_INSTALL)
	@if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
	  list='$(INFO_DEPS)'; \
	  for file in $$list; do \
	    echo " install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
	    install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file || :;\
	  done; \
	else : ; fi

uninstall-info:
	$(PRE_UNINSTALL)
	@if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
	  ii=yes; \
	else ii=; fi; \
	list='$(INFO_DEPS)'; \
	for file in $$list; do \
	  test -z "$$ii" \
	    || install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \
	done
	$(NORMAL_UNINSTALL)
	list='$(INFO_DEPS)'; \
	for file in $$list; do \
	  (cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \
	done

install-html: html
	for i in *.html ; do \
		$(INSTALL_DATA) $$i $(DESTDIR)$(htmldir)/$$i ; \
	done

STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf

# Copy the object files from a particular stage into a subdirectory.
stage1: force
	-mkdir stage1
	-mv $(STAGESTUFF) stage1

stage2: force
	-mkdir stage2
	-mv $(STAGESTUFF) stage2

stage3: force
	-mkdir stage3
	-mv $(STAGESTUFF) stage3

against=stage2

comparison: force
	for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done

de-stage1: force
	-(cd stage1 ; mv -f * ..)
	-rmdir stage1

de-stage2: force
	-(cd stage2 ; mv -f * ..)
	-rmdir stage2

de-stage3: force
	-(cd stage3 ; mv -f * ..)
	-rmdir stage3

# GDB QUICK REFERENCE (dvi output)
refcard.dvi : refcard.tex $(REFEDITS)
	echo > tmp.sed
	for f in x $(REFEDITS) ; do \
		test x$$f = xx && continue ; \
		cat $(srcdir)/$$f >>tmp.sed ; \
	done
	sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
	$(SET_TEXINPUTS) $(TEX) sedref.tex
	mv sedref.dvi refcard.dvi
	rm -f sedref.log sedref.tex tmp.sed

refcard.ps : refcard.dvi
	$(DVIPS) -t landscape -o $@ $?

# File to record current GDB version number (copied from main dir version.in)
GDBvn.texi : ${gdbdir}/version.in
	echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new
	mv GDBvn.new GDBvn.texi

# Updated atomically
.PRECIOUS: GDBvn.texi

# Choose configuration for GDB manual (normally `all'; normally not tied into
# `configure' script because most users prefer generic version of manual,
# not one for their binary config---which may not be specifically
# defined anyways).
gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
	(test "$(LN_S)" = "ln -s" && \
	  ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
	ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
	cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi

# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
# If your texinfo or makeinfo don't support these, get a new texinfo release
#
# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
#   Note that we can *generate* GDBvn.texi, but since we distribute one in the
#   source directory for the benefit of people who *don't* use this makefile,
#   VPATH will often tell make not to bother building it, because the one
#   in the srcdir is up to date.  (if not, then make should build one here).

# Clean these up before each run.  Avoids a catch 22 with not being
# able to re-generate these files (to fix a corruption) because these
# files contain a corruption.
GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
	gdb.tp* gdb.vr*

# GDB MANUAL: TeX dvi file
gdb.dvi: ${GDB_DOC_FILES}
	if [ ! -f ./GDBvn.texi ]; then \
		(test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
		ln $(srcdir)/GDBvn.texi . || \
		cp $(srcdir)/GDBvn.texi . ; else true; fi
	rm -f $(GDB_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo

gdb.ps: gdb.dvi
	$(DVIPS) -o $@ $?

gdb.pdf: ${GDB_DOC_FILES}
	if [ ! -f ./GDBvn.texi ]; then \
		(test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) || \
		ln $(srcdir)/GDBvn.texi . || \
		cp $(srcdir)/GDBvn.texi . ; else true; fi
	rm -f $(GDB_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo

# GDB MANUAL: info file
gdb.info: ${GDB_DOC_FILES}
	$(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
		-o gdb.info $(srcdir)/gdb.texinfo

# GDB MANUAL: roff translations
# Try to use a recent texi2roff.  v2 was put on prep in jan91.
# If you want an index, see texi2roff doc for postprocessing 
# and add -i to texi2roff invocations below.
# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
#    corresponding -e lines when later texi2roff's are current)
# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
# + @c's deleted explicitly because texi2roff sees texinfo commands in them
# + @   (that's at-BLANK) not recognized by texi2roff, turned into blank
# + @alphaenumerate is ridiculously new, turned into @enumerate

# texi2roff doesn't have a notion of include dirs, so we have to fake 
# it out for gdb manual's include files---but only if not configured
# in main sourcedir.
links2roff: $(GDB_DOC_SOURCE_INCLUDES)
	if [ ! -f gdb.texinfo ]; then \
		(test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
		ln $(GDB_DOC_SOURCE_INCLUDES)    . || \
		cp $(GDB_DOC_SOURCE_INCLUDES)    . ; \
	fi
	touch links2roff

# gdb manual suitable for [gtn]roff -me
gdb.me: $(GDB_DOC_FILES) links2roff
	sed -e '/\\input texinfo/d' \
		-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
		-e '/^@ifinfo/,/^@end ifinfo/d' \
		-e '/^@c /d' \
		-e 's/{.*,,/{/' \
		-e 's/@ / /g' \
		-e 's/^@alphaenumerate/@enumerate/g' \
		-e 's/^@end alphaenumerate/@end enumerate/g' \
		$(srcdir)/gdb.texinfo | \
	$(TEXI2ROFF) -me | \
	sed -e 's/---/\\(em/g' \
	>gdb.me 

# gdb manual suitable for [gtn]roff -ms
gdb.ms: $(GDB_DOC_FILES) links2roff
	sed -e '/\\input texinfo/d' \
		-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
		-e '/^@ifinfo/,/^@end ifinfo/d' \
		-e '/^@c /d' \
		-e 's/{.*,,/{/' \
		-e 's/@ / /g' \
		-e 's/^@alphaenumerate/@enumerate/g' \
		-e 's/^@end alphaenumerate/@end enumerate/g' \
		$(srcdir)/gdb.texinfo | \
	$(TEXI2ROFF) -ms | \
	sed -e 's/---/\\(em/g' \
	>gdb.ms 

# gdb manual suitable for [tn]roff -mm
# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer, 
#   try leaving them in
gdb.mm: $(GDB_DOC_FILES) links2roff
	sed -e '/\\input texinfo/d' \
		-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
		-e '/^@ifinfo/,/^@end ifinfo/d' \
		-e '/^@c /d' \
		-e 's/{.*,,/{/' \
		-e '/@noindent/d' \
		-e 's/@ / /g' \
		-e 's/^@alphaenumerate/@enumerate/g' \
		-e 's/^@end alphaenumerate/@end enumerate/g' \
		$(srcdir)/gdb.texinfo | \
	$(TEXI2ROFF) -mm | \
	sed -e 's/---/\\(em/g' \
	>gdb.mm 

# GDB MANUAL: HTML file

gdb_toc.html: ${GDB_DOC_FILES}
	$(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo

# Clean these up before each run.  Avoids a catch 22 with not being
# able to re-generate these files (to fix a corruption) because these
# files contain a corruption.
GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
	gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*

# GDB INTERNALS MANUAL: TeX dvi file
gdbint.dvi: $(GDBINT_DOC_FILES)
	rm -f $(GDBINT_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo

gdbint.ps : gdbint.dvi
	$(DVIPS) -o $@ $?

gdbint.pdf: $(GDBINT_DOC_FILES)
	rm -f $(GDBINT_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo

# GDB INTERNALS MANUAL: info file

gdbint.info: $(GDBINT_DOC_FILES)
	$(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo

# GDB INTERNALS MANUAL: HTML file

gdbint_toc.html: $(GDBINT_DOC_FILES)
	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo

stabs.info: $(STABS_DOC_FILES)
	$(MAKEINFO) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo

# STABS DOCUMENTATION: HTML file

stabs_toc.html: $(STABS_DOC_FILES)
	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo

# Clean these up before each run.  Avoids a catch 22 with not being
# able to re-generate these files (to fix a corruption) because these
# files contain a corruption.
STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
	stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*

# STABS DOCUMENTATION: TeX dvi file
stabs.dvi : $(STABS_DOC_FILES)
	rm -f $(STABS_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo

stabs.ps: stabs.dvi
	$(DVIPS) -o $@ $?

stabs.pdf: $(STABS_DOC_FILES)
	rm -f $(STABS_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo

# Clean these up before each run.  Avoids a catch 22 with not being
# able to re-generate these files (to fix a corruption) because these
# files contain a corruption.
ANNOTATE_TEX_TMPS = annotate.aux annotate.cp* annotate.fn* annotate.ky* \
	annotate.log annotate.pg* annotate.toc annotate.tp* annotate.vr*

# ANNOTATE DOCUMENTATION: TeX dvi file
annotate.dvi : $(ANNOTATE_DOC_FILES)
	rm -f $(ANNOTATE_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/annotate.texinfo

annotate.ps: annotate.dvi
	$(DVIPS) -o $@ $?

annotate.pdf: $(ANNOTATE_DOC_FILES)
	rm -f $(ANNOTATE_TEX_TMPS)
	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/annotate.texinfo

annotate.info: $(ANNOTATE_DOC_FILES)
	$(MAKEINFO)  -I $(srcdir) -o annotate.info $(srcdir)/annotate.texinfo

annotate_toc.html: $(ANNOTATE_DOC_FILES)
	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/annotate.texinfo

force:

Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
	$(SHELL) ./config.status


# The "least clean" level of cleaning.  Get rid of files which are
# automatically generated files that are just intermediate files,

mostlyclean:
	rm -f gdb.mm gdb.ms gdb.me links2roff
	rm -f $(GDB_TEX_TMPS)
	rm -f $(GDBINT_TEX_TMPS)
	rm -f $(STABS_TEX_TMPS)
	rm -f $(ANNOTATE_TEX_TMPS)
	rm -f sedref.dvi sedref.tex tmp.sed

clean: mostlyclean
	rm -f gdb-cfg.texi

distclean: clean
	rm -f Makefile config.status config.log

# GDBvn.texi, the dvi files, the info files, and the postscript files, 
# are all part of the distribution, so it should not be removed by
# "clean" or "distclean".  Use maintainer-clean to remove them.

maintainer-clean realclean: distclean
	rm -f GDBvn.texi *.info* *.dvi *.ps *.html *.pdf

install: install-info

uninstall: uninstall-info
Commit	Line	Data
6aba47ca DJ	1	##Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1999, 2000, 2002, 2003,
6aba47ca DJ	2	##2007 Free Software Foundation, Inc.
c906108c SS	3
	4	# Makefile for GDB documentation.
	5	# This file is part of GDB.
	6
	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 2 of the License, or
	10	# (at your option) any later version.
	11	#
	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.
	16	#
	17	# You should have received a copy of the GNU General Public License
	18	# along with this program; if not, write to the Free Software
c02a867d	19	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
c906108c SS	20
	21	srcdir = @srcdir@
	22	VPATH = @srcdir@
	23
	24	prefix = @prefix@
	25
	26	infodir = @infodir@
085dd6e6	27	htmldir = $(prefix)/html
c906108c SS	28
	29	SHELL = @SHELL@
	30
39ec5655 EZ	31	LN_S = @LN_S@
39ec5655 EZ	32
c906108c SS	33	INSTALL = @INSTALL@
	34	INSTALL_PROGRAM = @INSTALL_PROGRAM@
	35	INSTALL_DATA = @INSTALL_DATA@
	36
	37	# main GDB source directory
	38	gdbdir = $(srcdir)/..
	39
	40	# where to find texinfo; GDB dist should include a recent one
	41	TEXIDIR=${gdbdir}/../texinfo
	42
	43	# where to find makeinfo, preferably one designed for texinfo-2
	44	MAKEINFO=makeinfo
	45
6d2ebf8b SS	46	# Note that texinfo 4.0's makeinfo --html can only generate a
	47	# single file, which would be too large, so continue to use
	48	# texi2html. -sts 2000-03-28
	49
085dd6e6	50	MAKEHTML = texi2html
f4846649	51	MAKEHTMLFLAGS = -menu -split_chapter
085dd6e6	52
c906108c SS	53	# where to find texi2roff, ditto
	54	TEXI2ROFF=texi2roff
	55
be298bcc AC	56	# where to find texi2dvi, ditto
	57	TEXI2DVI=texi2dvi
	58
c906108c SS	59	# Where is the source dir for the READLINE library doc?
	60	# Traditionally readline is in .. or .
	61	READLINE_DIR = ${gdbdir}/../readline/doc
	62
7162c0ca EZ	63	# The GDB/MI docs come from a sibling directory ../mi
	64	GDBMI_DIR = ${gdbdir}/mi
	65
	66	SET_TEXINPUTS = \
	67	TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS
c906108c	68
63ac3005	69	# Files which should be generated via 'info' and installed by 'install-info'
e6f672d2	70	INFO_DEPS = gdb.info gdbint.info stabs.info annotate.info
63ac3005	71
c906108c SS	72	# There may be alternate predefined collections of switches to configure
	73	# the GDB manual. Normally this is not done in synch with the software
	74	# config system, since this choice tends to be independent; most people
	75	# want a doc config of `all' for a generic manual, regardless of sw config.
	76	DOC_CONFIG = all
	77
	78	# This list of sed edits will edit the GDB reference card
	79	# for what fonts and what papersize to use.
	80	# By default (NO edits applied), the refcard uses:
	81	# - Computer Modern (CM) fonts
	82	# - US letter paper (8.5x11in)
	83	# List some of the following files for alternative fonts and paper:
	84	# a4rc.sed use A4 paper (297 x 210 mm)
	85	# psrc.sed use PostScript fonts (Karl Berry short TeX names)
	86	# lpsrc.sed use PostScript fonts (full PostScript names in TeX)
	87	# e.g. for A4, Postscript: REFEDITS = a4rc.sed psrc.sed
	88	# for A4, CM fonts: REFEDITS = a4rc.sed
	89	# for US, PS fonts: REFEDITS = psrc.sed
	90	# for default:
	91	REFEDITS =
	92
	93	# Don Knuth's TeX formatter
	94	TEX = tex
	95
c906108c SS	96	# Program to generate Postscript files from DVI files.
	97	DVIPS = dvips
	98
b0787093 AC	99	# Main GDB manual
b0787093 AC	100	GDB_DOC_SOURCE_INCLUDES = \
aab4e0ec	101	$(srcdir)/fdl.texi \
b0787093	102	$(srcdir)/gpl.texi \
f418dd93	103	$(srcdir)/agentexpr.texi \
5bdf8622	104	$(READLINE_DIR)/rluser.texi \
b0787093 AC	105	$(READLINE_DIR)/inc-hist.texinfo
	106	GDB_DOC_BUILD_INCLUDES = \
	107	gdb-cfg.texi \
	108	GDBvn.texi
	109	GDB_DOC_FILES = \
	110	$(srcdir)/gdb.texinfo \
	111	$(GDB_DOC_SOURCE_INCLUDES) \
	112	$(GDB_DOC_BUILD_INCLUDES)
	113
	114	# Internals Manual
	115	GDBINT_DOC_SOURCE_INCLUDES = \
bcd7e15f JB	116	$(srcdir)/fdl.texi \
bcd7e15f JB	117	$(srcdir)/observer.texi
b0787093 AC	118	GDBINT_DOC_BUILD_INCLUDES = \
	119	gdb-cfg.texi \
	120	GDBvn.texi
	121	GDBINT_DOC_FILES = \
	122	$(srcdir)/gdbint.texinfo \
	123	$(GDBINT_DOC_SOURCE_INCLUDES) \
	124	$(GDBINT_DOC_BUILD_INCLUDES)
	125
	126	# Stabs manual: All files
e5249f67 AC	127	STABS_DOC_SOURCE_INCLUDES = \
e5249f67 AC	128	$(srcdir)/fdl.texi
b0787093 AC	129	STABS_DOC_BUILD_INCLUDES =
	130	STABS_DOC_FILES = \
	131	$(srcdir)/stabs.texinfo \
	132	$(STABS_DOC_SOURCE_INCLUDES) \
	133	$(STABS_DOC_BUILD_INCLUDES)
c906108c	134
e6f672d2 AC	135	# Annotate migration document
	136	ANNOTATE_DOC_SOURCE_INCLUDES = \
	137	$(srcdir)/fdl.texi
	138	ANNOTATE_DOC_BUILD_INCLUDES = \
	139	gdb-cfg.texi
	140	ANNOTATE_DOC_FILES = \
	141	$(srcdir)/annotate.texinfo \
	142	$(ANNOTATE_DOC_SOURCE_INCLUDES) \
	143	$(ANNOTATE_DOC_BUILD_INCLUDES)
	144
c906108c SS	145	#### Host, target, and site specific Makefile fragments come in here.
	146	###
	147
35db0260	148	all:
c906108c	149
63ac3005	150	info: $(INFO_DEPS)
e6f672d2 AC	151	dvi: gdb.dvi gdbint.dvi stabs.dvi refcard.dvi annotate.dvi
e6f672d2 AC	152	ps: gdb.ps gdbint.ps stabs.ps refcard.ps annotate.ps
e5249f67	153	html: gdb_toc.html gdbint_toc.html stabs_toc.html annotate_toc.html
e6f672d2	154	pdf: gdb.pdf gdbint.pdf stabs.pdf annotate.pdf
449f3b6c	155	all-doc: info dvi ps # pdf
3555de01	156	diststuff: info
c906108c	157
63ac3005	158	install-info: $(INFO_DEPS)
c938e9b0	159	$(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(infodir)
63ac3005 EZ	160	@list='$(INFO_DEPS)'; \
	161	for file in $$list; do \
	162	if test -f $$file; then d=.; else d=$(srcdir); fi; \
	163	for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
	164	if test -f $$d/$$ifile; then \
c938e9b0 L	165	echo " $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
c938e9b0 L	166	$(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile; \
63ac3005 EZ	167	else : ; fi; \
	168	done; \
	169	done
c166cdc7	170	$(POST_INSTALL)
d3229ae3	171	@if $(SHELL) -c 'install-info --version \| sed 1q \| fgrep -s -v -i debian' >/dev/null 2>&1; then \
63ac3005	172	list='$(INFO_DEPS)'; \
d3229ae3	173	for file in $$list; do \
5843504f EZ	174	echo " install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
5843504f EZ	175	install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file \|\| :;\
d3229ae3 EZ	176	done; \
d3229ae3 EZ	177	else : ; fi
c906108c	178
c166cdc7 EZ	179	uninstall-info:
	180	$(PRE_UNINSTALL)
	181	@if $(SHELL) -c 'install-info --version \| sed 1q \| fgrep -s -v -i debian' >/dev/null 2>&1; then \
	182	ii=yes; \
	183	else ii=; fi; \
	184	list='$(INFO_DEPS)'; \
	185	for file in $$list; do \
	186	test -z "$$ii" \
	187	\|\| install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \
	188	done
	189	$(NORMAL_UNINSTALL)
	190	list='$(INFO_DEPS)'; \
	191	for file in $$list; do \
	192	(cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \
	193	done
	194
085dd6e6 JM	195	install-html: html
085dd6e6 JM	196	for i in *.html ; do \
c938e9b0	197	$(INSTALL_DATA) $$i $(DESTDIR)$(htmldir)/$$i ; \
085dd6e6 JM	198	done
085dd6e6 JM	199
449f3b6c	200	STAGESTUFF = .info gdb-all.texi GDBvn.texi .ps .dvi *.pdf
c906108c SS	201
	202	# Copy the object files from a particular stage into a subdirectory.
	203	stage1: force
	204	-mkdir stage1
	205	-mv $(STAGESTUFF) stage1
	206
	207	stage2: force
	208	-mkdir stage2
	209	-mv $(STAGESTUFF) stage2
	210
	211	stage3: force
	212	-mkdir stage3
	213	-mv $(STAGESTUFF) stage3
	214
	215	against=stage2
	216
	217	comparison: force
	218	for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
	219
	220	de-stage1: force
	221	-(cd stage1 ; mv -f * ..)
	222	-rmdir stage1
	223
	224	de-stage2: force
	225	-(cd stage2 ; mv -f * ..)
	226	-rmdir stage2
	227
	228	de-stage3: force
	229	-(cd stage3 ; mv -f * ..)
	230	-rmdir stage3
	231
c906108c SS	232	# GDB QUICK REFERENCE (dvi output)
c906108c SS	233	refcard.dvi : refcard.tex $(REFEDITS)
dfa249fb AC	234	echo > tmp.sed
	235	for f in x $(REFEDITS) ; do \
	236	test x$$f = xx && continue ; \
	237	cat $(srcdir)/$$f >>tmp.sed ; \
	238	done
	239	sed -f tmp.sed $(srcdir)/refcard.tex >sedref.tex
c906108c SS	240	$(SET_TEXINPUTS) $(TEX) sedref.tex
	241	mv sedref.dvi refcard.dvi
	242	rm -f sedref.log sedref.tex tmp.sed
	243
	244	refcard.ps : refcard.dvi
	245	$(DVIPS) -t landscape -o $@ $?
	246
05a54c4f AC	247	# File to record current GDB version number (copied from main dir version.in)
05a54c4f AC	248	GDBvn.texi : ${gdbdir}/version.in
9ba8d803	249	echo "@set GDBVN `sed q $(srcdir)/../version.in`" > ./GDBvn.new
c906108c SS	250	mv GDBvn.new GDBvn.texi
	251
	252	# Updated atomically
	253	.PRECIOUS: GDBvn.texi
	254
	255	# Choose configuration for GDB manual (normally `all'; normally not tied into
	256	# `configure' script because most users prefer generic version of manual,
	257	# not one for their binary config---which may not be specifically
	258	# defined anyways).
	259	gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
44e2be90	260	(test "$(LN_S)" = "ln -s" && \
39ec5655	261	ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) \|\| \
c906108c SS	262	ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi \|\| \
	263	cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
	264
	265	# GDB MANUAL: texinfo source, using @set/@clear/@value/@ifset/@ifclear
	266	# If your texinfo or makeinfo don't support these, get a new texinfo release
	267	#
	268	# The nonsense with GDBvn.texi gets this to run with both Sun and GNU make.
	269	# Note that we can generate GDBvn.texi, but since we distribute one in the
	270	# source directory for the benefit of people who don't use this makefile,
	271	# VPATH will often tell make not to bother building it, because the one
	272	# in the srcdir is up to date. (if not, then make should build one here).
	273
46d8b1c3 AC	274	# Clean these up before each run. Avoids a catch 22 with not being
	275	# able to re-generate these files (to fix a corruption) because these
	276	# files contain a corruption.
b0787093 AC	277	GDB_TEX_TMPS = gdb.aux gdb.cp* gdb.fn* gdb.ky* gdb.log gdb.pg* gdb.toc \
	278	gdb.tp* gdb.vr*
	279
c906108c	280	# GDB MANUAL: TeX dvi file
b0787093	281	gdb.dvi: ${GDB_DOC_FILES}
c906108c	282	if [ ! -f ./GDBvn.texi ]; then \
44e2be90	283	(test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) \|\| \
c906108c SS	284	ln $(srcdir)/GDBvn.texi . \|\| \
c906108c SS	285	cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093	286	rm -f $(GDB_TEX_TMPS)
be298bcc	287	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdb.texinfo
c906108c SS	288
	289	gdb.ps: gdb.dvi
	290	$(DVIPS) -o $@ $?
	291
b0787093	292	gdb.pdf: ${GDB_DOC_FILES}
449f3b6c	293	if [ ! -f ./GDBvn.texi ]; then \
44e2be90	294	(test "$(LN_S)" = "ln -s" && ln -s $(srcdir)/GDBvn.texi .) \|\| \
449f3b6c AC	295	ln $(srcdir)/GDBvn.texi . \|\| \
449f3b6c AC	296	cp $(srcdir)/GDBvn.texi . ; else true; fi
b0787093	297	rm -f $(GDB_TEX_TMPS)
be298bcc	298	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdb.texinfo
449f3b6c	299
c906108c	300	# GDB MANUAL: info file
b0787093	301	gdb.info: ${GDB_DOC_FILES}
a7b40f07 AC	302	$(MAKEINFO) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) \
a7b40f07 AC	303	-o gdb.info $(srcdir)/gdb.texinfo
c906108c SS	304
	305	# GDB MANUAL: roff translations
	306	# Try to use a recent texi2roff. v2 was put on prep in jan91.
	307	# If you want an index, see texi2roff doc for postprocessing
	308	# and add -i to texi2roff invocations below.
	309	# Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
	310	# corresponding -e lines when later texi2roff's are current)
	311	# + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
	312	# + @c's deleted explicitly because texi2roff sees texinfo commands in them
	313	# + @ (that's at-BLANK) not recognized by texi2roff, turned into blank
	314	# + @alphaenumerate is ridiculously new, turned into @enumerate
	315
	316	# texi2roff doesn't have a notion of include dirs, so we have to fake
	317	# it out for gdb manual's include files---but only if not configured
	318	# in main sourcedir.
b0787093	319	links2roff: $(GDB_DOC_SOURCE_INCLUDES)
c906108c	320	if [ ! -f gdb.texinfo ]; then \
44e2be90	321	(test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) \|\| \
b0787093 AC	322	ln $(GDB_DOC_SOURCE_INCLUDES) . \|\| \
b0787093 AC	323	cp $(GDB_DOC_SOURCE_INCLUDES) . ; \
c906108c SS	324	fi
	325	touch links2roff
	326
c906108c	327	# gdb manual suitable for [gtn]roff -me
b0787093	328	gdb.me: $(GDB_DOC_FILES) links2roff
c906108c SS	329	sed -e '/\\input texinfo/d' \
	330	-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
	331	-e '/^@ifinfo/,/^@end ifinfo/d' \
	332	-e '/^@c /d' \
	333	-e 's/{.*,,/{/' \
	334	-e 's/@ / /g' \
	335	-e 's/^@alphaenumerate/@enumerate/g' \
	336	-e 's/^@end alphaenumerate/@end enumerate/g' \
	337	$(srcdir)/gdb.texinfo \| \
	338	$(TEXI2ROFF) -me \| \
	339	sed -e 's/---/\\(em/g' \
	340	>gdb.me
	341
	342	# gdb manual suitable for [gtn]roff -ms
b0787093	343	gdb.ms: $(GDB_DOC_FILES) links2roff
c906108c SS	344	sed -e '/\\input texinfo/d' \
	345	-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
	346	-e '/^@ifinfo/,/^@end ifinfo/d' \
	347	-e '/^@c /d' \
	348	-e 's/{.*,,/{/' \
	349	-e 's/@ / /g' \
	350	-e 's/^@alphaenumerate/@enumerate/g' \
	351	-e 's/^@end alphaenumerate/@end enumerate/g' \
	352	$(srcdir)/gdb.texinfo \| \
	353	$(TEXI2ROFF) -ms \| \
	354	sed -e 's/---/\\(em/g' \
	355	>gdb.ms
	356
	357	# gdb manual suitable for [tn]roff -mm
	358	# '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
	359	# try leaving them in
b0787093	360	gdb.mm: $(GDB_DOC_FILES) links2roff
c906108c SS	361	sed -e '/\\input texinfo/d' \
	362	-e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
	363	-e '/^@ifinfo/,/^@end ifinfo/d' \
	364	-e '/^@c /d' \
	365	-e 's/{.*,,/{/' \
	366	-e '/@noindent/d' \
	367	-e 's/@ / /g' \
	368	-e 's/^@alphaenumerate/@enumerate/g' \
	369	-e 's/^@end alphaenumerate/@end enumerate/g' \
	370	$(srcdir)/gdb.texinfo \| \
	371	$(TEXI2ROFF) -mm \| \
	372	sed -e 's/---/\\(em/g' \
	373	>gdb.mm
	374
085dd6e6 JM	375	# GDB MANUAL: HTML file
085dd6e6 JM	376
b0787093	377	gdb_toc.html: ${GDB_DOC_FILES}
7162c0ca	378	$(MAKEHTML) $(MAKEHTMLFLAGS) -I ${READLINE_DIR} -I ${GDBMI_DIR} -I $(srcdir) $(srcdir)/gdb.texinfo
085dd6e6	379
46d8b1c3 AC	380	# Clean these up before each run. Avoids a catch 22 with not being
	381	# able to re-generate these files (to fix a corruption) because these
	382	# files contain a corruption.
b0787093 AC	383	GDBINT_TEX_TMPS = gdbint.aux gdbint.cp* gdbint.fn* gdbint.ky* \
	384	gdbint.log gdbint.pg* gdbint.toc gdbint.tp* gdbint.vr*
	385
c906108c	386	# GDB INTERNALS MANUAL: TeX dvi file
b0787093 AC	387	gdbint.dvi: $(GDBINT_DOC_FILES)
b0787093 AC	388	rm -f $(GDBINT_TEX_TMPS)
be298bcc	389	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/gdbint.texinfo
c906108c SS	390
	391	gdbint.ps : gdbint.dvi
	392	$(DVIPS) -o $@ $?
	393
b0787093 AC	394	gdbint.pdf: $(GDBINT_DOC_FILES)
b0787093 AC	395	rm -f $(GDBINT_TEX_TMPS)
be298bcc	396	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/gdbint.texinfo
449f3b6c	397
c906108c SS	398	# GDB INTERNALS MANUAL: info file
c906108c SS	399
b0787093	400	gdbint.info: $(GDBINT_DOC_FILES)
aab4e0ec	401	$(MAKEINFO) -I $(srcdir) -o gdbint.info $(srcdir)/gdbint.texinfo
c906108c	402
085dd6e6 JM	403	# GDB INTERNALS MANUAL: HTML file
085dd6e6 JM	404
b0787093	405	gdbint_toc.html: $(GDBINT_DOC_FILES)
085dd6e6 JM	406	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/gdbint.texinfo
085dd6e6 JM	407
b0787093	408	stabs.info: $(STABS_DOC_FILES)
e5249f67	409	$(MAKEINFO) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo
c906108c	410
085dd6e6 JM	411	# STABS DOCUMENTATION: HTML file
085dd6e6 JM	412
b0787093	413	stabs_toc.html: $(STABS_DOC_FILES)
085dd6e6 JM	414	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/stabs.texinfo
085dd6e6 JM	415
46d8b1c3 AC	416	# Clean these up before each run. Avoids a catch 22 with not being
	417	# able to re-generate these files (to fix a corruption) because these
	418	# files contain a corruption.
b0787093 AC	419	STABS_TEX_TMPS = stabs.aux stabs.cp* stabs.fn* stabs.ky* \
	420	stabs.log stabs.pg* stabs.toc stabs.tp* stabs.vr*
	421
c906108c	422	# STABS DOCUMENTATION: TeX dvi file
b0787093 AC	423	stabs.dvi : $(STABS_DOC_FILES)
b0787093 AC	424	rm -f $(STABS_TEX_TMPS)
be298bcc	425	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/stabs.texinfo
c906108c SS	426
	427	stabs.ps: stabs.dvi
	428	$(DVIPS) -o $@ $?
	429
b0787093 AC	430	stabs.pdf: $(STABS_DOC_FILES)
b0787093 AC	431	rm -f $(STABS_TEX_TMPS)
be298bcc	432	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/stabs.texinfo
449f3b6c	433
e6f672d2 AC	434	# Clean these up before each run. Avoids a catch 22 with not being
	435	# able to re-generate these files (to fix a corruption) because these
	436	# files contain a corruption.
	437	ANNOTATE_TEX_TMPS = annotate.aux annotate.cp* annotate.fn* annotate.ky* \
	438	annotate.log annotate.pg* annotate.toc annotate.tp* annotate.vr*
	439
	440	# ANNOTATE DOCUMENTATION: TeX dvi file
	441	annotate.dvi : $(ANNOTATE_DOC_FILES)
	442	rm -f $(ANNOTATE_TEX_TMPS)
	443	$(SET_TEXINPUTS) $(TEXI2DVI) $(srcdir)/annotate.texinfo
	444
	445	annotate.ps: annotate.dvi
	446	$(DVIPS) -o $@ $?
	447
	448	annotate.pdf: $(ANNOTATE_DOC_FILES)
	449	rm -f $(ANNOTATE_TEX_TMPS)
	450	$(SET_TEXINPUTS) $(TEXI2DVI) --pdf $(srcdir)/annotate.texinfo
	451
	452	annotate.info: $(ANNOTATE_DOC_FILES)
	453	$(MAKEINFO) -I $(srcdir) -o annotate.info $(srcdir)/annotate.texinfo
	454
	455	annotate_toc.html: $(ANNOTATE_DOC_FILES)
	456	$(MAKEHTML) $(MAKEHTMLFLAGS) $(srcdir)/annotate.texinfo
	457
c906108c SS	458	force:
	459
	460	Makefile: Makefile.in $(host_makefile_frag) $(target_makefile_frag) config.status
	461	$(SHELL) ./config.status
46d8b1c3 AC	462
	463
	464	# The "least clean" level of cleaning. Get rid of files which are
	465	# automatically generated files that are just intermediate files,
	466
	467	mostlyclean:
	468	rm -f gdb.mm gdb.ms gdb.me links2roff
	469	rm -f $(GDB_TEX_TMPS)
	470	rm -f $(GDBINT_TEX_TMPS)
	471	rm -f $(STABS_TEX_TMPS)
e6f672d2	472	rm -f $(ANNOTATE_TEX_TMPS)
46d8b1c3 AC	473	rm -f sedref.dvi sedref.tex tmp.sed
	474
	475	clean: mostlyclean
	476	rm -f gdb-cfg.texi
	477
	478	distclean: clean
d7f4a264	479	rm -f Makefile config.status config.log
46d8b1c3 AC	480
	481	# GDBvn.texi, the dvi files, the info files, and the postscript files,
	482	# are all part of the distribution, so it should not be removed by
	483	# "clean" or "distclean". Use maintainer-clean to remove them.
	484
	485	maintainer-clean realclean: distclean
	486	rm -f GDBvn.texi .info .dvi .ps .html .pdf
	487
35db0260	488	install: install-info
c166cdc7 EZ	489
c166cdc7 EZ	490	uninstall: uninstall-info