Skip to contentSkip to conversation

Add mkimage manual

PATCH New Nobuhiro Iwamatsu 2 participants 3 messages Oct 16, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add mkimage manual

As for some distribution, a mkimage command is made a package. However, there was not manual of mkimage. This provides manual of mkimage.

---
 tools/mkimage.1 |  124 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 124 insertions(+), 0 deletions(-)
 create mode 100644 tools/mkimage.1
tools/mkimage.1 new file +20 -0
new file mode 100644
index 0000000..7b540c0
@@ -0,0 +1,124 @@
+.TH MKIMAGE 1 "2009-02-06"
+
+.SH NAME
+mkimage \- generate kernel image for U-Boot
+.SH SYNOPSIS
+.B mkimage
+.RB [\fIoptions\fP]
+.SH "DESCRIPTION"
+.B mkimage
+can also be used to create ramdisk images for use with U-Boot, either
+separated from the Linux kernel image, or combined into one file.
+mkimage encapsulates the images with a 64 byte header containing information
+about target architecture, operating system, image type, compression method,
+entry points, time stamp, CRC32 checksums, etc.
+
+.SH "MKIMAGE OPTIONS"
+
+.TP
+.BI "\-l [" "uimage file name" "]"
+mkimage lists the information contained in the header of an existing

U-Boot image.
+
+.TP
+.BI "\-A [" "architecture" "]"
+Set architecture.
+You can set the following architecture.
+.br
+\fBalpha\fR,
+\fBarm\fR,
+\fBx86\fR,
+\fBia64\fR,
+\fBm68k\fR,
+\fBmicroblaze\fR,
+\fBmips\fR,
+\fBmips64\fR,
+\fBppc\fR,
+\fBs390\fR,
+\fBsh\fR,
+\fBsparc\fR,
+\fBsparc64\fR.
+
+.TP
+.BI "\-O [" "os" "]"
+Set operating system. bootm command of u-boot changes boot method by os type. +.br
+You can set the following OS.
+.br
+\fB4_4bsd\fR,
+\fBartos\fR,
+\fBdell\fR,
+\fBesix\fR,
+\fBfreebsd\fR,
+\fBirix\fR,
+\fBlinux\fR,
+\fBlynxos\fR,
+\fBncr\fR,
+\fBnetbsd\fR,
+\fBopenbsd\fR,
+\fBpsos\fR,
+\fBqnx\fR,
+\fBrtems\fR,
+\fBsco\fR,
+\fBsolaris\fR,
+\fBsvr4\fR,
+\fBu?boot\fR,
+\fBvxworks\fR.
+.br
+
+.TP
+.BI "\-T [" "image type" "]"
+Set image type.
+.br
+You can set the following type.
+.br
+bootm and autoscr command of u-boot check this type.
+.br
+\fBfilesystem\fR,
+\fBfirmware\fR,
+\fBkernel\fR,
+\fBmulti\fR,
+\fBramdisk\fR,
+\fBscript\fR,
+\fBstandalone\fR.
+.br
+
+.TP
+.BI "\-C [" "compression type" "]"
+Set compression type.
+.br
+You can set the following type.
+.br
+\fBnone\fR,
+\fBbzip2\fR,
+\fBgzip\fR.
+
+.TP
+.BI "\-a [" "load addess" "]"
+Set load address by hex digit.
+
+.TP
+.BI "\-e [" "entry point" "]"
+Set entry point by hex digit.
+
+.TP
+.BI "\-n [" "image name" "]"
+Set image name.
+
+.TP
+.BI "\-d [" "image data file" "]"
+See image data file.
+
+.TP
+.BI "\-x"
+Set XIP (execute in place) flag.
+
+.SH HOMEPAGE
+http://www.denx.de/wiki/U-Boot/WebHome
+.PP
+.SH AUTHOR
+This manual page was written by Nobuhiro Iwamatsu <[email protected]>, +for the Debian GNU/Linux system (but may be used by others).
+
+Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU General Public License, Version 2 any later +version published by the Free Software Foundation.

Signature · 1 line
1.6.4.3
#1 lore raw

