- added svn props for newly added files
authorntfreak <ntfreak@b42882b7-edfa-0310-969c-e2dbd0fdcd60>
Fri, 4 Jul 2008 17:49:45 +0000 (17:49 +0000)
committerntfreak <ntfreak@b42882b7-edfa-0310-969c-e2dbd0fdcd60>
Fri, 4 Jul 2008 17:49:45 +0000 (17:49 +0000)
git-svn-id: svn://svn.berlios.de/openocd/trunk@752 b42882b7-edfa-0310-969c-e2dbd0fdcd60

src/scripting.txt

index dd70616552ebb7faac2329105bbfad330df401fb..fa7b94c3fc9bd58acf2b3f86cf844ec72eebeb02 100644 (file)
@@ -1,48 +1,48 @@
-Plan for hosted scripting support in OpenOCD\r
-============================================\r
-Jim Tcl support in OpenOCD currently exists as a patch.\r
-\r
-There has been some discussion on the list as to what\r
-purpose scripting support might serve in OpenOCD.\r
-\r
-Also Lua was proposed as a scripting language, but \r
-only Jim Tcl has been forwarded as a patch.\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
-Default implementation of procedures in tcl/procedures.tcl.\r
-\r
-- Polymorphic commands for target scripts.\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
-    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
-    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
+Plan for hosted scripting support in OpenOCD
+============================================
+Jim Tcl support in OpenOCD currently exists as a patch.
+
+There has been some discussion on the list as to what
+purpose scripting support might serve in OpenOCD.
+
+Also Lua was proposed as a scripting language, but 
+only Jim Tcl has been forwarded as a patch.
+
+Tcl is also backwards syntax compatible with OpenOCD 
+commands.
+
+What scripting will not do
+==========================
+It is not the intention that normal OpenOCD users will
+use tcl scripting extensively, write lots of clever scripts,
+or contribute back to OpenOCD. 
+
+The scripting support is intended for developers of OpenOCD.
+
+Target scripts can contain new procedures that end users may
+tinker to their needs without really understanding tcl.
+
+Since end users are not expected to mess with the scripting
+language, the choice of language is not terribly important
+to those same end users.
+
+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 <productionfile> <serialnumber>. 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 consit 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 & 
+    tms is handled.
+- replace some parts of the current command line handler.
+  This is only to simplify the implementation of OpenOCD
+  and will have no externally visible consequences.
+  Tcl has an advantage in that it's syntax is backwards
+  compatible with the current OpenOCD syntax.