diff options
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 319 | ||||
-rw-r--r-- | documentation/mega-manual/mega-manual.xml | 3 | ||||
-rw-r--r-- | documentation/ref-manual/ref-kickstart.xml | 284 | ||||
-rw-r--r-- | documentation/ref-manual/ref-manual.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 4 |
5 files changed, 294 insertions, 318 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 3f4c2802ce..ef2e9410d4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
@@ -4812,8 +4812,8 @@ | |||
4812 | system. | 4812 | system. |
4813 | <note> | 4813 | <note> |
4814 | For a kickstart file reference, see the | 4814 | For a kickstart file reference, see the |
4815 | "<link linkend='openembedded-kickstart-wks-reference'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link>" | 4815 | "<ulink url='&YOCTO_DOCS_REF_URL;#openembedded-kickstart-wks-reference'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</ulink>" |
4816 | section. | 4816 | Chapter in the Yocto Project Reference Manual. |
4817 | </note> | 4817 | </note> |
4818 | </para> | 4818 | </para> |
4819 | 4819 | ||
@@ -4934,7 +4934,7 @@ | |||
4934 | </para></listitem> | 4934 | </para></listitem> |
4935 | <listitem><para> | 4935 | <listitem><para> |
4936 | Include the name of the | 4936 | Include the name of the |
4937 | <link linkend='openembedded-kickstart-wks-reference'>wic kickstart file</link> | 4937 | <ulink url='&YOCTO_DOCS_REF_URL;#openembedded-kickstart-wks-reference'>wic kickstart file</ulink> |
4938 | as part of the | 4938 | as part of the |
4939 | <ulink url='&YOCTO_DOCS_REF_URL;#var-WKS_FILE'><filename>WKS_FILE</filename></ulink> | 4939 | <ulink url='&YOCTO_DOCS_REF_URL;#var-WKS_FILE'><filename>WKS_FILE</filename></ulink> |
4940 | variable | 4940 | variable |
@@ -5439,319 +5439,6 @@ | |||
5439 | </para> | 5439 | </para> |
5440 | </section> | 5440 | </section> |
5441 | </section> | 5441 | </section> |
5442 | |||
5443 | <section id='openembedded-kickstart-wks-reference'> | ||
5444 | <title>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</title> | ||
5445 | |||
5446 | <para> | ||
5447 | The current Wic implementation supports | ||
5448 | only the basic kickstart partitioning commands: | ||
5449 | <filename>partition</filename> (or <filename>part</filename> | ||
5450 | for short) and <filename>bootloader</filename>. | ||
5451 | <note> | ||
5452 | Future updates will implement more commands and options. | ||
5453 | If you use anything that is not specifically | ||
5454 | supported, results can be unpredictable. | ||
5455 | </note> | ||
5456 | </para> | ||
5457 | |||
5458 | <para> | ||
5459 | The following is a list of the commands, their syntax, | ||
5460 | and meanings. | ||
5461 | The commands are based on the Fedora | ||
5462 | kickstart versions but with modifications to | ||
5463 | reflect Wic capabilities. | ||
5464 | You can see the original documentation for those commands | ||
5465 | at the following links: | ||
5466 | <itemizedlist> | ||
5467 | <listitem><para> | ||
5468 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition</ulink> | ||
5469 | </para></listitem> | ||
5470 | <listitem><para> | ||
5471 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader</ulink> | ||
5472 | </para></listitem> | ||
5473 | </itemizedlist> | ||
5474 | </para> | ||
5475 | |||
5476 | <section id='command-part-or-partition'> | ||
5477 | <title>Command: part or partition</title> | ||
5478 | |||
5479 | <para> | ||
5480 | Either of these commands create a partition on the system | ||
5481 | and use the following syntax: | ||
5482 | <literallayout class='monospaced'> | ||
5483 | part [<replaceable>mntpoint</replaceable>] | ||
5484 | partition [<replaceable>mntpoint</replaceable>] | ||
5485 | </literallayout> | ||
5486 | If you do not provide | ||
5487 | <replaceable>mntpoint</replaceable>, Wic creates a | ||
5488 | partition but does not mount it. | ||
5489 | </para> | ||
5490 | |||
5491 | <para> | ||
5492 | The | ||
5493 | <filename><replaceable>mntpoint</replaceable></filename> | ||
5494 | is where the partition will be mounted and must be of | ||
5495 | one of the following forms: | ||
5496 | <itemizedlist> | ||
5497 | <listitem><para> | ||
5498 | <filename>/<replaceable>path</replaceable></filename>: | ||
5499 | For example, "/", "/usr", or "/home" | ||
5500 | </para></listitem> | ||
5501 | <listitem><para> | ||
5502 | <filename>swap</filename>: | ||
5503 | The created partition is used as swap space. | ||
5504 | </para></listitem> | ||
5505 | </itemizedlist> | ||
5506 | </para> | ||
5507 | |||
5508 | <para> | ||
5509 | Specifying a <replaceable>mntpoint</replaceable> causes | ||
5510 | the partition to automatically be mounted. | ||
5511 | Wic achieves this by adding entries to the filesystem | ||
5512 | table (fstab) during image generation. | ||
5513 | In order for wic to generate a valid fstab, you must | ||
5514 | also provide one of the <filename>--ondrive</filename>, | ||
5515 | <filename>--ondisk</filename>, or | ||
5516 | <filename>--use-uuid</filename> partition options as | ||
5517 | part of the command. | ||
5518 | Here is an example using "/" as the mountpoint. | ||
5519 | The command uses "--ondisk" to force the partition onto | ||
5520 | the <filename>sdb</filename> disk: | ||
5521 | <literallayout class='monospaced'> | ||
5522 | part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 | ||
5523 | </literallayout> | ||
5524 | </para> | ||
5525 | |||
5526 | <para> | ||
5527 | Here is a list that describes other supported options | ||
5528 | you can use with the <filename>part</filename> and | ||
5529 | <filename>partition</filename> commands: | ||
5530 | <itemizedlist> | ||
5531 | <listitem><para> | ||
5532 | <emphasis><filename>--size</filename>:</emphasis> | ||
5533 | The minimum partition size in MBytes. | ||
5534 | Specify an integer value such as 500. | ||
5535 | Do not append the number with "MB". | ||
5536 | You do not need this option if you use | ||
5537 | <filename>--source</filename>. | ||
5538 | </para></listitem> | ||
5539 | <listitem><para> | ||
5540 | <emphasis><filename>--source</filename>:</emphasis> | ||
5541 | This option is a | ||
5542 | Wic-specific option that | ||
5543 | names the source of the data that populates | ||
5544 | the partition. | ||
5545 | The most common value for this option is | ||
5546 | "rootfs", but you can use any value that maps to | ||
5547 | a valid source plug-in. | ||
5548 | For information on the source plug-ins, see the | ||
5549 | "<ulink url='&YOCTO_DOCS_REF_URL;#wic-plug-ins-interface'>Wic Plug-Ins Interface</ulink>" | ||
5550 | section in the Yocto Project Reference | ||
5551 | manual.</para> | ||
5552 | |||
5553 | <para>If you use | ||
5554 | <filename>--source rootfs</filename>, | ||
5555 | Wic creates a partition as | ||
5556 | large as needed and to fill it with the contents | ||
5557 | of the root filesystem pointed to by the | ||
5558 | <filename>-r</filename> command-line option | ||
5559 | or the equivalent rootfs derived from the | ||
5560 | <filename>-e</filename> command-line | ||
5561 | option. | ||
5562 | The filesystem type used to create the | ||
5563 | partition is driven by the value of the | ||
5564 | <filename>--fstype</filename> option | ||
5565 | specified for the partition. | ||
5566 | See the entry on | ||
5567 | <filename>--fstype</filename> that | ||
5568 | follows for more information. | ||
5569 | </para> | ||
5570 | |||
5571 | <para>If you use | ||
5572 | <filename>--source <replaceable>plugin-name</replaceable></filename>, | ||
5573 | Wic creates a partition as | ||
5574 | large as needed and fills it with the contents | ||
5575 | of the partition that is generated by the | ||
5576 | specified plug-in name using the data pointed | ||
5577 | to by the <filename>-r</filename> command-line | ||
5578 | option or the equivalent rootfs derived from the | ||
5579 | <filename>-e</filename> command-line | ||
5580 | option. | ||
5581 | Exactly what those contents and filesystem type | ||
5582 | end up being are dependent on the given plug-in | ||
5583 | implementation. | ||
5584 | </para> | ||
5585 | |||
5586 | <para>If you do not use the | ||
5587 | <filename>--source</filename> option, the | ||
5588 | <filename>wic</filename> command creates an | ||
5589 | empty partition. | ||
5590 | Consequently, you must use the | ||
5591 | <filename>--size</filename> option to specify | ||
5592 | the size of the empty partition. | ||
5593 | </para></listitem> | ||
5594 | <listitem><para> | ||
5595 | <emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis> | ||
5596 | Forces the partition to be created on a | ||
5597 | particular disk. | ||
5598 | </para></listitem> | ||
5599 | <listitem><para> | ||
5600 | <emphasis><filename>--fstype</filename>:</emphasis> | ||
5601 | Sets the file system type for the partition. | ||
5602 | Valid values are: | ||
5603 | <itemizedlist> | ||
5604 | <listitem><para> | ||
5605 | <filename>ext4</filename> | ||
5606 | </para></listitem> | ||
5607 | <listitem><para> | ||
5608 | <filename>ext3</filename> | ||
5609 | </para></listitem> | ||
5610 | <listitem><para> | ||
5611 | <filename>ext2</filename> | ||
5612 | </para></listitem> | ||
5613 | <listitem><para> | ||
5614 | <filename>btrfs</filename> | ||
5615 | </para></listitem> | ||
5616 | <listitem><para> | ||
5617 | <filename>squashfs</filename> | ||
5618 | </para></listitem> | ||
5619 | <listitem><para> | ||
5620 | <filename>swap</filename> | ||
5621 | </para></listitem> | ||
5622 | </itemizedlist> | ||
5623 | </para></listitem> | ||
5624 | <listitem><para> | ||
5625 | <emphasis><filename>--fsoptions</filename>:</emphasis> | ||
5626 | Specifies a free-form string of options to be | ||
5627 | used when mounting the filesystem. | ||
5628 | This string will be copied into the | ||
5629 | <filename>/etc/fstab</filename> file of the | ||
5630 | installed system and should be enclosed in | ||
5631 | quotes. | ||
5632 | If not specified, the default string | ||
5633 | is "defaults". | ||
5634 | </para></listitem> | ||
5635 | <listitem><para> | ||
5636 | <emphasis><filename>--label label</filename>:</emphasis> | ||
5637 | Specifies the label to give to the filesystem to | ||
5638 | be made on the partition. | ||
5639 | If the given label is already in use by another | ||
5640 | filesystem, a new label is created for the | ||
5641 | partition. | ||
5642 | </para></listitem> | ||
5643 | <listitem><para> | ||
5644 | <emphasis><filename>--active</filename>:</emphasis> | ||
5645 | Marks the partition as active. | ||
5646 | </para></listitem> | ||
5647 | <listitem><para> | ||
5648 | <emphasis><filename>--align (in KBytes)</filename>:</emphasis> | ||
5649 | This option is a | ||
5650 | Wic-specific option that | ||
5651 | says to start a partition on an | ||
5652 | <replaceable>x</replaceable> KBytes | ||
5653 | boundary.</para></listitem> | ||
5654 | <listitem><para> | ||
5655 | <emphasis><filename>--no-table</filename>:</emphasis> | ||
5656 | This option is a | ||
5657 | Wic-specific option. | ||
5658 | Using the option reserves space for the | ||
5659 | partition and causes it to become populated. | ||
5660 | However, the partition is not added to the | ||
5661 | partition table. | ||
5662 | </para></listitem> | ||
5663 | <listitem><para> | ||
5664 | <emphasis><filename>--extra-space</filename>:</emphasis> | ||
5665 | This option is a | ||
5666 | Wic-specific option that | ||
5667 | adds extra space after the space filled by the | ||
5668 | content of the partition. | ||
5669 | The final size can go beyond the size specified | ||
5670 | by the <filename>--size</filename> option. | ||
5671 | The default value is 10 Mbytes. | ||
5672 | </para></listitem> | ||
5673 | <listitem><para> | ||
5674 | <emphasis><filename>--overhead-factor</filename>:</emphasis> | ||
5675 | This option is a | ||
5676 | Wic-specific option that | ||
5677 | multiplies the size of the partition by the | ||
5678 | option's value. | ||
5679 | You must supply a value greater than or equal to | ||
5680 | "1". | ||
5681 | The default value is "1.3". | ||
5682 | </para></listitem> | ||
5683 | <listitem><para> | ||
5684 | <emphasis><filename>--part-type</filename>:</emphasis> | ||
5685 | This option is a | ||
5686 | Wic-specific option that | ||
5687 | specifies the partition type globally | ||
5688 | unique identifier (GUID) for GPT partitions. | ||
5689 | You can find the list of partition type GUIDs | ||
5690 | at | ||
5691 | <ulink url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs'></ulink>. | ||
5692 | </para></listitem> | ||
5693 | <listitem><para> | ||
5694 | <emphasis><filename>--use-uuid</filename>:</emphasis> | ||
5695 | This option is a | ||
5696 | Wic-specific option that | ||
5697 | causes Wic to generate a | ||
5698 | random GUID for the partition. | ||
5699 | The generated identifier is used in the | ||
5700 | bootloader configuration to specify the root | ||
5701 | partition. | ||
5702 | </para></listitem> | ||
5703 | <listitem><para> | ||
5704 | <emphasis><filename>--uuid</filename>:</emphasis> | ||
5705 | This option is a | ||
5706 | Wic-specific | ||
5707 | option that specifies the partition UUID. | ||
5708 | </para></listitem> | ||
5709 | </itemizedlist> | ||
5710 | </para> | ||
5711 | </section> | ||
5712 | |||
5713 | <section id='command-bootloader'> | ||
5714 | <title>Command: bootloader</title> | ||
5715 | |||
5716 | <para> | ||
5717 | This command specifies how the bootloader should be | ||
5718 | configured and supports the following options: | ||
5719 | <note> | ||
5720 | Bootloader functionality and boot partitions are | ||
5721 | implemented by the various | ||
5722 | <filename>--source</filename> | ||
5723 | plug-ins that implement bootloader functionality. | ||
5724 | The bootloader command essentially provides a | ||
5725 | means of modifying bootloader configuration. | ||
5726 | </note> | ||
5727 | <itemizedlist> | ||
5728 | <listitem><para> | ||
5729 | <emphasis><filename>--timeout</filename>:</emphasis> | ||
5730 | Specifies the number of seconds before the | ||
5731 | bootloader times out and boots the default | ||
5732 | option. | ||
5733 | </para></listitem> | ||
5734 | <listitem><para> | ||
5735 | <emphasis><filename>--append</filename>:</emphasis> | ||
5736 | Specifies kernel parameters. | ||
5737 | These parameters will be added to the syslinux | ||
5738 | <filename>APPEND</filename> or | ||
5739 | <filename>grub</filename> kernel command line. | ||
5740 | </para></listitem> | ||
5741 | <listitem><para> | ||
5742 | <emphasis><filename>--configfile</filename>:</emphasis> | ||
5743 | Specifies a user-defined configuration file for | ||
5744 | the bootloader. | ||
5745 | You can provide a full pathname for the file or | ||
5746 | a file that exists in the | ||
5747 | <filename>canned-wks</filename> folder. | ||
5748 | This option overrides all other bootloader | ||
5749 | options. | ||
5750 | </para></listitem> | ||
5751 | </itemizedlist> | ||
5752 | </para> | ||
5753 | </section> | ||
5754 | </section> | ||
5755 | </section> | 5442 | </section> |
5756 | 5443 | ||
5757 | <section id='building-an-initramfs-image'> | 5444 | <section id='building-an-initramfs-image'> |
diff --git a/documentation/mega-manual/mega-manual.xml b/documentation/mega-manual/mega-manual.xml index d4977537f5..8761e323f5 100644 --- a/documentation/mega-manual/mega-manual.xml +++ b/documentation/mega-manual/mega-manual.xml | |||
@@ -236,6 +236,9 @@ | |||
236 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/> | 236 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-devtool-reference.xml"/> |
237 | 237 | ||
238 | <xi:include | 238 | <xi:include |
239 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-kickstart.xml"/> | ||
240 | |||
241 | <xi:include | ||
239 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/> | 242 | xmlns:xi="http://www.w3.org/2003/XInclude" href="../ref-manual/ref-qa-checks.xml"/> |
240 | 243 | ||
241 | <xi:include | 244 | <xi:include |
diff --git a/documentation/ref-manual/ref-kickstart.xml b/documentation/ref-manual/ref-kickstart.xml new file mode 100644 index 0000000000..1dd36b242c --- /dev/null +++ b/documentation/ref-manual/ref-kickstart.xml | |||
@@ -0,0 +1,284 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
4 | |||
5 | <chapter id='ref-kickstart'> | ||
6 | <title>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</title> | ||
7 | |||
8 | <section id='openembedded-kickstart-wks-reference'> | ||
9 | <title>Introduction</title> | ||
10 | |||
11 | <para> | ||
12 | The current Wic implementation supports only the basic kickstart | ||
13 | partitioning commands: | ||
14 | <filename>partition</filename> (or <filename>part</filename> | ||
15 | for short) and <filename>bootloader</filename>. | ||
16 | <note> | ||
17 | Future updates will implement more commands and options. | ||
18 | If you use anything that is not specifically supported, results | ||
19 | can be unpredictable. | ||
20 | </note> | ||
21 | </para> | ||
22 | |||
23 | <para> | ||
24 | This chapter provides a reference on the available kickstart | ||
25 | commands. | ||
26 | The information lists the commands, their syntax, and meanings. | ||
27 | Kickstart commands are based on the Fedora kickstart versions but | ||
28 | with modifications to reflect Wic capabilities. | ||
29 | You can see the original documentation for those commands at the | ||
30 | following links: | ||
31 | <itemizedlist> | ||
32 | <listitem><para> | ||
33 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition'>http://fedoraproject.org/wiki/Anaconda/Kickstart#part_or_partition</ulink> | ||
34 | </para></listitem> | ||
35 | <listitem><para> | ||
36 | <ulink url='http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader'>http://fedoraproject.org/wiki/Anaconda/Kickstart#bootloader</ulink> | ||
37 | </para></listitem> | ||
38 | </itemizedlist> | ||
39 | </para> | ||
40 | </section> | ||
41 | |||
42 | <section id='command-part-or-partition'> | ||
43 | <title>Command: part or partition</title> | ||
44 | |||
45 | <para> | ||
46 | Either of these commands create a partition on the system and use | ||
47 | the following syntax: | ||
48 | <literallayout class='monospaced'> | ||
49 | part [<replaceable>mntpoint</replaceable>] | ||
50 | partition [<replaceable>mntpoint</replaceable>] | ||
51 | </literallayout> | ||
52 | If you do not provide <replaceable>mntpoint</replaceable>, Wic | ||
53 | creates a partition but does not mount it. | ||
54 | </para> | ||
55 | |||
56 | <para> | ||
57 | The <filename><replaceable>mntpoint</replaceable></filename> is | ||
58 | where the partition will be mounted and must be of one of the | ||
59 | following forms: | ||
60 | <itemizedlist> | ||
61 | <listitem><para> | ||
62 | <filename>/<replaceable>path</replaceable></filename>: | ||
63 | For example, "/", "/usr", or "/home" | ||
64 | </para></listitem> | ||
65 | <listitem><para> | ||
66 | <filename>swap</filename>: | ||
67 | The created partition is used as swap space. | ||
68 | </para></listitem> | ||
69 | </itemizedlist> | ||
70 | </para> | ||
71 | |||
72 | <para> | ||
73 | Specifying a <replaceable>mntpoint</replaceable> causes the | ||
74 | partition to automatically be mounted. | ||
75 | Wic achieves this by adding entries to the filesystem table (fstab) | ||
76 | during image generation. | ||
77 | In order for wic to generate a valid fstab, you must also provide | ||
78 | one of the <filename>--ondrive</filename>, | ||
79 | <filename>--ondisk</filename>, or | ||
80 | <filename>--use-uuid</filename> partition options as part of the | ||
81 | command. | ||
82 | Here is an example using "/" as the mountpoint. | ||
83 | The command uses "--ondisk" to force the partition onto the | ||
84 | <filename>sdb</filename> disk: | ||
85 | <literallayout class='monospaced'> | ||
86 | part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 | ||
87 | </literallayout> | ||
88 | </para> | ||
89 | |||
90 | <para> | ||
91 | Here is a list that describes other supported options you can use | ||
92 | with the <filename>part</filename> and | ||
93 | <filename>partition</filename> commands: | ||
94 | <itemizedlist> | ||
95 | <listitem><para> | ||
96 | <emphasis><filename>--size</filename>:</emphasis> | ||
97 | The minimum partition size in MBytes. | ||
98 | Specify an integer value such as 500. | ||
99 | Do not append the number with "MB". | ||
100 | You do not need this option if you use | ||
101 | <filename>--source</filename>. | ||
102 | </para></listitem> | ||
103 | <listitem><para> | ||
104 | <emphasis><filename>--source</filename>:</emphasis> | ||
105 | This option is a Wic-specific option that names the source | ||
106 | of the data that populates the partition. | ||
107 | The most common value for this option is "rootfs", but you | ||
108 | can use any value that maps to a valid source plug-in. | ||
109 | For information on the source plug-ins, see the | ||
110 | "<link linkend='wic-plug-ins-interface'>Wic Plug-Ins Interface</link>" | ||
111 | section.</para> | ||
112 | |||
113 | <para>If you use <filename>--source rootfs</filename>, Wic | ||
114 | creates a partition as large as needed and to fill it with | ||
115 | the contents of the root filesystem pointed to by the | ||
116 | <filename>-r</filename> command-line option or the | ||
117 | equivalent rootfs derived from the <filename>-e</filename> | ||
118 | command-line option. | ||
119 | The filesystem type used to create the partition is driven | ||
120 | by the value of the <filename>--fstype</filename> option | ||
121 | specified for the partition. | ||
122 | See the entry on <filename>--fstype</filename> that follows | ||
123 | for more information.</para> | ||
124 | |||
125 | <para>If you use | ||
126 | <filename>--source <replaceable>plugin-name</replaceable></filename>, | ||
127 | Wic creates a partition as large as needed and fills it | ||
128 | with the contents of the partition that is generated by the | ||
129 | specified plug-in name using the data pointed to by the | ||
130 | <filename>-r</filename> command-line option or the | ||
131 | equivalent rootfs derived from the <filename>-e</filename> | ||
132 | command-line option. | ||
133 | Exactly what those contents and filesystem type end up | ||
134 | being are dependent on the given plug-in implementation. | ||
135 | </para> | ||
136 | |||
137 | <para>If you do not use the <filename>--source</filename> | ||
138 | option, the <filename>wic</filename> command creates an | ||
139 | empty partition. | ||
140 | Consequently, you must use the <filename>--size</filename> | ||
141 | option to specify the size of the empty partition. | ||
142 | </para></listitem> | ||
143 | <listitem><para> | ||
144 | <emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis> | ||
145 | Forces the partition to be created on a particular disk. | ||
146 | </para></listitem> | ||
147 | <listitem><para> | ||
148 | <emphasis><filename>--fstype</filename>:</emphasis> | ||
149 | Sets the file system type for the partition. | ||
150 | Valid values are: | ||
151 | <itemizedlist> | ||
152 | <listitem><para> | ||
153 | <filename>ext4</filename> | ||
154 | </para></listitem> | ||
155 | <listitem><para> | ||
156 | <filename>ext3</filename> | ||
157 | </para></listitem> | ||
158 | <listitem><para> | ||
159 | <filename>ext2</filename> | ||
160 | </para></listitem> | ||
161 | <listitem><para> | ||
162 | <filename>btrfs</filename> | ||
163 | </para></listitem> | ||
164 | <listitem><para> | ||
165 | <filename>squashfs</filename> | ||
166 | </para></listitem> | ||
167 | <listitem><para> | ||
168 | <filename>swap</filename> | ||
169 | </para></listitem> | ||
170 | </itemizedlist> | ||
171 | </para></listitem> | ||
172 | <listitem><para> | ||
173 | <emphasis><filename>--fsoptions</filename>:</emphasis> | ||
174 | Specifies a free-form string of options to be used when | ||
175 | mounting the filesystem. | ||
176 | This string will be copied into the | ||
177 | <filename>/etc/fstab</filename> file of the installed | ||
178 | system and should be enclosed in quotes. | ||
179 | If not specified, the default string is "defaults". | ||
180 | </para></listitem> | ||
181 | <listitem><para> | ||
182 | <emphasis><filename>--label label</filename>:</emphasis> | ||
183 | Specifies the label to give to the filesystem to be made on | ||
184 | the partition. | ||
185 | If the given label is already in use by another filesystem, | ||
186 | a new label is created for the partition. | ||
187 | </para></listitem> | ||
188 | <listitem><para> | ||
189 | <emphasis><filename>--active</filename>:</emphasis> | ||
190 | Marks the partition as active. | ||
191 | </para></listitem> | ||
192 | <listitem><para> | ||
193 | <emphasis><filename>--align (in KBytes)</filename>:</emphasis> | ||
194 | This option is a Wic-specific option that says to start a | ||
195 | partition on an <replaceable>x</replaceable> KBytes | ||
196 | boundary. | ||
197 | </para></listitem> | ||
198 | <listitem><para> | ||
199 | <emphasis><filename>--no-table</filename>:</emphasis> | ||
200 | This option is a Wic-specific option. | ||
201 | Using the option reserves space for the partition and | ||
202 | causes it to become populated. | ||
203 | However, the partition is not added to the partition table. | ||
204 | </para></listitem> | ||
205 | <listitem><para> | ||
206 | <emphasis><filename>--extra-space</filename>:</emphasis> | ||
207 | This option is a Wic-specific option that adds extra space | ||
208 | after the space filled by the content of the partition. | ||
209 | The final size can go beyond the size specified by the | ||
210 | <filename>--size</filename> option. | ||
211 | The default value is 10 Mbytes. | ||
212 | </para></listitem> | ||
213 | <listitem><para> | ||
214 | <emphasis><filename>--overhead-factor</filename>:</emphasis> | ||
215 | This option is a Wic-specific option that multiplies the | ||
216 | size of the partition by the option's value. | ||
217 | You must supply a value greater than or equal to "1". | ||
218 | The default value is "1.3". | ||
219 | </para></listitem> | ||
220 | <listitem><para> | ||
221 | <emphasis><filename>--part-type</filename>:</emphasis> | ||
222 | This option is a Wic-specific option that specifies the | ||
223 | partition type globally unique identifier (GUID) for GPT | ||
224 | partitions. | ||
225 | You can find the list of partition type GUIDs at | ||
226 | <ulink url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs'></ulink>. | ||
227 | </para></listitem> | ||
228 | <listitem><para> | ||
229 | <emphasis><filename>--use-uuid</filename>:</emphasis> | ||
230 | This option is a Wic-specific option that causes Wic to | ||
231 | generate a random GUID for the partition. | ||
232 | The generated identifier is used in the bootloader | ||
233 | configuration to specify the root partition. | ||
234 | </para></listitem> | ||
235 | <listitem><para> | ||
236 | <emphasis><filename>--uuid</filename>:</emphasis> | ||
237 | This option is a Wic-specific option that specifies the | ||
238 | partition UUID. | ||
239 | </para></listitem> | ||
240 | </itemizedlist> | ||
241 | </para> | ||
242 | </section> | ||
243 | |||
244 | <section id='command-bootloader'> | ||
245 | <title>Command: bootloader</title> | ||
246 | |||
247 | <para> | ||
248 | This command specifies how the bootloader should be configured and | ||
249 | supports the following options: | ||
250 | <note> | ||
251 | Bootloader functionality and boot partitions are implemented by | ||
252 | the various <filename>--source</filename> plug-ins that | ||
253 | implement bootloader functionality. | ||
254 | The bootloader command essentially provides a means of | ||
255 | modifying bootloader configuration. | ||
256 | </note> | ||
257 | <itemizedlist> | ||
258 | <listitem><para> | ||
259 | <emphasis><filename>--timeout</filename>:</emphasis> | ||
260 | Specifies the number of seconds before the bootloader times | ||
261 | out and boots the default option. | ||
262 | </para></listitem> | ||
263 | <listitem><para> | ||
264 | <emphasis><filename>--append</filename>:</emphasis> | ||
265 | Specifies kernel parameters. | ||
266 | These parameters will be added to the syslinux | ||
267 | <filename>APPEND</filename> or <filename>grub</filename> | ||
268 | kernel command line. | ||
269 | </para></listitem> | ||
270 | <listitem><para> | ||
271 | <emphasis><filename>--configfile</filename>:</emphasis> | ||
272 | Specifies a user-defined configuration file for the | ||
273 | bootloader. | ||
274 | You can provide a full pathname for the file or a file that | ||
275 | exists in the <filename>canned-wks</filename> folder. | ||
276 | This option overrides all other bootloader options. | ||
277 | </para></listitem> | ||
278 | </itemizedlist> | ||
279 | </para> | ||
280 | </section> | ||
281 | </chapter> | ||
282 | <!-- | ||
283 | vim: expandtab tw=80 ts=4 | ||
284 | --> | ||
diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml index 4637fd03ec..a977cb86a8 100644 --- a/documentation/ref-manual/ref-manual.xml +++ b/documentation/ref-manual/ref-manual.xml | |||
@@ -179,6 +179,8 @@ | |||
179 | 179 | ||
180 | <xi:include href="ref-devtool-reference.xml"/> | 180 | <xi:include href="ref-devtool-reference.xml"/> |
181 | 181 | ||
182 | <xi:include href="ref-kickstart.xml"/> | ||
183 | |||
182 | <xi:include href="ref-qa-checks.xml"/> | 184 | <xi:include href="ref-qa-checks.xml"/> |
183 | 185 | ||
184 | <xi:include href="ref-images.xml"/> | 186 | <xi:include href="ref-images.xml"/> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 9396bae628..d99a57a54a 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -16252,8 +16252,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
16252 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images'>Creating Partitioned Images</ulink>" | 16252 | "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images'>Creating Partitioned Images</ulink>" |
16253 | section in the Yocto Project Development Manual. | 16253 | section in the Yocto Project Development Manual. |
16254 | For details on the kickstart file format, see the | 16254 | For details on the kickstart file format, see the |
16255 | "<ulink url='&YOCTO_DOCS_DEV_URL;#openembedded-kickstart-wks-reference'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</ulink> | 16255 | "<link linkend='openembedded-kickstart-wks-reference'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link> |
16256 | also in the Yocto Project Development Manual. | 16256 | Chapter. |
16257 | </para> | 16257 | </para> |
16258 | </glossdef> | 16258 | </glossdef> |
16259 | </glossentry> | 16259 | </glossentry> |