auracaster/openocd
3
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add documention for writing built-in commands

Browse Source 
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.
This commit is contained in:
Zachary T Welch
2009-11-11 01:31:34 -08:00
parent 89870c86e7
commit ebbc762182
3 changed files with 163 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/manual/main.txt
View File

@@ -42,11 +42,17 @@ associated with the fundamental technologies used by OpenOCD.
- @subpage primertcl
- @subpage primerjtag
These documents should bridge any "ancillary" gaps in contributor
The above documents should bridge any "ancillary" gaps in contributor
knowledge, without having to learn the complete languages or technology.
They should provide enough information for experienced developers to
learn how to make "correct" changes when creating patches.
Beyond the fundamentals, the following primers provide introductory
tutorials for OpenOCD's sub-systems. These complement the @ref oocd
pages that provide more high-level perspective on related topics.
- @subpage primercommand
In all cases, these Primers should use idiomatic conventions that the
community has agreed are the "right way of doing things". In this
respect, these documents typically assume some familiarity with the