disable ZY1000's UART forwarding test code.

[openocd] / doc / manual / main.txt

diff --git a/doc/manual/main.txt b/doc/manual/main.txt
index f4111ca4cea8c39862e6a419188d6005aebd2484..b9430b6df6c0a39aaeecff653b92c76f489a3eb1 100644 (file)
--- a/doc/manual/main.txt
+++ b/doc/manual/main.txt
@@ -1,14 +1,32 @@
 /** @mainpage OpenOCD Reference Manual
 
 /** @mainpage OpenOCD Reference Manual
 

-@ref oocd explains how the code has been organized into layers
-of APIs and gives an overview of how they fit together.  These pages
-attempt to give developers a high-level perspective of the various
-code modules provided by OpenOCD.
- 
-@ref primer provide introductory materials for new developers.
+Welcome to the OpenOCD Reference Manual -- the developer's resource for
+learning about the internal architecture of the OpenOCD project. @par

 
 

-The List of @ref thelist enumerates opportunities for improving or
-extending the OpenOCD platform.
+In addition, this document contains the tactical and strategic plans
+and processes that have been developed by and for the OpenOCD community.
+
+Developers that want to contribute to OpenOCD should read the following
+sections before starting work:
+
+- The List of @subpage thelist enumerates opportunities for improving or
+extending the OpenOCD platform.  If your ideas are on The List, you might
+check the mailing list archives to find the status of your feature (or bug).
+- The @subpage styleguide provides rules that developers should
+  follow when writing new code for OpenOCD.
+- The @subpage patchguide provides policies that developers should
+  follow when submitting patches to the project.
+- The @subpage bugs page contains the content of the BUGS file, which
+  provides instructions for submitting bug reports to the maintainers.
+- The @subpage releases page describes the project's release process.
+
+@ref primer provide introductory materials for new developers on various
+specific topics.
+
+Finally, the @ref oocd pages explain how the code has been organized
+into layers of APIs, providing an overview of how they fit together.
+These pages attempt to give developers a high-level perspective of the
+various code modules provided by OpenOCD.

 
  */
 
 
  */
 


@@ -18,9 +36,23 @@ This pages lists Technical Primers available for OpenOCD Developers.
 They seek to provide information to pull novices up the learning curves
 associated with the fundamental technologies used by OpenOCD.
 
 They seek to provide information to pull novices up the learning curves
 associated with the fundamental technologies used by OpenOCD.
 

+- @subpage primerpatches
+- @subpage primerdocs
+- @subpage primerautotools

 - @subpage primertcl
 - @subpage primerjtag
 
 - @subpage primertcl
 - @subpage primerjtag
 

+These 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.
+
+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
+information contained in one or more @ref styleguide, or they will
+directly refer to specific style guides as supplemental reading.
+

 Contributions or suggestions for new Technical Primers are welcome.
 
  */
 Contributions or suggestions for new Technical Primers are welcome.
 
  */


@@ -37,9 +69,10 @@ modules are stacked in the current implementation (from bottom to top):
   - @ref helpercommand
   - @ref helperlogging
 - @subpage jtagdocs
   - @ref helpercommand
   - @ref helperlogging
 - @subpage jtagdocs

-  - @ref jtagcable
-  - @ref jtagtap
-  - @ref jtagmdriver
+  - @ref jtagcore
+  - @ref jtagtcl
+  - @ref jtagcmd
+  - @ref jtagiface

   - @ref jtagdriver
 - @subpage targetdocs
   - @ref targetarm
   - @ref jtagdriver
 - @subpage targetdocs
   - @ref targetarm