interesting
/
riscv-openocd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: Group adapter sub-commands 

The commit 5280eb618a fixed all `adapter_khz` and
`adapter_nsrst_*` commands in the doc but missed grouping them.  This
let the commands `adapter speed`, `adapter srst pulse_width`, and
`adapter srst delay` not indexed.

Tell texinfo about adapter sub-commands by grouping them in one.

Change-Id: Ida53c4f5cfe28827320c145c8d501d53e831623c
Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
Reviewed-on: http://openocd.zylin.com/6134
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
This commit is contained in:
Yasushi SHOJI 2021-04-06 18:51:57 +09:00 committed by Antonio Borneo
parent 0f06d94336
commit eb6a5faf6a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/openocd.texi
View File

@ -3415,7 +3415,7 @@ may not be the fastest solution.
instead of @command{adapter speed}, but only for (ARM) cores and boards instead of @command{adapter speed}, but only for (ARM) cores and boards
which support adaptive clocking. which support adaptive clocking.
@deffn {Command} adapter speed max_speed_kHz @deffn Command {adapter speed} max_speed_kHz
A non-zero speed is in KHZ. Hence: 3000 is 3mhz. A non-zero speed is in KHZ. Hence: 3000 is 3mhz.
JTAG interfaces usually support a limited number of JTAG interfaces usually support a limited number of
speeds. The speed actually used won't be faster speeds. The speed actually used won't be faster
@ -3585,13 +3585,13 @@ needing to cope with both architecture and board specific constraints.
@section Commands for Handling Resets @section Commands for Handling Resets
@deffn {Command} adapter srst pulse_width milliseconds @deffn Command {adapter srst pulse_width} milliseconds
Minimum amount of time (in milliseconds) OpenOCD should wait Minimum amount of time (in milliseconds) OpenOCD should wait
after asserting nSRST (active-low system reset) before after asserting nSRST (active-low system reset) before
allowing it to be deasserted. allowing it to be deasserted.
@end deffn @end deffn
@deffn {Command} adapter srst delay milliseconds @deffn Command {adapter srst delay} milliseconds
How long (in milliseconds) OpenOCD should wait after deasserting How long (in milliseconds) OpenOCD should wait after deasserting
nSRST (active-low system reset) before starting new JTAG operations. nSRST (active-low system reset) before starting new JTAG operations.
When a board has a reset button connected to SRST line it will When a board has a reset button connected to SRST line it will