Skip to content

Commit

Permalink
whitespace cleanup, mostly for docs
Browse files Browse the repository at this point in the history
Remove useless space/tab at end of lines.
Remove spaces in indentation and replace with tab.

Signed-off-by: Antonio Borneo <[email protected]>
Signed-off-by: David Brownell <[email protected]>
  • Loading branch information
borneoa authored and David Brownell committed Dec 30, 2009
1 parent 17fb7ea commit 7c5acf8
Show file tree
Hide file tree
Showing 22 changed files with 399 additions and 400 deletions.
4 changes: 2 additions & 2 deletions BUGS
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ that may be important.
- If the report is for a regression:
- Include logs for both working and broken versions.
- Find the precise version that caused the regression by binary search.
You can use "git bisect" to expedite this binary search:
You can use "git bisect" to expedite this binary search:
http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html

If possible, please develop and attach a patch that helps to expose or
Expand All @@ -36,7 +36,7 @@ in total.
@section bugscrashdump Obtaining Crash Backtraces

If OpenOCD is crashing, there are two very effective things you can do to
improve your chances of getting help on the development mailing list.
improve your chances of getting help on the development mailing list.

Try to reproduce the problem using the dummy JTAG interface to allow other developers to replicate
your problem robustly and use GDB to get a trace:@par
Expand Down
4 changes: 2 additions & 2 deletions NEWS-0.2.0
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ must past stricter value checks, and many more error conditions have
been handled correctly. These efforts helped to make the 0.2.0 release
more stable and robust, though some changes may expose latent bugs in
your existing configuration scripts.

This release does not maintain backward compatibility in all respects,
so some target or configuration scripts may need to be updated. In some
cases, you may also see warnings; resolve those, because they indicate
Expand All @@ -20,7 +20,7 @@ The following areas of OpenOCD functionality changed in this release:
JTAG Layer:
- Improves modularity: core, TCL, driver commands, and interface have
been separated, encapsulated, and documented for developers. Mostly.
- Improves JTAG TAP transition tables:
- Improves JTAG TAP transition tables:
* Makes TAP paths variable length, rather than being fixed at 7 steps.
* Fixes problems with some targets that did not like longer paths.
- Improves JTAG driver/minidriver modularity and encapsulation.
Expand Down
12 changes: 6 additions & 6 deletions NEWTAPS
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Version Number Changes:
not a big deal. Please do report this information. We'd like to
know about it.

For example
For example

Error: ERROR: Tap: s3c4510.cpu - Expected id: 0x3f0f0f0f, Got: 0x1f0f0f0f
Error: ERROR: expected: mfg: 0x787, part: 0xf0f0, ver: 0x3
Expand All @@ -39,7 +39,7 @@ Error: ERROR: got: mfg: 0x787, part: 0xf0f0, ver: 0x1
========================================

Updating the Tap ID number your self

Why do this? You just want the warning to go away. And don't want
to update your version/instance of OpenOCD.

Expand Down Expand Up @@ -79,11 +79,11 @@ Examples:
0x3f0f0f0f - is a newer ARM7TDMI
0x3ba00477 - is an ARM cortex M3

Some chips have multiple JTAG taps - be sure to list
Some chips have multiple JTAG taps - be sure to list
each one individually - ORDER is important!

========================================
B) The maker of the part
B) The maker of the part

Examples:
Xilinx, Atmel, ST Micro Systems, Freescale
Expand All @@ -94,7 +94,7 @@ C) The family of parts it belongs to
Examples:
"NXP LPC Series"
"Atmel SAM7 Series"

========================================

D) The actual part number on the package
Expand All @@ -121,7 +121,7 @@ For example: A consumer GPS unit or a cellphone
ie: Olimex, LogicPD, Freescale(eval board)

========================================

(G) Identifying information on the board.

Not good: "iar red ST eval board"
Expand Down
2 changes: 1 addition & 1 deletion PATCHES
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ in response to feedback.
Add yourself to the GPL copyright for non-trivial changes.

To create a patch from the command line:
@code
@code
git diff >mypatch.txt
@endcode

Expand Down
8 changes: 4 additions & 4 deletions README.Win32
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ based JTAG debuggers.

http://sourceforge.net/projects/libusb-win32/

