Paul Eggert <eggert@cs.ucla.edu> writes:

> On 2025-08-02 13:10, Jeremy Bryant wrote:
>> Would the following clarification be clearer from your perspective?
>>         doc: /* Trap execution flow and hand over control to GDB.
>> To use, set up a breakpoint in GDB with
>> break Fdebugger_trap
>> This is done in the Emacs source distribution in src/.gdbinit.
>> The function itself is a do-nothing primitive.  It is reserved for
>> debugging purposes, and not called by Emacs otherwise.  */)
>
> Yes, thanks. Some minor wording tweaks, which make it easier for me to
> understand:
>
> Trap execution flow and hand over control to GDB. The Emacs source
> file src/.gdbinit uses this via the GDB command "break Fdebugger
> trap".
>
> This function has no effect.  It is reserved for debugging, and is not
> called by Emacs otherwise.

OK, revised patch attached for consideration.

The change is in the docstring, incorporating your suggestion, Paul, as
well as the addition proposed by Jim, at the end.

What do people think of this change now?



Extract of patch for the docstring:-

DEFUN ("debugger-trap", Fdebugger_trap, Sdebugger_trap, 0, 0, "",
       doc: /* Trap execution flow and hand over control to GDB.
The Emacs source file src/.gdbinit uses this via the GDB command
"break Fdebugger_trap".

This function has no effect.  It is reserved for debugging, and is not
called by Emacs otherwise.

For Lisp debugging see debug, as well as edebug, in the manual:
"(elisp) Debugging".  */)
  (void)
{
  return Qnil;
}