Move scripting overview from source tree to doxygen manual.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1852 b42882b7-edfa-0310-969c-e2dbd0fdcd60
__archive__
zwelch 2009-05-20 08:16:50 +00:00
parent 64faff8f9c
commit 2cca6fcb8b
1 changed files with 10 additions and 10 deletions

View File

@ -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 It is not the intention that normal OpenOCD users will
use tcl scripting extensively, write lots of clever scripts, use tcl scripting extensively, write lots of clever scripts,
or contribute back to OpenOCD. or contribute back to OpenOCD.
The scripting support is intended for developers of OpenOCD.
Target scripts can contain new procedures that end users may Target scripts can contain new procedures that end users may
tinker to their needs without really understanding tcl. 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 great in an embedded environment and Øyvind Harboe
had experience with it. had experience with it.
Uses of scripting @section Uses of scripting
=================
Default implementation of procedures in tcl/procedures.tcl. Default implementation of procedures in tcl/procedures.tcl.
- Polymorphic commands for target scripts. - Polymorphic commands for target scripts.
@ -54,8 +52,8 @@ Default implementation of procedures in tcl/procedures.tcl.
be simpler. be simpler.
External scripting @section External scripting
==================
The embedded Jim Tcl interpreter in OpenOCD is very limited The embedded Jim Tcl interpreter in OpenOCD is very limited
compared to any full scale PC hosted scripting language. 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 Basically a PC version of startup.tcl. Patches most
gratefully accepted! :-) gratefully accepted! :-)
*/