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