diff options
Diffstat (limited to 'scripts/lib/image')
-rw-r--r-- | scripts/lib/image/__init__.py | 22 | ||||
-rw-r--r-- | scripts/lib/image/canned-wks/directdisk.wks | 10 | ||||
-rw-r--r-- | scripts/lib/image/canned-wks/mkefidisk.wks | 11 | ||||
-rw-r--r-- | scripts/lib/image/canned-wks/uboot.wks | 17 | ||||
-rw-r--r-- | scripts/lib/image/config/wic.conf | 11 | ||||
-rw-r--r-- | scripts/lib/image/engine.py | 287 | ||||
-rw-r--r-- | scripts/lib/image/help.py | 311 |
7 files changed, 669 insertions, 0 deletions
diff --git a/scripts/lib/image/__init__.py b/scripts/lib/image/__init__.py new file mode 100644 index 0000000000..1ff814e761 --- /dev/null +++ b/scripts/lib/image/__init__.py | |||
@@ -0,0 +1,22 @@ | |||
1 | # | ||
2 | # OpenEmbedded Image tools library | ||
3 | # | ||
4 | # Copyright (c) 2013, Intel Corporation. | ||
5 | # All rights reserved. | ||
6 | # | ||
7 | # This program is free software; you can redistribute it and/or modify | ||
8 | # it under the terms of the GNU General Public License version 2 as | ||
9 | # published by the Free Software Foundation. | ||
10 | # | ||
11 | # This program is distributed in the hope that it will be useful, | ||
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
14 | # GNU General Public License for more details. | ||
15 | # | ||
16 | # You should have received a copy of the GNU General Public License along | ||
17 | # with this program; if not, write to the Free Software Foundation, Inc., | ||
18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||
19 | # | ||
20 | # AUTHORS | ||
21 | # Tom Zanussi <tom.zanussi (at] linux.intel.com> | ||
22 | # | ||
diff --git a/scripts/lib/image/canned-wks/directdisk.wks b/scripts/lib/image/canned-wks/directdisk.wks new file mode 100644 index 0000000000..397a929c74 --- /dev/null +++ b/scripts/lib/image/canned-wks/directdisk.wks | |||
@@ -0,0 +1,10 @@ | |||
1 | # short-description: Create a 'pcbios' direct disk image | ||
2 | # long-description: Creates a partitioned legacy BIOS disk image that the user | ||
3 | # can directly dd to boot media. | ||
4 | |||
5 | |||
6 | part /boot --source bootimg-pcbios --ondisk sda --fstype=msdos --label boot --active --align 1024 | ||
7 | part / --source rootfs --ondisk sda --fstype=ext3 --label platform --align 1024 | ||
8 | |||
9 | bootloader --timeout=0 --append="rootwait rootfstype=ext3 video=vesafb vga=0x318 console=tty0" | ||
10 | |||
diff --git a/scripts/lib/image/canned-wks/mkefidisk.wks b/scripts/lib/image/canned-wks/mkefidisk.wks new file mode 100644 index 0000000000..e976bc80dd --- /dev/null +++ b/scripts/lib/image/canned-wks/mkefidisk.wks | |||
@@ -0,0 +1,11 @@ | |||
1 | # short-description: Create an EFI disk image | ||
2 | # long-description: Creates a partitioned EFI disk image that the user | ||
3 | # can directly dd to boot media. | ||
4 | |||
5 | part /boot --source bootimg-efi --ondisk sda --fstype=msdos --label msdos --active --align 1024 | ||
6 | |||
7 | part / --source rootfs --ondisk sda --fstype=ext3 --label platform --align 1024 | ||
8 | |||
9 | part swap --ondisk sda --size 44 --label swap1 --fstype=swap | ||
10 | |||
11 | bootloader --timeout=10 --append="rootwait rootfstype=ext3 console=ttyPCH0,115200 console=tty0 vmalloc=256MB snd-hda-intel.enable_msi=0" | ||
diff --git a/scripts/lib/image/canned-wks/uboot.wks b/scripts/lib/image/canned-wks/uboot.wks new file mode 100644 index 0000000000..7de0572d0f --- /dev/null +++ b/scripts/lib/image/canned-wks/uboot.wks | |||
@@ -0,0 +1,17 @@ | |||
1 | # short-description: . Create a ramdisk image for U-Boot | ||
2 | # long-description: Creates a ramdisk image for U-Boot that user | ||
3 | # can directly load it into ram through tftp | ||
4 | # | ||
5 | # part - is a wic command that drive the process of generating a valid file system | ||
6 | # - --source=uboot : wic plugin that generates a ramdisk image for U-Boot | ||
7 | # - --fstype=ext2 : file system type( ext2 / ext3 / ext 4) | ||
8 | # | ||
9 | # %packages %end - option to provide a list of packages that will be installed | ||
10 | # into rootfs. All packages dependencies will be installed by | ||
11 | # package manager(default opkg). | ||
12 | |||
13 | |||
14 | part / --source=uboot --fstype=ext2 --label imageName --align 1024 | ||
15 | |||
16 | %packages | ||
17 | %end | ||
diff --git a/scripts/lib/image/config/wic.conf b/scripts/lib/image/config/wic.conf new file mode 100644 index 0000000000..2a2750b4ee --- /dev/null +++ b/scripts/lib/image/config/wic.conf | |||
@@ -0,0 +1,11 @@ | |||
1 | [common] | ||
2 | ; general settings | ||
3 | distro_name = OpenEmbedded | ||
4 | |||
5 | [create] | ||
6 | ; settings for create subcommand | ||
7 | ; repourl=http://linux.com/ipk/all http://linux.com/ipk/target http://linux.com/ipk/arch | ||
8 | arch=powerpc | ||
9 | pkgmgr=opkg | ||
10 | runtime=native | ||
11 | install_pkgs=source | ||
diff --git a/scripts/lib/image/engine.py b/scripts/lib/image/engine.py new file mode 100644 index 0000000000..0643780f1a --- /dev/null +++ b/scripts/lib/image/engine.py | |||
@@ -0,0 +1,287 @@ | |||
1 | # ex:ts=4:sw=4:sts=4:et | ||
2 | # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- | ||
3 | # | ||
4 | # Copyright (c) 2013, Intel Corporation. | ||
5 | # All rights reserved. | ||
6 | # | ||
7 | # This program is free software; you can redistribute it and/or modify | ||
8 | # it under the terms of the GNU General Public License version 2 as | ||
9 | # published by the Free Software Foundation. | ||
10 | # | ||
11 | # This program is distributed in the hope that it will be useful, | ||
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
14 | # GNU General Public License for more details. | ||
15 | # | ||
16 | # You should have received a copy of the GNU General Public License along | ||
17 | # with this program; if not, write to the Free Software Foundation, Inc., | ||
18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||
19 | # | ||
20 | # DESCRIPTION | ||
21 | |||
22 | # This module implements the image creation engine used by 'wic' to | ||
23 | # create images. The engine parses through the OpenEmbedded kickstart | ||
24 | # (wks) file specified and generates images that can then be directly | ||
25 | # written onto media. | ||
26 | # | ||
27 | # AUTHORS | ||
28 | # Tom Zanussi <tom.zanussi (at] linux.intel.com> | ||
29 | # | ||
30 | |||
31 | import os | ||
32 | import sys | ||
33 | from abc import ABCMeta, abstractmethod | ||
34 | import shlex | ||
35 | import json | ||
36 | import subprocess | ||
37 | import shutil | ||
38 | |||
39 | import os, sys, errno | ||
40 | from mic import msger, creator | ||
41 | from mic.utils import cmdln, misc, errors | ||
42 | from mic.conf import configmgr | ||
43 | from mic.plugin import pluginmgr | ||
44 | from mic.__version__ import VERSION | ||
45 | from mic.utils.oe.misc import * | ||
46 | |||
47 | |||
48 | def verify_build_env(): | ||
49 | """ | ||
50 | Verify that the build environment is sane. | ||
51 | |||
52 | Returns True if it is, false otherwise | ||
53 | """ | ||
54 | try: | ||
55 | builddir = os.environ["BUILDDIR"] | ||
56 | except KeyError: | ||
57 | print "BUILDDIR not found, exiting. (Did you forget to source oe-init-build-env?)" | ||
58 | sys.exit(1) | ||
59 | |||
60 | return True | ||
61 | |||
62 | |||
63 | def find_bitbake_env_lines(image_name): | ||
64 | """ | ||
65 | If image_name is empty, plugins might still be able to use the | ||
66 | environment, so set it regardless. | ||
67 | """ | ||
68 | if image_name: | ||
69 | bitbake_env_cmd = "bitbake -e %s" % image_name | ||
70 | else: | ||
71 | bitbake_env_cmd = "bitbake -e" | ||
72 | rc, bitbake_env_lines = exec_cmd(bitbake_env_cmd) | ||
73 | if rc != 0: | ||
74 | print "Couldn't get '%s' output." % bitbake_env_cmd | ||
75 | return None | ||
76 | |||
77 | return bitbake_env_lines | ||
78 | |||
79 | |||
80 | def find_artifacts(image_name): | ||
81 | """ | ||
82 | Gather the build artifacts for the current image (the image_name | ||
83 | e.g. core-image-minimal) for the current MACHINE set in local.conf | ||
84 | """ | ||
85 | bitbake_env_lines = get_bitbake_env_lines() | ||
86 | |||
87 | rootfs_dir = kernel_dir = hdddir = staging_data_dir = native_sysroot = "" | ||
88 | |||
89 | for line in bitbake_env_lines.split('\n'): | ||
90 | if (get_line_val(line, "IMAGE_ROOTFS")): | ||
91 | rootfs_dir = get_line_val(line, "IMAGE_ROOTFS") | ||
92 | continue | ||
93 | if (get_line_val(line, "STAGING_KERNEL_DIR")): | ||
94 | kernel_dir = get_line_val(line, "STAGING_KERNEL_DIR") | ||
95 | continue | ||
96 | if (get_line_val(line, "HDDDIR")): | ||
97 | hdddir = get_line_val(line, "HDDDIR") | ||
98 | continue | ||
99 | if (get_line_val(line, "STAGING_DATADIR")): | ||
100 | staging_data_dir = get_line_val(line, "STAGING_DATADIR") | ||
101 | continue | ||
102 | if (get_line_val(line, "STAGING_DIR_NATIVE")): | ||
103 | native_sysroot = get_line_val(line, "STAGING_DIR_NATIVE") | ||
104 | continue | ||
105 | |||
106 | return (rootfs_dir, kernel_dir, hdddir, staging_data_dir, native_sysroot) | ||
107 | |||
108 | |||
109 | CANNED_IMAGE_DIR = "lib/image/canned-wks" # relative to scripts | ||
110 | |||
111 | def find_canned_image(scripts_path, wks_file): | ||
112 | """ | ||
113 | Find a .wks file with the given name in the canned files dir. | ||
114 | |||
115 | Return False if not found | ||
116 | """ | ||
117 | canned_wks_dir = os.path.join(scripts_path, CANNED_IMAGE_DIR) | ||
118 | |||
119 | for root, dirs, files in os.walk(canned_wks_dir): | ||
120 | for file in files: | ||
121 | if file.endswith("~") or file.endswith("#"): | ||
122 | continue | ||
123 | if file.endswith(".wks") and wks_file + ".wks" == file: | ||
124 | fullpath = os.path.join(canned_wks_dir, file) | ||
125 | return fullpath | ||
126 | return None | ||
127 | |||
128 | |||
129 | def list_canned_images(scripts_path): | ||
130 | """ | ||
131 | List the .wks files in the canned image dir, minus the extension. | ||
132 | """ | ||
133 | canned_wks_dir = os.path.join(scripts_path, CANNED_IMAGE_DIR) | ||
134 | |||
135 | for root, dirs, files in os.walk(canned_wks_dir): | ||
136 | for file in files: | ||
137 | if file.endswith("~") or file.endswith("#"): | ||
138 | continue | ||
139 | if file.endswith(".wks"): | ||
140 | fullpath = os.path.join(canned_wks_dir, file) | ||
141 | f = open(fullpath, "r") | ||
142 | lines = f.readlines() | ||
143 | for line in lines: | ||
144 | desc = "" | ||
145 | idx = line.find("short-description:") | ||
146 | if idx != -1: | ||
147 | desc = line[idx + len("short-description:"):].strip() | ||
148 | break | ||
149 | basename = os.path.splitext(file)[0] | ||
150 | print " %s\t\t%s" % (basename, desc) | ||
151 | |||
152 | |||
153 | def list_canned_image_help(scripts_path, fullpath): | ||
154 | """ | ||
155 | List the help and params in the specified canned image. | ||
156 | """ | ||
157 | canned_wks_dir = os.path.join(scripts_path, CANNED_IMAGE_DIR) | ||
158 | |||
159 | f = open(fullpath, "r") | ||
160 | lines = f.readlines() | ||
161 | found = False | ||
162 | for line in lines: | ||
163 | if not found: | ||
164 | idx = line.find("long-description:") | ||
165 | if idx != -1: | ||
166 | |||
167 | print line[idx + len("long-description:"):].strip() | ||
168 | found = True | ||
169 | continue | ||
170 | if not line.strip(): | ||
171 | break | ||
172 | idx = line.find("#") | ||
173 | if idx != -1: | ||
174 | print line[idx + len("#:"):].rstrip() | ||
175 | else: | ||
176 | break | ||
177 | |||
178 | |||
179 | def wic_create(args, wks_file, rootfs_dir, bootimg_dir, kernel_dir, | ||
180 | native_sysroot, hdddir, staging_data_dir, scripts_path, | ||
181 | image_output_dir, debug, properties_file, properties=None): | ||
182 | """ | ||
183 | Create image | ||
184 | |||
185 | wks_file - user-defined OE kickstart file | ||
186 | rootfs_dir - absolute path to the build's /rootfs dir | ||
187 | bootimg_dir - absolute path to the build's boot artifacts directory | ||
188 | kernel_dir - absolute path to the build's kernel directory | ||
189 | native_sysroot - absolute path to the build's native sysroots dir | ||
190 | hdddir - absolute path to the build's HDDDIR dir | ||
191 | staging_data_dir - absolute path to the build's STAGING_DATA_DIR dir | ||
192 | scripts_path - absolute path to /scripts dir | ||
193 | image_output_dir - dirname to create for image | ||
194 | properties_file - use values from this file if nonempty i.e no prompting | ||
195 | properties - use values from this string if nonempty i.e no prompting | ||
196 | |||
197 | Normally, the values for the build artifacts values are determined | ||
198 | by 'wic -e' from the output of the 'bitbake -e' command given an | ||
199 | image name e.g. 'core-image-minimal' and a given machine set in | ||
200 | local.conf. If that's the case, the variables get the following | ||
201 | values from the output of 'bitbake -e': | ||
202 | |||
203 | rootfs_dir: IMAGE_ROOTFS | ||
204 | kernel_dir: STAGING_KERNEL_DIR | ||
205 | native_sysroot: STAGING_DIR_NATIVE | ||
206 | hdddir: HDDDIR | ||
207 | staging_data_dir: STAGING_DATA_DIR | ||
208 | |||
209 | In the above case, bootimg_dir remains unset and the image | ||
210 | creation code determines which of the passed-in directories to | ||
211 | use. | ||
212 | |||
213 | In the case where the values are passed in explicitly i.e 'wic -e' | ||
214 | is not used but rather the individual 'wic' options are used to | ||
215 | explicitly specify these values, hdddir and staging_data_dir will | ||
216 | be unset, but bootimg_dir must be explicit i.e. explicitly set to | ||
217 | either hdddir or staging_data_dir, depending on the image being | ||
218 | generated. The other values (rootfs_dir, kernel_dir, and | ||
219 | native_sysroot) correspond to the same values found above via | ||
220 | 'bitbake -e'). | ||
221 | |||
222 | """ | ||
223 | try: | ||
224 | oe_builddir = os.environ["BUILDDIR"] | ||
225 | except KeyError: | ||
226 | print "BUILDDIR not found, exiting. (Did you forget to source oe-init-build-env?)" | ||
227 | sys.exit(1) | ||
228 | |||
229 | direct_args = list() | ||
230 | direct_args.insert(0, oe_builddir) | ||
231 | direct_args.insert(0, image_output_dir) | ||
232 | direct_args.insert(0, wks_file) | ||
233 | direct_args.insert(0, rootfs_dir) | ||
234 | direct_args.insert(0, bootimg_dir) | ||
235 | direct_args.insert(0, kernel_dir) | ||
236 | direct_args.insert(0, native_sysroot) | ||
237 | direct_args.insert(0, hdddir) | ||
238 | direct_args.insert(0, staging_data_dir) | ||
239 | direct_args.insert(0, "direct") | ||
240 | |||
241 | if debug: | ||
242 | msger.set_loglevel('debug') | ||
243 | |||
244 | cr = creator.Creator() | ||
245 | |||
246 | cr.main(direct_args) | ||
247 | |||
248 | print "\nThe image(s) were created using OE kickstart file:\n %s" % wks_file | ||
249 | |||
250 | |||
251 | def wic_list(args, scripts_path, properties_file): | ||
252 | """ | ||
253 | Print the complete list of properties defined by the image, or the | ||
254 | possible values for a particular image property. | ||
255 | """ | ||
256 | if len(args) < 1: | ||
257 | return False | ||
258 | |||
259 | if len(args) == 1: | ||
260 | if args[0] == "images": | ||
261 | list_canned_images(scripts_path) | ||
262 | return True | ||
263 | elif args[0] == "properties": | ||
264 | return True | ||
265 | else: | ||
266 | return False | ||
267 | |||
268 | if len(args) == 2: | ||
269 | if args[0] == "properties": | ||
270 | wks_file = args[1] | ||
271 | print "print properties contained in wks file: %s" % wks_file | ||
272 | return True | ||
273 | elif args[0] == "property": | ||
274 | print "print property values for property: %s" % args[1] | ||
275 | return True | ||
276 | elif args[1] == "help": | ||
277 | wks_file = args[0] | ||
278 | fullpath = find_canned_image(scripts_path, wks_file) | ||
279 | if not fullpath: | ||
280 | print "No image named %s found, exiting. (Use 'wic list images' to list available images, or specify a fully-qualified OE kickstart (.wks) filename)\n" % wks_file | ||
281 | sys.exit(1) | ||
282 | list_canned_image_help(scripts_path, fullpath) | ||
283 | return True | ||
284 | else: | ||
285 | return False | ||
286 | |||
287 | return False | ||
diff --git a/scripts/lib/image/help.py b/scripts/lib/image/help.py new file mode 100644 index 0000000000..cb3112cf08 --- /dev/null +++ b/scripts/lib/image/help.py | |||
@@ -0,0 +1,311 @@ | |||
1 | # ex:ts=4:sw=4:sts=4:et | ||
2 | # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*- | ||
3 | # | ||
4 | # Copyright (c) 2013, Intel Corporation. | ||
5 | # All rights reserved. | ||
6 | # | ||
7 | # This program is free software; you can redistribute it and/or modify | ||
8 | # it under the terms of the GNU General Public License version 2 as | ||
9 | # published by the Free Software Foundation. | ||
10 | # | ||
11 | # This program is distributed in the hope that it will be useful, | ||
12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
14 | # GNU General Public License for more details. | ||
15 | # | ||
16 | # You should have received a copy of the GNU General Public License along | ||
17 | # with this program; if not, write to the Free Software Foundation, Inc., | ||
18 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||
19 | # | ||
20 | # DESCRIPTION | ||
21 | # This module implements some basic help invocation functions along | ||
22 | # with the bulk of the help topic text for the OE Core Image Tools. | ||
23 | # | ||
24 | # AUTHORS | ||
25 | # Tom Zanussi <tom.zanussi (at] linux.intel.com> | ||
26 | # | ||
27 | |||
28 | import subprocess | ||
29 | import logging | ||
30 | |||
31 | |||
32 | def subcommand_error(args): | ||
33 | logging.info("invalid subcommand %s" % args[0]) | ||
34 | |||
35 | |||
36 | def display_help(subcommand, subcommands): | ||
37 | """ | ||
38 | Display help for subcommand. | ||
39 | """ | ||
40 | if subcommand not in subcommands: | ||
41 | return False | ||
42 | |||
43 | help = subcommands.get(subcommand, subcommand_error)[2] | ||
44 | pager = subprocess.Popen('less', stdin=subprocess.PIPE) | ||
45 | pager.communicate(help) | ||
46 | |||
47 | return True | ||
48 | |||
49 | |||
50 | def wic_help(args, usage_str, subcommands): | ||
51 | """ | ||
52 | Subcommand help dispatcher. | ||
53 | """ | ||
54 | if len(args) == 1 or not display_help(args[1], subcommands): | ||
55 | print(usage_str) | ||
56 | |||
57 | |||
58 | def invoke_subcommand(args, parser, main_command_usage, subcommands): | ||
59 | """ | ||
60 | Dispatch to subcommand handler borrowed from combo-layer. | ||
61 | Should use argparse, but has to work in 2.6. | ||
62 | """ | ||
63 | if not args: | ||
64 | logging.error("No subcommand specified, exiting") | ||
65 | parser.print_help() | ||
66 | elif args[0] == "help": | ||
67 | wic_help(args, main_command_usage, subcommands) | ||
68 | elif args[0] not in subcommands: | ||
69 | logging.error("Unsupported subcommand %s, exiting\n" % (args[0])) | ||
70 | parser.print_help() | ||
71 | else: | ||
72 | usage = subcommands.get(args[0], subcommand_error)[1] | ||
73 | subcommands.get(args[0], subcommand_error)[0](args[1:], usage) | ||
74 | |||
75 | |||
76 | ## | ||
77 | # wic help and usage strings | ||
78 | ## | ||
79 | |||
80 | wic_usage = """ | ||
81 | |||
82 | Create a customized OpenEmbedded image | ||
83 | |||
84 | usage: wic [--version] [--help] COMMAND [ARGS] | ||
85 | |||
86 | Current 'wic' commands are: | ||
87 | create Create a new OpenEmbedded image | ||
88 | list List available values for options and image properties | ||
89 | |||
90 | See 'wic help COMMAND' for more information on a specific command. | ||
91 | """ | ||
92 | |||
93 | wic_help_usage = """ | ||
94 | |||
95 | usage: wic help <subcommand> | ||
96 | |||
97 | This command displays detailed help for the specified subcommand. | ||
98 | """ | ||
99 | |||
100 | wic_create_usage = """ | ||
101 | |||
102 | Create a new OpenEmbedded image | ||
103 | |||
104 | usage: wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>] | ||
105 | [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>] | ||
106 | [-e | --image-name] [-r, --rootfs-dir] [-b, --bootimg-dir] | ||
107 | [-k, --kernel-dir] [-n, --native-sysroot] [-s, --skip-build-check] | ||
108 | |||
109 | This command creates an OpenEmbedded image based on the 'OE kickstart | ||
110 | commands' found in the <wks file>. | ||
111 | |||
112 | The -o option can be used to place the image in a directory with a | ||
113 | different name and location. | ||
114 | |||
115 | See 'wic help create' for more detailed instructions. | ||
116 | """ | ||
117 | |||
118 | wic_create_help = """ | ||
119 | |||
120 | NAME | ||
121 | wic create - Create a new OpenEmbedded image | ||
122 | |||
123 | SYNOPSIS | ||
124 | wic create <wks file or image name> [-o <DIRNAME> | --outdir <DIRNAME>] | ||
125 | [-i <JSON PROPERTY FILE> | --infile <JSON PROPERTY_FILE>] | ||
126 | [-e | --image-name] [-r, --rootfs-dir] [-b, --bootimg-dir] | ||
127 | [-k, --kernel-dir] [-n, --native-sysroot] [-s, --skip-build-check] | ||
128 | |||
129 | DESCRIPTION | ||
130 | This command creates an OpenEmbedded image based on the 'OE | ||
131 | kickstart commands' found in the <wks file>. | ||
132 | |||
133 | In order to do this, wic needs to know the locations of the | ||
134 | various build artifacts required to build the image. | ||
135 | |||
136 | Users can explicitly specify the build artifact locations using | ||
137 | the -r, -b, -k, and -n options. See below for details on where | ||
138 | the corresponding artifacts are typically found in a normal | ||
139 | OpenEmbedded build. | ||
140 | |||
141 | Alternatively, users can use the -e option to have 'mic' determine | ||
142 | those locations for a given image. If the -e option is used, the | ||
143 | user needs to have set the appropriate MACHINE variable in | ||
144 | local.conf, and have sourced the build environment. | ||
145 | |||
146 | The -e option is used to specify the name of the image to use the | ||
147 | artifacts from e.g. core-image-sato. | ||
148 | |||
149 | The -r option is used to specify the path to the /rootfs dir to | ||
150 | use as the .wks rootfs source. | ||
151 | |||
152 | The -b option is used to specify the path to the dir containing | ||
153 | the boot artifacts (e.g. /EFI or /syslinux dirs) to use as the | ||
154 | .wks bootimg source. | ||
155 | |||
156 | The -k option is used to specify the path to the dir containing | ||
157 | the kernel to use in the .wks bootimg. | ||
158 | |||
159 | The -n option is used to specify the path to the native sysroot | ||
160 | containing the tools to use to build the image. | ||
161 | |||
162 | The -s option is used to skip the build check. The build check is | ||
163 | a simple sanity check used to determine whether the user has | ||
164 | sourced the build environment so that the -e option can operate | ||
165 | correctly. If the user has specified the build artifact locations | ||
166 | explicitly, 'wic' assumes the user knows what he or she is doing | ||
167 | and skips the build check. | ||
168 | |||
169 | When 'wic -e' is used, the locations for the build artifacts | ||
170 | values are determined by 'wic -e' from the output of the 'bitbake | ||
171 | -e' command given an image name e.g. 'core-image-minimal' and a | ||
172 | given machine set in local.conf. In that case, the image is | ||
173 | created as if the following 'bitbake -e' variables were used: | ||
174 | |||
175 | -r: IMAGE_ROOTFS | ||
176 | -k: STAGING_KERNEL_DIR | ||
177 | -n: STAGING_DIR_NATIVE | ||
178 | -b: HDDDIR and STAGING_DATA_DIR (handlers decide which to use) | ||
179 | |||
180 | If 'wic -e' is not used, the user needs to select the appropriate | ||
181 | value for -b (as well as -r, -k, and -n). | ||
182 | |||
183 | The -o option can be used to place the image in a directory with a | ||
184 | different name and location. | ||
185 | |||
186 | As an alternative to the wks file, the image-specific properties | ||
187 | that define the values that will be used to generate a particular | ||
188 | image can be specified on the command-line using the -i option and | ||
189 | supplying a JSON object consisting of the set of name:value pairs | ||
190 | needed by image creation. | ||
191 | |||
192 | The set of properties available for a given image type can be | ||
193 | listed using the 'wic list' command. | ||
194 | """ | ||
195 | |||
196 | wic_list_usage = """ | ||
197 | |||
198 | List available OpenEmbedded image properties and values | ||
199 | |||
200 | usage: wic list images | ||
201 | wic list <image> help | ||
202 | wic list properties | ||
203 | wic list properties <wks file> | ||
204 | wic list property <property> | ||
205 | [-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>] | ||
206 | |||
207 | This command enumerates the set of available canned images as well as | ||
208 | help for those images. It also can be used to enumerate the complete | ||
209 | set of possible values for a specified option or property needed by | ||
210 | the image creation process. | ||
211 | |||
212 | The first form enumerates all the available 'canned' images. | ||
213 | |||
214 | The second form lists the detailed help information for a specific | ||
215 | 'canned' image. | ||
216 | |||
217 | The third form enumerates all the possible values that exist and can | ||
218 | be specified in an OE kickstart (wks) file. | ||
219 | |||
220 | The fourth form enumerates all the possible options that exist for | ||
221 | the set of properties specified in a given OE kickstart (ks) file. | ||
222 | |||
223 | The final form enumerates all the possible values that exist and can | ||
224 | be specified for any given OE kickstart (wks) property. | ||
225 | |||
226 | See 'wic help list' for more details. | ||
227 | """ | ||
228 | |||
229 | wic_list_help = """ | ||
230 | |||
231 | NAME | ||
232 | wic list - List available OpenEmbedded image properties and values | ||
233 | |||
234 | SYNOPSIS | ||
235 | wic list images | ||
236 | wic list <image> help | ||
237 | wic list properties | ||
238 | wic list properties <wks file> | ||
239 | wic list property <property> | ||
240 | [-o <JSON PROPERTY FILE> | --outfile <JSON PROPERTY_FILE>] | ||
241 | |||
242 | DESCRIPTION | ||
243 | This command enumerates the complete set of possible values for a | ||
244 | specified option or property needed by the image creation process. | ||
245 | |||
246 | This command enumerates the set of available canned images as well | ||
247 | as help for those images. It also can be used to enumerate the | ||
248 | complete set of possible values for a specified option or property | ||
249 | needed by the image creation process. | ||
250 | |||
251 | The first form enumerates all the available 'canned' images. | ||
252 | These are actually just the set of .wks files that have been moved | ||
253 | into the /scripts/lib/image/canned-wks directory). | ||
254 | |||
255 | The second form lists the detailed help information for a specific | ||
256 | 'canned' image. | ||
257 | |||
258 | The third form enumerates all the possible values that exist and | ||
259 | can be specified in a OE kickstart (wks) file. The output of this | ||
260 | can be used by the third form to print the description and | ||
261 | possible values of a specific property. | ||
262 | |||
263 | The fourth form enumerates all the possible options that exist for | ||
264 | the set of properties specified in a given OE kickstart (wks) | ||
265 | file. If the -o option is specified, the list of properties, in | ||
266 | addition to being displayed, will be written to the specified file | ||
267 | as a JSON object. In this case, the object will consist of the | ||
268 | set of name:value pairs corresponding to the (possibly nested) | ||
269 | dictionary of properties defined by the input statements used by | ||
270 | the image. Some example output for the 'list <wks file>' command: | ||
271 | |||
272 | $ wic list test.ks | ||
273 | "part" : { | ||
274 | "mountpoint" : "/" | ||
275 | "fstype" : "ext3" | ||
276 | } | ||
277 | "part" : { | ||
278 | "mountpoint" : "/home" | ||
279 | "fstype" : "ext3" | ||
280 | "offset" : "10000" | ||
281 | } | ||
282 | "bootloader" : { | ||
283 | "type" : "efi" | ||
284 | } | ||
285 | . | ||
286 | . | ||
287 | . | ||
288 | |||
289 | Each entry in the output consists of the name of the input element | ||
290 | e.g. "part", followed by the properties defined for that | ||
291 | element enclosed in braces. This information should provide | ||
292 | sufficient information to create a complete user interface with. | ||
293 | |||
294 | The final form enumerates all the possible values that exist and | ||
295 | can be specified for any given OE kickstart (wks) property. If | ||
296 | the -o option is specified, the list of values for the given | ||
297 | property, in addition to being displayed, will be written to the | ||
298 | specified file as a JSON object. In this case, the object will | ||
299 | consist of the set of name:value pairs corresponding to the array | ||
300 | of property values associated with the property. | ||
301 | |||
302 | $ wic list property part | ||
303 | ["mountpoint", "where the partition should be mounted"] | ||
304 | ["fstype", "filesytem type of the partition"] | ||
305 | ["ext3"] | ||
306 | ["ext4"] | ||
307 | ["btrfs"] | ||
308 | ["swap"] | ||
309 | ["offset", "offset of the partition within the image"] | ||
310 | |||
311 | """ | ||