review.openocd Code Review - openocd.git/atom - doc/manual/main.txt history Open On-Chip Debugger https://review.openocd.org/gitweb?p=openocd.git Gerrit favicon.ico gitweb-logo.png 2022-08-27T16:18:17Z gitweb doc: how to use QEMU to test big-endian build 2022-05-05T15:23:49Z Antonio Borneo borneo.antonio@gmail.com Antonio Borneo borneo.antonio@gmail.com 2022-05-05T15:23:49Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=424f9f67964b01ce39c3cedfc2e189770c11a8bc
doc: how to use QEMU to test big-endian build

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>
  • [D] doc/manual/main.txt
doc/manual: Fix @subpage handling 2021-01-28T14:31:41Z Yasushi SHOJI yashi@spacecubics.com Antonio Borneo borneo.antonio@gmail.com 2021-01-28T14:31:41Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=8a2f2993da3601b22640f9e53ed4c586d0f9db20
doc/manual: Fix @subpage handling

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>
  • [D] doc/manual/main.txt
doc: Added MIPS target document 2012-10-07T22:41:36Z Drasko DRASKOVIC drasko.draskovic@gmail.com Spencer Oliver spen@spen-soft.co.uk 2012-10-07T22:41:36Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=8a4835bd267773b82b1ae137b38b8067fc5d07c0
doc: Added MIPS target document

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>
  • [D] doc/manual/main.txt
docs: remove unused primer ref 2012-03-30T21:29:14Z Spencer Oliver spen@spen-soft.co.uk Spencer Oliver spen@spen-soft.co.uk 2012-03-30T21:29:14Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=2c25ab45887b7bf2c1e48ad0fb579095c254cd02
docs: remove unused primer ref

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
  • [D] doc/manual/main.txt
Re-title Developer's Guide 2010-02-07T03:19:25Z David Brownell dbrownell@users.sourceforge.net David Brownell dbrownell@users.sourceforge.net 2010-02-07T03:19:25Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=885a2f5b96697e3aca9a5b9deb855d6d025c5021
Re-title Developer's Guide

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>
  • [D] doc/manual/main.txt
add documention for writing built-in commands 2009-11-11T09:31:34Z Zachary T Welch zw@superlucidity.net Zachary T Welch zw@superlucidity.net 2009-11-11T09:31:34Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=ebbc762182c943d5967ea106933181a2fb726b1b
add documention for writing built-in commands

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.
  • [D] doc/manual/main.txt
Commit first draft of release process documentation. 2009-07-02T10:54:30Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-07-02T10:54:30Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=fc240afcac4de15e5d4c0727c0e062ce4d9bbe64
Commit first draft of release process documentation.

git-svn-id: svn://svn.berlios.de/openocd/trunk@2453 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Minor fixes to Developer Manual pages. 2009-07-01T19:55:52Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-07-01T19:55:52Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=59a3df127e905643dd55d9bcad588814ca810066
Minor fixes to Developer Manual pages.
- 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
  • [D] doc/manual/main.txt
Add architectural introduction to the JTAG module in The Manual. 2009-06-03T02:57:55Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-06-03T02:57:55Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=6c39b5dd52969c1927c5115e24bb8a1fc9555349
Add architectural introduction to the JTAG module in The Manual.

git-svn-id: svn://svn.berlios.de/openocd/trunk@2024 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Add draft of Patching Primer in The Manual; update primer page. 2009-06-03T02:12:44Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-06-03T02:12:44Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=003318b911af8efa7a664cb50a2327f1c44e56b2
Add draft of Patching Primer in The Manual; update primer page.

git-svn-id: svn://svn.berlios.de/openocd/trunk@2021 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Numerous minor updates and fixes for The Manual: 2009-05-27T15:15:06Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-27T15:15:06Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=afa77f86726646d36c5670ed59f73201ca02e597
Numerous minor updates and fixes for The Manual:
- 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
  • [D] doc/manual/main.txt
Link new Primer pages into the main list of Primers. 2009-05-27T10:40:52Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-27T10:40:52Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=43ea8d91793d25eeae913955ee5fcabad0594ed9
Link new Primer pages into the main list of Primers.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1923 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Update main page of doxygen developer documentation: 2009-05-23T22:52:47Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-23T22:52:47Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=08d5f114c959876ee2eac2baa2de18a459ef2b6a
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
  • [D] doc/manual/main.txt
Add new TCL Primer under the main Technical Primer page. 2009-05-20T08:58:09Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-20T08:58:09Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=5a080c8f6e7b43f0d1399953ccc5cfb8a4319efe
Add new TCL Primer under the main Technical Primer page.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1856 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Add current draft of The List of Pending and Open Tasks. 2009-05-15T00:49:30Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-15T00:49:30Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=8ed887456dcb9c150ca087fb54b56622574786b8
Add current draft of The List of Pending and Open Tasks.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1791 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Several minor fixes for the new doxygen manual. 2009-05-14T22:16:20Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-14T22:16:20Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=30f6b1ebbcfc02f3df4ab6bbc27f59d9cd4b5bb4
Several minor fixes for the new doxygen manual.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1789 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Add JTAG Primer to doxygen manual, contributed by Strontium. 2009-05-13T11:10:35Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-13T11:10:35Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=7626139950a4282564cadbc2cdd349593841e3b8
Add JTAG Primer to doxygen manual, contributed by Strontium.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1776 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt
Commit skeleton files for high-level developer manual using doxygen. 2009-05-13T08:58:08Z zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 zwelch zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60 2009-05-13T08:58:08Z https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff;h=624aa80f8478a9beb3ee9497a535a80ec2d42638
Commit skeleton files for high-level developer manual using doxygen.

git-svn-id: svn://svn.berlios.de/openocd/trunk@1771 b42882b7-edfa-0310-969c-e2dbd0fdcd60
  • [D] doc/manual/main.txt