dev-manual: Miscellaneous wic edits.
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
Richard Purdie
parent
e0aa8f04e9
commit
7ef076cd9e
|
|
@ -3451,8 +3451,8 @@
|
|||
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>
|
||||
|
|
@ -3463,7 +3463,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
|
||||
|
|
@ -3533,9 +3533,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.
|
||||
|
|
@ -3555,14 +3555,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 <filename>wic</filename>, 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.
|
||||
|
|
@ -3613,8 +3616,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
|
||||
|
|
@ -3669,7 +3672,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.
|
||||
|
|
@ -3743,19 +3746,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:
|
||||
|
|
@ -3799,7 +3802,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
|
||||
|
|
@ -3826,7 +3829,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.
|
||||
|
|
@ -3879,7 +3882,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
|
||||
|
|
@ -4199,15 +4202,21 @@
|
|||
</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'>
|
||||
http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition
|
||||
http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader
|
||||
</literallayout>
|
||||
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:
|
||||
<itemizedlist>
|
||||
<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>
|
||||
|
||||
<section id='command-part-or-partition'>
|
||||
|
|
@ -4323,8 +4332,8 @@
|
|||
<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
|
||||
This option is a <filename>wic</filename>-specific
|
||||
option that says to start a partition on an
|
||||
x KBytes boundary.</para></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
|
@ -4358,7 +4367,7 @@
|
|||
</para></listitem>
|
||||
<listitem><para><emphasis><filename>--append</filename>:</emphasis>
|
||||
Specifies kernel parameters.
|
||||
These will be added to the syslinux
|
||||
These parameters will be added to the syslinux
|
||||
<filename>APPEND</filename> or
|
||||
<filename>grub</filename> kernel command line.
|
||||
</para></listitem>
|
||||
|
|
|
|||
Loading…
Reference in New Issue