doc: add missing reg command argument 'force'

The argument 'force' enables a user to bypass the internal cache and read
a target register directly. However it is missing from the user guide.

Change-Id: I26f689eec20b38a0dc5294626b25df566b554446
Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk>
Reviewed-on: http://openocd.zylin.com/1897
Tested-by: jenkins
This commit is contained in:
Spencer Oliver 2014-01-24 12:43:41 +00:00
parent 698eaf9896
commit 47d4224d48
2 changed files with 6 additions and 4 deletions

View File

@ -6372,7 +6372,7 @@ various operations. The current target may be changed
by using @command{targets} command with the name of the
target which should become current.
@deffn Command reg [(number|name) [value]]
@deffn Command reg [(number|name) [(value|'force')]]
Access a single register by @var{number} or by its @var{name}.
The target must generally be halted before access to CPU core
registers is allowed. Depending on the hardware, some other
@ -6386,6 +6386,8 @@ which are also dirty (and will be written back later)
are flagged as such.
@emph{With number/name}: display that register's value.
Use @var{force} argument to read directly from the target,
bypassing any internal cache.
@emph{With both number/name and value}: set register's value.
Writes may be held in a writeback cache internal to OpenOCD,

View File

@ -5871,9 +5871,9 @@ static const struct command_registration target_exec_command_handlers[] = {
.name = "reg",
.handler = handle_reg_command,
.mode = COMMAND_EXEC,
.help = "display or set a register; with no arguments, "
"displays all registers and their values",
.usage = "[(register_name|register_number) [value]]",
.help = "display (reread from target with \"force\") or set a register; "
"with no arguments, displays all registers and their values",
.usage = "[(register_number|register_name) [(value|'force')]]",
},
{
.name = "poll",