git.gag.com Git - fw/openocd/blob - doc/manual/main.txt

   1 /** @mainpage OpenOCD Reference Manual
   2
   3 Welcome to the OpenOCD Reference Manual -- the developer's resource for
   4 learning about the internal architecture of the OpenOCD project.
   5
   6 In addition, this document contains the tactical and strategic plans
   7 and processes that have been devleoped by and for the community.
   8
   9 Developers that want to contribute to OpenOCD should read the following
  10 sections before starting work:
  11
  12 - The List of @subpage thelist enumerates opportunities for improving or
  13 extending the OpenOCD platform.  If your ideas are on The List, you might
  14 check the mailing list archives to find the status of your feature (or bug).
  15 - The @subpage styleguide provides rules that developers should
  16   follow when writing new code for OpenOCD.
  17 - The @subpage patchguide provides policies that developers should
  18   follow when submitting patches to the project.
  19 - The @subpage bugs page contains the content of the BUGS file, which
  20   provides instructions for submitting bug reports to the maintainers.
  21
  22 @ref primer provide introductory materials for new developers on various
  23 specific topics.
  24
  25 Finally, the @ref oocd pages explain how the code has been organized
  26 into layers of APIs, providing an overview of how they fit together.
  27 These pages attempt to give developers a high-level perspective of the
  28 various code modules provided by OpenOCD.
  29
  30  */
  31
  32 /** @page primer OpenOCD Technical Primers
  33
  34 This pages lists Technical Primers available for OpenOCD Developers.
  35 They seek to provide information to pull novices up the learning curves
  36 associated with the fundamental technologies used by OpenOCD.
  37
  38 - @subpage primerdocs
  39 - @subpage primerautotools
  40 - @subpage primertcl
  41 - @subpage primerjtag
  42
  43 Contributions or suggestions for new Technical Primers are welcome.
  44
  45  */
  46
  47 /** @page oocd OpenOCD Architecture
  48
  49 The OpenOCD library consists of several APIs that build together to
  50 provide the support functionality.  The following list shows how these
  51 modules are stacked in the current implementation (from bottom to top):
  52
  53 - @subpage helperdocs
  54   - @ref helperporting
  55   - @ref helperjim
  56   - @ref helpercommand
  57   - @ref helperlogging
  58 - @subpage jtagdocs
  59   - @ref jtagcable
  60   - @ref jtagtap
  61   - @ref jtagmdriver
  62   - @ref jtagdriver
  63 - @subpage targetdocs
  64   - @ref targetarm
  65   - @ref targetnotarm
  66   - @ref targetregister
  67   - @ref targetimage
  68   - @ref targettrace
  69 - @subpage flashdocs
  70   - @ref flashcfi
  71   - @ref flashnand
  72   - @ref flashtarget
  73 - @subpage serverdocs
  74   - @ref servergdb
  75   - @ref servertelnet
  76   - @ref serverhttp
  77 - @subpage appdocs
  78
  79 Obviously, there are some nuances to the stack that are not shown by
  80 this linear list of layers.
  81
  82 The List of @ref thelist enumerates opportunities for improving or
  83 extending the OpenOCD platform.
  84
  85  */