summaryrefslogtreecommitdiff
path: root/src/scripting.txt
diff options
context:
space:
mode:
authoroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2008-07-10 06:44:11 +0000
committeroharboe <oharboe@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2008-07-10 06:44:11 +0000
commit313547ddd66b3dc7a8f1c6261621d26939d9d524 (patch)
treefdfda9f246967fbe47ad0c9fd8043d5e9cbf5bf4 /src/scripting.txt
parent92beb99bf75192621a04b8190ea2353ea91f6d6d (diff)
downloadopenocd+libswd-313547ddd66b3dc7a8f1c6261621d26939d9d524.tar.gz
openocd+libswd-313547ddd66b3dc7a8f1c6261621d26939d9d524.tar.bz2
openocd+libswd-313547ddd66b3dc7a8f1c6261621d26939d9d524.tar.xz
openocd+libswd-313547ddd66b3dc7a8f1c6261621d26939d9d524.zip
very slight cleanup of flash banks handling.
git-svn-id: svn://svn.berlios.de/openocd/trunk@782 b42882b7-edfa-0310-969c-e2dbd0fdcd60
Diffstat (limited to 'src/scripting.txt')
-rw-r--r--src/scripting.txt26
1 files changed, 16 insertions, 10 deletions
diff --git a/src/scripting.txt b/src/scripting.txt
index fa7b94c3..059bc85a 100644
--- a/src/scripting.txt
+++ b/src/scripting.txt
@@ -1,15 +1,5 @@
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
==========================
@@ -26,6 +16,10 @@ 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.
+Jim Tcl was chosen as it was easy to integrate, works
+great in an embedded environment and Øyvind Harboe
+had experience with it.
+
Uses of scripting
=================
Default implementation of procedures in tcl/procedures.tcl.
@@ -46,3 +40,15 @@ Default implementation of procedures in tcl/procedures.tcl.
and will have no externally visible consequences.
Tcl has an advantage in that it's syntax is backwards
compatible with the current OpenOCD syntax.
+- external scripting. Low level tcl functions will be defined
+ 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
+ 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. \ No newline at end of file