X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=doc%2Fmanual%2Fmain.txt;h=c14096b573e0895b3d247173c92d2a24b5e893b0;hp=576c9e1a0552d3dc16c9c22193bcf0243e41f19e;hb=0627e4686aa18159327751361940595e19b0c525;hpb=6c39b5dd52969c1927c5115e24bb8a1fc9555349 diff --git a/doc/manual/main.txt b/doc/manual/main.txt index 576c9e1a05..c14096b573 100644 --- a/doc/manual/main.txt +++ b/doc/manual/main.txt @@ -1,7 +1,7 @@ -/** @mainpage OpenOCD Reference Manual +/** @mainpage OpenOCD Developer's Guide -Welcome to the OpenOCD Reference Manual -- the developer's resource for -learning about the internal architecture of the OpenOCD project. +Welcome to the OpenOCD Developer's Guide -- the developer's resource for +learning about the internal architecture of the OpenOCD project. @par In addition, this document contains the tactical and strategic plans and processes that have been developed by and for the OpenOCD community. @@ -18,6 +18,7 @@ check the mailing list archives to find the status of your feature (or bug). follow when submitting patches to the project. - The @subpage bugs page contains the content of the BUGS file, which provides instructions for submitting bug reports to the maintainers. +- The @subpage releases page describes the project's release process. @ref primer provide introductory materials for new developers on various specific topics. @@ -35,17 +36,22 @@ 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. -- @subpage primerpatches - @subpage primerdocs - @subpage primerautotools - @subpage primertcl - @subpage primerjtag -These documents should bridge any "ancillary" gaps in contributor +The above documents should bridge any "ancillary" gaps in contributor knowledge, without having to learn the complete languages or technology. They should provide enough information for experienced developers to learn how to make "correct" changes when creating patches. +Beyond the fundamentals, the following primers provide introductory +tutorials for OpenOCD's sub-systems. These complement the @ref oocd +pages that provide more high-level perspective on related topics. + +- @subpage primercommand + In all cases, these Primers should use idiomatic conventions that the community has agreed are the "right way of doing things". In this respect, these documents typically assume some familiarity with the @@ -69,12 +75,14 @@ modules are stacked in the current implementation (from bottom to top): - @ref helperlogging - @subpage jtagdocs - @ref jtagcore + - @ref jtagtcl - @ref jtagcmd - @ref jtagiface - @ref jtagdriver - @subpage targetdocs - @ref targetarm - @ref targetnotarm + - @ref targetmips - @ref targetregister - @ref targetimage - @ref targettrace