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: command and doco for valgrind Date: Sat, 10 Jan 2004 14:34:40 +0200 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <9743-Sat10Jan2004143440+0200-eliz@elta.co.il> References: <16383.8247.758985.411260@nick.uklinux.net> Reply-To: Eli Zaretskii NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1073743954 27422 80.91.224.253 (10 Jan 2004 14:12:34 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sat, 10 Jan 2004 14:12:34 +0000 (UTC) Cc: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Sat Jan 10 15:12:29 2004 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1AfJqn-0007Y0-00 for ; Sat, 10 Jan 2004 15:12:29 +0100 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1AfJqn-0004rY-00 for ; Sat, 10 Jan 2004 15:12:29 +0100 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.24) id 1AfJtH-0004sN-Jn for emacs-devel@quimby.gnus.org; Sat, 10 Jan 2004 09:15:03 -0500 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.24) id 1AfJnK-0003OA-UN for emacs-devel@gnu.org; Sat, 10 Jan 2004 09:08:54 -0500 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.24) id 1AfJPf-0007CA-1U for emacs-devel@gnu.org; Sat, 10 Jan 2004 08:44:58 -0500 Original-Received: from [199.232.41.8] (helo=mx20.gnu.org) by monty-python.gnu.org with esmtp (TLSv1:DES-CBC3-SHA:168) (Exim 4.24) id 1AfJPd-0007BN-N4 for emacs-devel@gnu.org; Sat, 10 Jan 2004 08:44:25 -0500 Original-Received: from [192.114.186.24] (helo=legolas.inter.net.il) by mx20.gnu.org with esmtp (Exim 4.24) id 1AfING-0008Mb-9I for emacs-devel@gnu.org; Sat, 10 Jan 2004 07:37:54 -0500 Original-Received: from zaretski (pns03-194-224.inter.net.il [80.230.194.224]) by legolas.inter.net.il (Mirapoint Messaging Server MOS 3.3.8-GR) with ESMTP id BBW08370; Sat, 10 Jan 2004 14:37:40 +0200 (IST) Original-To: Nick Roberts X-Mailer: emacs 21.3.50 (via feedmail 8 I) and Blat ver 1.8.9 In-reply-to: <16383.8247.758985.411260@nick.uklinux.net> (message from Nick Roberts on Fri, 9 Jan 2004 21:42:15 +0000) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.2 Precedence: list List-Id: Emacs development discussions. List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:19130 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:19130 > From: Nick Roberts > Date: Fri, 9 Jan 2004 21:42:15 +0000 > > Here's a patch for valgrind relating to my earlier message. Any comments? This is IMHO a borderline case: not only do we document GDB-related features in the Emacs manual, but we also document usage of another program that might help debugging programs. I dunno. Anyway, assuming that we do include this in the manual, here are some comments regarding Texinfo usage: > + @cindex Valgrind Index entries regarding programs should use @pindex, not @cindex. > + To start running your program through valgrind type: "valgrind" should have the @code markup, since it's a program name. > + At a memory violation, when valgrind asks if you want to attach to gdb, type y: Ditto, and the same applies to "gdb". > + At the prompt for GDB type: > + > + @example > + @code{set ann 1} and type @key{RET} if you want the mode for M-x gdb. > + @code{set ann 3} and type @key{RET} if you want the mode for M-x gdba. > + @end example I think you should use @kbd here, like this: At GDB's prompt type @kbd{set ann 1 @key{RET}} if you want the mode for @samp{M-x gdb}, or @kbd{set ann 3 @key{RET}} if you want the mode for @samp{M-x gdba}. > + the resulting layout depends on the value of gdb-many-windows. In the "gdb-many-windows" is a variable, so its name should have the @code markup. > + If you now type bt, GDB prints the call stack. This also includes "bt" is something the user types, so it should have the @kbd markup.