wip.

git-svn-id: svn://svn.berlios.de/openocd/trunk@737 b42882b7-edfa-0310-969c-e2dbd0fdcd60

diff --git a/src/scripting.txt b/src/scripting.txt
index 7242e73f1701918b0eaa3b7516abb5250138bcdf..dd70616552ebb7faac2329105bbfad330df401fb 100644 (file)
--- a/src/scripting.txt
+++ b/src/scripting.txt
@@ -11,15 +11,38 @@ only Jim Tcl has been forwarded as a patch.
 Tcl is also backwards syntax compatible with OpenOCD \r
 commands.\r
 \r
 Tcl is also backwards syntax compatible with OpenOCD \r
 commands.\r
 \r

+What scripting will not do\r
+==========================\r
+It is not the intention that normal OpenOCD users will\r
+use tcl scripting extensively, write lots of clever scripts,\r
+or contribute back to OpenOCD. \r
+\r
+The scripting support is intended for developers of OpenOCD.\r
+\r
+Target scripts can contain new procedures that end users may\r
+tinker to their needs without really understanding tcl.\r
+\r
+Since end users are not expected to mess with the scripting\r
+language, the choice of language is not terribly important\r
+to those same end users.\r
+\r

 Uses of scripting\r
 =================\r
 Uses of scripting\r
 =================\r

-\r

 Default implementation of procedures in tcl/procedures.tcl.\r
 \r
 - Polymorphic commands for target scripts.\r
 Default implementation of procedures in tcl/procedures.tcl.\r
 \r
 - Polymorphic commands for target scripts.\r

-  - produce <file> <serialnumber>. Default implementation\r
+  - there will be added some commands in Tcl that the target\r
+    scripts can replace.\r
+  - produce <productionfile> <serialnumber>. Default implementation\r

     is to ignore serial number and write a raw binary file\r
     is to ignore serial number and write a raw binary file\r

-    to beginning of first flash. \r
+    to beginning of first flash. Target script can dictate\r
+    file format and structure of serialnumber. Tcl allows\r
+    an argument to consit of e.g. a list so the structure of\r
+    the serial number is not limited to a single string.\r

   - reset handling. Precise control of how srst, trst & \r
   - reset handling. Precise control of how srst, trst & \r

-    tms is handled and when.\r
-  
\ No newline at end of file
+    tms is handled.\r
+- replace some parts of the current command line handler.\r
+  This is only to simplify the implementation of OpenOCD\r
+  and will have no externally visible consequences.\r
+  Tcl has an advantage in that it's syntax is backwards\r
+  compatible with the current OpenOCD syntax.\r