fix typos in documentation

Fixes some minor typos in the top-level documentation files.

Signed-off-by: Zachary T Welch <zw@superlucidity.net>
This commit is contained in:
Uwe Hermann 2009-11-24 20:28:21 +01:00 committed by Zachary T Welch
parent 1240ae459f
commit cfc02ccca2
5 changed files with 11 additions and 11 deletions

2
BUGS
View File

@ -1,4 +1,4 @@
// This file is part of the Doyxgen Developer Manual // This file is part of the Doxygen Developer Manual
/** @page bugs Bug Reporting /** @page bugs Bug Reporting
Please report bugs by subscribing to the OpenOCD mailing list and Please report bugs by subscribing to the OpenOCD mailing list and

View File

@ -1 +1 @@
Retired in favour of SVN log. Retired in favor of git log.

View File

@ -1,4 +1,4 @@
// This file is part of the Doyxgen Developer Manual // This file is part of the Doxygen Developer Manual
/** @page patchguide Patch Guidelines /** @page patchguide Patch Guidelines
Please mail patches to: @par Please mail patches to: @par

4
README
View File

@ -338,7 +338,7 @@ all operating systems used with OpenOCD. You may, however, build such
copies for personal use. copies for personal use.
The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux) The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux)
TAR.GZ file. You must unpack them ``some where'' convient. As of this TAR.GZ file. You must unpack them ``some where'' convenient. As of this
writing FTDICHIP does not supply means to install these files "in an writing FTDICHIP does not supply means to install these files "in an
appropriate place." appropriate place."
@ -404,7 +404,7 @@ Then you can update that at your convenience using
git pull git pull
There is also a gitweb interface, which you can use either to browse There is also a gitweb interface, which you can use either to browse
the repository or to downlad arbitrary snapshots using HTTP: the repository or to download arbitrary snapshots using HTTP:
http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd
http://repo.or.cz/w/openocd.git http://repo.or.cz/w/openocd.git

12
TODO
View File

@ -1,4 +1,4 @@
// This file is part of the Doyxgen Developer Manual // This file is part of the Doxygen Developer Manual
/** @page tasks Pending and Open Tasks /** @page tasks Pending and Open Tasks
This page lists pending and open tasks being considered or worked upon This page lists pending and open tasks being considered or worked upon
@ -46,7 +46,7 @@ This section list issues that need to be resolved in the JTAG layer.
The following tasks have been suggested for cleaning up the JTAG layer: The following tasks have been suggested for cleaning up the JTAG layer:
- use tap_set_state everywhere to allow logging TAP state transitions - use tap_set_state everywhere to allow logging TAP state transitions
- Encapsulate cmd_queue_cur_state and related varaible handling. - Encapsulate cmd_queue_cur_state and related variable handling.
- add slick 32 bit versions of jtag_add_xxx_scan() that avoids - add slick 32 bit versions of jtag_add_xxx_scan() that avoids
buf_set_u32() calls and other evidence of poor impedance match between buf_set_u32() calls and other evidence of poor impedance match between
API and calling code. New API should cut down # of lines in calling API and calling code. New API should cut down # of lines in calling
@ -85,7 +85,7 @@ There are some known bugs to fix in JTAG adapter drivers:
Workaround: use "tms_sequence long" @par Workaround: use "tms_sequence long" @par
https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html https://lists.berlios.de/pipermail/openocd-development/2009-July/009426.html
The following tasks have been suggeted for improving OpenOCD's JTAG The following tasks have been suggested for improving OpenOCD's JTAG
interface support: interface support:
- rework USB communication to be more robust. Two possible options are: - rework USB communication to be more robust. Two possible options are:
@ -290,11 +290,11 @@ These ideas were first introduced here: @par
- automatically detect the features that are available, unless - automatically detect the features that are available, unless
options were specifically provided to configure options were specifically provided to configure
- provide a report of the drivers that will be build at the end of - provide a report of the drivers that will be build at the end of
running configure, so the users can verify which driverswill be running configure, so the users can verify which drivers will be
built during 'make' (and their options) . built during 'make' (and their options) .
- eliminate sources of confusion in @c bootstrap script: - eliminate sources of confusion in @c bootstrap script:
-# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'? -# Make @c bootstrap call 'configure --enable-maintainer-mode \<opts\>'?
-# Add @c buildstrap script to assist with boostrap and configure steps. -# Add @c buildstrap script to assist with bootstrap and configure steps.
- automatically build tool-chains required for cross-compiling - automatically build tool-chains required for cross-compiling
- produce mingw32, arm-elf, others using in-tree scripts - produce mingw32, arm-elf, others using in-tree scripts
- build all required target code from sources - build all required target code from sources
@ -348,7 +348,7 @@ to complete:
- reviewing patches - reviewing patches
- committing to Subversion - committing to Subversion
- Review The Guide for OpenOCD Users for documentation errors or omissions - Review The Guide for OpenOCD Users for documentation errors or omissions
- Update The Manual for OpenOCD Developerrs: - Update The Manual for OpenOCD Developers:
- Add documentation describing the architecture of each module - Add documentation describing the architecture of each module
- Provide more Technical Primers to bootstrap contributor knowledge - Provide more Technical Primers to bootstrap contributor knowledge