diff mbox

[U-Boot] doc: README.mxsimage: Use mkimage provided by U-boot

Message ID 1379261501-18624-1-git-send-email-festevam@gmail.com
State Changes Requested
Delegated to: Stefano Babic
Headers show

Commit Message

Fabio Estevam Sept. 15, 2013, 4:11 p.m. UTC
From: Fabio Estevam <fabio.estevam@freescale.com>

Fix the text to make clear that the 'mkimage' provided by U-boot should be used
instead of the one provided by the host PC distribution.

While at it, also fix the directory location of the configuration files.

After these changes, it is possible succesfully generate a u-boot.sb image.

Signed-off-by: Fabio Estevam <fabio.estevam@freescale.com>
---
 doc/README.mxsimage | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Marek Vasut Sept. 15, 2013, 4:45 p.m. UTC | #1
Dear Fabio Estevam,

> From: Fabio Estevam <fabio.estevam@freescale.com>
> 
> Fix the text to make clear that the 'mkimage' provided by U-boot should be
> used instead of the one provided by the host PC distribution.
> 
> While at it, also fix the directory location of the configuration files.
> 
> After these changes, it is possible succesfully generate a u-boot.sb image.
> 
> Signed-off-by: Fabio Estevam <fabio.estevam@freescale.com>
> ---
>  doc/README.mxsimage | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/README.mxsimage b/doc/README.mxsimage
> index 88a2caf..79cd06e 100644
> --- a/doc/README.mxsimage
> +++ b/doc/README.mxsimage
> @@ -9,12 +9,12 @@ Usage -- producing image:
>  The mxsimage tool is targeted to be a simple replacement for the elftosb2
> . To generate an image, write an image configuration file and run:
> 
> - mkimage -A arm -O u-boot -T mxsimage -n <path to configuration file> \
> + ./tools/mkimage -A arm -O u-boot -T mxsimage -n <path to configuration
> file> \ <output bootstream file>
> 
>  The output bootstream file is usually using the .sb file extension. Note
>  that the example configuration files for producing bootable BootStream
> with -the U-Boot bootloader can be found under
> arch/arm/boot/cpu/arm926ejs/mxs/ +the U-Boot bootloader can be found under
> arch/arm/cpu/arm926ejs/mxs/ directory. See the following files:
> 
>   mxsimage.mx23.cfg -- This is an example configuration for i.MX23
> @@ -158,7 +158,7 @@ Usage -- verifying image:
>  The mxsimage can also verify and dump contents of an image. Use the
> following syntax to verify and dump contents of an image:
> 
> - mkimage -l <input bootstream file>
> + ./tools/mkimage -l <input bootstream file>
> 
>  This will output all the information from the SB image header and all the
>  instructions contained in the SB image. It will also check if the various

Tom, are you OK with such a hack (invoking the in-tree mkimage) in the 
documentation?

Best regards,
Marek Vasut
Fabio Estevam Sept. 15, 2013, 4:50 p.m. UTC | #2
Hi Marek,

On Sun, Sep 15, 2013 at 1:45 PM, Marek Vasut <marex@denx.de> wrote:

> Tom, are you OK with such a hack (invoking the in-tree mkimage) in the
> documentation?

This seems to be a common practice in the U-boot doc directory:

doc/README.imximage:./tools/mkimage -l <mx u-boot_file>
doc/README.imximage:./tools/mkimage -T imximage \
doc/README.imximage:./tools/mkimage -n ./board/freescale/mx51evk/imximage.cfg \
doc/README.kwbimage:./tools/mkimage -l <kwboot_file>
doc/README.kwbimage:./tools/mkimage -n <board specific configuration file> \
doc/README.kwbimage:./tools/mkimage -n ./board/Marvell/openrd_base/kwbimage.cfg
doc/README.mxsimage: ./tools/mkimage -A arm -O u-boot -T mxsimage -n <path to co
doc/README.mxsimage: ./tools/mkimage -l <input bootstream file>
doc/README.qemu-mips:# tools/mkimage -A mips -O linux -T kernel -C gzip -a 0x800
doc/README.ublimage:./tools/mkimage -l <u-boot_file>
doc/README.ublimage:./tools/mkimage -T ublimage \
doc/README.ublimage:./tools/mkimage -n ./board/davinci/dm365evm/ublimage.cfg \
doc/SPL/README.am335x-network:$ ./tools/mkimage -A arm -O U-Boot -C none -T scri

Regards,

Fabio Estevam
Otavio Salvador Sept. 15, 2013, 10:58 p.m. UTC | #3
On Sun, Sep 15, 2013 at 1:50 PM, Fabio Estevam <festevam@gmail.com> wrote:
> Hi Marek,
>
> On Sun, Sep 15, 2013 at 1:45 PM, Marek Vasut <marex@denx.de> wrote:
>
>> Tom, are you OK with such a hack (invoking the in-tree mkimage) in the
>> documentation?
>
> This seems to be a common practice in the U-boot doc directory:
>
> doc/README.imximage:./tools/mkimage -l <mx u-boot_file>
> doc/README.imximage:./tools/mkimage -T imximage \
> doc/README.imximage:./tools/mkimage -n ./board/freescale/mx51evk/imximage.cfg \
> doc/README.kwbimage:./tools/mkimage -l <kwboot_file>
> doc/README.kwbimage:./tools/mkimage -n <board specific configuration file> \
> doc/README.kwbimage:./tools/mkimage -n ./board/Marvell/openrd_base/kwbimage.cfg
> doc/README.mxsimage: ./tools/mkimage -A arm -O u-boot -T mxsimage -n <path to co
> doc/README.mxsimage: ./tools/mkimage -l <input bootstream file>
> doc/README.qemu-mips:# tools/mkimage -A mips -O linux -T kernel -C gzip -a 0x800
> doc/README.ublimage:./tools/mkimage -l <u-boot_file>
> doc/README.ublimage:./tools/mkimage -T ublimage \
> doc/README.ublimage:./tools/mkimage -n ./board/davinci/dm365evm/ublimage.cfg \
> doc/SPL/README.am335x-network:$ ./tools/mkimage -A arm -O U-Boot -C none -T scri

