Update wic related documentation
cover Update wic related documentation
Hi,
Synchronized output of 'wic help kickstart' with the dev manual. Updated list of image types in ref-variables.
The following changes since commit 2cd061a29a94fdcdfec86732e6bcbb71c12c4afc:
bluez5: include the patch only for 5.36 (2015-12-28 13:02:11 +0000)
are available in the git repository at:
git://git.yoctoproject.org/poky-contrib ed/wic/documentation-8821
http://git.yoctoproject.org/cgit.cgi/poky-contrib/log/?h=ed/wic/documentation-8821
Ed Bartosh (7):
dev-manual: describe creation of empty partition
dev-manual: add description of --no-table option
dev-manual: add description of --extra-space option
dev-manual: add description of --overhead-factor option
dev-manual: add description of UUID options
dev-manual: add description of --configfile option
ref-variables: update list of image types
.../dev-manual/dev-manual-common-tasks.xml | 39 +++++++++++++++++++- documentation/ref-manual/ref-variables.xml | 41 ++++++++++++++-------- 2 files changed, 65 insertions(+), 15 deletions(-)
--
Regards,
Ed
PATCH 1/7 dev-manual: describe creation of empty partition
Copied an explanations of empty partition creation from 'wic help kickstart' output.
[YOCTO #8821]
--- documentation/dev-manual/dev-manual-common-tasks.xml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-)
documentation/dev-manual/dev-manual-common-tasks.xml +6 -1
@@ -4561,7 +4561,12 @@ Exactly what those contents and filesystem type end up being are dependent on the given plugin implementation. - </para></listitem> + </para> + <para>If <filename>--source</filename>option is not used, the <filename>wic</filename> + command will create empty partition. <filename>--size</filename> parameter has + to be used to specify size of empty partition. + </para> + </listitem> <listitem><para><emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis> Forces the partition to be created on a particular disk.</para></listitem>
Signature · 1 line
2.1.4
PATCH 2/7 dev-manual: add description of --no-table option
In reply to Ed BartoshAdded description of wic kickstart part --no-table option to OpenEmbedded Kickstart (.wks) Reference
--- documentation/dev-manual/dev-manual-common-tasks.xml | 4 ++++ 1 file changed, 4 insertions(+)
documentation/dev-manual/dev-manual-common-tasks.xml +4 -0
@@ -4609,6 +4609,10 @@ This option is a <filename>wic</filename>-specific option that says to start a partition on an x KBytes boundary.</para></listitem> + <listitem><para><emphasis><filename>--no-table</filename>:</emphasis> + This option is a <filename>wic</filename>-specific option. + Space will be reserved for the partition and it will be + populated but it will not be added to the partition table.</para></listitem> </itemizedlist> </para> </section>
Signature · 1 line
2.1.4
PATCH 3/7 dev-manual: add description of --extra-space option
In reply to Ed BartoshAdded description of wic kickstart part --extra-space option to OpenEmbedded Kickstart (.wks) Reference
--- documentation/dev-manual/dev-manual-common-tasks.xml | 5 +++++ 1 file changed, 5 insertions(+)
documentation/dev-manual/dev-manual-common-tasks.xml +5 -0
@@ -4613,6 +4613,11 @@ This option is a <filename>wic</filename>-specific option. Space will be reserved for the partition and it will be populated but it will not be added to the partition table.</para></listitem> + <listitem><para><emphasis><filename>--extra-space</filename>:</emphasis> + This option is a <filename>wic</filename>-specific option that + adds extra space after the space filled by the content + of the partition. The final size can go beyond the size specified + by <filename>--size</filename>. Default value is 10MB.</para></listitem> </itemizedlist> </para> </section>
Signature · 1 line
2.1.4
PATCH 4/7 dev-manual: add description of --overhead-factor option
In reply to Ed BartoshAdded description of wic kickstart part --overhead-factor option to OpenEmbedded Kickstart (.wks) Reference
--- documentation/dev-manual/dev-manual-common-tasks.xml | 4 ++++ 1 file changed, 4 insertions(+)
documentation/dev-manual/dev-manual-common-tasks.xml +4 -0
@@ -4618,6 +4618,10 @@ adds extra space after the space filled by the content of the partition. The final size can go beyond the size specified by <filename>--size</filename>. Default value is 10MB.</para></listitem> + <listitem><para><emphasis><filename>--overhead-factor</filename>:</emphasis> + This option is a <filename>wic</filename>-specific. + The size of the partition is multiplied by this factor. It has to be + greater than or equal to 1. The default value is 1.3.</para></listitem> </itemizedlist> </para> </section>
Signature · 1 line
2.1.4
PATCH 5/7 dev-manual: add description of UUID options
In reply to Ed BartoshAdded description of 3 wic kickstart part options related to UUID:
--part-type, --use-uuid and --uuid to OpenEmbedded Kickstart (.wks) Reference.
--- documentation/dev-manual/dev-manual-common-tasks.xml | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
documentation/dev-manual/dev-manual-common-tasks.xml +14 -0
@@ -4622,6 +4622,20 @@ This option is a <filename>wic</filename>-specific. The size of the partition is multiplied by this factor. It has to be greater than or equal to 1. The default value is 1.3.</para></listitem> + <listitem><para><emphasis><filename>--part-type</filename>:</emphasis> + This option is specific to <filename>wic</filename>. + It specifies partition type GUID for GPT partitions. + List of partition type GUIDS can be found here: + <ulink url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs'> + </ulink></para></listitem> + <listitem><para><emphasis><filename>--use-uuid</filename>:</emphasis> + This option is specific to <filename>wic</filename>. + It makes <filename>wic</filename> to generate random globally unique + identifier (GUID) for the partition and use it in bootloader configuration + to specify root partition.</para></listitem> + <listitem><para><emphasis><filename>--uuid</filename>:</emphasis> + This option is specific to <filename>wic</filename>. + It specifies partition UUID.</para></listitem> </itemizedlist> </para> </section>
Signature · 1 line
2.1.4
PATCH 6/7 dev-manual: add description of --configfile option
In reply to Ed BartoshAdded description of wic kickstart bootloader --configfile option to OpenEmbedded Kickstart (.wks) Reference.
--- documentation/dev-manual/dev-manual-common-tasks.xml | 5 +++++ 1 file changed, 5 insertions(+)
documentation/dev-manual/dev-manual-common-tasks.xml +5 -0
@@ -4665,6 +4665,11 @@ <filename>APPEND</filename> or <filename>grub</filename> kernel command line. </para></listitem> + <listitem><para><emphasis><filename>--configfile</filename>:</emphasis> + Specifies a user defined configuration file for the bootloader. + This file must be located in the canned-wks folder or could be the + full path to the file. This option overrides all other bootloader + options.</para></listitem> </itemizedlist> </para> </section>
Signature · 1 line
2.1.4
PATCH 7/7 ref-variables: update list of image types
In reply to Ed BartoshUpdated list of supported image types. Ordered them alphabetically to make the list more readable.
--- documentation/ref-manual/ref-variables.xml | 41 ++++++++++++++++++++---------- 1 file changed, 27 insertions(+), 14 deletions(-)
documentation/ref-manual/ref-variables.xml +27 -14
@@ -5768,32 +5768,45 @@ Specifies the complete list of supported image types by default: <literallayout class='monospaced'> - jffs2 - jffs2.sum + btrfs + cpio + cpio.gz + cpio.lz4 + cpio.lzma + cpio.xz cramfs + elf ext2 - ext2.gz ext2.bz2 + ext2.gz + ext2.lzma ext3 ext3.gz - ext2.lzma - btrfs - live + ext4 + ext4.gz + hdddirect + hddimg + iso + jffs2 + jffs2.sum + multiubi + qcow2 squashfs + squashfs-lzo squashfs-xz - ubi - ubifs tar - tar.gz tar.bz2 + tar.gz + tar.lz4 tar.xz - cpio - cpio.gz - cpio.xz - cpio.lzma + ubi + ubifs vdi vmdk - elf + wic + wic.bz2 + wic.gz + wic.lzma </literallayout> </para>
Signature · 1 line
2.1.4