drivers/bcm2835gpio: Fully restore GPIOs after use

[fw/openocd] / doc / manual / primer / docs.txt

diff --git a/doc/manual/primer/docs.txt b/doc/manual/primer/docs.txt
index c21a0b5b700b282dd90bb72b5e134b26030ea027..b1c0531375b3579ae5f087bb9af3fb11655a34cc 100644 (file)
--- 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.
@@ -19,7 +19,7 @@ OpenOCD presently produces several kinds of documentation:
   - See @subpage primerlatex and @ref stylelatex.
 - The Manual:
   - Focuses on developing the OpenOCD software.
-  - Details the architecutre, driver interfaces, and processes.
+  - Details the architecture, driver interfaces, and processes.
   - Provides "full" coverage of C source code (work-in-progress).
   - Written using Doxygen C language conventions (i.e. in comments).
   - Created with 'make doxygen'.
@@ -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.
@@ -88,7 +90,7 @@ provide detailed documentation for each option.
 To support out-of-tree building of the documentation, the @c Doxyfile.in
 @c INPUT values will have all instances of the string @c "@srcdir@"
 replaced with the current value of the make variable
-<code>$(srcdir)</code>.  The Makefile uses a rule to convert 
+<code>$(srcdir)</code>.  The Makefile uses a rule to convert
 @c Doxyfile.in into the @c Doxyfile used by <code>make doxygen</code>.
 
 @section primerdoxyoocd OpenOCD Input Files
@@ -103,7 +105,7 @@ that can be found under the @c doc/manual directory in the project tree.
 New files containing valid Doxygen markup that are placed in or under
 that directory will be detected and included in The Manual automatically.
 
-@section primerdoxyman Doxygen Reference Manual 
+@section primerdoxyman Doxygen Reference Manual
 
 The full documentation for Doxygen can be referenced on-line at the project
 home page: http://www.doxygen.org/index.html.  In HTML versions of this