zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some minor URL fixes and typo fixes, no functional changes. 

Change-Id: Ib262d9e6330c35d26868942b821de7b53e00b854
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Reviewed-on: http://openocd.zylin.com/1859
Tested-by: jenkins
Reviewed-by: Bill Traynor <btraynor@gmail.com>
Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
__archive__
Robert P. J. Day 2014-01-09 11:09:48 -05:00 committed by Spencer Oliver
parent 215c41c017
commit e4b5e8fb02
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/manual/helper.txt
View File

@ -23,7 +23,7 @@ portability API.
The Jim API provides access to a small-footprint TCL implementation. The Jim API provides access to a small-footprint TCL implementation.
Visit http://jim.berlios.de/ for more information on Jim. Visit http://jim.tcl.tk/ for more information on Jim.
This section needs to be expanded to describe OpenOCD's Jim API. This section needs to be expanded to describe OpenOCD's Jim API.
@ -33,8 +33,8 @@ This section needs to be expanded to describe OpenOCD's Jim API.
OpenOCD's command API allows modules to register callbacks that are then OpenOCD's command API allows modules to register callbacks that are then
available to the scripting services. It provides the mechanism for available to the scripting services. It provides the mechanism for
these commands to be dispatched to the modlue using a standard these commands to be dispatched to the module using a standard
interfaces. It provides macros for defining functions that use and interface. It provides macros for defining functions that use and
extend this interface. extend this interface.
@section helpercmdhandler Command Handlers @section helpercmdhandler Command Handlers
@ -46,7 +46,7 @@ another layer of handlers.
@subsection helpercmdhandlerdef Defining and Calling Command Handlers @subsection helpercmdhandlerdef Defining and Calling Command Handlers
These functions should be defined using the @c COMMAND_HANDLER macro. These functions should be defined using the @c COMMAND_HANDLER macro.
These methods must be defined as static, as their principle entry point These methods must be defined as static, as their principal entry point
should be the run_command dispatch mechanism. should be the run_command dispatch mechanism.
Command helper functions that require access to the full set of Command helper functions that require access to the full set of
@ -56,7 +56,7 @@ among several files (e.g. @c s3c24xx_nand.h).
Both types of routines must be called using the @c CALL_COMMAND_HANDLER macro. Both types of routines must be called using the @c CALL_COMMAND_HANDLER macro.
Calls using this macro to normal handlers require the name of the command Calls using this macro to normal handlers require the name of the command
handler (which can a name or function pointer). Calls to helpers and handler (which can be a name or function pointer). Calls to helpers and
derived handlers must pass those extra parameters specified by their derived handlers must pass those extra parameters specified by their
definitions; however, lexical capture is used for the core parameters. definitions; however, lexical capture is used for the core parameters.
This dirty trick is being used as a stop-gap measure while the API is This dirty trick is being used as a stop-gap measure while the API is
@ -69,7 +69,7 @@ handlers or helpers:
- @c COMMAND_HANDLER - declare or define a command handler. - @c COMMAND_HANDLER - declare or define a command handler.
- @c COMMAND_HELPER - declare or define a derived command handler or helper. - @c COMMAND_HELPER - declare or define a derived command handler or helper.
- @c CALL_COMMAND_COMMAND - call a command handler/helper. - @c CALL_COMMAND_HANDLER - call a command handler/helper.
@subsection helpercmdhandlermacros Command Handler Macros @subsection helpercmdhandlermacros Command Handler Macros
@ -119,7 +119,7 @@ added in the same context as the other commands in the array.
@section helpercmdprimer Command Development Primer @section helpercmdprimer Command Development Primer
This @ref primercommand provides details about the @c hello module, This @ref primercommand provides details about the @c hello module,
showing how the pieces desrcribed on this page fit together. showing how the pieces described on this page fit together.
*/ */