aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/primer
AgeCommit message (Collapse)Author
2019-05-14helper/command: change prototype of command_print/command_print_samelineAntonio Borneo
To prepare for handling TCL return values consistently, all calls to command_print/command_print_sameline should switch to CMD as first parameter. Change prototype of command_print() and command_print_sameline() to pass CMD instead of CMD_CTX. Since the first parameter is currently not used, the change can be done though scripts without manual coding. This patch is created using the command: sed -i PATTERN $(find src/ doc/ -type f) with all the following patters: 's/\(command_print(cmd\)->ctx,/\1,/' 's/\(command_print(CMD\)_CTX,/\1,/' 's/\(command_print(struct command_\)context \*context,/\1invocation *cmd,/' 's/\(command_print_sameline(cmd\)->ctx,/\1,/' 's/\(command_print_sameline(CMD\)_CTX,/\1,/' 's/\(command_print_sameline(struct command_\)context \*context,/\1invocation *cmd,/' This change is inspired by http://openocd.zylin.com/1815 from Paul Fertser but is now done through scripting. Change-Id: I3386d8f96cdc477e7a2308dd18269de3bed04385 Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/5081 Tested-by: jenkins Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
2018-05-09doc: fix several typos within manual documentsAntonio Borneo
Mostly trivial fixes spotted by spell checker Change-Id: I3af693faf5506c866e2abe253a0e37aea3c4d284 Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/4510 Tested-by: jenkins Reviewed-by: Christopher Head <chead@zaber.com> Reviewed-by: Matthias Welwarsky <matthias@welwarsky.de>
2013-07-15configure: remove AM_MAINTAINER_MODE, effectively always enabling all the rulesPaul Fertser
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 Oliver
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
2012-01-18doc: Update patch procedureTimo Ketola
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>
2011-10-12docs: update project url'sSpencer Oliver
Change-Id: I54fc3aff722ed25143aad85e58d19b72fcecbba0 Signed-off-by: Spencer Oliver <ntfreak@users.sourceforge.net>
2010-05-15comments on doc/manual/primer/jtag.txtJun Ma
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-01-08Doc/examples: clarify usage messagesDavid Brownell
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 Borneo
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-25update command handler documentationZachary T Welch
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 Welch
Improve the developer manual and primer sections which talk about writing command handlers. Notably, it documents the new CMD_* macros.
2009-11-13add documention for writing built-in commandsZachary T Welch
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-10-08Change most in-tree references from SVN to GIT.dbrownell
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-09-21Remove annoying end-of-line whitespace from doc/* files.dbrownell
git-svn-id: svn://svn.berlios.de/openocd/trunk@2744 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-07-08Add microscopic style guide at the end of the PATCH primer.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2501 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-18David Brownell <david-b@pacbell.net>:zwelch
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-07Fix reference warning in JTAG primer, add another external reference.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2101 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-03Improve remaining documentation that was causing Doxygen warnings.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2026 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-03Add draft of Patching Primer in The Manual; update primer page.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@2021 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-31Add new JTAG boundary scan primer, with links to BSDL information.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1954 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27Numerous minor updates and fixes for The Manual:zwelch
- 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
2009-05-27Add Documentation Primer to The Manual.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1922 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27Add draft of Autotools Primer to The Manual.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1921 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-20Move TCL overview from source tree to doxygen manual.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1855 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-14Several minor fixes for the new doxygen manual.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1789 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13Add JTAG Primer to doxygen manual, contributed by Strontium.zwelch
git-svn-id: svn://svn.berlios.de/openocd/trunk@1776 b42882b7-edfa-0310-969c-e2dbd0fdcd60
generated by cgit v1.2.3-18-g5258 (git 2.32.0) at 2025-08-06 19:29:21 +0000