Acked-by: Otavio Salvador <otavio@ossystems.com.br>
Tom Rini Sept. 19, 2013, 2:48 p.m. UTC | #4
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 09/15/2013 06:58 PM, Otavio Salvador wrote:
> On Sun, Sep 15, 2013 at 1:50 PM, Fabio Estevam <festevam@gmail.com> wrote:
>> Hi Marek,
>>
>> On Sun, Sep 15, 2013 at 1:45 PM, Marek Vasut <marex@denx.de> wrote:
>>
>>> Tom, are you OK with such a hack (invoking the in-tree mkimage) in the
>>> documentation?
>>
>> This seems to be a common practice in the U-boot doc directory:
>>
>> doc/README.imximage:./tools/mkimage -l <mx u-boot_file>
>> doc/README.imximage:./tools/mkimage -T imximage \
>> doc/README.imximage:./tools/mkimage -n ./board/freescale/mx51evk/imximage.cfg \
>> doc/README.kwbimage:./tools/mkimage -l <kwboot_file>
>> doc/README.kwbimage:./tools/mkimage -n <board specific configuration file> \
>> doc/README.kwbimage:./tools/mkimage -n ./board/Marvell/openrd_base/kwbimage.cfg
>> doc/README.mxsimage: ./tools/mkimage -A arm -O u-boot -T mxsimage -n <path to co
>> doc/README.mxsimage: ./tools/mkimage -l <input bootstream file>
>> doc/README.qemu-mips:# tools/mkimage -A mips -O linux -T kernel -C gzip -a 0x800
>> doc/README.ublimage:./tools/mkimage -l <u-boot_file>
>> doc/README.ublimage:./tools/mkimage -T ublimage \
>> doc/README.ublimage:./tools/mkimage -n ./board/davinci/dm365evm/ublimage.cfg \
>> doc/SPL/README.am335x-network:$ ./tools/mkimage -A arm -O U-Boot -C none -T scri
> 
> Acked-by: Otavio Salvador <otavio@ossystems.com.br>

Acked-by: Tom Rini <trini@ti.com>

- -- 
Tom
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQIcBAEBAgAGBQJSOw63AAoJENk4IS6UOR1Ww5YP/0+t+Q4CFLv0TND3Tz/i/V0u
j5ifPl0KBrYNkwJY+ZVjCCT2XqmTEVZstkUqCoyrFHwBc2+4hxa3Mc/ZpJwe1gIe
yeUOxDNFE+NpZpSiwQ5nopqLy//de300u0ElDy3QqBJBwc0NIz4hnKetZiGPzIRF
0CSKng+jGoYKvNu3weOuA8dtA4AqbVzR6PMkJLQxgZSclp4wThLhf2PTMcsbhILw
FJXDcuoUST3fkv24U/h2aqS1BYnMaCaVJh9l0keZs/PqtPEvuHjbQEieMTHVz51E
Q8crfSy4yUimkqBAZzFTLpBrP9/TaXokXFuYJ/rWqVxT56f+MSQpsofyeKS9fR95
B8A9yAg+84XaG6tk9sbT+UNfzscdizPJXJnjL5wNrBykxXXbbCBawm2/lZMz2rw3
EIZelYrSuhHHZOOJCIEY0nPVXpEoIDn1ndr6uin7chsfdAtnAgSRTrcdf8qjlUnW
47DPDtKEi91BwFHc//k6jXEf69OCRSyecn8coF54ddEsRn7QDJRO791XvHKAvIUD
PJkNG/rGTv/1J0sqHLAUuowl8tr+dFxJSGp3kHkX2JQ0LsrYqZJq1wDGTLZ8OPbF
XXI8gFytDEC/TJnr8ft7Kl8iKqM6aYc7zLFAIe85P2CWbpsf+Y3C0NOug+5kXWJP
1T9P/B8OWZ1YRTGlwDj6
=SK11
-----END PGP SIGNATURE-----
diff mbox

Patch

diff --git a/doc/README.mxsimage b/doc/README.mxsimage
index 88a2caf..79cd06e 100644
--- a/doc/README.mxsimage
+++ b/doc/README.mxsimage
@@ -9,12 +9,12 @@  Usage -- producing image:
 The mxsimage tool is targeted to be a simple replacement for the elftosb2 .
 To generate an image, write an image configuration file and run:
 
- mkimage -A arm -O u-boot -T mxsimage -n <path to configuration file> \
+ ./tools/mkimage -A arm -O u-boot -T mxsimage -n <path to configuration file> \
          <output bootstream file>
 
 The output bootstream file is usually using the .sb file extension. Note
 that the example configuration files for producing bootable BootStream with
-the U-Boot bootloader can be found under arch/arm/boot/cpu/arm926ejs/mxs/
+the U-Boot bootloader can be found under arch/arm/cpu/arm926ejs/mxs/
 directory. See the following files:
 
  mxsimage.mx23.cfg -- This is an example configuration for i.MX23
@@ -158,7 +158,7 @@  Usage -- verifying image:
 The mxsimage can also verify and dump contents of an image. Use the following
 syntax to verify and dump contents of an image:
 
- mkimage -l <input bootstream file>
+ ./tools/mkimage -l <input bootstream file>
 
 This will output all the information from the SB image header and all the
 instructions contained in the SB image. It will also check if the various