Re: [Bug win32/14529] Make gdb capable of JIT-debugging on W32

[Eli Zaretskii <eliz@gnu.org>]

> Date: Sat, 29 Sep 2012 23:32:31 +0400
> From: LRN <lrn1986@gmail.com>
> 
> > First, please use "MS-Windows" instead of "W32".
> OK, although it might not be technically correct. I have no idea
> whether ReactOS implements this debugging facility or not, but if it
> does, then it is not right to name it "MS-Windows", since ReactOS is
> neither MS, nor Windows.
> I usually use "W32", because most of the time doing something with
> WinAPI means interacting with Win32 subsystem, which, as i've
> mentioned above, [is not/will not be] implemented exclusively by Windows.
> Now, since GNU folks frown upon "win" in Win32, and naming it Woe32
> sounds weird to me, i just use "W32".

W32 is not an acronym known to users.  We can use "Windows API", if
you think this is more accurate.

> +@kindex signal-event
> +@item signal-event @var{id}
> +This command signals an event with user-provided @var{id}. Used to resume
                                                            ^^

Please use 2 spaces between sentences.

> +To use it, create or edit the following keys in
> +@code{HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\AeDebug} and/or
> +@code{HKLM\SOFTWARE\Wow6432Node\Microsoft\Windows NT\CurrentVersion\AeDebug}
> +(for x86_64 versions):
> +
> +@itemize @minus
> +@item
> +Debugger (REG_SZ)

"Debugger" should be in @code{}.

>  - a command to launch the debugger. Suggested command is:
   ^

Three dashes here, "---", so that in print there will be a nice
em-dash character.  One dash is typeset as a minus sign, not what you
wanted.

> +<fully-qualified-path-to-gdb.exe> -ex "attach %ld" -ex "signal-event %ld"
> +-ex "c"

The command should be in @code, and it should use @var for something
the user should substitute.  Like this:

 Suggested command: @code{@var{absolute-file-name-of-gdb.exe} -ex
 "attach %ld" -ex "signal-event %ld" -ex "continue"}.

> +First %ld will be replaced by process ID, second %ld will be replaced by ID
> +of the event that blocks the crashing process, waiting for debugger to attach.

Please put the %ld in @code{}.

> +@item
> +Auto (REG_SZ) - either @code{1} or @code{0}. @code{1} will make the system run

"Auto" should be in @code{}.

> +debugger specified by Debugger key automatically, @code{0} will cause a dialog
> +box with "OK" and "Cancel" buttons to appear, which allows the user to either
> +terminate crashing process (OK) or debug it (Cancel).

Please use ``OK'' and ``Cancel'', not double quotes, for better looks
in print.

The documentation patch is OK with those changes.

Thanks.