diff options
| author | Zachary T Welch <zw@superlucidity.net> | 2009-11-11 01:31:34 -0800 |
|---|---|---|
| committer | Zachary T Welch <zw@superlucidity.net> | 2009-11-13 11:02:22 -0800 |
| commit | ebbc762182c943d5967ea106933181a2fb726b1b (patch) | |
| tree | 88bb13151fed6b1b4d50a78956684aec6a73a64f /doc/manual/main.txt | |
| parent | 89870c86e7aafd81a5720fcfd30002d24d26b232 (diff) | |
| download | openocd+libswd-ebbc762182c943d5967ea106933181a2fb726b1b.tar.gz openocd+libswd-ebbc762182c943d5967ea106933181a2fb726b1b.tar.bz2 openocd+libswd-ebbc762182c943d5967ea106933181a2fb726b1b.tar.xz openocd+libswd-ebbc762182c943d5967ea106933181a2fb726b1b.zip | |
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.
Diffstat (limited to 'doc/manual/main.txt')
| -rw-r--r-- | doc/manual/main.txt | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/manual/main.txt b/doc/manual/main.txt index b9430b6d..8e764643 100644 --- a/doc/manual/main.txt +++ b/doc/manual/main.txt @@ -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 |