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

doc: [2/3] uniform the texinfo syntax for commands definition 

To avoid errors in the documentation, like the one fixed by change
http://openocd.zylin.com/6134/ , use a uniform notation across the
file so simple copy-paste will work.

Enclose every Command within curly-brackets '{...}', even single
word commands.
Patch generated through:
	sed -i 's/^\(@deffn {Command} \)\([^{][^ ]*\)/\1{\2}/' doc/openocd.texi
	sed -i 's/^\(@deffnx {Command} \)\([^{][^ ]*\)/\1{\2}/' doc/openocd.texi

Change-Id: I797e8d9f5ab0aa1936f350b340d3bdd52373f5aa
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/6151
Tested-by: jenkins
This commit is contained in:
Antonio Borneo 2021-04-06 23:31:32 +02:00
parent 7c4458fe28
commit d4eecfaab5
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
doc/openocd.texi
View File

@ -2115,7 +2115,7 @@ If you disable all access through TCP/IP, you will need to
use the command line @option{-pipe} option. use the command line @option{-pipe} option.
@anchor{gdb_port} @anchor{gdb_port}
@deffn {Command} gdb_port [number] @deffn {Command} {gdb_port} [number]
@cindex GDB server @cindex GDB server
Normally gdb listens to a TCP/IP port, but GDB can also Normally gdb listens to a TCP/IP port, but GDB can also
communicate via pipes(stdin/out or named pipes). The name communicate via pipes(stdin/out or named pipes). The name
@ -2148,7 +2148,7 @@ gdb (with 'set remotetimeout') is recommended. An insufficient timeout may
cause initialization to fail with "Unknown remote qXfer reply: OK". cause initialization to fail with "Unknown remote qXfer reply: OK".
@end deffn @end deffn
@deffn {Command} tcl_port [number] @deffn {Command} {tcl_port} [number]
Specify or query the port used for a simplified RPC Specify or query the port used for a simplified RPC
connection that can be used by clients to issue TCL commands and get the connection that can be used by clients to issue TCL commands and get the
output from the Tcl engine. output from the Tcl engine.
@ -2158,7 +2158,7 @@ the port @var{number} defaults to 6666.
When specified as "disabled", this service is not activated. When specified as "disabled", this service is not activated.
@end deffn @end deffn
@deffn {Command} telnet_port [number] @deffn {Command} {telnet_port} [number]
Specify or query the Specify or query the
port on which to listen for incoming telnet connections. port on which to listen for incoming telnet connections.
This port is intended for interaction with one human through TCL commands. This port is intended for interaction with one human through TCL commands.
@ -2177,7 +2177,7 @@ The ones listed here are static and global.
@xref{targetevents,,Target Events}, about configuring target-specific event handling. @xref{targetevents,,Target Events}, about configuring target-specific event handling.
@anchor{gdbbreakpointoverride} @anchor{gdbbreakpointoverride}
@deffn {Command} gdb_breakpoint_override [@option{hard}|@option{soft}|@option{disable}] @deffn {Command} {gdb_breakpoint_override} [@option{hard}|@option{soft}|@option{disable}]
Force breakpoint type for gdb @command{break} commands. Force breakpoint type for gdb @command{break} commands.
This option supports GDB GUIs which don't This option supports GDB GUIs which don't
distinguish hard versus soft breakpoints, if the default OpenOCD and distinguish hard versus soft breakpoints, if the default OpenOCD and
@ -2220,7 +2220,7 @@ Set to @option{enable} to cause OpenOCD to send the target descriptions to gdb v
The default behaviour is @option{enable}. The default behaviour is @option{enable}.
@end deffn @end deffn
@deffn {Command} gdb_save_tdesc @deffn {Command} {gdb_save_tdesc}
Saves the target description file to the local file system. Saves the target description file to the local file system.
The file name is @i{target_name}.xml. The file name is @i{target_name}.xml.
@ -2265,7 +2265,7 @@ to the various active targets.
There is a command to manage and monitor that polling, There is a command to manage and monitor that polling,
which is normally done in the background. which is normally done in the background.
@deffn {Command} poll [@option{on}|@option{off}] @deffn {Command} {poll} [@option{on}|@option{off}]
Poll the current target for its current state. Poll the current target for its current state.
(Also, @pxref{targetcurstate,,target curstate}.) (Also, @pxref{targetcurstate,,target curstate}.)
If that target is in debug mode, architecture If that target is in debug mode, architecture
@ -3598,19 +3598,19 @@ When a board has a reset button connected to SRST line it will
probably have hardware debouncing, implying you should use this. probably have hardware debouncing, implying you should use this.
@end deffn @end deffn
@deffn {Command} jtag_ntrst_assert_width milliseconds @deffn {Command} {jtag_ntrst_assert_width} milliseconds
Minimum amount of time (in milliseconds) OpenOCD should wait Minimum amount of time (in milliseconds) OpenOCD should wait
after asserting nTRST (active-low JTAG TAP reset) before after asserting nTRST (active-low JTAG TAP reset) before
allowing it to be deasserted. allowing it to be deasserted.
@end deffn @end deffn
@deffn {Command} jtag_ntrst_delay milliseconds @deffn {Command} {jtag_ntrst_delay} milliseconds
How long (in milliseconds) OpenOCD should wait after deasserting How long (in milliseconds) OpenOCD should wait after deasserting
nTRST (active-low JTAG TAP reset) before starting new JTAG operations. nTRST (active-low JTAG TAP reset) before starting new JTAG operations.
@end deffn @end deffn
@anchor{reset_config} @anchor{reset_config}
@deffn {Command} reset_config mode_flag ... @deffn {Command} {reset_config} mode_flag ...
This command displays or modifies the reset configuration This command displays or modifies the reset configuration
of your combination of JTAG board and target in target of your combination of JTAG board and target in target
configuration scripts. configuration scripts.
@ -4446,7 +4446,7 @@ foreach t [target names] @{
@c yep, "target list" would have been better. @c yep, "target list" would have been better.
@c plus maybe "target setdefault". @c plus maybe "target setdefault".
@deffn {Command} targets [name] @deffn {Command} {targets} [name]
@emph{Note: the name of this command is plural. Other target @emph{Note: the name of this command is plural. Other target
command names are singular.} command names are singular.}
@ -8032,11 +8032,11 @@ port is 5555.
@section Server Commands @section Server Commands
@deffn {Command} exit @deffn {Command} {exit}
Exits the current telnet session. Exits the current telnet session.
@end deffn @end deffn
@deffn {Command} help [string] @deffn {Command} {help} [string]
With no parameters, prints help text for all commands. With no parameters, prints help text for all commands.
Otherwise, prints each helptext containing @var{string}. Otherwise, prints each helptext containing @var{string}.
Not every command provides helptext. Not every command provides helptext.
@ -8047,7 +8047,7 @@ In most cases, no such restriction is listed; this indicates commands
which are only available after the configuration stage has completed. which are only available after the configuration stage has completed.
@end deffn @end deffn
@deffn {Command} sleep msec [@option{busy}] @deffn {Command} {sleep} msec [@option{busy}]
Wait for at least @var{msec} milliseconds before resuming. Wait for at least @var{msec} milliseconds before resuming.
If @option{busy} is passed, busy-wait instead of sleeping. If @option{busy} is passed, busy-wait instead of sleeping.
(This option is strongly discouraged.) (This option is strongly discouraged.)
@ -8055,7 +8055,7 @@ Useful in connection with script files
(@command{script} command and @command{target_name} configuration). (@command{script} command and @command{target_name} configuration).
@end deffn @end deffn
@deffn {Command} shutdown [@option{error}] @deffn {Command} {shutdown} [@option{error}]
Close the OpenOCD server, disconnecting all clients (GDB, telnet, Close the OpenOCD server, disconnecting all clients (GDB, telnet,
other). If option @option{error} is used, OpenOCD will return a other). If option @option{error} is used, OpenOCD will return a
non-zero exit code to the parent process. non-zero exit code to the parent process.
@ -8075,7 +8075,7 @@ or its replacement will be automatically executed before OpenOCD exits.
@end deffn @end deffn
@anchor{debuglevel} @anchor{debuglevel}
@deffn {Command} debug_level [n] @deffn {Command} {debug_level} [n]
@cindex message level @cindex message level
Display debug level. Display debug level.
If @var{n} (from 0..4) is provided, then set it to that level. If @var{n} (from 0..4) is provided, then set it to that level.
@ -8091,7 +8091,7 @@ file (which is normally the server's standard output).
@xref{Running}. @xref{Running}.
@end deffn @end deffn
@deffn {Command} echo [-n] message @deffn {Command} {echo} [-n] message
Logs a message at "user" priority. Logs a message at "user" priority.
Output @var{message} to stdout. Output @var{message} to stdout.
Option "-n" suppresses trailing newline. Option "-n" suppresses trailing newline.
@ -8100,16 +8100,16 @@ echo "Downloading kernel -- please wait"
@end example @end example
@end deffn @end deffn
@deffn {Command} log_output [filename | "default"] @deffn {Command} {log_output} [filename | "default"]
Redirect logging to @var{filename} or set it back to default output; Redirect logging to @var{filename} or set it back to default output;
the default log output channel is stderr. the default log output channel is stderr.
@end deffn @end deffn
@deffn {Command} add_script_search_dir [directory] @deffn {Command} {add_script_search_dir} [directory]
Add @var{directory} to the file/script search path. Add @var{directory} to the file/script search path.
@end deffn @end deffn
@deffn {Command} bindto [@var{name}] @deffn {Command} {bindto} [@var{name}]
Specify hostname or IPv4 address on which to listen for incoming Specify hostname or IPv4 address on which to listen for incoming
TCP/IP connections. By default, OpenOCD will listen on the loopback TCP/IP connections. By default, OpenOCD will listen on the loopback
interface only. If your network environment is safe, @code{bindto interface only. If your network environment is safe, @code{bindto
@ -8130,7 +8130,7 @@ various operations. The current target may be changed
by using @command{targets} command with the name of the by using @command{targets} command with the name of the
target which should become current. target which should become current.
@deffn {Command} reg [(number|name) [(value|'force')]] @deffn {Command} {reg} [(number|name) [(value|'force')]]
Access a single register by @var{number} or by its @var{name}. Access a single register by @var{number} or by its @var{name}.
The target must generally be halted before access to CPU core The target must generally be halted before access to CPU core
registers is allowed. Depending on the hardware, some other registers is allowed. Depending on the hardware, some other
@ -8169,8 +8169,8 @@ Debug and trace infrastructure:
@end example @end example
@end deffn @end deffn
@deffn {Command} halt [ms] @deffn {Command} {halt} [ms]
@deffnx {Command} wait_halt [ms] @deffnx {Command} {wait_halt} [ms]
The @command{halt} command first sends a halt request to the target, The @command{halt} command first sends a halt request to the target,
which @command{wait_halt} doesn't. which @command{wait_halt} doesn't.
Otherwise these behave the same: wait up to @var{ms} milliseconds, Otherwise these behave the same: wait up to @var{ms} milliseconds,
@ -8204,19 +8204,19 @@ power consumption (because the CPU is needlessly clocked).
@end deffn @end deffn
@deffn {Command} resume [address] @deffn {Command} {resume} [address]
Resume the target at its current code position, Resume the target at its current code position,
or the optional @var{address} if it is provided. or the optional @var{address} if it is provided.
OpenOCD will wait 5 seconds for the target to resume. OpenOCD will wait 5 seconds for the target to resume.
@end deffn @end deffn
@deffn {Command} step [address] @deffn {Command} {step} [address]
Single-step the target at its current code position, Single-step the target at its current code position,
or the optional @var{address} if it is provided. or the optional @var{address} if it is provided.
@end deffn @end deffn
@anchor{resetcommand} @anchor{resetcommand}
@deffn {Command} reset @deffn {Command} {reset}
@deffnx {Command} {reset run} @deffnx {Command} {reset run}
@deffnx {Command} {reset halt} @deffnx {Command} {reset halt}
@deffnx {Command} {reset init} @deffnx {Command} {reset init}
@ -8237,7 +8237,7 @@ The other options will not work on all systems.
@end itemize @end itemize
@end deffn @end deffn
@deffn {Command} soft_reset_halt @deffn {Command} {soft_reset_halt}
Requesting target halt and executing a soft reset. This is often used Requesting target halt and executing a soft reset. This is often used
when a target cannot be reset and halted. The target, after reset is when a target cannot be reset and halted. The target, after reset is
released begins to execute code. OpenOCD attempts to stop the CPU and released begins to execute code. OpenOCD attempts to stop the CPU and
@ -8293,10 +8293,10 @@ Please use their TARGET object siblings to avoid making assumptions
about what TAP is the current target, or about MMU configuration. about what TAP is the current target, or about MMU configuration.
@end enumerate @end enumerate
@deffn {Command} mdd [phys] addr [count] @deffn {Command} {mdd} [phys] addr [count]
@deffnx {Command} mdw [phys] addr [count] @deffnx {Command} {mdw} [phys] addr [count]
@deffnx {Command} mdh [phys] addr [count] @deffnx {Command} {mdh} [phys] addr [count]
@deffnx {Command} mdb [phys] addr [count] @deffnx {Command} {mdb} [phys] addr [count]
Display contents of address @var{addr}, as Display contents of address @var{addr}, as
64-bit doublewords (@command{mdd}), 64-bit doublewords (@command{mdd}),
32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}), 32-bit words (@command{mdw}), 16-bit halfwords (@command{mdh}),
@ -8310,10 +8310,10 @@ If @var{count} is specified, displays that many units.
see the @code{mem2array} primitives.) see the @code{mem2array} primitives.)
@end deffn @end deffn
@deffn {Command} mwd [phys] addr doubleword [count] @deffn {Command} {mwd} [phys] addr doubleword [count]
@deffnx {Command} mww [phys] addr word [count] @deffnx {Command} {mww} [phys] addr word [count]
@deffnx {Command} mwh [phys] addr halfword [count] @deffnx {Command} {mwh} [phys] addr halfword [count]
@deffnx {Command} mwb [phys] addr byte [count] @deffnx {Command} {mwb} [phys] addr byte [count]
Writes the specified @var{doubleword} (64 bits), @var{word} (32 bits), Writes the specified @var{doubleword} (64 bits), @var{word} (32 bits),
@var{halfword} (16 bits), or @var{byte} (8-bit) value, @var{halfword} (16 bits), or @var{byte} (8-bit) value,
at the specified address @var{addr}. at the specified address @var{addr}.
@ -11162,7 +11162,7 @@ type target_state state [state-name]
type target_reset mode [reset-mode] type target_reset mode [reset-mode]
@end verbatim @end verbatim
@deffn {Command} tcl_notifications [on/off] @deffn {Command} {tcl_notifications} [on/off]
Toggle output of target notifications to the current Tcl RPC server. Toggle output of target notifications to the current Tcl RPC server.
Only available from the Tcl RPC server. Only available from the Tcl RPC server.
Defaults to off. Defaults to off.
@ -11181,7 +11181,7 @@ Target trace data is emitted as a Tcl associative array in the following format.
type target_trace data [trace-data-hex-encoded] type target_trace data [trace-data-hex-encoded]
@end verbatim @end verbatim
@deffn {Command} tcl_trace [on/off] @deffn {Command} {tcl_trace} [on/off]
Toggle output of target trace data to the current Tcl RPC server. Toggle output of target trace data to the current Tcl RPC server.
Only available from the Tcl RPC server. Only available from the Tcl RPC server.
Defaults to off. Defaults to off.