1 /** @mainpage OpenOCD Reference Manual
3 Welcome to the OpenOCD Reference Manual -- the developer's resource for
4 learning about the internal architecture of the OpenOCD project. @par
6 In addition, this document contains the tactical and strategic plans
7 and processes that have been developed by and for the OpenOCD community.
9 Developers that want to contribute to OpenOCD should read the following
10 sections before starting work:
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.
22 @ref primer provide introductory materials for new developers on various
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.
32 /** @page primer OpenOCD Technical Primers
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.
38 - @subpage primerpatches
40 - @subpage primerautotools
44 These 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.
49 In all cases, these Primers should use idiomatic conventions that the
50 community has agreed are the "right way of doing things". In this
51 respect, these documents typically assume some familiarity with the
52 information contained in one or more @ref styleguide, or they will
53 directly refer to specific style guides as supplemental reading.
55 Contributions or suggestions for new Technical Primers are welcome.
59 /** @page oocd OpenOCD Architecture
61 The OpenOCD library consists of several APIs that build together to
62 provide the support functionality. The following list shows how these
63 modules are stacked in the current implementation (from bottom to top):
92 Obviously, there are some nuances to the stack that are not shown by
93 this linear list of layers.
95 The List of @ref thelist enumerates opportunities for improving or
96 extending the OpenOCD platform.