cfg: ftdi icdi enable srst open drain config

[fw/openocd] / doc / manual / main.txt

diff --git a/doc/manual/main.txt b/doc/manual/main.txt
index e25cae67654b3d487625363dbce9b920b46a4efb..93dd3da01f2c5f9ef6d2abc814aa824697021ea1 100644 (file)
--- a/doc/manual/main.txt
+++ b/doc/manual/main.txt
@@ -1,7 +1,7 @@
-/** @mainpage OpenOCD Reference Manual
+/** @mainpage OpenOCD Developer's Guide
 
-Welcome to the OpenOCD Reference Manual -- the developer's resource for
-learning about the internal architecture of the OpenOCD project.
+Welcome to the OpenOCD Developer's Guide -- the developer's resource for
+learning about the internal architecture of the OpenOCD project. @par
 
 In addition, this document contains the tactical and strategic plans
 and processes that have been developed by and for the OpenOCD community.
@@ -18,6 +18,7 @@ check the mailing list archives to find the status of your feature (or bug).
   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.
@@ -40,6 +41,23 @@ associated with the fundamental technologies used by OpenOCD.
 - @subpage primertcl
 - @subpage primerjtag
 
+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
+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.
 
  */
@@ -56,9 +74,10 @@ modules are stacked in the current implementation (from bottom to top):
   - @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