You need to download the libusb-win32-device-bin-0.1.12.2.tar.gz
package. Extract this file into a temp directory.
You need to download the libusb-win32-device-bin-0.1.12.2.tar.gz
package. Extract this file into a temp directory.

Copy the file libusb-win32-device-bin-0.1.12.2\include\usb.h
to your MinGW include directory.
Expand Down Expand Up @@ -59,10 +59,10 @@ released source tarball or the git tree.
If you are using the git tree, the following are the instructions from
README.mingw. You will need to have the cmake utility installed.

- Edit Toolchain-mingw32.cmake to point to the correct MinGW
- Edit Toolchain-mingw32.cmake to point to the correct MinGW
installation.
- Create a build directory like "mkdir build-win32", e.g in ../libftdi/
- cd into that directory and run
- cd into that directory and run
"cmake -DCMAKE_TOOLCHAIN_FILE=../Toolchain-mingw32.cmake .."
- Copy src/ftdi.h to your MinGW include directory.
- Copy build-win32/src/*.a to your MinGW lib directory.
Expand Down
14 changes: 7 additions & 7 deletions TODO
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ This section provides possible things to improve with OpenOCD's TCL support.
parameters. Currently variables assigned through one such parameter
command/script are unset before the next one is invoked.

- Isolate all TCL command support:
- Pure C CLI implementations using --disable-builtin-tcl.
- Isolate all TCL command support:
- Pure C CLI implementations using --disable-builtin-tcl.
- Allow developers to build new dongles using OpenOCD's JTAG core.
- At first, provide only low-level JTAG support; target layer and
above rely heavily on scripting event mechanisms.
Expand Down Expand Up @@ -112,7 +112,7 @@ TCP/IP packets handled by the server.

@section thelistswd Serial Wire Debug

- implement Serial Wire Debug interface
- implement Serial Wire Debug interface

@section thelistbs Boundary Scan Support

Expand Down Expand Up @@ -163,7 +163,7 @@ https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html
use hardware stepping if available.
- mdb can return garbage data if read byte operation fails for
a memory region(16 & 32 byte access modes may be supported). Is this
a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
a bug in the .MX31 PDK init script? Try on i.MX31 PDK:
mdw 0xb80005f0 0x8, mdh 0xb80005f0 0x10, mdb 0xb80005f0 0x20. mdb returns
garabage.
- implement missing functionality (grep FNC_INFO_NOTIMPLEMENTED ...)
Expand Down Expand Up @@ -197,8 +197,8 @@ https://lists.berlios.de/pipermail/openocd-development/2009-October/011506.html

@section thelistsvf SVF/XSVF

- develop SVF unit tests
- develop XSVF unit tests
- develop SVF unit tests
- develop XSVF unit tests

@section thelistflash Flash Support

Expand Down Expand Up @@ -328,7 +328,7 @@ at the bottom of the list below. Example, on amd64:
from unaligned memory addresses
- libopenocd support: @par
https://lists.berlios.de/pipermail/openocd-development/2009-May/006405.html
- review and clean up interface/target/flash APIs
- review and clean up interface/target/flash APIs

The following strategic tasks will require ambition, knowledge, and time
to complete:
Expand Down
2 changes: 1 addition & 1 deletion bootstrap
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/sh -e
# Run the autotools bootstrap sequence to create the configure script

# Stop execution as soon as we have an unknown command
# Stop execution as soon as we have an unknown command
set -e

if libtoolize --version >/dev/null 2>&1; then
Expand Down
2 changes: 1 addition & 1 deletion configure.in
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ case $host in
AC_MSG_WARN([--disable-parport-giveio is not supported by MinGW32 hosts])
fi
parport_use_giveio=yes

CFLAGS="$CFLAGS -D__USE_MINGW_ANSI_STDIO"

AC_DEFINE(IS_MINGW, 1, [1 if building for MinGW.])
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/primer/commands.txt
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ static COMMAND_HELPER(handle_hello_args, const char **sep, const char **name)
@endcode

Of course, you may also call other macros or functions, but that extends
beyond the scope of this tutorial on writing commands.
beyond the scope of this tutorial on writing commands.

@section primercmdreg Command Registration

Expand Down
2 changes: 1 addition & 1 deletion doc/manual/release.txt
Original file line number Diff line number Diff line change
Expand Up @@ -399,7 +399,7 @@ affect its behavior:

@section releasetutorial Release Tutorials

This section should contain a brief tutorial for using the Release
This section should contain a brief tutorial for using the Release
Script to perform release tasks, but the new script needs to be
used for 0.3.0.

Expand Down
2 changes: 1 addition & 1 deletion doc/manual/server.txt
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,6 @@ openocd -s /usr/local/share/openocd -f httpd/httpd.tcl -f interface/dummy.cfg -f

Navigate to: http://localhost:8888/



*/
24 changes: 12 additions & 12 deletions doc/openocd.texi
Original file line number Diff line number Diff line change
Expand Up @@ -3757,14 +3757,14 @@ Use it in board specific configuration files, not interactively.
@comment the REAL name for this command is "ocd_flash_banks"
@comment less confusing would be: "flash list" (like "nand list")
@deffn Command {flash banks}
Prints a one-line summary of each device that was
Prints a one-line summary of each device that was
declared using @command{flash bank}, numbered from zero.
Note that this is the @emph{plural} form;
the @emph{singular} form is a very different command.
@end deffn

