aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/main.txt
AgeCommit message (Collapse)AuthorFilesLines
2022-08-27doc: how to use QEMU to test big-endian buildAntonio Borneo1-0/+2
Document the process of using buildroot to build a big-endian binary of OpenOCD and using QEMU User Mode Emulation for running the big-endian binary on a little-endian host PC. Change-Id: Ic5fe26e353a4cf69e57af3c23ae7fa4b25347b2b Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: https://review.openocd.org/c/openocd/+/6968 Tested-by: jenkins Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
2021-02-03doc/manual: Fix @subpage handlingYasushi SHOJI1-1/+1
The subpage "thelist" used to have a title "Pending and Open Tasks" but the commit c41db358a0100ab changed it to "The List". With @subpage, it now renders: "The List of The List enumerates opportunities for" instead of "The List of Pending and Open Tasks enumerates opportunities for" This commit fix it to "The List enumerates opportunities for" Change-Id: Ifee0dcd9b3c9f7e651a8748a7afda99eedea3c5c Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com> Reviewed-on: http://openocd.zylin.com/6041 Tested-by: jenkins Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
2013-03-13doc: Added MIPS target documentDrasko DRASKOVIC1-0/+1
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
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>
2009-11-13add documention for writing built-in commandsZachary T Welch1-1/+7
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-07-02Commit first draft of release process documentation.zwelch1-0/+1
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-03Add architectural introduction to the JTAG module in The Manual.zwelch1-3/+3
git-svn-id: svn://svn.berlios.de/openocd/trunk@2024 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-06-03Add draft of Patching Primer in The Manual; update primer page.zwelch1-0/+12
git-svn-id: svn://svn.berlios.de/openocd/trunk@2021 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-27Numerous minor updates and fixes for The Manual:zwelch1-1/+1
- 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-27Link new Primer pages into the main list of Primers.zwelch1-0/+2
git-svn-id: svn://svn.berlios.de/openocd/trunk@1923 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-23Update main page of doxygen developer documentation:zwelch1-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
2009-05-20Add new TCL Primer under the main Technical Primer page.zwelch1-0/+1
git-svn-id: svn://svn.berlios.de/openocd/trunk@1856 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-15Add current draft of The List of Pending and Open Tasks.zwelch1-4/+12
git-svn-id: svn://svn.berlios.de/openocd/trunk@1791 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-14Several minor fixes for the new doxygen manual.zwelch1-2/+2
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.zwelch1-0/+12
git-svn-id: svn://svn.berlios.de/openocd/trunk@1776 b42882b7-edfa-0310-969c-e2dbd0fdcd60
2009-05-13Commit skeleton files for high-level developer manual using doxygen.zwelch1-0/+45
git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
generated by cgit v1.1 at 2024-09-18 08:38:10 +0000