Skip to contentSkip to conversation

tools: dumpimage: Remove remaining mentions of the -i option

PATCH New Tyler Hicks 3 participants 3 messages Oct 26, 2020 – Nov 20, 2020

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 tools: dumpimage: Remove remaining mentions of the -i option

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")
Cc Martyn Welch <[email protected]>
---
 README            | 12 ++----------
 tools/imagetool.h |  6 +++---
 2 files changed, 5 insertions(+), 13 deletions(-)
README +2 -10
index cb49aa15dae2..7b73a1c97321 100644
@@ -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:
 -------------------------
tools/imagetool.h +3 -3
index acbc48e9be0d..8726792c8c06 100644
@@ -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.
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/1 tools: dumpimage: Remove remaining mentions of the -i option

Quoted 10 lines · Tyler Hicks

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")
Cc Martyn Welch <[email protected]>
Quoted 55 lines
---
 README            | 12 ++----------
 tools/imagetool.h |  6 +++---
 2 files changed, 5 insertions(+), 13 deletions(-)
README +0 -0
index cb49aa15dae2..7b73a1c97321 100644
@@ -3832,16 +3832,8 @@ when your kernel is intended to use an initial

ramdisk:

README +0 -1
 	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"

README +0 -6
-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'

README +1 -1
-
+The "dumpimage" tool can be used to disassemble or list the contents

of images

README +1 -0
+built by mkimage. See dumpimage's help output (-h) for details.
 
 Installing a Linux Image:
 -------------------------
tools/imagetool.h +0 -1
index acbc48e9be0d..8726792c8c06 100644
@@ -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>

tools/imagetool.h +0 -2
-	 * <sub-image-name>).
-	 * Thus the code to extract a file from an image must be put

here.

tools/imagetool.h +2 -0
+	 * (sub-image) from the image (i.e. dumpimage -p <position>
+	 * -o <component-outfile> <image>). Thus the code to extract a

file

tools/imagetool.h +1 -0
+	 * 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 lore raw

PATCH 1/1 tools: dumpimage: Remove remaining mentions of the -i option

In reply to Tyler Hicks
Quoted 11 lines · Tyler Hicks

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")
Cc Martyn Welch <[email protected]>

Applied to u-boot/master, thanks!

Signature · 8 lines
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>