diff options
| author | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-05-23 22:52:47 +0000 |
|---|---|---|
| committer | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-05-23 22:52:47 +0000 |
| commit | 08d5f114c959876ee2eac2baa2de18a459ef2b6a (patch) | |
| tree | 2ad80bd3203ca952491419567a850697df4f05cf | |
| parent | 31316364922b42fb7c9a43856a2d21e0781cdf7a (diff) | |
| download | openocd+libswd-08d5f114c959876ee2eac2baa2de18a459ef2b6a.tar.gz openocd+libswd-08d5f114c959876ee2eac2baa2de18a459ef2b6a.tar.bz2 openocd+libswd-08d5f114c959876ee2eac2baa2de18a459ef2b6a.tar.xz openocd+libswd-08d5f114c959876ee2eac2baa2de18a459ef2b6a.zip | |
Update main page of doxygen developer documentation:
- Rewrite copy to give a better introduction and overview.
- Add subpages: The List, Style Guide, Patch Policies, and Bug Reporting.
git-svn-id: svn://svn.berlios.de/openocd/trunk@1897 b42882b7-edfa-0310-969c-e2dbd0fdcd60
| -rw-r--r-- | doc/manual/main.txt | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/doc/manual/main.txt b/doc/manual/main.txt index f4111ca4..0a0e43cd 100644 --- a/doc/manual/main.txt +++ b/doc/manual/main.txt @@ -1,14 +1,31 @@ /** @mainpage OpenOCD Reference Manual -@ref oocd explains how the code has been organized into layers -of APIs and gives an overview of how they fit together. These pages -attempt to give developers a high-level perspective of the various -code modules provided by OpenOCD. - -@ref primer provide introductory materials for new developers. +Welcome to the OpenOCD Reference Manual -- the developer's resource for +learning about the internal architecture of the OpenOCD project. -The List of @ref thelist enumerates opportunities for improving or -extending the OpenOCD platform. +In addition, this document contains the tactical and strategic plans +and processes that have been devleoped by and for the community. + +Developers that want to contribute to OpenOCD should read the following +sections before starting work: + +- The List of @subpage thelist enumerates opportunities for improving or +extending the OpenOCD platform. If your ideas are on The List, you might +check the mailing list archives to find the status of your feature (or bug). +- The @subpage styleguide provides rules that developers should + follow when writing new code for OpenOCD. +- The @subpage patchguide provides policies that developers should + 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. + +@ref primer provide introductory materials for new developers on various +specific topics. + +Finally, the @ref oocd pages explain how the code has been organized +into layers of APIs, providing an overview of how they fit together. +These pages attempt to give developers a high-level perspective of the +various code modules provided by OpenOCD. */ |