Hi, please pull from the "doc-fixes" branch from my OpenOCD repo:
Clone URL: git clone git://gitorious.org/openocd/openocd.git The branch has a bunch of minor typos and documentation fixes. The "git format-patch" output is attached for easier review. Thanks, Uwe. -- http://www.hermann-uwe.de | http://www.randomprojects.org http://www.crazy-hacks.org | http://www.unmaintained-free-software.org
>From da5f4c32e087bb6725e6f48395087925d900c6d7 Mon Sep 17 00:00:00 2001 From: Uwe Hermann <[email protected]> Date: Tue, 24 Nov 2009 20:01:15 +0100 Subject: [PATCH 1/3] Fix a bunch of typos. --- src/server/gdb_server.c | 10 +++++----- src/server/httpd.c | 4 ++-- src/server/server.c | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c index bd1d047..3c099fa 100644 --- a/src/server/gdb_server.c +++ b/src/server/gdb_server.c @@ -53,7 +53,7 @@ static const char *DIGITS = "0123456789abcdef"; static void gdb_log_callback(void *priv, const char *file, unsigned line, const char *function, const char *string); -/* number of gdb connections, mainly to supress gdb related debugging spam +/* number of gdb connections, mainly to suppress gdb related debugging spam * in helper/log.c when no gdb connections are actually active */ int gdb_actual_connections; @@ -568,7 +568,7 @@ int gdb_get_packet_inner(struct connection *connection, char *buffer, int *len) break; case '+': /* gdb sends a dummy ack '+' at every remote connect - see remote_start_remote (remote.c) - * incase anyone tries to debug why they receive this warning every time */ + * in case anyone tries to debug why they receive this warning every time */ LOG_WARNING("acknowledgment received, but no packet pending"); break; case '-': @@ -859,7 +859,7 @@ static int gdb_reg_pos(struct target *target, int pos, int len) * register might be non-divisible by 8(a byte), in which * case an entire byte is shown. * - * NB! the format on the wire is the target endianess + * NB! the format on the wire is the target endianness * * The format of reg->value is little endian * @@ -2141,7 +2141,7 @@ int gdb_input_inner(struct connection *connection) target_name(target)); break; default: - /* ignore unkown packets */ + /* ignore unknown packets */ LOG_DEBUG("ignoring 0x%2.2x packet", packet[0]); gdb_put_packet(connection, NULL, 0); break; @@ -2320,7 +2320,7 @@ COMMAND_HANDLER(handle_gdb_breakpoint_override_command) LOG_USER("force %s breakpoints", (gdb_breakpoint_override_type == BKPT_HARD)?"hard":"soft"); } else { - LOG_USER("breakpoint type is not overriden"); + LOG_USER("breakpoint type is not overridden"); } return ERROR_OK; diff --git a/src/server/httpd.c b/src/server/httpd.c index 8c1d3db..9fa5879 100644 --- a/src/server/httpd.c +++ b/src/server/httpd.c @@ -207,7 +207,7 @@ static void request_completed(void *cls, struct MHD_Connection *connection, *con_cls = NULL; } -/* append to said key in dictonary */ +/* append to said key in dictionary */ static void append_key(struct httpd_request *r, const char *key, const char *data, size_t off, size_t size) { @@ -388,7 +388,7 @@ static int ahc_echo_inner(void * cls, struct MHD_Connection * connection, r->post = post; Jim_SetVariableStr(interp, "httppostdata", Jim_NewDictObj(interp, NULL, 0)); - /* fill in url query strings in dictonary */ + /* fill in url query strings in dictionary */ MHD_get_connection_values(connection, MHD_GET_ARGUMENT_KIND, record_arg, r); diff --git a/src/server/server.c b/src/server/server.c index 50bc00e..3ba433e 100644 --- a/src/server/server.c +++ b/src/server/server.c @@ -309,7 +309,7 @@ int server_loop(struct command_context *command_context) while (!shutdown_openocd) { - /* monitor sockets for acitvity */ + /* monitor sockets for activity */ fd_max = 0; FD_ZERO(&read_fds); -- 1.6.5.3
>From 4ca4c68798cffe767e0eba3a38a9c4537b382ab6 Mon Sep 17 00:00:00 2001 From: Uwe Hermann <[email protected]> Date: Tue, 24 Nov 2009 20:28:21 +0100 Subject: [PATCH 2/3] Fix some typos in the top-level documentation files. --- BUGS | 2 +- ChangeLog | 2 +- PATCHES | 2 +- README | 4 ++-- TODO | 12 ++++++------ 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/BUGS b/BUGS index 0cb99ae..6967525 100644 --- a/BUGS +++ b/BUGS @@ -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 Please report bugs by subscribing to the OpenOCD mailing list and diff --git a/ChangeLog b/ChangeLog index d80c896..a8df5d0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1 +1 @@ -Retired in favour of SVN log. +Retired in favor of git log. diff --git a/PATCHES b/PATCHES index 32f1bda..74a76fd 100644 --- a/PATCHES +++ b/PATCHES @@ -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 Please mail patches to: @par diff --git a/README b/README index 0ba6f76..35118da 100644 --- a/README +++ b/README @@ -338,7 +338,7 @@ all operating systems used with OpenOCD. You may, however, build such copies for personal use. 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 appropriate place." @@ -404,7 +404,7 @@ Then you can update that at your convenience using git pull 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://repo.or.cz/w/openocd.git diff --git a/TODO b/TODO index da5cf52..a9e95f6 100644 --- a/TODO +++ b/TODO @@ -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 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: - 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 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 @@ -85,7 +85,7 @@ There are some known bugs to fix in JTAG adapter drivers: Workaround: use "tms_sequence long" @par 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: - 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 options were specifically provided to configure - 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) . - eliminate sources of confusion in @c bootstrap script: -# 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 - produce mingw32, arm-elf, others using in-tree scripts - build all required target code from sources @@ -348,7 +348,7 @@ to complete: - reviewing patches - committing to Subversion - 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 - Provide more Technical Primers to bootstrap contributor knowledge -- 1.6.5.3
>From 90ccc71d6ddd7017ed2cbfed85d9d01dfac31ad4 Mon Sep 17 00:00:00 2001 From: Uwe Hermann <[email protected]> Date: Tue, 24 Nov 2009 20:42:42 +0100 Subject: [PATCH 3/3] The Berlios bugtracker is disabled, bug reports go to the list. --- doc/openocd.1 | 6 ++---- 1 files changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/openocd.1 b/doc/openocd.1 index 77abcf9..d9f8a7c 100644 --- a/doc/openocd.1 +++ b/doc/openocd.1 @@ -1,4 +1,4 @@ -.TH "OPENOCD" "1" "January 08, 2009" +.TH "OPENOCD" "1" "November 24, 2009" .SH "NAME" openocd \- A free and open on\-chip debugging, in\-system programming and boundary\-scan testing tool for ARM and MIPS systems @@ -69,9 +69,7 @@ Show a help text and exit. .B "\-v, \-\-version" Show version information and exit. .SH "BUGS" -Please report any bugs at -.B http://developer.berlios.de/bugs/?group_id=4148 -or on the mailing list +Please report any bugs on the mailing list at .BR openocd\[email protected] . .SH "LICENCE" .B OpenOCD -- 1.6.5.3
_______________________________________________ Openocd-development mailing list [email protected] https://lists.berlios.de/mailman/listinfo/openocd-development
