aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-05-20 08:16:50 +0000
committerzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-05-20 08:16:50 +0000
commit2cca6fcb8b8d58c27ad8517952f5c24c70801e2a (patch)
tree95222fa25a617ea809ec7540dffc7e14a4e2893d
parent64faff8f9ca599d00807d2df59e8852aaf687fbe (diff)
downloadriscv-openocd-2cca6fcb8b8d58c27ad8517952f5c24c70801e2a.zip
riscv-openocd-2cca6fcb8b8d58c27ad8517952f5c24c70801e2a.tar.gz
riscv-openocd-2cca6fcb8b8d58c27ad8517952f5c24c70801e2a.tar.bz2
Move scripting overview from source tree to doxygen manual.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1852 b42882b7-edfa-0310-969c-e2dbd0fdcd60
-rw-r--r--doc/manual/scripting.txt (renamed from src/scripting.txt)20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/scripting.txt b/doc/manual/scripting.txt
index cc8f597..e62cba6 100644
--- a/src/scripting.txt
+++ b/doc/manual/scripting.txt
@@ -1,14 +1,12 @@
-Plan for hosted scripting support in OpenOCD
-============================================
+/** @page scripting OpenOCD Scripting Overview
-What scripting will not do
-==========================
+@section 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.
-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.
@@ -20,8 +18,8 @@ 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
-=================
+@section Uses of scripting
+
Default implementation of procedures in tcl/procedures.tcl.
- Polymorphic commands for target scripts.
@@ -54,8 +52,8 @@ Default implementation of procedures in tcl/procedures.tcl.
be simpler.
-External scripting
-==================
+@section External scripting
+
The embedded Jim Tcl interpreter in OpenOCD is very limited
compared to any full scale PC hosted scripting language.
@@ -78,3 +76,5 @@ unknown commands to OpenOCD.
Basically a PC version of startup.tcl. Patches most
gratefully accepted! :-)
+
+ */