gdb/doc/Makefile.in

   1 ##Copyright (C) 1991-2024 Free Software Foundation, Inc.
   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 3 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, see <http://www.gnu.org/licenses/>.
  18
  19 srcdir = @srcdir@
  20 VPATH = @srcdir@
  21
  22 prefix = @prefix@
  23
  24 infodir = @infodir@
  25 datarootdir = @datarootdir@
  26 docdir = @docdir@
  27 dvidir = @dvidir@
  28 pdfdir = @pdfdir@
  29 htmldir = @htmldir@
  30 mandir = @mandir@
  31 man1dir = $(mandir)/man1
  32 man5dir = $(mandir)/man5
  33
  34 transform = @program_transform_name@
  35
  36 include $(srcdir)/../silent-rules.mk
  37
  38 SHELL = @SHELL@
  39
  40 LN_S = @LN_S@
  41
  42 INSTALL = @INSTALL@
  43 INSTALL_PROGRAM = @INSTALL_PROGRAM@
  44 INSTALL_DATA = @INSTALL_DATA@
  45
  46 SYSTEM_GDBINIT = @SYSTEM_GDBINIT@
  47 SYSTEM_GDBINIT_DIR = @SYSTEM_GDBINIT_DIR@
  48
  49 mkinstalldirs = $(SHELL) $(srcdir)/../../mkinstalldirs
  50
  51 # main GDB source directory
  52 gdbdir = $(srcdir)/..
  53
  54 # where to find texinfo; GDB dist should include a recent one
  55 TEXIDIR=${gdbdir}/../texinfo
  56
  57 # where to find makeinfo, preferably one designed for texinfo-2
  58 MAKEINFO = @MAKEINFO@
  59 MAKEINFOFLAGS = @MAKEINFOFLAGS@
  60 MAKEINFO_EXTRA_FLAGS = @MAKEINFO_EXTRA_FLAGS@
  61 MAKEINFO_CMD = $(MAKEINFO) $(MAKEINFOFLAGS) $(MAKEINFO_EXTRA_FLAGS)
  62
  63 MAKEHTML = $(MAKEINFO_CMD) --html
  64 MAKEHTMLFLAGS =
  65
  66 # where to find texi2roff, ditto
  67 TEXI2ROFF=texi2roff
  68
  69 # Where to find texi2dvi.  The use of --build and --build-dir options
  70 # mean that at least texinfo 4.9 is required.
  71 TEXI2DVI=texi2dvi
  72 TEXI2DVI_TMPDIR=texi2dvi_tmpdir
  73 TEXI2DVI_CMD = rm -fr $(TEXI2DVI_TMPDIR)/$(subst .,_,$@) \
  74                 && mkdir -p $(TEXI2DVI_TMPDIR)/$(subst .,_,$@) \
  75                 && $(TEXI2DVI) --build=tidy \
  76                                --build-dir=$(TEXI2DVI_TMPDIR)/$(subst .,_,$@)
  77
  78 # Package to install the docs under
  79 PACKAGE = @PACKAGE@
  80
  81 # Package version and bug-reporting URL.
  82 PKGVERSION = @PKGVERSION@
  83 BUGURL_TEXI = @REPORT_BUGS_TEXI@
  84
  85 # Where is the source dir for the READLINE library doc?
  86 # Traditionally readline is in .. or .
  87 READLINE_DIR = ${gdbdir}/../readline/readline/doc
  88 READLINE_TEXI_INCFLAG = @READLINE_TEXI_INCFLAG@
  89
  90 # The GDB/MI docs come from a sibling directory ../mi
  91 GDBMI_DIR = ${gdbdir}/mi
  92
  93 SET_TEXINPUTS = \
  94    TEXINPUTS=${TEXIDIR}:.:$(srcdir):$(READLINE_DIR):$(GDBMI_DIR):$$TEXINPUTS
  95
  96 # Files which should be generated via 'info' and installed by 'install-info'
  97 INFO_DEPS = gdb.info stabs.info annotate.info
  98
  99 # Files which should be generated via 'dvi' and installed by 'install-dvi'
 100 DVIFILES = gdb.dvi stabs.dvi refcard.dvi annotate.dvi
 101 # Files which should be generated via 'pdf' and installed by 'install-pdf'
 102 PDFFILES = gdb.pdf stabs.pdf refcard.pdf annotate.pdf
 103 # Files which should be generated via 'html' and installed by 'install-html'
 104 HTMLFILES =  gdb/index.html stabs/index.html annotate/index.html
 105 HTMLFILES_INSTALL = gdb stabs annotate
 106
 107 # There may be alternate predefined collections of switches to configure
 108 # the GDB manual.  Normally this is not done in synch with the software
 109 # config system, since this choice tends to be independent; most people
 110 # want a doc config of `all' for a generic manual, regardless of sw config.
 111 DOC_CONFIG = all
 112
 113 # This list of sed edits will edit the GDB reference card
 114 # for what fonts and what papersize to use.
 115 # By default (NO edits applied), the refcard uses:
 116 #    - Computer Modern (CM) fonts
 117 #    - US letter paper (8.5x11in)
 118 # List some of the following files for alternative fonts and paper:
 119 #  a4rc.sed     use A4 paper (297 x 210 mm)
 120 #  psrc.sed     use PostScript fonts (Karl Berry short TeX names)
 121 # lpsrc.sed     use PostScript fonts (full PostScript names in TeX)
 122 # e.g. for A4, Postscript:  REFEDITS = a4rc.sed psrc.sed
 123 #      for A4, CM fonts:    REFEDITS = a4rc.sed
 124 #      for US, PS fonts:    REFEDITS = psrc.sed
 125 #      for default:
 126 REFEDITS =
 127
 128 # Don Knuth's TeX formatter
 129 TEX = tex
 130 PDFTEX = pdftex
 131
 132 # Program to generate Postscript files from DVI files.
 133 DVIPS = dvips
 134
 135 # Readline includes.
 136 READLINE_SYSTEM_DOC_INCLUDES =
 137 READLINE_INTREE_DOC_INCLUDES = $(READLINE_DIR)/rluser.texi $(READLINE_DIR)/hsuser.texi
 138 READLINE_DOC_SOURCE_INCLUDES = @READLINE_DOC_SOURCE_INCLUDES@
 139
 140 # Main GDB manual
 141 # Note that this unconditionally includes the readline texi files,
 142 # even when --with-system-readline is used.  This is harmless because
 143 # these are only used as dependencies.
 144 GDB_DOC_SOURCE_INCLUDES = \
 145         $(srcdir)/fdl.texi \
 146         $(srcdir)/gpl.texi \
 147         $(srcdir)/agentexpr.texi \
 148         $(READLINE_DOC_SOURCE_INCLUDES)
 149 GDB_DOC_BUILD_INCLUDES = \
 150         gdb-cfg.texi \
 151         GDBvn.texi
 152 GDB_DOC_FILES = \
 153         $(srcdir)/gdb.texinfo \
 154         $(srcdir)/guile.texi \
 155         $(srcdir)/python.texi \
 156         $(GDB_DOC_SOURCE_INCLUDES) \
 157         $(GDB_DOC_BUILD_INCLUDES)
 158
 159 # Stabs manual: All files
 160 STABS_DOC_SOURCE_INCLUDES = \
 161         $(srcdir)/fdl.texi
 162 STABS_DOC_BUILD_INCLUDES = \
 163         gdb-cfg.texi \
 164         GDBvn.texi
 165 STABS_DOC_FILES = \
 166         $(srcdir)/stabs.texinfo \
 167         $(STABS_DOC_SOURCE_INCLUDES) \
 168         $(STABS_DOC_BUILD_INCLUDES)
 169
 170 # Annotate migration document
 171 ANNOTATE_DOC_SOURCE_INCLUDES = \
 172         $(srcdir)/fdl.texi
 173 ANNOTATE_DOC_BUILD_INCLUDES = \
 174         gdb-cfg.texi \
 175         GDBvn.texi
 176 ANNOTATE_DOC_FILES = \
 177         $(srcdir)/annotate.texinfo \
 178         $(ANNOTATE_DOC_SOURCE_INCLUDES) \
 179         $(ANNOTATE_DOC_BUILD_INCLUDES)
 180
 181 # Options to extract the man page from gdb.texinfo
 182 MANCONF = -Dman
 183
 184 TEXI2POD = perl $(srcdir)/../../etc/texi2pod.pl \
 185                 $(MAKEINFOFLAGS) $(MAKEINFO_EXTRA_FLAGS) -I $(srcdir)
 186
 187
 188 POD2MAN = pod2man --center="GNU Development Tools"
 189
 190 # List of man pages generated from gdb.texi
 191 MAN1S = gdb.1 gdbserver.1 gcore.1 gdb-add-index.1
 192 MAN5S = gdbinit.5
 193 MANS = $(MAN1S) $(MAN5S)
 194
 195 # The pod files that are generated as a side effect of creating the
 196 # man pages.
 197 POD_FILE_TMPS = $(patsubst %.1,%.pod,$(MAN1S)) \
 198                 $(patsubst %.5,%.pod,$(MAN5S))
 199
 200 HAVE_NATIVE_GCORE_TARGET = @HAVE_NATIVE_GCORE_TARGET@
 201 HAVE_NATIVE_GCORE_HOST = @HAVE_NATIVE_GCORE_HOST@
 202
 203 ###
 204
 205 all: info
 206
 207 info: $(INFO_DEPS)
 208 dvi: $(DVIFILES)
 209 ps: gdb.ps stabs.ps refcard.ps annotate.ps
 210 html: $(HTMLFILES)
 211 pdf: $(PDFFILES)
 212 man: $(MANS)
 213
 214 DOXYGEN = doxygen
 215 doxyedit = sed -e 's,@srcdir\@,$(srcdir),g'
 216
 217 doxy:   doxy/index.html \
 218         doxy/gdb-api/index.html \
 219         doxy/gdb-xref/index.html \
 220         doxy/gdbserver/index.html
 221
 222 doxy/index.html: $(srcdir)/doxy-index.in
 223         -mkdir -p doxy
 224         cp $(srcdir)/doxy-index.in doxy/index.html
 225
 226 doxy/gdb-api/index.html: Doxyfile-gdb-api Doxyfile-base
 227         -mkdir -p doxy
 228         $(DOXYGEN) Doxyfile-gdb-api
 229
 230 doxy/gdb-xref/index.html: Doxyfile-gdb-xref Doxyfile-base
 231         -mkdir -p doxy
 232         $(DOXYGEN) Doxyfile-gdb-xref
 233
 234 doxy/gdbserver/index.html: Doxyfile-gdbserver Doxyfile-base
 235         -mkdir -p doxy
 236         $(DOXYGEN) Doxyfile-gdbserver
 237
 238 Doxyfile-base:  $(srcdir)/Doxyfile-base.in
 239         $(doxyedit) $(srcdir)/Doxyfile-base.in >Doxyfile-base
 240
 241 Doxyfile-gdb-api:       $(srcdir)/Doxyfile-gdb-api.in
 242         $(doxyedit) $(srcdir)/Doxyfile-gdb-api.in >Doxyfile-gdb-api
 243
 244 Doxyfile-gdb-xref:      $(srcdir)/Doxyfile-gdb-xref.in
 245         $(doxyedit) $(srcdir)/Doxyfile-gdb-xref.in >Doxyfile-gdb-xref
 246
 247 Doxyfile-gdbserver:     $(srcdir)/Doxyfile-gdbserver.in
 248         $(doxyedit) $(srcdir)/Doxyfile-gdbserver.in >Doxyfile-gdbserver
 249
 250 all-doc: info man dvi ps pdf html
 251 diststuff: info man
 252
 253 install-info: $(INFO_DEPS)
 254         $(SHELL) $(srcdir)/../../mkinstalldirs $(DESTDIR)$(infodir)
 255         @list='$(INFO_DEPS)'; \
 256         for file in $$list; do \
 257           if test -f $$file; then d=.; else d=$(srcdir); fi; \
 258           for ifile in `cd $$d && echo $$file $$file-[0-9] $$file-[0-9][0-9]`; do \
 259             if test -f $$d/$$ifile; then \
 260               echo " $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile"; \
 261               $(INSTALL_DATA) $$d/$$ifile $(DESTDIR)$(infodir)/$$ifile; \
 262             else : ; fi; \
 263           done; \
 264         done
 265         $(POST_INSTALL)
 266         @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
 267           list='$(INFO_DEPS)'; \
 268           for file in $$list; do \
 269             echo " install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file";\
 270             install-info --info-dir=$(DESTDIR)$(infodir) $(DESTDIR)$(infodir)/$$file || :;\
 271           done; \
 272         else : ; fi
 273
 274 uninstall-info:
 275         $(PRE_UNINSTALL)
 276         @if $(SHELL) -c 'install-info --version | sed 1q | fgrep -s -v -i debian' >/dev/null 2>&1; then \
 277           ii=yes; \
 278         else ii=; fi; \
 279         list='$(INFO_DEPS)'; \
 280         for file in $$list; do \
 281           test -z "$$ii" \
 282             || install-info --info-dir=$(DESTDIR)$(infodir) --remove $$file; \
 283         done
 284         $(NORMAL_UNINSTALL)
 285         list='$(INFO_DEPS)'; \
 286         for file in $$list; do \
 287           (cd $(DESTDIR)$(infodir) && rm -f $$file $$file-[0-9] $$file-[0-9][0-9]); \
 288         done
 289
 290 html__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
 291
 292 install-html: $(HTMLFILES)
 293         @$(NORMAL_INSTALL)
 294         test -z "$(htmldir)" || $(mkinstalldirs) "$(DESTDIR)$(htmldir)"
 295         @list='$(HTMLFILES_INSTALL)'; for p in $$list; do \
 296           if test -f "$$p" || test -d "$$p"; then d=""; else d="$(srcdir)/"; fi; \
 297           f=$(html__strip_dir) \
 298           if test -d "$$d$$p"; then \
 299             echo " $(mkinstalldirs) '$(DESTDIR)$(htmldir)/$$f'"; \
 300             $(mkinstalldirs) "$(DESTDIR)$(htmldir)/$$f" || exit 1; \
 301             echo " $(INSTALL_DATA) '$$d$$p'/* '$(DESTDIR)$(htmldir)/$$f'"; \
 302             $(INSTALL_DATA) "$$d$$p"/* "$(DESTDIR)$(htmldir)/$$f"; \
 303           else \
 304             echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(htmldir)/$$f'"; \
 305             $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(htmldir)/$$f"; \
 306           fi; \
 307         done
 308
 309 dvi__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
 310
 311 install-dvi: $(DVIFILES)
 312         @$(NORMAL_INSTALL)
 313         test -z "$(dvidir)" || $(mkinstalldirs) "$(DESTDIR)$(dvidir)"
 314         @list='$(DVIFILES)'; for p in $$list; do \
 315           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 316           f=$(dvi__strip_dir) \
 317           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(dvidir)/$$f'"; \
 318           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(dvidir)/$$f"; \
 319         done
 320
 321 pdf__strip_dir = `echo $$p | sed -e 's|^.*/||'`;
 322
 323 install-pdf: $(PDFFILES)
 324         @$(NORMAL_INSTALL)
 325         test -z "$(pdfdir)" || $(mkinstalldirs) "$(DESTDIR)$(pdfdir)"
 326         @list='$(PDFFILES)'; for p in $$list; do \
 327           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 328           f=$(pdf__strip_dir) \
 329           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(pdfdir)/$$f'"; \
 330           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(pdfdir)/$$f"; \
 331         done
 332
 333 install-man: install-man1 install-man5
 334
 335 install-man1: $(MAN1S)
 336         test -z "$(man1dir)" || $(mkinstalldirs) "$(DESTDIR)$(man1dir)"
 337         @list='$(MAN1S)'; for p in $$list; do \
 338           if test "x$(HAVE_NATIVE_GCORE_TARGET)$(HAVE_NATIVE_GCORE_HOST)" = x \
 339                   -a "$$p" = gcore.1; then \
 340             continue; \
 341           fi; \
 342           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 343           f=`echo $$p | sed -e 's|^.*/||' -e '$(transform)'`; \
 344           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(man1dir)/$$f'"; \
 345           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(man1dir)/$$f"; \
 346         done
 347
 348 install-man5: $(MAN5S)
 349         test -z "$(man5dir)" || $(mkinstalldirs) "$(DESTDIR)$(man5dir)"
 350         @list='$(MAN5S)'; for p in $$list; do \
 351           if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \
 352           f=`echo $$p | sed -e 's|^.*/||' -e '$(transform)'`; \
 353           echo " $(INSTALL_DATA) '$$d$$p' '$(DESTDIR)$(man5dir)/$$f'"; \
 354           $(INSTALL_DATA) "$$d$$p" "$(DESTDIR)$(man5dir)/$$f"; \
 355         done
 356
 357 uninstall-man: uninstall-man1 uninstall-man5
 358
 359 uninstall-man1:
 360         @test -n "$(man1dir)" || exit 0; \
 361         files=`{ l2='$(MAN1S)'; for i in $$l2; do \
 362           if test "x$(HAVE_NATIVE_GCORE_TARGET)$(HAVE_NATIVE_GCORE_HOST)" = x \
 363                   -a "$$i" = gcore.1; then \
 364             continue; \
 365           fi; \
 366           echo "$$i"; \
 367         done | \
 368           sed -n '/\.1[a-z]*$$/p'; \
 369         } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^1][0-9a-z]*$$,1,;x' \
 370               -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
 371         test -z "$$files" || { \
 372           echo " ( cd '$(DESTDIR)$(man1dir)' && rm -f" $$files ")"; \
 373           cd "$(DESTDIR)$(man1dir)" && rm -f $$files; }
 374
 375 uninstall-man5:
 376         @test -n "$(man5dir)" || exit 0; \
 377         files=`{ l2='$(MAN5S)'; for i in $$l2; do echo "$$i"; done | \
 378           sed -n '/\.5[a-z]*$$/p'; \
 379         } | sed -e 's,.*/,,;h;s,.*\.,,;s,^[^5][0-9a-z]*$$,5,;x' \
 380               -e 's,\.[0-9a-z]*$$,,;$(transform);G;s,\n,.,'`; \
 381         test -z "$$files" || { \
 382           echo " ( cd '$(DESTDIR)$(man5dir)' && rm -f" $$files ")"; \
 383           cd "$(DESTDIR)$(man5dir)" && rm -f $$files; }
 384
 385 STAGESTUFF = *.info* gdb-all.texi GDBvn.texi *.ps *.dvi *.pdf *.1 *.5
 386
 387 # Copy the object files from a particular stage into a subdirectory.
 388 stage1: force
 389         -mkdir stage1
 390         -mv $(STAGESTUFF) stage1
 391
 392 stage2: force
 393         -mkdir stage2
 394         -mv $(STAGESTUFF) stage2
 395
 396 stage3: force
 397         -mkdir stage3
 398         -mv $(STAGESTUFF) stage3
 399
 400 against=stage2
 401
 402 comparison: force
 403         for i in $(STAGESTUFF) ; do cmp $$i $(against)/$$i ; done
 404
 405 de-stage1: force
 406         -(cd stage1 ; mv -f * ..)
 407         -rmdir stage1
 408
 409 de-stage2: force
 410         -(cd stage2 ; mv -f * ..)
 411         -rmdir stage2
 412
 413 de-stage3: force
 414         -(cd stage3 ; mv -f * ..)
 415         -rmdir stage3
 416
 417
 418 sedref.tex : refcard.tex $(REFEDITS)
 419         $(SILENCE) echo > refcard.sed
 420         $(SILENCE) for f in x $(REFEDITS) ; do \
 421                 test x$$f = xx && continue ; \
 422                 cat $(srcdir)/$$f >>refcard.sed ; \
 423         done
 424         $(ECHO_GEN) sed -f refcard.sed $(srcdir)/refcard.tex >$@
 425         $(SILENCE) rm -f refcard.sed
 426
 427
 428 # GDB QUICK REFERENCE (dvi output)
 429 refcard.dvi : sedref.tex
 430         $(SILENCE) rm -f sedref_dvi.*
 431         $(SILENCE) cp $< sedref_dvi.tex
 432         $(ECHO_TEX) $(SET_TEXINPUTS) $(TEX) sedref_dvi.tex && \
 433                 mv sedref_dvi.dvi $@
 434
 435 refcard.ps : refcard.dvi
 436         $(ECHO_DVIPS) $(DVIPS) $(SILENT_Q_FLAG) -t landscape -o $@ $?
 437
 438 refcard.pdf : sedref.tex
 439         $(SILENCE) rm -f sedref_pdf.*
 440         $(SILENCE) cp $< sedref_pdf.tex
 441         $(ECHO_PDFTEX) $(SET_TEXINPUTS) $(PDFTEX) sedref_pdf.tex && \
 442                 mv sedref_pdf.pdf $@
 443
 444 # File to record current GDB version number.
 445 #
 446 # It is important that version.subst be the first dependency so that
 447 # $< can be used in the recipe, this allows us to find version.subst
 448 # in either the source tree or the build tree as this file is
 449 # included, pre-built, as part of a release.
 450 GDBvn.texi : version.subst
 451         $(ECHO_GEN)
 452         $(SILENCE) echo "@set GDBVN `sed q $<`" > ./GDBvn.new
 453         $(SILENCE) if [ -n "$(PKGVERSION)" ]; then \
 454           echo "@set VERSION_PACKAGE $(PKGVERSION)" >> ./GDBvn.new; \
 455         fi
 456         $(SILENCE) echo "@set BUGURL $(BUGURL_TEXI)" >> ./GDBvn.new
 457         $(SILENCE) if [ "$(BUGURL_TEXI)" = "@uref{http://www.gnu.org/software/gdb/bugs/}" ]; then \
 458           echo "@set BUGURL_DEFAULT" >> ./GDBvn.new; \
 459         fi
 460         $(SILENCE) if test -z "$(READLINE_TEXI_INCFLAG)"; then \
 461           echo "@set SYSTEM_READLINE" >> ./GDBvn.new; \
 462         fi
 463         $(SILENCE) if [ -n "$(SYSTEM_GDBINIT)" ]; then \
 464           escaped_system_gdbinit=`echo $(SYSTEM_GDBINIT) | sed 's/@/@@/g'`; \
 465           echo "@set SYSTEM_GDBINIT $$escaped_system_gdbinit" >> ./GDBvn.new; \
 466         fi
 467         $(SILENCE) if [ -n "$(SYSTEM_GDBINIT_DIR)" ]; then \
 468           escaped_system_gdbinit_dir=`echo $(SYSTEM_GDBINIT_DIR) | sed 's/@/@@/g'`; \
 469           echo "@set SYSTEM_GDBINIT_DIR $$escaped_system_gdbinit_dir" >> ./GDBvn.new; \
 470         fi
 471         $(SILENCE) mv GDBvn.new GDBvn.texi
 472
 473 version.subst: $(gdbdir)/version.in $(gdbdir)/../bfd/version.h
 474         $(ECHO_GEN) date=`sed -n -e 's/^.* BFD_VERSION_DATE \(.*\)$$/\1/p' $(gdbdir)/../bfd/version.h`; \
 475         sed -e "s/DATE/$$date/" < $(gdbdir)/version.in > version.subst
 476
 477 # Updated atomically
 478 .PRECIOUS: GDBvn.texi
 479
 480 # Choose configuration for GDB manual (normally `all'; normally not tied into
 481 # `configure' script because most users prefer generic version of manual,
 482 # not one for their binary config---which may not be specifically
 483 # defined anyways).
 484 gdb-cfg.texi: ${srcdir}/${DOC_CONFIG}-cfg.texi
 485         $(ECHO_GEN) (test "$(LN_S)" = "ln -s" && \
 486           ln -s ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi) || \
 487         ln ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi || \
 488         cp ${srcdir}/${DOC_CONFIG}-cfg.texi gdb-cfg.texi
 489
 490 # GDB MANUAL: TeX dvi file
 491 gdb.dvi: ${GDB_DOC_FILES}
 492         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) \
 493                 $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) \
 494                 $(srcdir)/gdb.texinfo
 495
 496 gdb.ps: gdb.dvi
 497         $(ECHO_DVIPS) $(DVIPS) $(SILENT_Q_FLAG) -o $@ $?
 498
 499 gdb.pdf: ${GDB_DOC_FILES}
 500         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) --pdf \
 501                 $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) \
 502                 $(srcdir)/gdb.texinfo
 503
 504 # GDB MANUAL: info file
 505 gdb.info: ${GDB_DOC_FILES}
 506         $(ECHO_MAKEINFO) $(MAKEINFO_CMD) $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) \
 507                 -o gdb.info $(srcdir)/gdb.texinfo
 508
 509 # GDB MANUAL: roff translations
 510 # Try to use a recent texi2roff.  v2 was put on prep in jan91.
 511 # If you want an index, see texi2roff doc for postprocessing
 512 # and add -i to texi2roff invocations below.
 513 # Workarounds for texi2roff-2 (probably fixed in later texi2roff's, delete
 514 #    corresponding -e lines when later texi2roff's are current)
 515 # + @ifinfo's deleted explicitly due to texi2roff-2 bug w nested constructs.
 516 # + @c's deleted explicitly because texi2roff sees texinfo commands in them
 517 # + @   (that's at-BLANK) not recognized by texi2roff, turned into blank
 518 # + @alphaenumerate is ridiculously new, turned into @enumerate
 519
 520 # texi2roff doesn't have a notion of include dirs, so we have to fake
 521 # it out for gdb manual's include files---but only if not configured
 522 # in main sourcedir.
 523 links2roff: $(GDB_DOC_SOURCE_INCLUDES)
 524         $(ECHO_GEN) if [ ! -f gdb.texinfo ]; then \
 525                 (test "$(LN_S)" = "ln -s" && ln -s $(GDB_DOC_SOURCE_INCLUDES) .) || \
 526                 ln $(GDB_DOC_SOURCE_INCLUDES)    . || \
 527                 cp $(GDB_DOC_SOURCE_INCLUDES)    . ; \
 528         fi
 529         $(SILENCE) touch links2roff
 530
 531 # gdb manual suitable for [gtn]roff -me
 532 gdb.me: $(GDB_DOC_FILES) links2roff
 533         $(ECHO_GEN) sed -e '/\\input texinfo/d' \
 534                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 535                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 536                 -e '/^@c /d' \
 537                 -e 's/{.*,,/{/' \
 538                 -e 's/@ / /g' \
 539                 -e 's/^@alphaenumerate/@enumerate/g' \
 540                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 541                 $(srcdir)/gdb.texinfo | \
 542         $(TEXI2ROFF) -me | \
 543         sed -e 's/---/\\(em/g' \
 544         >gdb.me
 545
 546 # gdb manual suitable for [gtn]roff -ms
 547 gdb.ms: $(GDB_DOC_FILES) links2roff
 548         $(ECHO_GEN) sed -e '/\\input texinfo/d' \
 549                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 550                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 551                 -e '/^@c /d' \
 552                 -e 's/{.*,,/{/' \
 553                 -e 's/@ / /g' \
 554                 -e 's/^@alphaenumerate/@enumerate/g' \
 555                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 556                 $(srcdir)/gdb.texinfo | \
 557         $(TEXI2ROFF) -ms | \
 558         sed -e 's/---/\\(em/g' \
 559         >gdb.ms
 560
 561 # gdb manual suitable for [tn]roff -mm
 562 # '@noindent's removed due to texi2roff-2 mm bug; if yours is newer,
 563 #   try leaving them in
 564 gdb.mm: $(GDB_DOC_FILES) links2roff
 565         $(ECHO_GEN) sed -e '/\\input texinfo/d' \
 566                 -e '/@c TEXI2ROFF-KILL/,/@c END TEXI2ROFF-KILL/d' \
 567                 -e '/^@ifinfo/,/^@end ifinfo/d' \
 568                 -e '/^@c /d' \
 569                 -e 's/{.*,,/{/' \
 570                 -e '/@noindent/d' \
 571                 -e 's/@ / /g' \
 572                 -e 's/^@alphaenumerate/@enumerate/g' \
 573                 -e 's/^@end alphaenumerate/@end enumerate/g' \
 574                 $(srcdir)/gdb.texinfo | \
 575         $(TEXI2ROFF) -mm | \
 576         sed -e 's/---/\\(em/g' \
 577         >gdb.mm
 578
 579 # GDB MANUAL: HTML file
 580
 581 gdb/index.html: ${GDB_DOC_FILES}
 582         $(ECHO_GEN) $(MAKEHTML) $(MAKEHTMLFLAGS) \
 583                 -o gdb \
 584                 $(READLINE_TEXI_INCFLAG) -I ${GDBMI_DIR} -I $(srcdir) \
 585                 $(srcdir)/gdb.texinfo
 586
 587 stabs.info: $(STABS_DOC_FILES)
 588         $(ECHO_MAKEINFO) $(MAKEINFO_CMD) -I $(srcdir) -o stabs.info $(srcdir)/stabs.texinfo
 589
 590 # STABS DOCUMENTATION: HTML file
 591
 592 stabs/index.html: $(STABS_DOC_FILES)
 593         $(ECHO_GEN) $(MAKEHTML) $(MAKEHTMLFLAGS) \
 594                 -o stabs \
 595                 -I $(srcdir) \
 596                 $(srcdir)/stabs.texinfo
 597
 598 # STABS DOCUMENTATION: TeX dvi file
 599 stabs.dvi : $(STABS_DOC_FILES)
 600         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) -I $(srcdir) \
 601                 $(srcdir)/stabs.texinfo
 602
 603 stabs.ps: stabs.dvi
 604         $(ECHO_DVIPS) $(DVIPS) $(SILENT_Q_FLAG) -o $@ $?
 605
 606 stabs.pdf: $(STABS_DOC_FILES)
 607         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) --pdf -I $(srcdir) \
 608                 $(srcdir)/stabs.texinfo
 609
 610 # ANNOTATE DOCUMENTATION: TeX dvi file
 611 annotate.dvi : $(ANNOTATE_DOC_FILES)
 612         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) -I $(srcdir) \
 613                 $(srcdir)/annotate.texinfo
 614
 615 annotate.ps: annotate.dvi
 616         $(ECHO_DVIPS) $(DVIPS) $(SILENT_Q_FLAG) -o $@ $?
 617
 618 annotate.pdf: $(ANNOTATE_DOC_FILES)
 619         $(ECHO_TEXI2DVI) $(TEXI2DVI_CMD) $(SILENT_Q_FLAG) --pdf -I $(srcdir) \
 620                 $(srcdir)/annotate.texinfo
 621
 622 annotate.info: $(ANNOTATE_DOC_FILES)
 623         $(ECHO_MAKEINFO) $(MAKEINFO_CMD) -I $(srcdir) -o annotate.info $(srcdir)/annotate.texinfo
 624
 625 annotate/index.html: $(ANNOTATE_DOC_FILES)
 626         $(ECHO_MAKEHTML) $(MAKEHTML) $(MAKEHTMLFLAGS) \
 627                 -o annotate \
 628                 -I $(srcdir) \
 629                 $(srcdir)/annotate.texinfo
 630
 631 # Man pages.  The TEXI2POD and TEXI2MAN steps are performed within a
 632 # single recipe to support how we distribute GDB releases.  A release
 633 # includes the .1 and .5 man pages in the source tree, but not the
 634 # .pod files.
 635 #
 636 # When building and installing a release of GDB it should not be
 637 # necessary to rebuild the .1 or .5 man page files, nor should it be
 638 # necessary to rebuild the .pod files.
 639 #
 640 # If we split the .pod creation from the creation of the .1 and .5
 641 # pages, then the .pod files must become a dependency, this will
 642 # trigger an attempt to rebuild these files while building and
 643 # installing a release of GDB, which is something we don't want.
 644 #
 645 # It is important that version.subst be the first dependency so that
 646 # $< can be used in the recipe, this allows us to find version.subst
 647 # in either the source tree or the build tree as this file is
 648 # included, pre-built, as part of a release.
 649 $(MAN1S) $(MAN5S) : version.subst $(GDB_DOC_FILES)
 650         $(ECHO_TEXI2POD) $(TEXI2POD) $(MANCONF) -D$(basename $@) \
 651                 < $(srcdir)/gdb.texinfo > $(basename $@).pod
 652         $(ECHO_TEXI2MAN) ($(POD2MAN) --section=$(subst .,,$(suffix $@)) \
 653                         --release="gdb-`sed q $<`" $(basename $@).pod | \
 654                 sed -e '/^.if n .na/d' > $@.T$$$$ && \
 655                 mv -f $@.T$$$$ $@) || (rm -f $@.T$$$$ && exit 1)
 656         $(SILENCE) rm -f $(basename $@).pod
 657
 658 force:
 659
 660 Makefile: Makefile.in $(host_makefile_frag) ../config.status
 661         $(ECHO_GEN) cd .. && $(SHELL) ./config.status $(SILENT_FLAG) doc/Makefile
 662
 663
 664 # The "least clean" level of cleaning.  Get rid of files which are
 665 # automatically generated files that are just intermediate files,
 666
 667 mostlyclean:
 668         rm -f gdb.mm gdb.ms gdb.me links2roff
 669         rm -fr $(TEXI2DVI_TMPDIR)
 670         rm -f refcard.sed sedref.tex sedref_dvi.* sedref_pdf.*
 671         rm -f $(POD_FILE_TMPS)
 672
 673 clean: mostlyclean
 674         rm -f gdb-cfg.texi
 675
 676 distclean: clean
 677         rm -f Makefile
 678
 679 # GDBvn.texi, the dvi files, the info files, and the postscript files,
 680 # are all part of the distribution, so it should not be removed by
 681 # "clean" or "distclean".  Use maintainer-clean to remove them.
 682
 683 maintainer-clean realclean: distclean
 684         rm -f GDBvn.texi version.subst *.info* *.dvi *.ps *.html *.pdf $(MANS)
 685
 686 install: install-info install-man
 687
 688 uninstall: uninstall-info uninstall-man
 689
 690 # Disable implicit make rules.
 691 include $(srcdir)/../disable-implicit-rules.mk