doc/manual/main.txt

   1 /** @mainpage OpenOCD Developer's Guide
   2
   3 Welcome to the OpenOCD Developer's Guide -- the developer's resource for
   4 learning about the internal architecture of the OpenOCD project. @par
   5
   6 In addition, this document contains the tactical and strategic plans
   7 and processes that have been developed by and for the OpenOCD community.
   8
   9 Developers that want to contribute to OpenOCD should read the following
  10 sections before starting work:
  11
  12 - @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 - The @subpage releases page describes the project's release process.
  22 - The @subpage endianness provides hints about writing and testing
  23   endianness independent code for OpenOCD.
  24
  25 @ref primer provide introductory materials for new developers on various
  26 specific topics.
  27
  28 Finally, the @ref oocd pages explain how the code has been organized
  29 into layers of APIs, providing an overview of how they fit together.
  30 These pages attempt to give developers a high-level perspective of the
  31 various code modules provided by OpenOCD.
  32
  33  */
  34
  35 /** @page primer OpenOCD Technical Primers
  36
  37 This pages lists Technical Primers available for OpenOCD Developers.
  38 They seek to provide information to pull novices up the learning curves
  39 associated with the fundamental technologies used by OpenOCD.
  40
  41 - @subpage primerdocs
  42 - @subpage primerautotools
  43 - @subpage primertcl
  44 - @subpage primerjtag
  45
  46 The above documents should bridge any "ancillary" gaps in contributor
  47 knowledge, without having to learn the complete languages or technology.
  48 They should provide enough information for experienced developers to
  49 learn how to make "correct" changes when creating patches.
  50
  51 Beyond the fundamentals, the following primers provide introductory
  52 tutorials for OpenOCD's sub-systems.  These complement the @ref oocd
  53 pages that provide more high-level perspective on related topics.
  54
  55 - @subpage primercommand
  56
  57 In all cases, these Primers should use idiomatic conventions that the
  58 community has agreed are the "right way of doing things".  In this
  59 respect, these documents typically assume some familiarity with the
  60 information contained in one or more @ref styleguide, or they will
  61 directly refer to specific style guides as supplemental reading.
  62
  63 Contributions or suggestions for new Technical Primers are welcome.
  64
  65  */
  66
  67 /** @page oocd OpenOCD Architecture
  68
  69 The OpenOCD library consists of several APIs that build together to
  70 provide the support functionality.  The following list shows how these
  71 modules are stacked in the current implementation (from bottom to top):
  72
  73 - @subpage helperdocs
  74   - @ref helperporting
  75   - @ref helperjim
  76   - @ref helpercommand
  77   - @ref helperlogging
  78 - @subpage jtagdocs
  79   - @ref jtagcore
  80   - @ref jtagtcl
  81   - @ref jtagcmd
  82   - @ref jtagiface
  83   - @ref jtagdriver
  84 - @subpage targetdocs
  85   - @ref targetarm
  86   - @ref targetnotarm
  87   - @ref targetmips
  88   - @ref targetregister
  89   - @ref targetimage
  90   - @ref targettrace
  91 - @subpage flashdocs
  92   - @ref flashcfi
  93   - @ref flashnand
  94   - @ref flashtarget
  95 - @subpage serverdocs
  96   - @ref servergdb
  97   - @ref servertelnet
  98   - @ref serverhttp
  99 - @subpage appdocs
 100
 101 Obviously, there are some nuances to the stack that are not shown by
 102 this linear list of layers.
 103
 104 The List of @ref thelist enumerates opportunities for improving or
 105 extending the OpenOCD platform.
 106
 107  */