gdb: fix documentation of gdbarch_displaced_step_copy_insn
authorSimon Marchi <simon.marchi@efficios.com>
Mon, 29 Jun 2020 15:27:40 +0000 (11:27 -0400)
committerSimon Marchi <simon.marchi@efficios.com>
Mon, 29 Jun 2020 15:27:46 +0000 (11:27 -0400)
commit19b187a978c5229578ca20627c23eb2b3553f24b
tree6cedff92eafa97785f8ca9b14f37c51d6b09e9bf
parentdf5b8876083ec8c7bfb44ecb91b516c864edebfd
gdb: fix documentation of gdbarch_displaced_step_copy_insn

I spotted something that looks wrong in the doc of
gdbarch_displaced_step_copy_insn.

It says that if the function returns NULL, it means that it has emulated
the behavior of the instruction and written the result to REGS.
However, it says below that the function may return NULL to indicate
that the instruction can't be single-stepped out-of-line, in which case
the core steps the instruction in-line.  The two are contradictory.

The right one is the latter, if the function returns NULL, the core
falls back to in-line stepping. I checked all the implementations of
this function and they all agree with this.

gdb/ChangeLog:

* gdbarch.sh (displaced_step_copy_insn): Update doc.
* gdbarch.h: Re-generate.

Change-Id: I98163cdd38970cde4c77680e249b10f5d2d5bf9b
gdb/ChangeLog
gdb/gdbarch.h
gdb/gdbarch.sh