From: "Eli Zaretskii" <eliz@elta.co.il>
Cc: emacs-devel@gnu.org
Subject: Re: command and doco for valgrind
Date: Sat, 10 Jan 2004 14:34:40 +0200 [thread overview]
Message-ID: <9743-Sat10Jan2004143440+0200-eliz@elta.co.il> (raw)
In-Reply-To: <16383.8247.758985.411260@nick.uklinux.net> (message from Nick Roberts on Fri, 9 Jan 2004 21:42:15 +0000)
> From: Nick Roberts <nick@nick.uklinux.net>
> 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.
next prev parent reply other threads:[~2004-01-10 12:34 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-01-09 21:42 command and doco for valgrind Nick Roberts
2004-01-10 12:34 ` Eli Zaretskii [this message]
2004-01-17 23:38 ` Nick Roberts
2004-01-18 7:25 ` Eli Zaretskii
2004-01-18 19:15 ` Richard Stallman
2004-01-19 6:32 ` Eli Zaretskii
2004-01-18 14:17 ` Eli Zaretskii
2004-01-18 19:15 ` Eli Zaretskii
2004-01-19 20:11 ` Richard Stallman
2004-01-19 21:33 ` Eli Zaretskii
2004-01-19 22:57 ` Nick Roberts
2004-01-20 6:21 ` EMACS and valgrind (was: command and doco for valgrind) Eli Zaretskii
2004-01-20 15:26 ` Stefan Monnier
2004-01-22 21:46 ` EMACS and valgrind Nick Roberts
2004-01-22 22:26 ` Stefan Monnier
2004-01-23 22:07 ` Nick Roberts
2004-01-24 10:25 ` Eli Zaretskii
2004-03-21 16:47 ` command and doco for valgrind Nick Roberts
2004-03-21 16:56 ` Eli Zaretskii
2004-03-22 18:27 ` Nick Roberts
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=9743-Sat10Jan2004143440+0200-eliz@elta.co.il \
--to=eliz@elta.co.il \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.