@deffn Command {flash list}
Retrieves a list of associative arrays for each device that was
Retrieves a list of associative arrays for each device that was
declared using @command{flash bank}, numbered from zero.
This returned list can be manipulated easily from within scripts.
@end deffn
Expand Down Expand Up @@ -4914,28 +4914,28 @@ nand device $NANDFLASH at91sam9 $CHIPNAME 0x40000000 0xfffffe800
@end example
AT91SAM9 chips support single-bit ECC hardware. The @code{write_page} and
@code{read_page} methods are used to utilize the ECC hardware unless they are
disabled by using the @command{nand raw_access} command. There are four
disabled by using the @command{nand raw_access} command. There are four
additional commands that are needed to fully configure the AT91SAM9 NAND
controller. Two are optional; most boards use the same wiring for ALE/CLE:
@deffn Command {at91sam9 cle} num addr_line
Configure the address line used for latching commands. The @var{num}
Configure the address line used for latching commands. The @var{num}
parameter is the value shown by @command{nand list}.
@end deffn
@deffn Command {at91sam9 ale} num addr_line
Configure the address line used for latching addresses. The @var{num}
Configure the address line used for latching addresses. The @var{num}
parameter is the value shown by @command{nand list}.
@end deffn

For the next two commands, it is assumed that the pins have already been
For the next two commands, it is assumed that the pins have already been
properly configured for input or output.
@deffn Command {at91sam9 rdy_busy} num pio_base_addr pin
Configure the RDY/nBUSY input from the NAND device. The @var{num}
parameter is the value shown by @command{nand list}. @var{pio_base_addr}
Configure the RDY/nBUSY input from the NAND device. The @var{num}
parameter is the value shown by @command{nand list}. @var{pio_base_addr}
is the base address of the PIO controller and @var{pin} is the pin number.
@end deffn
@deffn Command {at91sam9 ce} num pio_base_addr pin
Configure the chip enable input to the NAND device. The @var{num}
parameter is the value shown by @command{nand list}. @var{pio_base_addr}
Configure the chip enable input to the NAND device. The @var{num}
parameter is the value shown by @command{nand list}. @var{pio_base_addr}
is the base address of the PIO controller and @var{pin} is the pin number.
@end deffn
@end deffn
Expand Down Expand Up @@ -5824,7 +5824,7 @@ and using the MCR instruction.
an ARM register.)
@end deffn

@deffn Command {arm mrc} pX coproc op1 CRn CRm op2
@deffn Command {arm mrc} pX coproc op1 CRn CRm op2
Read a coprocessor @var{pX} register passing parameters @var{CRn},
@var{CRm}, opcodes @var{opc1} and @var{opc2},
and the MRC instruction.
Expand All @@ -5843,7 +5843,7 @@ core mode if necessary.
@cindex ARMv5

The ARMv4 and ARMv5 architectures are widely used in embedded systems,
and introduced core parts of the instruction set in use today.
and introduced core parts of the instruction set in use today.
That includes the Thumb instruction set, introduced in the ARMv4T
variant.

Expand Down
2 changes: 1 addition & 1 deletion ecosflash/notes.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Some of these binaries are build & linked using eCos.
Some of these binaries are build & linked using eCos.

For source for the flash drivers, see:

Expand Down
Loading

0 comments on commit 7c5acf8

Please sign in to comment.