summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZachary T Welch <zw@superlucidity.net>2009-12-06 21:30:21 -0800
committerZachary T Welch <zw@superlucidity.net>2009-12-06 21:39:35 -0800
commit30a6e683b85291b8248a2f6189aa292fdf43162d (patch)
tree29da5c15eb238cfe8970b20cacc01f9c6d47da9c /doc
parent2bc4dee7e64662c7ca24b83cfa566bcca68cb3b4 (diff)
downloadopenocd+libswd-30a6e683b85291b8248a2f6189aa292fdf43162d.tar.gz
openocd+libswd-30a6e683b85291b8248a2f6189aa292fdf43162d.tar.bz2
openocd+libswd-30a6e683b85291b8248a2f6189aa292fdf43162d.tar.xz
openocd+libswd-30a6e683b85291b8248a2f6189aa292fdf43162d.zip
add 'flash list', rewrite 'flash banks'
Rename the existing 'flash banks' implementation as 'flash list', and replace the broken 'flash_banks' TCL wrapper with a new command handler. Adds documentation for the new 'flash list' command in the user guide.
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index b6be87e1..36517791 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -3638,12 +3638,18 @@ 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 declared
-using @command{flash bank}, numbered from zero.
+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
+declared using @command{flash bank}, numbered from zero.
+This returned list can be manipulated easily from within scripts.
+@end deffn
+
@deffn Command {flash probe} num
Identify the flash, or validate the parameters of the configured flash. Operation
depends on the flash type.