summaryrefslogtreecommitdiff
path: root/doc/manual
Commit message (Collapse)AuthorAgeFilesLines
* Re-title Developer's GuideDavid Brownell2010-02-061-2/+2
| | | | | | | | | | | | The Doxygen output was previously titled "OpenOCD Reference Manual", which was quite misleading ... the User's Guide is the reference manual which folk should consult about how to use the software. Just rename it to match how it's been discussed previously, and to bring out its intended audience: developers of this software. As a rule, Doxygen is only for folk who work with the code it documents. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* Doc/examples: clarify usage messagesDavid Brownell2010-01-082-5/+10
| | | | | | | | Update/bugfix the "hello" example; emphasize using EBNF syntax, matching the User's Guide. Correct the Texinfo style guide to say EBNF, not BNF. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* whitespace cleanup, mostly for docsAntonio Borneo2009-12-303-3/+3
| | | | | | | | Remove useless space/tab at end of lines. Remove spaces in indentation and replace with tab. Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* styleguide: add some embedded style rules.Øyvind Harboe2009-11-261-0/+3
| | | | | | | Embedded and pthreads rely on modest and predictable stack usage. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
* update command handler documentationZachary T Welch2009-11-252-18/+83
| | | | | Adds sections on command registration and chaining, giving an overview to developers that want to use these features.
* update command_handler documentationZachary T Welch2009-11-172-21/+22
| | | | | Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
* update developer manual for new typesZachary T Welch2009-11-132-5/+6
| | | | | Update the style guide and chase obvious references to structures that have been renamed.
* add documention for writing built-in commandsZachary T Welch2009-11-133-2/+163
| | | | | | | | This documentation update provides an introduction to the command handling facilities provided by command.[ch]. A primer walks the user through the elements of a pointedly pedantic module: src/hello.c. A summary of the API is provided in the OpenOCD Architecture section.
* Release docs: fix notesDavid Brownell2009-11-041-7/+12
| | | | | | | | | | | We currently do something unusual: version codes in config.in get updated after the release, which means that "git describe" won't match up to development version labels. Comment that trouble spot. We can fix this by switching away from the major/minor/micro type release numbering, as various other projects have done. The major numbers basically don't tend to change, and doing a good job with micro versions is so annoying that they rarely change either.
* Doc: fix broken linkDavid Brownell2009-11-041-1/+1
| | | | Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* Other files: stop referring to ChangeLog tooDavid Brownell2009-11-041-3/+1
| | | | | | | The ChangeLog idiom is redundant given any decent SCM. Time to phase it out here. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* Tweak release docsDavid Brownell2009-11-041-110/+172
| | | | | | | | | | | | | | | | | | Contrast releases to git snapshot tarballs. Mention that releases have some quality-improvement focus, with special non-"dev" version IDs. Explain more about version IDs, using "openocd -v" to see them, etc; Make release milestone info be less specific about timing, and presume we have both a merge window and an RC stage. Rework the release process information to match reality a bit more closely. Reference the version.sh script (in one place the wrong script was referenced). Bugfix branches get special treatment, while non-bugfix releases are more or less what *defines* being the mainline branch. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
* Rewrite release script to use GIT.Zachary T Welch2009-10-271-136/+62
| | | | | | | | Update documentation to reflect GIT methodology. Rewrite release.sh script to use appropriate process. With this update, tools/release.sh can be used for producing private release tags on local branches. The documentation still needs work, but their use for v0.3.x should help rectify the deficiences.
* Change most in-tree references from SVN to GIT.dbrownell2009-10-084-99/+46
| | | | | | | | | Also, talk about "mainline" not "trunk". The release.txt and release.sh files need more updates. git-svn-id: svn://svn.berlios.de/openocd/trunk@2825 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Change version labels to work better with GITdbrownell2009-10-071-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | - The guess-rev.sh script is now a tweaked version of "setlocalversion" as seen in Linux, U-Boot, and various other projects. When it finds source control support (git, hg, svn) it uses IDs from there. Else (specific to this project) it reports itself as "-snapshot", e.g. from gitweb. I verified this new "guess-rev.sh" script runs under Cygwin. - Also update the generic version strings to be like "0.3.0-dev" (during development) instead of the very long "0.3.0-in-development". These also show up in the PDF docs. For better tracking, we might eventually change these strings to include the version IDs too. - Change the startup banner version strings so they include the guess-rev output. Development and release versions with GIT will be like Open On-Chip Debugger 0.3.0-dev-00282-g7191a4f-dirty (2009-10-05-20:57) Open On-Chip Debugger 0.3.0 (2009-10-05-20:57) instead of the previous SVN-specific (even when using git-svn!) Open On-Chip Debugger 0.3.0-in-development (2009-10-05-01:39) svn:exported Open On-Chip Debugger 0.3.0 (2009-10-05-01:39) Release git-svn-id: svn://svn.berlios.de/openocd/trunk@2809 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Update release process documentation.zwelch2009-09-301-26/+49
| | | | | | | | | - Improve and clarify the wording of the introduction. - Add section on version taggging. - Some other minor corrections. git-svn-id: svn://svn.berlios.de/openocd/trunk@2788 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Document and automate signature creation for the release archives.zwelch2009-09-301-1/+2
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2783 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* httpd smoketest infooharboe2009-09-291-1/+10
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2769 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* spelling fixoharboe2009-09-281-1/+1
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2766 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Remove annoying end-of-line whitespace from doc/* files.dbrownell2009-09-2112-89/+89
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2744 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Andreas Fritiofson <andreas.fritiofson@gmail.com> UTF8 fixesoharboe2009-07-171-1/+1
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2549 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add style rule to avoid combining assignment and logical tests.zwelch2009-07-081-0/+14
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2503 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add microscopic style guide at the end of the PATCH primer.zwelch2009-07-081-0/+13
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2501 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Update Release Script documentation to reflect current implementation.zwelch2009-07-061-7/+16
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2476 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* The late birth of the NEWS file also caused me to revisit the releasezwelch2009-07-061-15/+24
| | | | | | | | | | | | | | | | process once again and reconsider it in some detail. In doing so, some further revisions to the process were required: 1) The URL of the repository is embedded in the released code. - The packages need to be created from the tagged branch. - The URL then points to where to get the tagged code. 2) Improve the instructions for NEWS handling. - NEWS file must be updated for each release; describe that process. - The NEWS file should be archived an recreated for each release. 3) Add detail steps for the berliOS release process. 4) Minor cleanups to release process doxygen markup. git-svn-id: svn://svn.berlios.de/openocd/trunk@2475 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Major update to release process documentation:zwelch2009-07-041-56/+319
| | | | | | | | | | | | - Provide overview of OpenOCD versioning schema. - Outline responsibilities and authority of the release manager. - Explain the need for flexibility in the release schedule. - Add and refine the release process steps. - Include tutorials for using new release script. - Many more improvements, too numerous to list. git-svn-id: svn://svn.berlios.de/openocd/trunk@2462 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Commit first draft of release process documentation.zwelch2009-07-022-0/+123
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2453 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Minor fixes to Developer Manual pages.zwelch2009-07-011-1/+2
| | | | | | | | - Fix cosmetic bug on main page - Add missing JTAG list item. git-svn-id: svn://svn.berlios.de/openocd/trunk@2445 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Update Style Guide documentation to explain basic type rules.zwelch2009-06-181-0/+7
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2284 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* David Brownell <david-b@pacbell.net>:zwelch2009-06-182-6/+102
| | | | | | | | Take a whack at providing some texinfo style docs. Mostly it's just basic "how 2 write sane dox" stuff. git-svn-id: svn://svn.berlios.de/openocd/trunk@2270 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Provide brief description of newly factored TCL layer in The Manual.zwelch2009-06-091-0/+11
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2150 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Fix reference warning in JTAG primer, add another external reference.zwelch2009-06-071-1/+7
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2101 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Improve remaining documentation that was causing Doxygen warnings.zwelch2009-06-032-2/+2
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2026 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add architectural introduction to the JTAG module in The Manual.zwelch2009-06-032-16/+39
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2024 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add draft of Patching Primer in The Manual; update primer page.zwelch2009-06-032-0/+222
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@2021 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add new JTAG boundary scan primer, with links to BSDL information.zwelch2009-05-311-4/+62
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1954 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Numerous minor updates and fixes for The Manual:zwelch2009-05-274-3/+5
| | | | | | | | | | - Link Scripting Overview into the TCL Primer; both need more work. - Remove redundant OpenOCD from Scripting Overview subpage title. - Fix incorrect tag in Doxygen style guide example. - Fix minor typo in first introductory paragraph of main page. git-svn-id: svn://svn.berlios.de/openocd/trunk@1932 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add new Style Guides for languages used (and to be used) by project.zwelch2009-05-271-19/+212
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1924 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Link new Primer pages into the main list of Primers.zwelch2009-05-271-0/+2
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1923 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add Documentation Primer to The Manual.zwelch2009-05-271-0/+122
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1922 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add draft of Autotools Primer to The Manual.zwelch2009-05-271-0/+167
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1921 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add section identifiers to developer scripting introduction.zwelch2009-05-231-3/+3
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1898 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Update main page of doxygen developer documentation:zwelch2009-05-231-8/+25
| | | | | | | | - 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
* Add extended doxygen-based style guide draft; requires more work.zwelch2009-05-231-0/+93
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1896 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add initial OpenOCD server documentation (Duane Ellis and myself).zwelch2009-05-201-1/+287
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1857 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add new TCL Primer under the main Technical Primer page.zwelch2009-05-201-0/+1
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1856 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Move TCL overview from source tree to doxygen manual.zwelch2009-05-201-0/+438
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1855 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Move non-arm target overview from source tree to doxygen manual.zwelch2009-05-202-6/+71
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1853 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Move scripting overview from source tree to doxygen manual.zwelch2009-05-201-0/+80
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1852 b42882b7-edfa-0310-969c-e2dbd0fdcd60
* Add current draft of The List of Pending and Open Tasks.zwelch2009-05-151-4/+12
| | | | git-svn-id: svn://svn.berlios.de/openocd/trunk@1791 b42882b7-edfa-0310-969c-e2dbd0fdcd60
generated by cgit v1.2.3 (git 2.46.0) at 2024-11-20 03:27:40 +0000