mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 17:19:20 +00:00
Code Issues Projects Releases Wiki Activity

dev-manual: Miscellaneous wic edits.

Browse Source 
This is a set of fixes for miscellaneous dev-manual updates noticed
while transcribing wic help for the dev manual.

(From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Tom Zanussi
2014-07-30 11:12:36 +03:00
committed by Richard Purdie
parent e0aa8f04e9
commit 7ef076cd9e
1 changed files with 44 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/dev-manual/dev-manual-common-tasks.xml
+44 -35
View File
@@ -3451,8 +3451,8 @@
Usually, information about the hardware can tell you what image Usually, information about the hardware can tell you what image
format the device requires. format the device requires.
Should your device require multiple partitions on an SD card, flash, Should your device require multiple partitions on an SD card, flash,
or an HDD, you can use the OpenEmbedded Image Creator or an HDD, you can use the OpenEmbedded Image Creator,
to create the properly partitioned image. <filename>wic</filename>, to create the properly partitioned image.
</para> </para>
<para> <para>
@@ -3463,7 +3463,7 @@
specified either directly on the command-line or as one of a specified either directly on the command-line or as one of a
selection of canned <filename>.wks</filename> files as shown selection of canned <filename>.wks</filename> files as shown
with the <filename>wic list images</filename> command in the 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. section.
When applied to a given set of build artifacts, the result is an 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 image or set of images that can be directly written onto media and
@@ -3533,9 +3533,9 @@
<title>Requirements</title> <title>Requirements</title>
<para> <para>
In order to use the <filename>wic</filename> utility with the In order to use the <filename>wic</filename> utility
OpenEmbedded Build system, you need to meet the following with the OpenEmbedded Build system, your system needs
requirements: to meet the following requirements:
<itemizedlist> <itemizedlist>
<listitem><para>The Linux distribution on your <listitem><para>The Linux distribution on your
development host must support the Yocto Project. development host must support the Yocto Project.
@@ -3555,14 +3555,17 @@
system. system.
</para></listitem> </para></listitem>
<listitem><para> <listitem><para>
Have the build artifacts already available. You need to have the build artifacts already
You must already have created an image using the available, which typically means that you must
have already created an image using the
Openembedded build system (e.g. Openembedded build system (e.g.
<filename>core-image-minimal</filename>. <filename>core-image-minimal</filename>).
It might seem redundant to generate an image in order It might seem redundant to generate an image in
to create an image using <filename>wic</filename>, order to create an image using
but the artifacts are needed and they are generated <filename>wic</filename>, but in the current
with the build system.</para></listitem> version <filename>wic</filename>, the artifacts
are needed in the form generated by the build
system.</para></listitem>
<listitem><para> <listitem><para>
You must have sourced one of the build environment You must have sourced one of the build environment
setup scripts (i.e. setup scripts (i.e.
@@ -3613,8 +3616,8 @@
</para> </para>
<para> <para>
You can find more out about the images You can find out more about the images
<filename>wic</filename> creates using the provided <filename>wic</filename> creates using the existing
kickstart files with the following form of the command: kickstart files with the following form of the command:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ wic list &lt;image&gt; help $ wic list &lt;image&gt; help
@@ -3669,7 +3672,7 @@
<replaceable>image_name</replaceable>.wks <replaceable>image_name</replaceable>.wks
An an OpenEmbedded kickstart file. You can provide An an OpenEmbedded kickstart file. You can provide
your own custom file or use a file from a set of 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> -o <replaceable>OUTDIR</replaceable>, --outdir=<replaceable>OUTDIR</replaceable>
The name of a directory in which to create image. The name of a directory in which to create image.
@@ -3743,19 +3746,19 @@
</section> </section>
<section id='using-a-provided-kickstart_file'> <section id='using-a-provided-kickstart_file'>
<title>Using a Provided Kickstart File</title> <title>Using an Existing Kickstart File</title>
<para> <para>
If you do not want to create your own If you do not want to create your own
<filename>.wks</filename> file, you can use a provided <filename>.wks</filename> file, you can use an existing
file. file provided by the <filename>wic</filename> installation.
Use the following command to list the available files: Use the following command to list the available files:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ wic list images $ wic list images
directdisk Create a 'pcbios' direct disk image directdisk Create a 'pcbios' direct disk image
mkefidisk Create an EFI disk image mkefidisk Create an EFI disk image
</literallayout> </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. <filename>.wks</filename> extension.
Here is an example in Raw Mode that uses the Here is an example in Raw Mode that uses the
<filename>directdisk</filename> file: <filename>directdisk</filename> file:
@@ -3799,7 +3802,7 @@
</para> </para>
<section id='generate-an-image-using-a-provided-kickstart-file'> <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> <para>
This example runs in Cooked Mode and uses the This example runs in Cooked Mode and uses the
@@ -3826,7 +3829,7 @@
</literallayout> </literallayout>
This example shows the easiest way to create an image This example shows the easiest way to create an image
by running in Cooked Mode and using the 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. file.
All that is necessary is to specify the image used to All that is necessary is to specify the image used to
generate the artifacts. generate the artifacts.
@@ -3879,7 +3882,7 @@
<para> <para>
As mentioned earlier, you can use the command As mentioned earlier, you can use the command
<filename>wic list images</filename> to show the list <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 The directory in which these files reside is
<filename>scripts/lib/image/canned-wks/</filename> <filename>scripts/lib/image/canned-wks/</filename>
located in the located in the
@@ -4199,15 +4202,21 @@
</para> </para>
<para> <para>
Following is a listing of the commands, their syntax, and The following is a list of the commands, their syntax,
meanings. and meanings.
The commands are based on the Fedora kickstart documentation The commands are based on the Fedora
but with modifications to reflect <filename>wic</filename> kickstart documentation but with modifications to
capabilities. reflect <filename>wic</filename> capabilities.
<literallayout class='monospaced'> You can see the original documentation for those commands
http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition at the following links:
http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader <itemizedlist>
</literallayout> <listitem><para>
<ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition</ulink>
</para></listitem>
<listitem><para>
<ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader</ulink>
</para></listitem>
</itemizedlist>
</para> </para>
<section id='command-part-or-partition'> <section id='command-part-or-partition'>
@@ -4323,8 +4332,8 @@
<listitem><para><emphasis><filename>--active</filename>:</emphasis> <listitem><para><emphasis><filename>--active</filename>:</emphasis>
Marks the partition as active.</para></listitem> Marks the partition as active.</para></listitem>
<listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis> <listitem><para><emphasis><filename>--align (in KBytes)</filename>:</emphasis>
This option is specific to the Meego Image This option is a <filename>wic</filename>-specific
Creator (mic) that says to start a partition on an option that says to start a partition on an
x KBytes boundary.</para></listitem> x KBytes boundary.</para></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
@@ -4358,7 +4367,7 @@
</para></listitem> </para></listitem>
<listitem><para><emphasis><filename>--append</filename>:</emphasis> <listitem><para><emphasis><filename>--append</filename>:</emphasis>
Specifies kernel parameters. Specifies kernel parameters.
These will be added to the syslinux These parameters will be added to the syslinux
<filename>APPEND</filename> or <filename>APPEND</filename> or
<filename>grub</filename> kernel command line. <filename>grub</filename> kernel command line.
</para></listitem> </para></listitem>