* [PATCH] tools: dumpimage: Remove remaining mentions of the -i option
@ 2020-10-26 15:40 Tyler Hicks
2020-11-06 9:56 ` Martyn Welch
2020-11-20 1:35 ` Tom Rini
0 siblings, 2 replies; 3+ messages in thread
From: Tyler Hicks @ 2020-10-26 15:40 UTC (permalink / raw)
To: u-boot
The -i option of the dumpimage tool has been removed so it should no
longer be documented in the README file. Refer readers to the tool's
help output rather than maintain a copy of the usage in the README.
Finally, adjust the example dumpfile invocation in imagetool.h to use
the -o option instead of the removed -i option.
Fixes: 12b831879a76 ("tools: dumpimage: Simplify arguments")
Signed-off-by: Tyler Hicks <tyhicks@linux.microsoft.com>
Cc: Martyn Welch <martyn.welch@collabora.com>
---
README | 12 ++----------
tools/imagetool.h | 6 +++---
2 files changed, 5 insertions(+), 13 deletions(-)
diff --git a/README b/README
index cb49aa15dae2..7b73a1c97321 100644
--- a/README
+++ b/README
@@ -3832,16 +3832,8 @@ when your kernel is intended to use an initial ramdisk:
Load Address: 0x00000000
Entry Point: 0x00000000
-The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
-option performs the converse operation of the mkimage's second form (the "-d"
-option). Given an image built by mkimage, the dumpimage extracts a "data file"
-from the image:
-
- tools/dumpimage -i image -T type -p position data_file
- -i ==> extract from the 'image' a specific 'data_file'
- -T ==> set image type to 'type'
- -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
-
+The "dumpimage" tool can be used to disassemble or list the contents of images
+built by mkimage. See dumpimage's help output (-h) for details.
Installing a Linux Image:
-------------------------
diff --git a/tools/imagetool.h b/tools/imagetool.h
index acbc48e9be0d..8726792c8c06 100644
--- a/tools/imagetool.h
+++ b/tools/imagetool.h
@@ -126,9 +126,9 @@ struct image_type_params {
struct image_tool_params *);
/*
* This function is used by the command to retrieve a component
- * (sub-image) from the image (i.e. dumpimage -i <image> -p <position>
- * <sub-image-name>).
- * Thus the code to extract a file from an image must be put here.
+ * (sub-image) from the image (i.e. dumpimage -p <position>
+ * -o <component-outfile> <image>). Thus the code to extract a file
+ * from an image must be put here.
*
* Returns 0 if the file was successfully retrieved from the image,
* or a negative value on error.
--
2.25.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH] tools: dumpimage: Remove remaining mentions of the -i option
2020-10-26 15:40 [PATCH] tools: dumpimage: Remove remaining mentions of the -i option Tyler Hicks
@ 2020-11-06 9:56 ` Martyn Welch
2020-11-20 1:35 ` Tom Rini
1 sibling, 0 replies; 3+ messages in thread
From: Martyn Welch @ 2020-11-06 9:56 UTC (permalink / raw)
To: u-boot
On Mon, 2020-10-26 at 10:40 -0500, Tyler Hicks wrote:
> The -i option of the dumpimage tool has been removed so it should no
> longer be documented in the README file. Refer readers to the tool's
> help output rather than maintain a copy of the usage in the README.
>
> Finally, adjust the example dumpfile invocation in imagetool.h to use
> the -o option instead of the removed -i option.
>
> Fixes: 12b831879a76 ("tools: dumpimage: Simplify arguments")
> Signed-off-by: Tyler Hicks <tyhicks@linux.microsoft.com>
> Cc: Martyn Welch <martyn.welch@collabora.com>
Acked-by: Martyn Welch <martyn.welch@collabora.com>
> ---
> README | 12 ++----------
> tools/imagetool.h | 6 +++---
> 2 files changed, 5 insertions(+), 13 deletions(-)
>
> diff --git a/README b/README
> index cb49aa15dae2..7b73a1c97321 100644
> --- a/README
> +++ b/README
> @@ -3832,16 +3832,8 @@ when your kernel is intended to use an initial
> ramdisk:
> Load Address: 0x00000000
> Entry Point: 0x00000000
>
> -The "dumpimage" is a tool to disassemble images built by mkimage.
> Its "-i"
> -option performs the converse operation of the mkimage's second form
> (the "-d"
> -option). Given an image built by mkimage, the dumpimage extracts a
> "data file"
> -from the image:
> -
> - tools/dumpimage -i image -T type -p position data_file
> - -i ==> extract from the 'image' a specific 'data_file'
> - -T ==> set image type to 'type'
> - -p ==> 'position' (starting at 0) of the 'data_file' inside
> the 'image'
> -
> +The "dumpimage" tool can be used to disassemble or list the contents
> of images
> +built by mkimage. See dumpimage's help output (-h) for details.
>
> Installing a Linux Image:
> -------------------------
> diff --git a/tools/imagetool.h b/tools/imagetool.h
> index acbc48e9be0d..8726792c8c06 100644
> --- a/tools/imagetool.h
> +++ b/tools/imagetool.h
> @@ -126,9 +126,9 @@ struct image_type_params {
> struct image_tool_params *);
> /*
> * This function is used by the command to retrieve a component
> - * (sub-image) from the image (i.e. dumpimage -i <image> -p
> <position>
> - * <sub-image-name>).
> - * Thus the code to extract a file from an image must be put
> here.
> + * (sub-image) from the image (i.e. dumpimage -p <position>
> + * -o <component-outfile> <image>). Thus the code to extract a
> file
> + * from an image must be put here.
> *
> * Returns 0 if the file was successfully retrieved from the
> image,
> * or a negative value on error.
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH] tools: dumpimage: Remove remaining mentions of the -i option
2020-10-26 15:40 [PATCH] tools: dumpimage: Remove remaining mentions of the -i option Tyler Hicks
2020-11-06 9:56 ` Martyn Welch
@ 2020-11-20 1:35 ` Tom Rini
1 sibling, 0 replies; 3+ messages in thread
From: Tom Rini @ 2020-11-20 1:35 UTC (permalink / raw)
To: u-boot
On Mon, Oct 26, 2020 at 10:40:24AM -0500, Tyler Hicks wrote:
> The -i option of the dumpimage tool has been removed so it should no
> longer be documented in the README file. Refer readers to the tool's
> help output rather than maintain a copy of the usage in the README.
>
> Finally, adjust the example dumpfile invocation in imagetool.h to use
> the -o option instead of the removed -i option.
>
> Fixes: 12b831879a76 ("tools: dumpimage: Simplify arguments")
> Signed-off-by: Tyler Hicks <tyhicks@linux.microsoft.com>
> Cc: Martyn Welch <martyn.welch@collabora.com>
> Acked-by: Martyn Welch <martyn.welch@collabora.com>
Applied to u-boot/master, thanks!
--
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201119/445dd977/attachment.sig>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-11-20 1:35 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-26 15:40 [PATCH] tools: dumpimage: Remove remaining mentions of the -i option Tyler Hicks
2020-11-06 9:56 ` Martyn Welch
2020-11-20 1:35 ` Tom Rini
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.