diff --git a/documentation/Makefile b/documentation/Makefile index 1ab74fc61a..7c3d16ec04 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -235,6 +235,20 @@ FIGURES = figures STYLESHEET = $(DOC)/*.css endif +ifeq ($(DOC),kernel-dev) +XSLTOPTS = --stringparam html.stylesheet kernel-dev-style.css \ + --stringparam chapter.autolabel 1 \ + --stringparam appendix.autolabel A \ + --stringparam section.autolabel 1 \ + --stringparam section.label.includes.component.label 1 \ + --xinclude +ALLPREQ = html pdf tarball +TARFILES = kernel-dev.html kernel-dev.pdf kernel-dev-style.css figures/kernel-dev-title.png +MANUALS = $(DOC)/$(DOC).html $(DOC)/$(DOC).pdf +FIGURES = figures +STYLESHEET = $(DOC)/*.css +endif + ## # These URI should be rewritten by your distribution's xml catalog to diff --git a/documentation/kernel-dev/figures/kernel-dev-title.png b/documentation/kernel-dev/figures/kernel-dev-title.png index 1cb989f34a..7a8dd54372 100644 Binary files a/documentation/kernel-dev/figures/kernel-dev-title.png and b/documentation/kernel-dev/figures/kernel-dev-title.png differ diff --git a/documentation/kernel-dev/kernel-dev-intro.xml b/documentation/kernel-dev/kernel-dev-intro.xml index c1cc22bb7a..68fac80ac7 100644 --- a/documentation/kernel-dev/kernel-dev-intro.xml +++ b/documentation/kernel-dev/kernel-dev-intro.xml @@ -2,76 +2,79 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ %poky; ] > - + -Yocto Project Kernel Architecture and Use Manual +Yocto Project Kernel Development Manual -
+
Introduction + - The Yocto Project presents kernels as a fully patched, history-clean Git - repositories. - Each repository represents selected features, board support, - and configurations extensively tested by the Yocto Project. - Yocto Project kernels allow the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. - - - This manual describes Yocto Project kernels by providing information - on history, organization, benefits, and use. - The manual consists of two sections: - - Concepts: Describes concepts behind a kernel. - You will understand how a kernel is organized and why it is organized in - the way it is. You will understand the benefits of a kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process. - Using a Kernel: Describes best practices - and "how-to" information - that lets you put a kernel to practical use. - Some examples are how to examine changes in a branch and how to - save kernel modifications. - + Regardless of how you intend to make use of the Yocto Project, chances are you +are going to need to work with the Linux kernel. The Yocto Project provides a +powerful set of tools for managing Linux kernel sources and configuration data. +If you want to make a single configuration change, apply a couple of patches, or +work with your own sources, the Yocto Project has tooling in place to help you +do it. - For more information on the Linux kernel, see the following links: - - The Linux Foundation's guide for kernel development - process - - A fairly encompassing guide on Linux kernel development - - - + Each Yocto Project release introduces a new set of linux-yocto kernel recipes, +tracking the latest upstream developments and introducing newly supported +platforms. In addition to the new kernel recipes, the previous recipes are +refreshed and supported for at least one additional release. As they align, +these previous releases are updated to include the latest from the LTSI project. +Besides these recipes, a linux-yocto-dev recipe is available for working with +the very latest in upstream Linux kernel development as well as meta-data +development. - For more discussion on the Yocto Project kernel, you can see these sections - in the Yocto Project Development Manual: + If you do not maintain your own kernel sources and need to make only minimal +changes to the sources, these recipes provide a vetted base upon which to layer +your changes. Doing so allows you to benefit from the continual kernel +integration and testing performed during development of the Yocto Project. + + + + If, instead, you have a very specific Linux kernel source tree and are unable to +align with one of the many official linux-yocto releases, an alternative +exists by which you can use the Yocto Project Linux kernel tools with your own +sources. + + + + The sections that follow provide instructions for completing specific Linux +kernel development tasks. They assume familiarity with working with bitbake +recipes and basic open-source development tools. Understanding these concepts +will facilitate the process of working with the kernel recipes. If you find you +need some additional background, please be sure to review and understand the +following documentation: - - "Kernel Overview" - - "Kernel Modification Workflow" + Yocto Project Quick Start - - "Patching the Kernel" - - "Configuring the Kernel" + Yocto Project Development Manual + + 4.3 Modifying Temporary Source Code + + 5.1 Understanding and Creating Layers + + 4.1.2 Modifying the Kernel + (This section should be retired, as well as 5.6, 5.7 - with this document + providing the necessary information) + - For general information on the Yocto Project, visit the website at - . + Finally, while this document focuses on the manual creation of recipes, patches, +and configuration files, the Yocto Project BSP tools are available to automate +this process with existing content and work well to create the initial framework +and boilerplate code. For details, refer to the Yocto Project BSP Developer's +Guide.
- - - - - -