ed90b6659f
update command handler documentation
...
Adds sections on command registration and chaining, giving an overview
to developers that want to use these features.
2009-11-25 10:29:06 -08:00
789d47c180
update command_handler documentation
...
Improve the developer manual and primer sections which talk about
writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-17 11:40:21 -08:00
ebbc762182
add documention for writing built-in commands
...
This documentation update provides an introduction to the command
handling facilities provided by command.[ch]. A primer walks the user
through the elements of a pointedly pedantic module: src/hello.c.
A summary of the API is provided in the OpenOCD Architecture section.
2009-11-13 11:02:22 -08:00
03c9e48f88
Change most in-tree references from SVN to GIT.
...
Also, talk about "mainline" not "trunk".
The release.txt and release.sh files need more updates.
git-svn-id: svn://svn.berlios.de/openocd/trunk@2825 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-10-08 00:13:50 +00:00
b11d79110e
Remove annoying end-of-line whitespace from doc/* files.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@2744 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-09-21 18:52:45 +00:00
adae530eb7
Add microscopic style guide at the end of the PATCH primer.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@2501 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-08 22:26:29 +00:00
8ab9b6d39e
David Brownell <david-b@pacbell.net>:
...
Take a whack at providing some texinfo style docs.
Mostly it's just basic "how 2 write sane dox" stuff.
git-svn-id: svn://svn.berlios.de/openocd/trunk@2270 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-18 00:29:33 +00:00
b770ad5b19
Fix reference warning in JTAG primer, add another external reference.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@2101 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-07 23:49:14 +00:00
2d0e1dbc02
Improve remaining documentation that was causing Doxygen warnings.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@2026 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-03 04:44:38 +00:00
003318b911
Add draft of Patching Primer in The Manual; update primer page.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@2021 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-03 02:12:44 +00:00
cc639cc44c
Add new JTAG boundary scan primer, with links to BSDL information.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1954 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-31 00:49:03 +00:00
afa77f8672
Numerous minor updates and fixes for The Manual:
...
- Link Scripting Overview into the TCL Primer; both need more work.
- Remove redundant OpenOCD from Scripting Overview subpage title.
- Fix incorrect tag in Doxygen style guide example.
- Fix minor typo in first introductory paragraph of main page.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1932 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27 15:15:06 +00:00
c71f891f2e
Add Documentation Primer to The Manual.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1922 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27 10:35:20 +00:00
eedfcb2cbe
Add draft of Autotools Primer to The Manual.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1921 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27 10:27:32 +00:00
c46dc5ba2d
Move TCL overview from source tree to doxygen manual.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1855 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20 08:48:19 +00:00
30f6b1ebbc
Several minor fixes for the new doxygen manual.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1789 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-14 22:16:20 +00:00
7626139950
Add JTAG Primer to doxygen manual, contributed by Strontium.
...
git-svn-id: svn://svn.berlios.de/openocd/trunk@1776 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13 11:10:35 +00:00
Zachary T Welch
dbrownell
zwelch