aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
AgeCommit message (Collapse)AuthorFilesLines
2016-11-06Remove since long deprecated ft2232 driverAndreas Fritiofson1-1/+1
Purge all legacy interface configurations so there's no more confusion over which one to use. Also remove doc/INSTALL.txt which mentions ft2232 but otherwise just duplicates what INSTALL says. Change-Id: Ic94f808f123d4917e600b79309f1272c78a7bb11 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/3236 Tested-by: jenkins Reviewed-by: Andreas Färber <afaerber@suse.de> Reviewed-by: Freddie Chopin <freddie.chopin@gmail.com>
2016-05-24Make #include guard naming consistentMarc Schink1-0/+19
Change-Id: Ie13e8af0bb74ed290f811dcad64ad06c9d8cb4fa Signed-off-by: Marc Schink <openocd-dev@marcschink.de> Reviewed-on: http://openocd.zylin.com/2956 Tested-by: jenkins Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2014-01-11Some minor URL fixes and typo fixes, no functional changes.Robert P. J. Day1-7/+7
Change-Id: Ib262d9e6330c35d26868942b821de7b53e00b854 Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-on: http://openocd.zylin.com/1859 Tested-by: jenkins Reviewed-by: Bill Traynor <btraynor@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2013-07-15configure: remove AM_MAINTAINER_MODE, effectively always enabling all the rulesPaul Fertser1-20/+0
There're strong arguments against using this macro (mostly regarding build consistency), so remove it altogether. Change-Id: I90c8e9a86a24571019366435bd868a6799a09c45 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/1476 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
2013-07-01doxygen: use inline jtag state maching imageSpencer Oliver2-2/+1
The currently used image is 404 so use an inline image instead. Change-Id: I56a0d187fd06dc2c5c370e6532d89815ccec63d6 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/1451 Tested-by: jenkins
2013-05-02dev-doc: fix to release process docsFreddie Chopin1-2/+2
Change-Id: I916e7ff1af211baef1c6d56fd44d292ee6983599 Signed-off-by: Freddie Chopin <freddie.chopin@gmail.com> Reviewed-on: http://openocd.zylin.com/1368 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2013-03-13doc: Added MIPS target documentDrasko DRASKOVIC3-0/+538
This document explains MIPS EJTAG operations implementations within OpenOCD. Change-Id: Ieaf01f8bc5a97d7b0f2c847bac5fbb2ccf8ba088 Signed-off-by: Drasko DRASKOVIC <drasko.draskovic@gmail.com> Reviewed-on: http://openocd.zylin.com/904 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2012-04-04docs: remove unused primer refSpencer Oliver1-1/+0
we already have a link to the patch primer in the main index. Change-Id: Ib90ade76a17f5d99da8fe481d8f87c68eca38f1c Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/546 Tested-by: jenkins
2012-03-30docs: update release docs to use configure.acSpencer Oliver1-7/+7
Change-Id: I7b52ad1c3744a82832c5b55898bf47607e24d03e Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/538 Tested-by: jenkins
2012-01-18doc: Update patch procedureTimo Ketola1-172/+0
Change-Id: I3e50357b4ddaf483712bbac68b6427b31529f666 Signed-off-by: Timo Ketola <timo@exertus.fi> Reviewed-on: http://openocd.zylin.com/387 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2012-01-09docs: fix doxygen buildSpencer Oliver1-2/+2
This fixes issues with newer versions of doxygen Change-Id: Id5d3287857cb154e26064b4ce37f6b72117d5254 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/350 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com>
2011-11-10docs: remove berlios related infoSpencer Oliver1-10/+2
Change-Id: I9593eb165fce51411f20fa068e324b3fd882cdb3 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/190 Tested-by: jenkins
2011-10-12docs: update project url'sSpencer Oliver2-1/+6
Change-Id: I54fc3aff722ed25143aad85e58d19b72fcecbba0 Signed-off-by: Spencer Oliver <ntfreak@users.sourceforge.net>
2011-09-02Implementation of a new jtag remote_bitbang driver.Richard Uhler1-0/+53
The driver sends ascii encoded bitbang commands over unix sockets or TCP to another process. This driver is useful for debugging software running on processors which are being simulated.
2010-11-15httpd: retire this serverØyvind Harboe1-14/+0
this never panned out and there are enough mistakes in the code that probably nobody used this. Use the tcl server and implement a standalone http app instead works fine. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2010-05-15comments on doc/manual/primer/jtag.txtJun Ma1-10/+6
1. fix some errors in jtag.txt(in my personal opinion, please review). 2. remove a broken link Signed-off-by: Jun Ma <sync.jma@gmail.com> Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2010-03-05doc: not all debug adapters are "dongles"David Brownell1-4/+4
Talk more about "debug adapters" instead of only "dongles". Not all adapters are discrete widgets; some are integrated onto boards. If we only talk about "dongles" we rule out many valid setups, and help confuse some users (who may be using Dongle-free environments). Also start bringing out the point that JTAG isn't the only transport protocol, even though OpenOCD historically presumes "all is JTAG". (Not all debug adapters are JTAG adapters, or JTAG-only adapters.) Plus a few minor fixes (spelling etc) in the vicinity of those changes, and updates about FT2232H clocking issues (they can go faster than the older chips, and can support adaptive clocking). Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2010-02-21Developer's Guide: refresh release proceduresDavid Brownell1-44/+99
Be a closer match to what I've actually done for the past few cycles. In particular, hold off pushing repository updates until after the packages are published, as part of opening the merge window, and mention the utility commands which actually create the archives. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2010-02-06Re-title Developer's GuideDavid Brownell1-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>
2010-01-08Doc/examples: clarify usage messagesDavid Brownell2-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>
2009-12-30whitespace cleanup, mostly for docsAntonio Borneo3-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>
2009-11-26styleguide: add some embedded style rules.Øyvind Harboe1-0/+3
Embedded and pthreads rely on modest and predictable stack usage. Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
2009-11-25update command handler documentationZachary T Welch2-18/+83
Adds sections on command registration and chaining, giving an overview to developers that want to use these features.
2009-11-17update command_handler documentationZachary T Welch2-21/+22
Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-13update developer manual for new typesZachary T Welch2-5/+6
Update the style guide and chase obvious references to structures that have been renamed.
2009-11-13add documention for writing built-in commandsZachary T Welch3-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.
2009-11-04Release docs: fix notesDavid Brownell1-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.
2009-11-04Doc: fix broken linkDavid Brownell1-1/+1
Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-04Other files: stop referring to ChangeLog tooDavid Brownell1-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>
2009-11-04Tweak release docsDavid Brownell1-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>
2009-10-27Rewrite release script to use GIT.Zachary T Welch1-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.
2009-10-08Change most in-tree references from SVN to GIT.dbrownell4-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
2009-10-07Change version labels to work better with GITdbrownell1-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
2009-09-30Update release process documentation.zwelch1-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
2009-09-30Document and automate signature creation for the release archives.zwelch1-1/+2
git-svn-id: svn://svn.berlios.de/openocd/trunk@2783 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-09-29httpd smoketest infooharboe1-1/+10
git-svn-id: svn://svn.berlios.de/openocd/trunk@2769 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-09-28spelling fixoharboe1-1/+1
git-svn-id: svn://svn.berlios.de/openocd/trunk@2766 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-09-21Remove annoying end-of-line whitespace from doc/* files.dbrownell12-89/+89
git-svn-id: svn://svn.berlios.de/openocd/trunk@2744 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-17Andreas Fritiofson <andreas.fritiofson@gmail.com> UTF8 fixesoharboe1-1/+1
git-svn-id: svn://svn.berlios.de/openocd/trunk@2549 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-08Add style rule to avoid combining assignment and logical tests.zwelch1-0/+14
git-svn-id: svn://svn.berlios.de/openocd/trunk@2503 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-08Add microscopic style guide at the end of the PATCH primer.zwelch1-0/+13
git-svn-id: svn://svn.berlios.de/openocd/trunk@2501 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-06Update Release Script documentation to reflect current implementation.zwelch1-7/+16
git-svn-id: svn://svn.berlios.de/openocd/trunk@2476 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-06The late birth of the NEWS file also caused me to revisit the releasezwelch1-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
2009-07-04Major update to release process documentation:zwelch1-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
2009-07-02Commit first draft of release process documentation.zwelch2-0/+123
git-svn-id: svn://svn.berlios.de/openocd/trunk@2453 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-01Minor fixes to Developer Manual pages.zwelch1-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
2009-06-18Update Style Guide documentation to explain basic type rules.zwelch1-0/+7
git-svn-id: svn://svn.berlios.de/openocd/trunk@2284 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-18David Brownell <david-b@pacbell.net>:zwelch2-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
2009-06-09Provide brief description of newly factored TCL layer in The Manual.zwelch1-0/+11
git-svn-id: svn://svn.berlios.de/openocd/trunk@2150 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-07Fix reference warning in JTAG primer, add another external reference.zwelch1-1/+7
git-svn-id: svn://svn.berlios.de/openocd/trunk@2101 b42882b7-edfa-0310-969c-e2dbd0fdcd60
generated by cgit v1.1 at 2024-09-10 06:21:13 +0000