summaryrefslogtreecommitdiff
path: root/doc/manual/primer
diff options
context:
space:
mode:
authorzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-06-18 00:29:33 +0000
committerzwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60>2009-06-18 00:29:33 +0000
commit8ab9b6d39eb2f17e7367b48855736ae73ad8360f (patch)
treee94a183f7f4ea178369bcf32e01e9873724dedb4 /doc/manual/primer
parent1a400f8b8e9942c73d02c82dda13403a343e1335 (diff)
downloadopenocd_libswd-8ab9b6d39eb2f17e7367b48855736ae73ad8360f.tar.gz
openocd_libswd-8ab9b6d39eb2f17e7367b48855736ae73ad8360f.tar.bz2
openocd_libswd-8ab9b6d39eb2f17e7367b48855736ae73ad8360f.tar.xz
openocd_libswd-8ab9b6d39eb2f17e7367b48855736ae73ad8360f.zip
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
Diffstat (limited to 'doc/manual/primer')
-rw-r--r--doc/manual/primer/docs.txt10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/manual/primer/docs.txt b/doc/manual/primer/docs.txt
index c21a0b5b..d478d81c 100644
--- a/doc/manual/primer/docs.txt
+++ b/doc/manual/primer/docs.txt
@@ -3,7 +3,7 @@
This page provides an introduction to OpenOCD's documentation processes.
OpenOCD presently produces several kinds of documentation:
-- The Guide:
+- The User's Guide:
- Focuses on using the OpenOCD software.
- Details the installation, usage, and customization.
- Provides descriptions of public Jim/TCL script commands.
@@ -31,13 +31,15 @@ contribute new or updated documentation to the OpenOCD project.
*/
/** @page primertexinfo Texinfo Primer
-The OpenOCD User Guide presently exists entirely within the
+The OpenOCD User's Guide presently exists entirely within the
doc/openocd.texi document. That file contains documentation with
mark-up suitable for being parsed by the GNU Texinfo utilities
(http://www.gnu.org/software/texinfo/).
-This section needs to be expanded to provide an overview to new
-developers.
+When you add a new command, driver, or driver option, it needs to be
+documented in the User's Guide. Use the existing documentation for
+models, but feel free to make better use of Texinfo mechanisms. See
+the Texinfo web site for the Texinfo manual and more information.
OpenOCD style guidelines for Texinfo documentation can be found on the
@ref styletexinfo page.