* [PATCH 1/5] dev-manual: Add 'Creating Partitioned Images/Plugins' subsection
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
@ 2014-07-29 19:33 ` Tom Zanussi
2014-07-29 19:33 ` [PATCH 2/5] dev-manual: Add squashfs to --fstypes documentation Tom Zanussi
` (3 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
Add a new section discussing plugins, taken directly from the
corresponding wic help section.
Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
.../dev-manual/dev-manual-common-tasks.xml | 158 +++++++++++++++++++++
1 file changed, 158 insertions(+)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index c4c3d9f..c3df8b3 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3916,6 +3916,164 @@
</section>
</section>
+ <section id='openembedded-kickstart-plugins'>
+ <title>Plugins</title>
+
+ <para>
+ Plugins allow <filename>wic</filename> functionality to
+ be extended and specialized by users. This section
+ documents the plugin interface, which is currently
+ restricted to 'source' plugins.
+ </para>
+
+ <para>
+ 'Source' plugins provide a mechanism to customize
+ various aspects of the image generation process in
+ <filename>wic</filename>, mainly the contents of
+ partitions.
+ </para>
+
+ <para>
+ Source plugins provide a mechanism for mapping values
+ specified in <filename>.wks</filename> files using the
+ <filename>--source</filename> keyword to a particular
+ plugin implementation that populates a corresponding
+ partition.
+ </para>
+
+ <para>
+ A source plugin is created as a subclass of
+ <filename>SourcePlugin</filename> (see
+ <filename>scripts/lib/mic/pluginbase.py</filename>) and
+ the plugin file containing it is added to
+ <filename>scripts/lib/mic/plugins/source/</filename> to
+ make the plugin implementation available to the
+ <filename>wic</filename> implementation.
+ </para>
+
+ <para>
+ Source plugins can also be implemented and added by
+ external layers - any plugins found in a
+ <filename>scripts/lib/mic/plugins/source/</filename>
+ directory in an external layer will also be made
+ available.
+ </para>
+
+ <para>
+ When the <filename>wic</filename> implementation needs
+ to invoke a partition-specific implementation, it looks
+ for the plugin that has the same name as the
+ <filename>--source</filename> param given to that
+ partition. For example, if the partition is set up like
+ this:
+ </para>
+
+ <para>
+ <literallayout class='monospaced'>
+ part /boot --source bootimg-pcbios ...
+ </literallayout>
+ </para>
+
+ <para>
+ then the methods defined as class members of the plugin
+ having the matching <filename>bootimg-pcbios
+ .name</filename> class member would be used.
+ </para>
+
+ <para>
+ To be more concrete, here's the plugin definition that
+ would match a <filename>'--source
+ bootimg-pcbios'</filename> usage, along with an example
+ method that would be called by the
+ <filename>wic</filename> implementation when it needed
+ to invoke an implementation-specific
+ partition-preparation function:
+ </para>
+
+ <para>
+ <literallayout class='monospaced'>
+ class BootimgPcbiosPlugin(SourcePlugin):
+ name = 'bootimg-pcbios'
+
+ @classmethod
+ def do_prepare_partition(self, part, ...)
+ </literallayout>
+ </para>
+
+ <para>
+ If the subclass itself doesn't implement a function, a
+ 'default' version in a superclass will be located and
+ used, which is why all plugins must be derived from
+ <filename>SourcePlugin</filename>.
+ </para>
+
+ <para>
+ The <filename>SourcePlugin</filename> class defines the
+ following methods, which is the current set of methods
+ that can be implemented/overridden by
+ <filename>--source</filename> plugins. Any methods not
+ implemented by a <filename>SourcePlugin</filename>
+ subclass inherit the implementations present in the
+ <filename>SourcePlugin</filename> class (see the
+ <filename>SourcePlugin</filename> source for details):
+ </para>
+
+ <para>
+ <itemizedlist>
+ <listitem><para><emphasis><filename>do_prepare_partition()</filename>:</emphasis>
+ Called to do the actual content population for a
+ partition. In other words, it 'prepares' the final
+ partition image which will be incorporated into the
+ disk image. </para></listitem>
+
+ <listitem><para><emphasis><filename>do_configure_partition()</filename>:</emphasis>
+ Called before
+ <filename>do_prepare_partition()</filename>, typically
+ used to create custom configuration files for a
+ partition, for example syslinux or grub config files.
+ </para></listitem>
+
+ <listitem><para><emphasis><filename>do_install_disk()</filename>:</emphasis>
+ Called after all partitions have been prepared and
+ assembled into a disk image. This provides a hook to
+ allow finalization of a disk image, for example to
+ write an MBR to it. </para></listitem>
+
+ <listitem><para><emphasis><filename>do_stage_partition()</filename>:</emphasis>
+ Special content-staging hook called before
+ <filename>do_prepare_partition()</filename>, normally
+ empty.
+ <para>
+ Typically, a partition will just use the passed-in
+ parameters, for example the unmodified value of
+ <filename>bootimg_dir</filename>. In some cases,
+ however, things may need to be more tailored. As an
+ example, certain files may additionally need to be
+ taken from <filename>bootimg_dir + /boot</filename>.
+ This hook allows those files to be staged in a
+ customized fashion. Note that
+ <filename>get_bitbake_var()</filename> allows you to
+ access non-standard variables that you might want to
+ use for this.
+ </para>
+ </para></listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ This scheme is extensible - adding more hooks is a
+ simple matter of adding more plugin methods to
+ <filename>SourcePlugin</filename> and derived classes.
+ The code that then needs to call the plugin methods uses
+ <filename>plugin.get_source_plugin_methods()</filename>
+ to find the method(s) needed by the call; this is done
+ by filling up a dict with keys containing the method
+ names of interest - on success, these will be filled in
+ with the actual methods. Please see the implementation
+ for examples and details.
+ </para>
+ </section>
+
<section id='openembedded-kickstart-wks-reference'>
<title>OpenEmbedded Kickstart (.wks) Reference</title>
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 2/5] dev-manual: Add squashfs to --fstypes documentation
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
2014-07-29 19:33 ` [PATCH 1/5] dev-manual: Add 'Creating Partitioned Images/Plugins' subsection Tom Zanussi
@ 2014-07-29 19:33 ` Tom Zanussi
2014-07-29 19:33 ` [PATCH 3/5] dev-manual: Add documentation for --fsoptions Tom Zanussi
` (2 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
squashfs support was recently added to wic, so document it.
Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
documentation/dev-manual/dev-manual-common-tasks.xml | 2 ++
1 file changed, 2 insertions(+)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index c3df8b3..f8a1398 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4174,6 +4174,8 @@
</para></listitem>
<listitem><para><filename>btrfs</filename>
</para></listitem>
+ <listitem><para><filename>squashfs</filename>
+ </para></listitem>
<listitem><para><filename>swap</filename>
</para></listitem>
</itemizedlist></para></listitem>
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 0/5] dev-manual updates for wic
@ 2014-07-29 19:33 Tom Zanussi
2014-07-29 19:33 ` [PATCH 1/5] dev-manual: Add 'Creating Partitioned Images/Plugins' subsection Tom Zanussi
` (4 more replies)
0 siblings, 5 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
This patchset updates the wic documentation in the dev-manual for
master.
The following changes since commit 2d1660112e54653f7bb763939d0416472c49fe01:
populate_sdk_base: Fix grep command usage on old hosts (2014-07-29 09:58:27 +0100)
are available in the git repository at:
git://git.yoctoproject.org/poky-contrib.git tzanussi/dev-manual-wic-updates
http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=tzanussi/dev-manual-wic-updates
Tom Zanussi (5):
dev-manual: Add 'Creating Partitioned Images/Plugins' subsection
dev-manual: Add squashfs to --fstypes documentation
dev-manual: Add documentation for --fsoptions
dev-manual: Various updates to the 'Creating Partitioned Images'
section
dev-manual: Various minor fixes for 'Creating Partitioned Images'
section
.../dev-manual/dev-manual-common-tasks.xml | 399 ++++++++++++++++-----
1 file changed, 308 insertions(+), 91 deletions(-)
--
1.8.3.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 3/5] dev-manual: Add documentation for --fsoptions
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
2014-07-29 19:33 ` [PATCH 1/5] dev-manual: Add 'Creating Partitioned Images/Plugins' subsection Tom Zanussi
2014-07-29 19:33 ` [PATCH 2/5] dev-manual: Add squashfs to --fstypes documentation Tom Zanussi
@ 2014-07-29 19:33 ` Tom Zanussi
2014-07-29 19:33 ` [PATCH 4/5] dev-manual: Various updates to the 'Creating Partitioned Images' section Tom Zanussi
2014-07-29 19:33 ` [PATCH 5/5] dev-manual: Various minor fixes for " Tom Zanussi
4 siblings, 0 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
--fsoptions support was recently added to wic, so document it.
Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
documentation/dev-manual/dev-manual-common-tasks.xml | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index f8a1398..c00c961 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -4179,6 +4179,14 @@
<listitem><para><filename>swap</filename>
</para></listitem>
</itemizedlist></para></listitem>
+ <listitem><para><emphasis><filename>--fsoptions</filename>:</emphasis>
+ Specifies a free-form string of options to be
+ used when mounting the filesystem. This string
+ will be copied into the
+ <filename>/etc/fstab</filename> file of the
+ installed system and should be enclosed in
+ quotes. If not specified, the default string
+ is "defaults".</para></listitem>
<listitem><para><emphasis><filename>--label label</filename>:</emphasis>
Specifies the label to give to the filesystem to
be made on the partition.
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 4/5] dev-manual: Various updates to the 'Creating Partitioned Images' section
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
` (2 preceding siblings ...)
2014-07-29 19:33 ` [PATCH 3/5] dev-manual: Add documentation for --fsoptions Tom Zanussi
@ 2014-07-29 19:33 ` Tom Zanussi
2014-07-29 19:33 ` [PATCH 5/5] dev-manual: Various minor fixes for " Tom Zanussi
4 siblings, 0 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
This is a set of miscellaneous updates brought over from the wic help
text.
Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
.../dev-manual/dev-manual-common-tasks.xml | 137 +++++++++++++--------
1 file changed, 86 insertions(+), 51 deletions(-)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index c00c961..e72e983 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3380,6 +3380,15 @@
</para>
<para>
+ The <filename>wic</filename> command and the infrastructure
+ it's based on is by definition incomplete - its purpose is
+ to allow the generation of customized images, and as such
+ was designed to be completely extensible via a plugin
+ interface (see "<link
+ linkend='openembedded-kickstart-plugins'>Plugins</link>").
+ </para>
+
+ <para>
This section provides some background information on
<filename>wic</filename>, describes what you need to have in
place to run the tool, provides instruction on how to use
@@ -3416,12 +3425,13 @@
easier-to-use and more flexible replacements for a
couple bits of existing functionality in OE Core's
<filename>directdisk.bbclass</filename> and
- <filename>mkefidisk.sh</filename> script.
- The replaced scripts are implemented by a
- general-purpose partitioning language based on Red Hat
- kickstart syntax.
- Underlying code for <filename>wic</filename> succeeded
- from several projects over time.</para></listitem>
+ <filename>mkefidisk.sh</filename> scripts.
+ The difference between
+ <filename>wic</filename> and those examples is
+ that with <filename>wic</filename> the
+ functionality of those scripts is implemented
+ by a general-purpose partitioning 'language'
+ based on Redhat kickstart syntax.</para></listitem>
</itemizedlist>
</para>
</section>
@@ -3496,6 +3506,19 @@
</para>
<para>
+ You can also get detailed help on a number of topics
+ from the help system. The output of <filename>wic
+ --help</filename> displays a list of available help
+ topics under a 'Help topics' heading. You can have
+ the help system display the help text for a given
+ topic by prefacing the topic with <filename>wic
+ help</filename>:
+ <literallayout class='monospaced'>
+ $ wic help <help topic>
+ </literallayout>
+ </para>
+
+ <para>
You can find more out about the images
<filename>wic</filename> creates using the provided
kickstart files with the following form of the command:
@@ -3512,8 +3535,10 @@
<title>Operational Modes</title>
<para>
- You can run <filename>wic</filename> in two modes: Raw and
- Cooked:
+ <filename>wic</filename> can be used in two different
+ modes, depending on how much control the user needs in
+ specifying the Openembedded build artifacts that will be
+ used in creating the image: Raw and Cooked:
<itemizedlist>
<listitem><para><emphasis>Raw Mode:</emphasis>
You explicitly specify build artifacts through
@@ -3655,7 +3680,7 @@
# long-description: Creates a partitioned EFI disk image that the user
# can directly dd to boot media.
- part /boot ‐‐source bootimg-efi ‐‐ondisk sda ‐‐fstype=efi ‐‐active
+ part /boot ‐‐source bootimg-efi ‐‐ondisk sda ‐‐active
part / ‐‐source rootfs ‐‐ondisk sda ‐‐fstype=ext3 ‐‐label platform
@@ -3798,7 +3823,7 @@
The example changes the following two lines and leaves the
remaining lines untouched:
<literallayout class='monospaced'>
- part /boot --source bootimg --ondisk sdb --fstype=msdos --label boot --active --align 1024
+ part /boot --source bootimg-pcbios --ondisk sdb --label boot --active --align 1024
part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
</literallayout>
Once the lines are changed, the example generates the
@@ -4129,32 +4154,49 @@
You do not need this option if you use
<filename>--source</filename>.</para></listitem>
<listitem><para><emphasis><filename>--source</filename>:</emphasis>
- This option is a wic-specific option that can
- currently have one of two values, "bootimg" or
- "rootfs".</para>
- <para>If <filename>--source rootfs</filename> is
- used, it tells the <filename>wic</filename> command
- to create a partition as large as needed to fill
- with the contents of the root filesystem
- (specified by the <filename>-r</filename>
- <filename>wic</filename> option) and to fill it
- with the contents of <filename>/rootfs</filename>.
- </para>
- <para>If <filename>--source bootimg</filename>
- is used, it tells the <filename>wic</filename>
- command to create a partition as large as needed to
- fill with the contents of the boot partition
- (specified by the <filename>-b</filename>
- <filename>wic</filename> option).
- Exactly what those contents are depend on the value
- of the <filename>--fstype</filename> option for
- that partition.
- If <filename>--fstype=efi</filename> is specified,
- the boot artifacts contained in HDDDIR are used,
- and if <filename>--fstype=msdos</filename> is
- specified, the boot artifacts found in
- <filename>STAGING_DATADIR</filename> are used.
- </para></listitem>
+ This option is a
+ <filename>wic</filename>-specific option that
+ names the source of the data that will
+ populate the partition. The most common value
+ for this option is 'rootfs', but can be any
+ value which maps to a valid 'source plugin'
+ (see "<link
+ linkend='openembedded-kickstart-plugins'>Plugins</link>").</para>
+
+ <para>
+ If <filename>--source rootfs</filename> is
+ used, it tells the <filename>wic</filename>
+ command to create a partition as large as
+ needed and to fill it with the contents of
+ the root filesystem pointed to by the
+ <filename>-r</filename>
+ <filename>wic</filename> command-line option
+ (or the equivalent rootfs derived from the
+ <filename>-e</filename> command-line
+ option). The filesystem type that will be
+ used to create the partition is driven by
+ the value of the
+ <filename>--fstype</filename> option
+ specified for the partition (see
+ <filename>--fstype</filename> below).
+ </para>
+
+ <para>
+ If <filename>--source
+ <plugin-name></filename> is used, it
+ tells the <filename>wic</filename> command
+ to create a partition as large as needed and
+ to fill with the contents of the partition
+ that will be generated by the specified
+ plugin name using the data pointed to by the
+ <filename>-r</filename>
+ <filename>wic</filename> command-line option
+ (or the equivalent rootfs derived from the
+ <filename>-e</filename> command-line
+ option). Exactly what those contents and
+ filesystem type end up being are dependent
+ on the given plugin implementation. </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>
@@ -4162,10 +4204,6 @@
Sets the file system type for the partition.
Valid values are:
<itemizedlist>
- <listitem><para><filename>msdos</filename>
- </para></listitem>
- <listitem><para><filename>efi</filename>
- </para></listitem>
<listitem><para><filename>ext4</filename>
</para></listitem>
<listitem><para><filename>ext3</filename>
@@ -4220,17 +4258,14 @@
<filename>APPEND</filename> or
<filename>grub</filename> kernel command line.
</para>
- <para>The boot type is determined by the fstype of
- the <filename>/boot</filename> mountpoint.
- If the fstype is "msdos" the boot type is
- "pcbios", otherwise it is the fstype, which
- is currently "efi" (more to be added later).
- </para>
- <para>If the boot type is "efi", the image will
- use <filename>grub</filename> and has one
- menuentry: "boot".</para>
- <para>If the boot type is "pcbios", the image
- will use syslinux and has one menu label: "boot".
+ <para>
+ Note that bootloader functionality and
+ boot partitions are implemented by the
+ various <filename>--source</filename>
+ plugins that implement bootloader
+ functionality; the bootloader command
+ essentially provides a means of
+ modifying bootloader configuration.
</para>
<para>Future updates will implement more options.
If you use anything that is not specifically
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 5/5] dev-manual: Various minor fixes for 'Creating Partitioned Images' section
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
` (3 preceding siblings ...)
2014-07-29 19:33 ` [PATCH 4/5] dev-manual: Various updates to the 'Creating Partitioned Images' section Tom Zanussi
@ 2014-07-29 19:33 ` Tom Zanussi
4 siblings, 0 replies; 6+ messages in thread
From: Tom Zanussi @ 2014-07-29 19:33 UTC (permalink / raw)
To: scott.m.rifenbark, yocto; +Cc: Tom Zanussi
This is a set of fixes for miscellaneous dev-manual updates noticed
while transcribing wic help for the dev manual.
Signed-off-by: Tom Zanussi <tom.zanussi@linux.intel.com>
---
.../dev-manual/dev-manual-common-tasks.xml | 94 +++++++++++++---------
1 file changed, 54 insertions(+), 40 deletions(-)
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index e72e983..8189247 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3354,14 +3354,14 @@
<para>
Creating an image for a particular hardware target using the
OpenEmbedded build system does not necessarily mean you can boot
- that image as is on your device.
+ that image as-is on your device.
Physical devices accept and boot images in various ways depending
on the specifics of the device.
Usually, information about the hardware can tell you what image
format the device requires.
Should your device require multiple partitions on an SD card, flash,
- or an HDD, you can use the OpenEmbedded Image Creator
- to create the properly partitioned image.
+ or an HDD, you can use the OpenEmbedded Image Creator,
+ <filename>wic</filename>, to create the properly partitioned image.
</para>
<para>
@@ -3372,7 +3372,7 @@
specified either directly on the command-line or as one of a
selection of canned <filename>.wks</filename> files as shown
with the <filename>wic list images</filename> command in the
- "<link linkend='using-a-provided-kickstart_file'>Using a Provided Kickstart File</link>"
+ "<link linkend='using-a-provided-kickstart_file'>Using an Existing Kickstart File</link>"
section.
When applied to a given set of build artifacts, the result is an
image or set of images that can be directly written onto media and
@@ -3440,9 +3440,9 @@
<title>Requirements</title>
<para>
- In order to use the <filename>wic</filename> utility with the
- OpenEmbedded Build system, you need to meet the following
- requirements:
+ In order to use the <filename>wic</filename> utility
+ with the OpenEmbedded Build system, your system needs
+ to meet the following requirements:
<itemizedlist>
<listitem><para>The Linux distribution on your
development host must support the Yocto Project.
@@ -3462,14 +3462,17 @@
system.
</para></listitem>
<listitem><para>
- Have the build artifacts already available.
- You must already have created an image using the
+ You need to have the build artifacts already
+ available, which typically means that you must
+ have already created an image using the
Openembedded build system (e.g.
- <filename>core-image-minimal</filename>.
- It might seem redundant to generate an image in order
- to create an image using <filename>wic</filename>,
- but the artifacts are needed and they are generated
- with the build system.</para></listitem>
+ <filename>core-image-minimal</filename>. It
+ might seem redundant to generate an image in
+ order to create an image using
+ <filename>wic</filename>, but in the current
+ version the artifacts are needed in the form
+ generated by the build
+ system.</para></listitem>
<listitem><para>
You must have sourced one of the build environment
setup scripts (i.e.
@@ -3519,8 +3522,8 @@
</para>
<para>
- You can find more out about the images
- <filename>wic</filename> creates using the provided
+ You can find out more about the images
+ <filename>wic</filename> creates using the existing
kickstart files with the following form of the command:
<literallayout class='monospaced'>
$ wic list <image> help
@@ -3552,7 +3555,7 @@
</para>
<para>
- Regardless of the mode you use, you need to have the build
+ Regardless of which mode you use, you need to have the build
artifacts ready and available.
Additionally, the environment must be set up using the
<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
@@ -3575,7 +3578,7 @@
<replaceable>image_name</replaceable>.wks
An an OpenEmbedded kickstart file. You can provide
your own custom file or use a file from a set of
- provided files as described by further options.
+ existing files as described by further options.
-o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable>
The name of a directory in which to create image.
@@ -3649,19 +3652,19 @@
</section>
<section id='using-a-provided-kickstart_file'>
- <title>Using a Provided Kickstart File</title>
+ <title>Using an Existing Kickstart File</title>
<para>
If you do not want to create your own
- <filename>.wks</filename> file, you can use a provided
- file.
+ <filename>.wks</filename> file, you can use an existing
+ file provided by the <filename>wic</filename> installation.
Use the following command to list the available files:
<literallayout class='monospaced'>
$ wic list images
directdisk Create a 'pcbios' direct disk image
mkefidisk Create an EFI disk image
</literallayout>
- When you use a provided file, you do not have to use the
+ When you use an existing file, you do not have to use the
<filename>.wks</filename> extension.
Here is an example in Raw Mode that uses the
<filename>directdisk</filename> file:
@@ -3705,7 +3708,7 @@
</para>
<section id='generate-an-image-using-a-provided-kickstart-file'>
- <title>Generate an Image using a Provided Kickstart File</title>
+ <title>Generate an Image using an Existing Kickstart File</title>
<para>
This example runs in Cooked Mode and uses the
@@ -3732,7 +3735,7 @@
</literallayout>
This example shows the easiest way to create an image
by running in Cooked Mode and using the
- <filename>-e</filename> option with a provided kickstart
+ <filename>-e</filename> option with an existing kickstart
file.
All that is necessary is to specify the image used to
generate the artifacts.
@@ -3785,7 +3788,7 @@
<para>
As mentioned earlier, you can use the command
<filename>wic list images</filename> to show the list
- of provided kickstart files.
+ of existing kickstart files.
The directory in which these files reside is
<filename>scripts/lib/image/canned-wks/</filename>
located in the
@@ -4110,15 +4113,25 @@
</para>
<para>
- Following is a listing of the commands, their syntax, and
- meanings.
- The commands are based on the Fedora kickstart documentation
- but with modifications to reflect <filename>wic</filename>
- capabilities.
- <literallayout class='monospaced'>
+ The following is a list of the commands, their syntax,
+ and meanings. The commands are based on the Fedora
+ kickstart documentation but with modifications to
+ reflect <filename>wic</filename> capabilities. You
+ can see the original documentation for those commands
+ at the following links, in case you're interested:
+
+ <itemizedlist>
+ <listitem>
+ <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>
http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition
+ </ulink>
+ </listitem>
+ <listitem>
+ <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>
http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader
- </literallayout>
+ </ulink>
+ </listitem>
+ </itemizedlist>
</para>
<section id='command-part-or-partition'>
@@ -4234,9 +4247,10 @@
<listitem><para><emphasis><filename>--active</filename>:</emphasis>
Marks the partition as active.</para></listitem>
<listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis>
- This option is specific to the Meego Image
- Creator (mic) that says to start a partition on an
- x KBytes boundary.</para></listitem>
+ This option is a
+ <filename>wic</filename>-specific option
+ that says to start a partition on an x
+ KBytes boundary.</para></listitem>
</itemizedlist>
</para>
</section>
@@ -4246,7 +4260,7 @@
<para>
This command specifies how the boot loader should be
- and supports the following options:
+ configured and supports the following options:
<itemizedlist>
<listitem><para><emphasis><filename>--timeout</filename>:</emphasis>
Specifies the number of seconds before the
@@ -4266,14 +4280,14 @@
functionality; the bootloader command
essentially provides a means of
modifying bootloader configuration.
- </para>
- <para>Future updates will implement more options.
- If you use anything that is not specifically
- supported, results can be unpredictable.
</para></listitem>
</itemizedlist>
</para>
</section>
+ <para>Future updates will implement more options.
+ If you use anything that is not specifically
+ supported, results can be unpredictable.
+ </para>
</section>
</section>
--
1.8.3.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2014-07-29 19:34 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-07-29 19:33 [PATCH 0/5] dev-manual updates for wic Tom Zanussi
2014-07-29 19:33 ` [PATCH 1/5] dev-manual: Add 'Creating Partitioned Images/Plugins' subsection Tom Zanussi
2014-07-29 19:33 ` [PATCH 2/5] dev-manual: Add squashfs to --fstypes documentation Tom Zanussi
2014-07-29 19:33 ` [PATCH 3/5] dev-manual: Add documentation for --fsoptions Tom Zanussi
2014-07-29 19:33 ` [PATCH 4/5] dev-manual: Various updates to the 'Creating Partitioned Images' section Tom Zanussi
2014-07-29 19:33 ` [PATCH 5/5] dev-manual: Various minor fixes for " Tom Zanussi
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.