Re: command and doco for valgrind

[Eli Zaretskii]

> From: Nick Roberts <address@hidden>
> 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.