diff options
author | Roland Pesch <pesch@cygnus> | 1991-11-15 00:58:33 +0000 |
---|---|---|
committer | Roland Pesch <pesch@cygnus> | 1991-11-15 00:58:33 +0000 |
commit | 92b73793963c2b918a12cbef1c87c0f79aec2498 (patch) | |
tree | 66acfdcd1fdc6b52b7369bd2856fc691a0c4e44f /gdb/doc | |
parent | 653d6c56a180771bd5024b45c3ad24d642ea0894 (diff) | |
download | gdb-92b73793963c2b918a12cbef1c87c0f79aec2498.zip gdb-92b73793963c2b918a12cbef1c87c0f79aec2498.tar.gz gdb-92b73793963c2b918a12cbef1c87c0f79aec2498.tar.bz2 |
Two kinds of changes:
(1) repair refs to readline includes to use new shorter filenames
(2) provision for texi2roff conversion of doc via Makefile
(new targets: gdb.mm, gdb.me, gdb.ms).
Diffstat (limited to 'gdb/doc')
-rw-r--r-- | gdb/doc/Makefile.in | 93 | ||||
-rw-r--r-- | gdb/doc/gdb.texinfo | 32 | ||||
-rwxr-xr-x | gdb/doc/rdl-apps.texi | 4 |
3 files changed, 110 insertions, 19 deletions
diff --git a/gdb/doc/Makefile.in b/gdb/doc/Makefile.in index e077d43..628c1cc 100644 --- a/gdb/doc/Makefile.in +++ b/gdb/doc/Makefile.in @@ -38,6 +38,9 @@ TEXIDIR=$(srcdir)/${gdbdir}/../texinfo/fsf # where to find makeinfo, preferably one designed for texinfo-2 MAKEINFO=makeinfo +# where to find texi2roff, ditto +TEXI2ROFF=texi2roff + # Where is the source dir for the READLINE library? Traditionally in .. or . # (For the binary library built from it, we use ${READLINE_DIR}${subdir}.) READLINE_DIR = $(srcdir)/${gdbdir}/../readline @@ -47,6 +50,9 @@ SFILES_DOCDIR = \ $(srcdir)/gdb.texinfo $(srcdir)/pretex.m4 $(srcdir)/none.m4 \ $(srcdir)/all.m4 gdbinv-m.m4 gdbinv-s.m4 gdbVN.m4 +# Which version of GDB manual? default includes everything +CONFIG=all + all install: all-info: gdb.info gdbint.info @@ -79,11 +85,11 @@ refcard.ps : refcard.tex rm -f rcfonts.tex # Cover file for "Readline" appendices -rdl-apps.texi: ${READLINE_DIR}/inc-readline.texinfo \ - ${READLINE_DIR}/inc-history.texinfo +rdl-apps.texi: ${READLINE_DIR}/inc-read.texi \ + ${READLINE_DIR}/inc-hist.texi rm -f rdl-apps.texi - echo "@include ${READLINE_DIR}/inc-readline.texinfo" >rdl-apps.texi - echo "@include ${READLINE_DIR}/inc-history.texinfo" >>rdl-apps.texi + echo "@include ${READLINE_DIR}/inc-read.texi" >rdl-apps.texi + echo "@include ${READLINE_DIR}/inc-hist.texi" >>rdl-apps.texi # File to record current GDB version number (copied from main dir Makefile.in) gdbVN.m4 : ${gdbdir}/Makefile.in @@ -91,6 +97,9 @@ gdbVN.m4 : ${gdbdir}/Makefile.in echo "_define__(<_GDB_VN__>,$$VER)" > gdbVN.m4 ) # GDB MANUAL: texinfo source, created by preprocessing w/m4 +# If you want other configs in the makefile, add or modify instructions for +# building source here, then change CONFIG (that way you get info, dvi, +# roff targets automatically for your config). # Be sure to not create a bad gdb-all.texi if ${M4} is missing or aborts... gdb-all.texi: ${SFILES_DOCDIR} rm -f foobus.texinfo @@ -99,19 +108,79 @@ gdb-all.texi: ${SFILES_DOCDIR} mv foobus.texinfo gdb-all.texi # GDB MANUAL: TeX dvi file -gdb.dvi : gdb-all.texi rdl-apps.texi - TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-all.texi - texindex gdb-all.?? - TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-all.texi - mv gdb-all.dvi gdb.dvi - rm -f gdb-all.?? gdb-all.??? +gdb.dvi : gdb-${CONFIG}.texi rdl-apps.texi + TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-${CONFIG}.texi + texindex gdb-${CONFIG}.?? + TEXINPUTS=${TEXIDIR}:.:$$TEXINPUTS tex gdb-${CONFIG}.texi + mv gdb-${CONFIG}.dvi gdb.dvi + rm -f gdb-${CONFIG}.?? gdb-${CONFIG}.??? # GDB MANUAL: info file # We're using texinfo2, and older makeinfo's may not be able to # cope with all the markup. In the meantime, we distribute the info # files -gdb.info: gdb-all.texi - $(MAKEINFO) -o gdb.info gdb-all.texi +gdb.info: gdb-${CONFIG}.texi + $(MAKEINFO) -o gdb.info gdb-${CONFIG}.texi + +# 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 +# correspondint -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 + + +# 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-${CONFIG}.texi + 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' \ + gdb-${CONFIG}.texi | \ + $(TEXI2ROFF) -mm | \ + sed -e 's/---/\\(em/g' \ + >gdb.mm + +# gdb manual suitable for [gtn]roff -me +gdb.me: gdb-${CONFIG}.texi + 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' \ + gdb-${CONFIG}.texi | \ + $(TEXI2ROFF) -me | \ + sed -e 's/---/\\(em/g' \ + >gdb.me + +# gdb manual suitable for [gtn]roff -ms +gdb.ms: gdb-${CONFIG}.texi + 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' \ + gdb-${CONFIG}.texi | \ + $(TEXI2ROFF) -ms | \ + sed -e 's/---/\\(em/g' \ + >gdb.ms # GDB INTERNALS MANUAL: TeX dvi file gdbint.dvi : gdbint.texinfo diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index ce09f8f..4c4dfd5 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -85,16 +85,26 @@ _fi__(!_GENERIC__) @finalout @end iftex @titlepage -@title{Using _GDBN__} -@subtitle{A Guide to the GNU Source-Level Debugger} +@title Using _GDBN__ +@subtitle A Guide to the GNU Source-Level Debugger _if__(!_GENERIC__) -@subtitle{On _HOST__ Systems} +@subtitle On _HOST__ Systems _fi__(!_GENERIC__) @sp 1 @subtitle _GDBN__ version _GDB_VN__ @subtitle November 1991 -@author{Richard M. Stallman@qquad @hfill Free Software Foundation} -@author{Roland H. Pesch@qquad @hfill Cygnus Support} +@c TEXI2ROFF-KILL +@c let's be nice to texi2roff, it can't be expected to know about hfill... +@author Richard M. Stallman@qquad @hfill Free Software Foundation +@author Roland H. Pesch@qquad @hfill Cygnus Support +@ignore +@c END TEXI2ROFF-KILL +@c sneaky, eh? +@author Richard M. Stallman, Free Software Foundation +@author Roland H. Pesch, Cygnus Support +@c TEXI2ROFF-KILL +@end ignore +@c END TEXI2ROFF-KILL @page @tex {\parskip=0pt @@ -7005,10 +7015,14 @@ command set as a whole more consistent and easier to use and remember: @kindex show history write @kindex unset +@c TEXI2ROFF-KILL @ifinfo +@c END TEXI2ROFF-KILL @example OLD COMMAND NEW COMMAND +@c TEXI2ROFF-KILL --------------- ------------------------------- +@c END TEXI2ROFF-KILL add-syms add-symbol-file delete environment unset environment info convenience show convenience @@ -7036,6 +7050,7 @@ set/show vtblprint set/show print vtbl unset [No longer an alias for delete] @end example +@c TEXI2ROFF-KILL @end ifinfo @tex @@ -7070,6 +7085,7 @@ set{\rm / }show vtblprint &&set{\rm / }show print vtbl\cr unset &&\rm(No longer an alias for delete)\cr } @end tex +@c END TEXI2ROFF-KILL @node Installing _GDBN__, Copying, Renamed Commands, Top @appendix Installing _GDBN__ @@ -7248,11 +7264,15 @@ The following table shows all the architectures, hosts, and OS prefixes that @code{configure} recognizes in _GDBN__ _GDB_VN__. Entries in the ``OS prefix'' column ending in a @samp{*} may be followed by a release number. +@c TEXI2ROFF-KILL @ifinfo +@c END TEXI2ROFF-KILL @example ARCHITECTURE VENDOR OS prefix +@c TEXI2ROFF-KILL ------------+--------------------------+--------------------------- +@c END TEXI2ROFF-KILL | | 580 | altos hp | aix* msdos* a29k | amd ibm | amigados newsos* @@ -7280,6 +7300,7 @@ ARCHITECTURE VENDOR OS prefix xmp | | ymp | | @end example +@c TEXI2ROFF-KILL @end ifinfo @tex %\vskip\parskip @@ -7316,6 +7337,7 @@ ARCHITECTURE VENDOR OS prefix ymp && & && & \cr }\hfil} @end tex +@c END TEXI2ROFF-KILL @quotation @emph{Warning:} Many combinations of architecture, vendor, and OS are untested. diff --git a/gdb/doc/rdl-apps.texi b/gdb/doc/rdl-apps.texi index 85b120c..28fd2ba 100755 --- a/gdb/doc/rdl-apps.texi +++ b/gdb/doc/rdl-apps.texi @@ -1,2 +1,2 @@ -@include ../../readline/inc-readline.texinfo -@include ../../readline/inc-history.texinfo +@include ./../../readline/inc-read.texi +@include ./../../readline/inc-hist.texi |