Re: Timetable for 3.3.12 release. Documentation issues

"R. Bernstein" <[email protected]>
Newsgroups gmane.comp.debugging.ddd.general
Message-ID <[email protected]>
Peter Wainwright writes:
 > On Sat, 2009-01-31 at 13:55 -0500, R. Bernstein wrote:
 > > Peter Wainwright writes:
 > >  > I agree.  I should think "Everyone" has a PDF viewer (free or non-free)
 > >  > and appropriate printer drivers now, the PS version is therefore a
 > >  > legacy item.
 > >  > 
 > >  > 
 > >  > Peter
 > > 
 > > But one thing I would consider doing is updating
 > > texinfo/texinfo.texi. There have been improvements in the last decade
 > > and one of these I believe is better line number reporting on errors.
 > 
 > I tried a recent texinfo.tex (from gnulib), but it breaks.
 > 
 > prw@ceiriog:ddd$ pdfetex ddd.texi
 > This is pdfTeXk, Version 3.141592-1.40.3 (Web2C 7.5.6)
 >  %&-line parsing enabled.
 > entering extended mode
 > (./ddd.texi (./texinfo.tex Loading texinfo [version 2007-09-03.05]: pdf,
 > fonts, page headings, tables, conditionals, indexing, sectioning, toc,
 > environments, defuns, macros, cross references, insertions,
 > (/home/prw/src/ddd/ddd-trunk/texinfo/epsf.tex) localization, formatting,
 > and turning on texinfo input format.) (./ddd.aux) (./config.texi)
 > (./macros.texi)
 > ! Missing \endcsname inserted.
 > <to be read again> 
 >                    \def 
 > \parseargusing #1#2->\def 
 >                           \argtorun {#2}\begingroup \obeylines
 > \spaceisspace...
 > 
 > \setfont ...ntprefix #2#3 scaled #4 \csname cmap#5
 >                                                   \endcsname #1
 > l.165 \title
 >              \bigtitlesf{Debugging with \value{DDD}}
 > ? x
 > No pages of output.
 > 
 > pdfTeX warning: pdfetex: dangling objects discarded, no output file
 > produced.
 > Transcript written on ddd.log.
 > 
 > I don't understand TeX and friends very well, so I haven't a clue what
 > is going on there.
 > 

I looked a little at this. Basically there's some customized title
pages that is using and assuming some low-level (old) TeXinfo macros
that have changed (probably for the better). My suggestion here is to
get rid of the custom titling and stick with the default title layout
texinfo uses.

Second, there was some weird and probably misguided macros used in the
@node commands. This is like trying to use (not encoded) unicode in
URLs so that they'll look nice in the browser message bar. There is
largely little benefit to doing this because it's for internal
linking. It doesn't have print implications (other than what was
mentioned). So again given that what's needed to reduce maintenance
headaches, I'd also recommend removing this.

Here's a patch with these two changes a that I think will run through
a current texinfo fine:

_______________________________________________
ddd mailing list
[email protected]
http://lists.gnu.org/mailman/listinfo/ddd
ddd-ddd.texi.patch (application/octet-stream, 4.3 KB)
Index: ddd/ddd.texi
===================================================================
--- ddd/ddd.texi	(revision 7173)
+++ ddd/ddd.texi	(working copy)
@@ -153,29 +153,12 @@
 @ifnothtml
 @titlepage
 @sp -7
-@ifnottex
 @title Debugging with @value{DDD}
 @subtitle User's Guide and Reference Manual
 @subtitle @value{EDITION} Edition, for @value{DDD} Version @value{VERSION}
 @subtitle Last updated @value{DATE}
 @author Andreas Zeller
-@end ifnottex
-@tex
-\setfont\bigtitlesf\sfbshape{10}{\magstep4}
-\title \bigtitlesf{Debugging with \value{DDD}}
-\subtitle \textsf{User's Guide and Reference Manual}
-\subtitle \textsf{\value{EDITION} Edition, for \value{DDD} Version \value{VERSION}}
-\subtitle \textsf{Last updated \value{DATE}}
-\sp 2
-\author \titlesf{Andreas Zeller}
-@end tex
 @page
-@tex
-{\parskip=0pt
-\hfill \textsf{Debugging with @value{DDD}}\par
-\hfill \textsf{User's Guide and Reference Manual}\par
-}
-@end tex
 
 @vskip 0pt plus 1filll
 Copyright @copyright{} 2004 Universität des Saarlandes @*
@@ -615,7 +598,7 @@
 
 * Entering Commands::           Direct interaction with the inferior debugger.
 * TTY mode::                    Controlling @DDD{} from a terminal.
-* Integrating @DDD{}::          @DDD{} and your programming environment.
+* Integrating DDD::             @DDD{} and your programming environment.
 * Defining Buttons::            Add your own @DDD{} buttons.
 * Defining Commands::           Add your own @DDD{} commands.
 
@@ -650,7 +633,7 @@
 Bugs and How To Report Them
 
 * Where to Send Bug Reports::   Our e-mail address.
-* Is it a @DDD{} Bug?::         @DDD{} may not be at fault.
+* Is it a DDD Bug?::            @DDD{} may not be at fault.
 * How to Report Bugs::          Report all the facts.
 * Bug Reports::                 Include all configuration information.
 * Diagnostics::                 Maintaining @DDD{}
@@ -658,7 +641,7 @@
 Getting Diagnostics
 
 * Logging::                     @DDD{} logs all interactions.
-* Debugging @DDD{}::            Facilities to debug @DDD{}.
+* Debugging DDD::               Facilities to debug @DDD{}.
 * Customizing Diagnostics::     All diagnostics resources.
 
 Logging
@@ -854,7 +837,7 @@
 * About this Manual::           Getting copies in various formats.
 * Typographic Conventions::     Typographic conventions.
 * Free Software::               How to copy and redistribute @DDD{}.
-* Getting @DDD{}::              How to obtain copies of @DDD{}.
+* Getting DDD::                 How to obtain copies of @DDD{}.
 * Contributors::                Who has done all this?
 * History::                     Old @DDD{} versions.
 @end menu
@@ -1009,7 +992,7 @@
 just copy it.
 
 
-@node Getting @DDD{}
+@node Getting DDD
 @unnumberedsec Getting @value{DDD}
 
 If you have access to the Internet, you can get the latest version of
@@ -10824,7 +10807,7 @@
 @menu
 * Entering Commands::           Direct interaction with the inferior debugger.
 * TTY mode::                    Controlling @DDD{} from a terminal.
-* Integrating @DDD{}::          @DDD{} and your programming environment.
+* Integrating DDD::             @DDD{} and your programming environment.
 * Defining Buttons::            Add your own @DDD{} buttons.
 * Defining Commands::           Add your own @DDD{} commands.
 @end menu
@@ -11077,7 +11060,7 @@
 
 
 
-@node Integrating @DDD{}
+@node Integrating DDD
 @section Integrating @value{DDD}
 @cindex Integrating @DDD{}
 
@@ -12219,7 +12202,7 @@
 
 @menu
 * Where to Send Bug Reports::   Our e-mail address.
-* Is it a @DDD{} Bug?::         @DDD{} may not be at fault.
+* Is it a DDD Bug?::            @DDD{} may not be at fault.
 * How to Report Bugs::          Report all the facts.
 * Bug Reports::                 Include all configuration information.
 * Diagnostics::                 Maintaining @DDD{}
@@ -12235,7 +12218,7 @@
 @end example
 
 
-@node Is it a @DDD{} Bug?
+@node Is it a DDD Bug?
 @section Is it a @value{DDD} Bug?
 
 Before sending in a bug report, try to find out whether the problem
@@ -12352,7 +12335,7 @@
 
 @menu
 * Logging::                     @DDD{} logs all interactions.
-* Debugging @DDD{}::            Facilities to debug @DDD{}.
+* Debugging DDD::               Facilities to debug @DDD{}.
 * Customizing Diagnostics::     All diagnostics resources.
 @end menu
 
@@ -12441,7 +12424,7 @@
 
 
 
-@node Debugging @DDD{}
+@node Debugging DDD
 @subsection Debugging @value{DDD}
 
 @cindex Debugging @DDD{}
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.