From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: "Eli Zaretskii" Newsgroups: gmane.emacs.devel Subject: Re: Texinfo doc for GDB-UI Date: Tue, 24 Dec 2002 21:29:15 +0300 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <3405-Tue24Dec2002212914+0200-eliz@is.elta.co.il> References: <15879.34324.916528.669630@nick.uklinux.net> Reply-To: Eli Zaretskii NNTP-Posting-Host: main.gmane.org X-Trace: main.gmane.org 1040758309 30831 80.91.224.249 (24 Dec 2002 19:31:49 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Tue, 24 Dec 2002 19:31:49 +0000 (UTC) Cc: emacs-devel@gnu.org Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 18QumK-000818-00 for ; Tue, 24 Dec 2002 20:31:48 +0100 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian)) id 18Quq0-0002Ha-00 for ; Tue, 24 Dec 2002 20:35:36 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 18QumJ-00023f-00 for emacs-devel@quimby.gnus.org; Tue, 24 Dec 2002 14:31:47 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.10.13) id 18Qulz-000218-00 for emacs-devel@gnu.org; Tue, 24 Dec 2002 14:31:27 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.10.13) id 18Qulw-0001ze-00 for emacs-devel@gnu.org; Tue, 24 Dec 2002 14:31:26 -0500 Original-Received: from aragorn.inter.net.il ([192.114.186.23]) by monty-python.gnu.org with esmtp (Exim 4.10.13) id 18Qulw-0001yi-00 for emacs-devel@gnu.org; Tue, 24 Dec 2002 14:31:24 -0500 Original-Received: from zaretsky (adsl-ayalon-pc-128-68.inter.net.il [213.8.128.68]) by aragorn.inter.net.il (Mirapoint Messaging Server MOS 3.2.1-GA) with ESMTP id AAZ59543; Tue, 24 Dec 2002 21:31:15 +0200 (IST) Original-To: nick@nick.uklinux.net X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 1.8.9 In-reply-to: <15879.34324.916528.669630@nick.uklinux.net> (message from Nick Roberts on Mon, 23 Dec 2002 21:54:28 +0000) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1b5 Precedence: list List-Id: Emacs development discussions. List-Help: List-Post: List-Subscribe: , List-Archive: List-Unsubscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:10334 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:10334 > From: Nick Roberts > Date: Mon, 23 Dec 2002 21:54:28 +0000 > > Here is my attempt at writing something for gdb-ui.el for the emacs manual. Thanks! A few comments: > + @item M-x gdba @key{RET} @var{file} @key{RET} > + @findex gdba > + Run GDB as a subprocess of Emacs. This command generates a more extensive > + user interface than the command gdb. These extra features are described in > + @xref{GDB-UI}. First, please don't use @xref except at the beginning of a sentence, since the text it produces begins with a capitalized "See", and will look like a typo in the middle of a sentence. Secondly, an index entry for a command ("@findex gdba" above) should be where the command is explained in full, not where it's mentioned for the first time. So the right place for the index entry is in the second paragraph of the node GDB-UI. Finally, please make sure every sentence has either two spaces or a newline after the period that ends the sentence. This is so TeX typesets the sentence separation correctly. > + with just one or two windows. So, after re-compilation, the window > + layout for the debugging session can be restored with > + @code{gdb-restore-windows}. Please make an @findex entry for every command you mention in the manual (here gdb-restore-windows). (There are other places where commands are mentioned without an @findex entry.) > + @node Layout > + @subsubsection Layout It is generally advisable to make @cindex entries where important parts of the UI are described, under the assumption that users may wish to find those details quickly. For example, this section would probably benefit from an entry such as "@cindex GDB-UT layout". The subsection name is in many cases a good starting point for the @cindex entry. > + If @code{gdb-many-windows} is nil (the default value) `nil' is a symbol, so it should have the @code markup. > + @verb{+--------------------------------------------------------------------- > + GDB Toolbar > + --------------------------------------------------------------------- > + GUD buffer (I/O of GDB) | Locals buffer I suggest to make the lines here shorter; anything longer than 64 characters will produce overfull hbox warnings from TeX, and will spill over to the margin of the page. > + This buffer allows control of the breakpoints which have been set > + previously and uses the output from the GDB command @xref{Set Breaks,, > + info breakpoints, Gdb, The GNU debugger}. Does this xref really work? The GDB manual's name is `gdb.info', not `Gdb.info', so on a case-sensitive filesystem the xref might not work (but I didn't actually try that, so I might be missing something). > + grey when it is disabled. Text-only terminals will correspondingly > + display a `B' or `b'. Please use @samp{b} and @samp{B}, not `b' and `B' here. > + This buffer controls the list of expressions set up to display > + automatically and uses the output from the GDB command @xref{Auto > + Display,,info display, Gdb, The GNU debugger}. As with the > + breakpoints the displayed may be enabled/disabled or deleted. I think the last sentence should say "displayed expressions" or maybe "displays", not "displayed".