kernel-imximage.bbclass: Add documentation about the class

This adds a small documentation about the class as comment.

Signed-off-by: Otavio Salvador <otavio@ossystems.com.br>
This commit is contained in:
Otavio Salvador 2017-09-30 09:34:33 -03:00
parent f012327810
commit 357c7c27e7

View File

@ -1,3 +1,22 @@
# -*- python -*-
# Linux kernel with DCD headers
#
# This new image type adds support to generate a Linux kernel with DCD
# headers. Essentially it adds support to directly boot a Linux kernel
# without a bootloader.
#
# As the Linux kernel will be boot directly, it required that the Device
# Tree is appended to the kernel image. To have the Linux kernel
# generated with the DCD headers, following steps must be followed:
#
# - Linux kernel recipe must inherit kernel-imximage class;
# - Device Tree appended Linux kernel must be used
# (KERNEL_DEVICETREE_BUNDLE = "1");
# - DCD header configuration must be provided (dcd.cfg or
# dcd-<devicetree>.cfg);
#
# Copyright 2017 (C) O.S. Systems Software LTDA.
DEPENDS_append = ' u-boot-mkimage-native'
IMXIMAGE_ENTRYPOINT ?= "${UBOOT_ENTRYPOINT}"