Article View: gnu.gdb.bug
Article #560documentation suggestions
From: Karl Berry
Date: Mon, 14 Dec 1992 07:54
Date: Mon, 14 Dec 1992 07:54
80 lines
2909 bytes
2909 bytes
GDB documentation:
[@node Command Syntax]
A line of input starting with @kbd{#} is a comment; it does nothing.
Actually, isn't it the first # on a line that starts a comment?
For example:
(gdb) p 1 + 1 # foo
$1 = 2
(gdb)
[@node Running]
To debug a program, you must run it under GDB.
Well, there are other debuggers in the universe. Perhaps something like
`To debug a program using GDB, you must run it under GDB's control.' or
`... while in GDB.'
[@node Expressions]
by the programming language you are using is legal in an expression in
rms once told me he used `legal' in situations that referred to actual
laws, and used `valid' for things like this. It seems a useful
distinction to me.
[@node Output formats]
Print as integer in binary. The letter @samp{t} stands for ``two''.
Perhaps the manual could explain why `b' for ``binary'' is unsuitable.
[@node Print settings]
@item set print array off.
There shouldn't be a period here.
@section Switching between source languages
@section Displaying the language
@section Type and range Checking
@subsection An overview of type checking
@subsection An overview of Range Checking
@section Giving your program a Signal
@section Returning from a Function
@section Calling your Program's Functions
@section Patching your Program
All the other chapter/section titles in the manual capitalize all the
words (except articles, etc., as usual). Personally, I like this style
(capitalize as in text) for headings better, but I doubt you want to
change everything.
[@node Emacs]
Emacs uses a separate buffer for source display, and splits the
window to show both your GDB session and the source.
I think ``the screen'' would be better than ``the window'' here.
There's (at least) two windows. Or maybe ``the current window''.
[@node Formatting Documentation]
@TeX{}, a printing program such as @code{lpr}, and @file{texinfo.tex},
Actually, lpr will do you no good whatsoever without a DVI-to-device
translator for whatever output device you want to use.
@TeX{} is typesetting program; it does not print files directly, but
Insert `a' before `typesetting'.
is @kbd{dvips}. The @sc{dvi} print command may require a file name
I'd suggest adding `(for PostScript devices)' after the `{dvips}'.
Technical Details
Message-ID:
<199212141754.AA20095@claude.cs.umb.edu>Path:
arc1-ca.pugleaf.net!sparky!uunet!europa.asd.contel.com!howland.reston.ans.net!usc!zaphod.mps.ohio-state.edu!cis.ohio-state.edu!claude.cs.umb.edu!karlShow Full Headers
Complete Article Headers
Newsgroups: gnu.gdb.bug Path: arc1-ca.pugleaf.net!sparky!uunet!europa.asd.contel.com!howland.reston.ans.net!usc!zaphod.mps.ohio-state.edu!cis.ohio-state.edu!claude.cs.umb.edu!karl From: karl@claude.cs.umb.edu (Karl Berry) Subject: documentation suggestions Message-ID: <199212141754.AA20095@claude.cs.umb.edu> Sender: gnulists@ai.mit.edu Reply-To: karl@cs.umb.edu Organization: GNUs Not Usenet Distribution: gnu Date: Mon, 14 Dec 1992 07:54:59 GMT Approved: bug-gdb@prep.ai.mit.edu Lines: 81