You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

100 lines
3.4 KiB

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