PATCH 1/1 Add mkimage manual

Quoted 1 line · On Thursday 15 October 2009 23:01:18 Nobuhiro Iwamatsu wrote:

+mkimage \- generate kernel image for U-Boot

mkimage creates bootable U-Boot images. there is no "kernel" restriction.

Quoted 6 lines

+.SH SYNOPSIS
+.B mkimage
+.RB [\fIoptions\fP]
+.SH "DESCRIPTION"
+.B mkimage
+can also be used to create ramdisk images for use with U-Boot, either

eh ? mkimage doesnt create ramdisk images afaik.

Review

Quoted 2 lines
(quoted diff) +2 -0
+separated from the Linux kernel image, or combined into one file.
+mkimage encapsulates the images with a 64 byte header containing

the exact header size doesnt matter to the description

Quoted 2 lines

information about target architecture, operating system, image type, compression method, entry points, time stamp, CRC32 checksums, etc.

i dont think CRC32 needs to be mentioned either ... "checksum" is fine.

Quoted 1 line

+.SH "MKIMAGE OPTIONS"

just "OPTIONS"

Quoted 8 lines

+.TP
+.BI "\-A [" "architecture" "]"

(quoted diff) +6 -0
+Set architecture.
+You can set the following architecture.
+.br
+\fBalpha\fR,
+\fBarm\fR,
+\fBx86\fR,

Review

Quoted 10 lines
(quoted diff) +10 -0
+\fBia64\fR,
+\fBm68k\fR,
+\fBmicroblaze\fR,
+\fBmips\fR,
+\fBmips64\fR,
+\fBppc\fR,
+\fBs390\fR,
+\fBsh\fR,
+\fBsparc\fR,
+\fBsparc64\fR.

this is pretty ugly syntax -- easy to typo and hard to read. this is why people do:
.BR foo ,
.BR moo ,
.BR cow ,

ignoring that, i dont think we need to list the arches. otherwise it's just one more random list that needs to be updated whenever arches are added/removed. better to say something like:
Pass -h as the architecture to see the list of supported architectures.

Quoted 3 lines

+.BI "\-O [" "os" "]"
+Set operating system. bootm command of u-boot changes boot method by os
type

same issues with this hardcoded list.

Quoted 2 lines

+.BI "\-T [" "image type" "]"
+Set image type.

and this list

Quoted 2 lines

+.BI "\-C [" "compression type" "]"
+Set compression type.

and this list

Review

Quoted 4 lines

+.BI "\-a [" "load addess" "]"

(quoted diff) +3 -0
+Set load address by hex digit.
+.BI "\-e [" "entry point" "]"
+Set entry point by hex digit.

"by hex digit" -> "with a hex number"

Quoted 2 lines

+.BI "\-n [" "image name" "]"
+Set image name.

be good to mention that the name is purely a human friendly description

Quoted 2 lines

+.BI "\-d [" "image data file" "]"
+See image data file.

should expand on what exactly an "image data file" is ... copying the short description from mkimage -h isnt terribly useful

Review

Quoted 3 lines

+.SH AUTHOR

(quoted diff) +2 -0
+This manual page was written by Nobuhiro Iwamatsu <[email protected]>,
+for the Debian GNU/Linux system (but may be used by others).

was it really written for Debian GNU/Linux, or did you just copy & paste from some other file ?

Review

Quoted 3 lines
(quoted diff) +3 -0
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU General Public License, Version 2 any later
+version published by the Free Software Foundation.

i'd stick the licensing info as a comment at the top of the file. personally, i find licensing blobs in man pages to be pure noise. anyone who cares about the "source" will read it and see the license info.
-mike
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 836 bytes
Desc: This is a digitally signed message part.
Url : http://lists.denx.de/pipermail/u-boot/attachments/20091015/8a181779/attachment.pgp

#2 lore raw

PATCH 1/1 Add mkimage manual

Hi, Mike.

Thank you for comment.

2009/10/16 Mike Frysinger <[email protected]>:

