From: michal smulski <michal.smulski@ooma.com>
Date: Tue, 20 Apr 2010 20:18:04 +0000 (+0200)
Subject: docs: improve load_image docs
X-Git-Tag: v0.5.0-rc1~741
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=cc5f3c85de7632a32f41b435c54b83487a3aa622;p=openocd

docs: improve load_image docs

add docs for missing args.

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>
---

diff --git a/doc/openocd.texi b/doc/openocd.texi
index 5273d5de..cfba79f6 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -5671,10 +5671,20 @@ separately.
 @end deffn
 
 @anchor{load_image}
-@deffn Command {load_image} filename address [@option{bin}|@option{ihex}|@option{elf}]
-Load image from file @var{filename} to target memory at @var{address}.
+@deffn Command {load_image} filename address [@option{bin}|@option{ihex}|@option{elf}] @option{min_addr} @option{max_length}]
+Load image from file @var{filename} to target memory offset by @var{address} from its load address. 
 The file format may optionally be specified
-(@option{bin}, @option{ihex}, or @option{elf})
+(@option{bin}, @option{ihex}, or @option{elf}).
+In addition the following arguments may be specifed:
+@var{min_addr} - ignore data below @var{min_addr} (this is w.r.t. to the target's load address + @var{address})
+@var{max_length} - maximum number of bytes to load.
+@example
+proc load_image_bin @{fname foffset address length @} @{
+    # Load data from fname filename at foffset offset to
+    # target at address. Load at most length bytes.
+    load_image $fname [expr $address - $foffset] bin $address $length      
+@}
+@end example
 @end deffn
 
 @deffn Command {test_image} filename [address [@option{bin}|@option{ihex}|@option{elf}]]