diff options
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index a6e5ed6d4d..9fef0fc5f7 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -1314,28 +1314,35 @@ | |||
1314 | <title><filename>image_types.bbclass</filename></title> | 1314 | <title><filename>image_types.bbclass</filename></title> |
1315 | 1315 | ||
1316 | <para> | 1316 | <para> |
1317 | The <filename>image_types</filename> class defines all of | 1317 | The <filename>image_types</filename> class defines all of the |
1318 | the standard image output types that you can enable through the | 1318 | standard image output types that you can enable through the |
1319 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | 1319 | <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> |
1320 | variable. | 1320 | variable. |
1321 | You can use this class as a reference on how to add support for custom | 1321 | You can use this class as a reference on how to add support for |
1322 | image output types. | 1322 | custom image output types. |
1323 | </para> | 1323 | </para> |
1324 | 1324 | ||
1325 | <para> | 1325 | <para> |
1326 | By default, this class is enabled through the | 1326 | By default, the |
1327 | <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> | 1327 | <link linkend='ref-classes-image'><filename>image</filename></link> |
1328 | variable in | 1328 | class automatically enables the <filename>image_types</filename> class. |
1329 | <link linkend='ref-classes-image'><filename>image.bbclass</filename></link>. | 1329 | The <filename>image</filename> class uses the |
1330 | If you define your own image types using a custom BitBake class and | 1330 | <filename>IMGCLASSES</filename> variable as follows: |
1331 | then use <filename>IMAGE_CLASSES</filename> to enable it, the custom | 1331 | <literallayout class='monospaced'> |
1332 | class must either inherit <filename>image_types</filename> or | 1332 | IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" |
1333 | <filename>image_types</filename> must also appear in | 1333 | IMGCLASSES += "${@['populate_sdk_base', 'populate_sdk_ext']['linux' in d.getVar("SDK_OS")]}" |
1334 | <filename>IMAGE_CLASSES</filename>. | 1334 | IMGCLASSES += "${@bb.utils.contains_any('IMAGE_FSTYPES', 'live iso hddimg', 'image-live', '', d)}" |
1335 | IMGCLASSES += "${@bb.utils.contains('IMAGE_FSTYPES', 'container', 'image-container', '', d)}" | ||
1336 | IMGCLASSES += "image_types_wic" | ||
1337 | IMGCLASSES += "rootfs-postcommands" | ||
1338 | IMGCLASSES += "image-postinst-intercepts" | ||
1339 | inherit ${IMGCLASSES} | ||
1340 | </literallayout> | ||
1335 | </para> | 1341 | </para> |
1336 | 1342 | ||
1337 | <para> | 1343 | <para> |
1338 | This class also handles conversion and compression of images. | 1344 | The <filename>image_types</filename> class also handles conversion and |
1345 | compression of images. | ||
1339 | <note> | 1346 | <note> |
1340 | To build a VMware VMDK image, you need to add "wic.vmdk" to | 1347 | To build a VMware VMDK image, you need to add "wic.vmdk" to |
1341 | <filename>IMAGE_FSTYPES</filename>. | 1348 | <filename>IMAGE_FSTYPES</filename>. |