Add new JTAG boundary scan primer, with links to BSDL information.

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

diff --git a/doc/manual/main.txt b/doc/manual/main.txt
index d574927219adad9fa6fa3efb1098b985c28dad9b..e25cae67654b3d487625363dbce9b920b46a4efb 100644 (file)
--- a/doc/manual/main.txt
+++ b/doc/manual/main.txt
@@ -1,18 +1,43 @@
 /** @mainpage OpenOCD Reference Manual
 
-The @ref primer page provides 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.
+
+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.
+
+@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.
 
-The @ref oocd page explains how the code has been organized into layers
-of APIs and gives an overview of how they fit together.
- 
  */
 
-/** @page primer OpenOCD Techincal Primers
+/** @page primer OpenOCD Technical Primers
 
-This pages lists Techincal Primers available for OpenOCD Developers.
+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.
 
+- @subpage primerdocs
+- @subpage primerautotools
+- @subpage primertcl
 - @subpage primerjtag
 
 Contributions or suggestions for new Technical Primers are welcome.
@@ -54,4 +79,7 @@ modules are stacked in the current implementation (from bottom to top):
 Obviously, there are some nuances to the stack that are not shown by
 this linear list of layers.
 
+The List of @ref thelist enumerates opportunities for improving or
+extending the OpenOCD platform.
+
  */