summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..64e2cd0
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+agl-yocto-kernel-meta
+=====================
+
+Yocto Project kernel rich Metadata [1] for AGL based on YP's kernel rich
+metadata [2].
+
+Using Yocto Linux Kernel is recommended in "Yocto Project Board Support Package
+Developer's Guide" [3]:
+
+> Kernel recipes in the BSP should be based on a Yocto Linux kernel. Basing your
+> recipes on these kernels reduces the costs for maintaining the BSP and
+> increases its scalability.
+
+YP advanced kernel metadata besides configuration fragments and patches,
+realizes scc description files (scc stands for Series Configuration Control, but
+the naming has less significance in the current implementation of the tooling
+than it had in the past) which allow to:
+
+* group configuration fragments and patches into a reusable unit
+* include scc files from other scc files
+* besides BSP description scc file, additional scc files can be easily applied
+ by adding them to KERNEL_FEATURES variable
+
+and much more.
+
+[1]: https://docs.yoctoproject.org/4.0.2/kernel-dev/advanced.html
+[2]: https://git.yoctoproject.org/yocto-kernel-cache
+[3]: https://docs.yoctoproject.org/4.0.2/bsp-guide/bsp.html#released-bsp-recommendations