Several minor fixes for the new doxygen manual.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1789 b42882b7-edfa-0310-969c-e2dbd0fdcd60

diff --git a/doc/manual/jtag.txt b/doc/manual/jtag.txt
index b2e5b194680649a8f3a075070708fc264f894ff3..3c8a181ca5619c2c081f8e64aa3a32ffb311f2d6 100644 (file)
--- a/doc/manual/jtag.txt
+++ b/doc/manual/jtag.txt
@@ -1,7 +1,7 @@
 /** @page jtagdocs OpenOCD JTAG APIs
 
-This document contains @subpage jtagprimer, which introduces the
-IEEE JTAG interface.
+For new developers unfamiliar with the technology, @ref primerjtag provides
+a brief introduction to the IEEE JTAG interface.
 
 The OpenOCD JTAG library API covers several functional areas:
 

diff --git a/doc/manual/main.txt b/doc/manual/main.txt
index d574927219adad9fa6fa3efb1098b985c28dad9b..be1460b3edf8558154bbbf171db16d5cdc2ef43d 100644 (file)
--- a/doc/manual/main.txt
+++ b/doc/manual/main.txt
@@ -7,9 +7,9 @@ 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.
 

diff --git a/doc/manual/primer/jtag.txt b/doc/manual/primer/jtag.txt
index 9563729059a7f7bd1d100c186698b83de43400ae..c12e266fba605111789290091e6ec2402868f86c 100644 (file)
--- a/doc/manual/primer/jtag.txt
+++ b/doc/manual/primer/jtag.txt
@@ -30,10 +30,10 @@ between TDI and TDO.  The second diagram shows the state transitions on
 TMS which will select different shift registers.
 
 The first thing you need to do is reset the state machine, because when 
-you connect to a chip you dont know what state the jtag is in,you need 
+you connect to a chip you do not know what state the controller is in,you need 
 to clock TMS as 1, at least 7 times.  This will put you into "Test Logic 
 Reset" State.  Knowing this, you can, once reset, then track what each 
-transition on TMS will do, and hence know what state the jtag state 
+transition on TMS will do, and hence know what state the JTAG state 
 machine is in.
 
 There are 2 "types" of shift registers.  The Instruction shift register 
@@ -47,7 +47,7 @@ instruction register.
 
 For example, one of the data registers will be known as "bypass" this is 
 (usually) a single bit which has no function and is used to bypass the 
-chip.  Eg, assume we have 3 identical chips, wired up like the picture 
+chip.  Assume we have 3 identical chips, wired up like the picture 
 and each has a 3 bit instruction register, and there are 2 known 
 instructions (110 = bypass, 010 = some other function) if we want to use 
 "some other function", on the second chip in the line, and not change 
@@ -88,7 +88,8 @@ TDI (holding TMS to 0):
 
   0 1 0 1 0 1 1 1 1 0
 
-Again, we are clocking the lsbit first.  Then we would clock TMS:
+Again, we are clocking the least-significant bit first.  Then we would
+clock TMS:
 
   1 1 0