Quoted 4 lines · On Thursday 15 October 2009 23:01:18 Nobuhiro Iwamatsu wrote:
Quoted 1 line

+mkimage \- generate kernel image for U-Boot

mkimage creates bootable U-Boot images. ?there is no "kernel" restriction.

OK.

Quoted 17 lines
Quoted 7 lines

+.SH SYNOPSIS
+.B mkimage
+.RB [\fIoptions\fP]
+.SH "DESCRIPTION"
+.B mkimage
+can also be used to create ramdisk images for use with U-Boot, either

eh ? ?mkimage doesnt create ramdisk images afaik.

Review

Quoted 2 lines
(quoted diff) +2 -0
+separated from the Linux kernel image, or combined into one file.
+mkimage encapsulates the images with a 64 byte header containing

the exact header size doesnt matter to the description

Quoted 8 lines
Quoted 2 lines

?information about target architecture, operating system, image type, ?compression method, entry points, time stamp, CRC32 checksums, etc.

i dont think CRC32 needs to be mentioned either ... "checksum" is fine.

Quoted 1 line

+.SH "MKIMAGE OPTIONS"

just "OPTIONS"

OK.

Quoted 26 lines
Quoted 9 lines

+.TP
+.BI "\-A [" "architecture" "]"

(quoted diff) +6 -0
+Set architecture.
+You can set the following architecture.
+.br
+\fBalpha\fR,
+\fBarm\fR,
+\fBx86\fR,

Review

Quoted 10 lines
(quoted diff) +10 -0
+\fBia64\fR,
+\fBm68k\fR,
+\fBmicroblaze\fR,
+\fBmips\fR,
+\fBmips64\fR,
+\fBppc\fR,
+\fBs390\fR,
+\fBsh\fR,
+\fBsparc\fR,
+\fBsparc64\fR.

this is pretty ugly syntax -- easy to typo and hard to read. ?this is why people do:
.BR foo ,
.BR moo ,
.BR cow ,

Quoted 4 lines

ignoring that, i dont think we need to list the arches. ?otherwise it's just one more random list that needs to be updated whenever arches are added/removed. ?better to say something like:
Pass -h as the architecture to see the list of supported architectures.

OK, I will fix.

Quoted 27 lines
Quoted 4 lines

+.BI "\-O [" "os" "]"
+Set operating system. bootm command of u-boot changes boot method by os ?type

same issues with this hardcoded list.

Quoted 2 lines

+.BI "\-T [" "image type" "]"
+Set image type.

and this list

Quoted 2 lines

+.BI "\-C [" "compression type" "]"
+Set compression type.

and this list

Review

Quoted 4 lines

+.BI "\-a [" "load addess" "]"

(quoted diff) +3 -0
+Set load address by hex digit.
+.BI "\-e [" "entry point" "]"
+Set entry point by hex digit.

"by hex digit" -> "with a hex number"

Quoted 2 lines

+.BI "\-n [" "image name" "]"
+Set image name.

Quoted 8 lines

be good to mention that the name is purely a human friendly description

Quoted 2 lines

+.BI "\-d [" "image data file" "]"
+See image data file.

should expand on what exactly an "image data file" is ... copying the short description from mkimage -h isnt terribly useful

OK.

Quoted 6 lines

Review

Quoted 3 lines

+.SH AUTHOR

(quoted diff) +2 -0
+This manual page was written by Nobuhiro Iwamatsu <[email protected]>,
+for the Debian GNU/Linux system (but may be used by others).

was it really written for Debian GNU/Linux, or did you just copy & paste from some other file ?

I wrote this for uboot-mkimage of Debian.
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=514445

However, it is not a problem that I delete a line of Debian.

Quoted 8 lines

Review

Quoted 4 lines
(quoted diff) +3 -0
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU General Public License, Version 2 any later
+version published by the Free Software Foundation.

i'd stick the licensing info as a comment at the top of the file. ?personally, i find licensing blobs in man pages to be pure noise. ?anyone who cares about the "source" will read it and see the license info.

You are right.

OK, I will fix your point and resend.

Thank you a lot.
--
Nobuhiro