X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fmanual%2Fscripting.txt;h=f8764e2d7c2b5a6008f8c6e226278489b2d9df51;hp=e62cba6df42c76f5b494d08d743e9929c7fe8d07;hb=f21c12abecb9df244f147740166378ede7ea398e;hpb=2cca6fcb8b8d58c27ad8517952f5c24c70801e2a diff --git a/doc/manual/scripting.txt b/doc/manual/scripting.txt index e62cba6df4..f8764e2d7c 100644 --- a/doc/manual/scripting.txt +++ b/doc/manual/scripting.txt @@ -1,11 +1,11 @@ -/** @page scripting OpenOCD Scripting Overview +/** @page scripting Scripting Overview -@section What scripting will not do +@section scriptingisnt What scripting will not do The scripting support is intended for developers of OpenOCD. It is not the intention that normal OpenOCD users will use tcl scripting extensively, write lots of clever scripts, -or contribute back to OpenOCD. +or contribute back to OpenOCD. Target scripts can contain new procedures that end users may tinker to their needs without really understanding tcl. @@ -15,23 +15,23 @@ language, the choice of language is not terribly important to those same end users. Jim Tcl was chosen as it was easy to integrate, works -great in an embedded environment and Øyvind Harboe +great in an embedded environment and Øyvind Harboe had experience with it. -@section Uses of scripting +@section scriptinguses Uses of scripting Default implementation of procedures in tcl/procedures.tcl. - Polymorphic commands for target scripts. - there will be added some commands in Tcl that the target scripts can replace. - - produce . Default implementation + - produce \ \. Default implementation is to ignore serial number and write a raw binary file to beginning of first flash. Target script can dictate file format and structure of serialnumber. Tcl allows an argument to consist of e.g. a list so the structure of the serial number is not limited to a single string. - - reset handling. Precise control of how srst, trst & + - reset handling. Precise control of how srst, trst & tms is handled. - replace some parts of the current command line handler. This is only to simplify the implementation of OpenOCD @@ -42,17 +42,17 @@ Default implementation of procedures in tcl/procedures.tcl. that return machine readable output. These low level tcl functions constitute the tcl api. flash_banks is such a low level tcl proc. "flash banks" is an example of - a command that has human readable output. The human - readable output is expected to change inbetween versions + a command that has human readable output. The human + readable output is expected to change in between versions of OpenOCD. The output from flash_banks may not be in the preferred form for the client. The client then has two choices a) parse the output from flash_banks or b) write a small piece of tcl to output the flash_banks output to a more suitable form. The latter may be simpler. - - -@section External scripting + + +@section scriptingexternal External scripting The embedded Jim Tcl interpreter in OpenOCD is very limited compared to any full scale PC hosted scripting language.