From acb3f72afaa28ba5d23ca6e5cdf9f1162ea656a3 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 7 Dec 2012 17:25:45 -0600 Subject: [PATCH] Documentation: kernel-manual - Removed all trailing whitespace. (From yocto-docs rev: 188e1ad10217ff1a6a8363f100bff4e9ef3b9bf7) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../kernel-manual/kernel-concepts.xml | 2 +- .../kernel-manual/kernel-doc-intro.xml | 26 +- documentation/kernel-manual/kernel-how-to.xml | 344 +++++++++--------- documentation/kernel-manual/kernel-manual.xml | 16 +- 4 files changed, 194 insertions(+), 194 deletions(-) diff --git a/documentation/kernel-manual/kernel-concepts.xml b/documentation/kernel-manual/kernel-concepts.xml index ec9ac950b7..1290994257 100644 --- a/documentation/kernel-manual/kernel-concepts.xml +++ b/documentation/kernel-manual/kernel-concepts.xml @@ -146,7 +146,7 @@ Yocto Project and provides information on the mechanisms used to achieve that architecture. - +
Overview diff --git a/documentation/kernel-manual/kernel-doc-intro.xml b/documentation/kernel-manual/kernel-doc-intro.xml index 40c1b12590..c1cc22bb7a 100644 --- a/documentation/kernel-manual/kernel-doc-intro.xml +++ b/documentation/kernel-manual/kernel-doc-intro.xml @@ -10,9 +10,9 @@ Introduction The Yocto Project presents kernels as a fully patched, history-clean Git - repositories. + repositories. Each repository represents selected features, board support, - and configurations extensively tested by the Yocto Project. + 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. @@ -22,14 +22,14 @@ 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 + 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 + 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 + 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. @@ -39,8 +39,8 @@ The Linux Foundation's guide for kernel development process - - A fairly encompassing guide on Linux kernel development - - + A fairly encompassing guide on Linux kernel development - + @@ -53,14 +53,14 @@ "Kernel Modification Workflow" - + "Patching the Kernel" - + "Configuring the Kernel" - + For general information on the Yocto Project, visit the website at . diff --git a/documentation/kernel-manual/kernel-how-to.xml b/documentation/kernel-manual/kernel-how-to.xml index 9d0ec6a699..f29a0a865a 100644 --- a/documentation/kernel-manual/kernel-how-to.xml +++ b/documentation/kernel-manual/kernel-how-to.xml @@ -10,11 +10,11 @@
Introduction - This chapter describes how to accomplish tasks involving a kernel's tree structure. - The information is designed to help the developer that wants to modify the Yocto + This chapter describes how to accomplish tasks involving a kernel's tree structure. + The information is designed to help the developer that wants to modify the Yocto Project kernel and contribute changes upstream to the Yocto Project. The information covers the following: - + Tree construction Build strategies Workflow examples @@ -25,72 +25,72 @@
Tree Construction - This section describes construction of the Yocto Project kernel source repositories + This section describes construction of the Yocto Project kernel source repositories as accomplished by the Yocto Project team to create kernel repositories. These kernel repositories are found under the heading "Yocto Linux Kernel" at &YOCTO_GIT_URL;/cgit.cgi - and can be shipped as part of a Yocto Project release. + and can be shipped as part of a Yocto Project release. The team creates these repositories by compiling and executing the set of feature descriptions for every BSP/feature - in the product. + in the product. Those feature descriptions list all necessary patches, configuration, branching, tagging and feature divisions found in a kernel. Thus, the Yocto Project kernel repository (or tree) is built. - The existence of this tree allows you to access and clone a particular + The existence of this tree allows you to access and clone a particular Yocto Project kernel repository and use it to build images based on their configurations and features. - You can find the files used to describe all the valid features and BSPs - in the Yocto Project kernel in any clone of the Yocto Project kernel source repository + You can find the files used to describe all the valid features and BSPs + in the Yocto Project kernel in any clone of the Yocto Project kernel source repository Git tree. - For example, the following command clones the Yocto Project baseline kernel that + For example, the following command clones the Yocto Project baseline kernel that branched off of linux.org version 3.4: $ git clone git://git.yoctoproject.org/linux-yocto-3.4 For another example of how to set up a local Git repository of the Yocto Project - kernel files, see the - "Yocto Project Kernel" bulleted + kernel files, see the + "Yocto Project Kernel" bulleted item in the Yocto Project Development Manual. - - Once you have cloned the kernel Git repository on your local machine, you can + + Once you have cloned the kernel Git repository on your local machine, you can switch to the meta branch within the repository. - Here is an example that assumes the local Git repository for the kernel is in + Here is an example that assumes the local Git repository for the kernel is in a top-level directory named linux-yocto-3.4: $ cd ~/linux-yocto-3.4 $ git checkout -b meta origin/meta Once you have checked out and switched to the meta branch, - you can see a snapshot of all the kernel configuration and feature descriptions that are + you can see a snapshot of all the kernel configuration and feature descriptions that are used to build that particular kernel repository. - These descriptions are in the form of .scc files. + These descriptions are in the form of .scc files. You should realize, however, that browsing your local kernel repository for feature descriptions and patches is not an effective way to determine what is in a - particular kernel branch. + particular kernel branch. Instead, you should use Git directly to discover the changes in a branch. - Using Git is an efficient and flexible way to inspect changes to the kernel. + Using Git is an efficient and flexible way to inspect changes to the kernel. For examples showing how to use Git to inspect kernel commits, see the following sections in this chapter. - Ground up reconstruction of the complete kernel tree is an action only taken by the - Yocto Project team during an active development cycle. - When you create a clone of the kernel Git repository, you are simply making it + Ground up reconstruction of the complete kernel tree is an action only taken by the + Yocto Project team during an active development cycle. + When you create a clone of the kernel Git repository, you are simply making it efficiently available for building and development. The following steps describe what happens when the Yocto Project Team constructs - the Yocto Project kernel source Git repository (or tree) found at - given the - introduction of a new top-level kernel feature or BSP. - These are the actions that effectively create the tree + the Yocto Project kernel source Git repository (or tree) found at + given the + introduction of a new top-level kernel feature or BSP. + These are the actions that effectively create the tree that includes the new feature, patch or BSP: A top-level kernel feature is passed to the kernel build subsystem. @@ -103,7 +103,7 @@ Areas pointed to by SRC_URI statements found in recipes - For a typical build, the target of the search is a + For a typical build, the target of the search is a feature description in an .scc file whose name follows this format: @@ -113,19 +113,19 @@ Once located, the feature description is either compiled into a simple script of actions, or into an existing equivalent script that is already part of the shipped kernel. - Extra features are appended to the top-level feature description. - These features can come from the + Extra features are appended to the top-level feature description. + These features can come from the KERNEL_FEATURES variable in recipes. - Each extra feature is located, compiled and appended to the script + Each extra feature is located, compiled and appended to the script as described in step three. The script is executed to produce a series of meta-* - directories. + directories. These directories are descriptions of all the branches, tags, patches and configurations that need to be applied to the base Git repository to completely create the source (build) branch for the new BSP or feature. The base repository is cloned, and the actions - listed in the meta-* directories are applied to the + listed in the meta-* directories are applied to the tree. The Git repository is left with the desired branch checked out and any required branching, patching and tagging has been performed. @@ -133,17 +133,17 @@ The kernel tree is now ready for developer consumption to be locally cloned, - configured, and built into a Yocto Project kernel specific to some target hardware. - The generated meta-* directories add to the kernel - as shipped with the Yocto Project release. - Any add-ons and configuration data are applied to the end of an existing branch. - The full repository generation that is found in the + configured, and built into a Yocto Project kernel specific to some target hardware. + The generated meta-* directories add to the kernel + as shipped with the Yocto Project release. + Any add-ons and configuration data are applied to the end of an existing branch. + The full repository generation that is found in the official Yocto Project kernel repositories at http://git.yoctoproject.org/cgit.cgi is the combination of all supported boards and configurations. - The technique the Yocto Project team uses is flexible and allows for seamless - blending of an immutable history with additional patches specific to a - deployment. + The technique the Yocto Project team uses is flexible and allows for seamless + blending of an immutable history with additional patches specific to a + deployment. Any additions to the kernel become an integrated part of the branches. @@ -152,15 +152,15 @@
Build Strategy - Once a local Git repository of the Yocto Project kernel exists on a development system, + Once a local Git repository of the Yocto Project kernel exists on a development system, you can consider the compilation phase of kernel development - building a kernel image. Some prerequisites exist that are validated by the build process before compilation starts: - The - SRC_URI points + The + SRC_URI points to the kernel Git repository. A BSP build branch exists. This branch has the following form: @@ -171,22 +171,22 @@ The OpenEmbedded build system makes sure these conditions exist before attempting compilation. - Other means, however, do exist, such as as bootstrapping a BSP, see + Other means, however, do exist, such as as bootstrapping a BSP, see the "Workflow Examples". - Before building a kernel, the build process verifies the tree + Before building a kernel, the build process verifies the tree and configures the kernel by processing all of the configuration "fragments" specified by feature descriptions in the .scc - files. + files. As the features are compiled, associated kernel configuration fragments are noted - and recorded in the meta-* series of directories in their compilation order. + and recorded in the meta-* series of directories in their compilation order. The fragments are migrated, pre-processed and passed to the Linux Kernel - Configuration subsystem (lkc) as raw input in the form + Configuration subsystem (lkc) as raw input in the form of a .config file. The lkc uses its own internal dependency constraints to do the final - processing of that information and generates the final .config file + processing of that information and generates the final .config file that is used during compilation. @@ -197,9 +197,9 @@ The other thing that you notice once you configure a kernel is that - the build process generates a build tree that is separate from your kernel's local Git + the build process generates a build tree that is separate from your kernel's local Git source repository tree. - This build tree has a name that uses the following form, where + This build tree has a name that uses the following form, where ${MACHINE} is the metadata name of the machine (BSP) and "kernel_type" is one of the Yocto Project supported kernel types (e.g. "standard"): @@ -208,13 +208,13 @@ - The existing support in the kernel.org tree achieves this + The existing support in the kernel.org tree achieves this default functionality. - This behavior means that all the generated files for a particular machine or BSP are now in - the build tree directory. + This behavior means that all the generated files for a particular machine or BSP are now in + the build tree directory. The files include the final .config file, all the .o files, the .a files, and so forth. Since each machine or BSP has its own separate build directory in its own separate branch @@ -229,18 +229,18 @@ As previously noted, the Yocto Project kernel has built-in Git integration. However, these utilities are not the only way to work with the kernel repository. The Yocto Project has not made changes to Git or to other tools that - would invalidate alternate workflows. - Additionally, the way the kernel repository is constructed results in using - only core Git functionality, thus allowing any number of tools or front ends to use the + would invalidate alternate workflows. + Additionally, the way the kernel repository is constructed results in using + only core Git functionality, thus allowing any number of tools or front ends to use the resulting tree. This section contains several workflow examples. - Many of the examples use Git commands. - You can find Git documentation at + Many of the examples use Git commands. + You can find Git documentation at . - You can find a simple overview of using Git with the Yocto Project in the + You can find a simple overview of using Git with the Yocto Project in the "Git" section of the Yocto Project Development Manual. @@ -249,25 +249,25 @@ Change Inspection: Kernel Changes/Commits - A common question when working with a BSP or kernel is: + A common question when working with a BSP or kernel is: "What changes have been applied to this tree?" In projects that have a collection of directories that - contain patches to the kernel, it is possible to inspect or "grep" the contents - of the directories to get a general feel for the changes. + contain patches to the kernel, it is possible to inspect or "grep" the contents + of the directories to get a general feel for the changes. This sort of patch inspection is not an efficient way to determine what has been done to the kernel. - The reason it is inefficient is because there are many optional patches that are + The reason it is inefficient is because there are many optional patches that are selected based on the kernel type and the feature description. Additionally, patches could exist in directories that are not included in the search. A more efficient way to determine what has changed in the kernel is to use - Git and inspect or search the kernel tree. - This method gives you a full view of not only the source code modifications, + Git and inspect or search the kernel tree. + This method gives you a full view of not only the source code modifications, but also provides the reasons for the changes. @@ -277,11 +277,11 @@ Following are a few examples that show how to use Git to examine changes. Because the Yocto Project Git repository does not break existing Git - functionality and because there exists many permutations of these types of + functionality and because there exists many permutations of these types of commands, there are many more methods to discover changes. - Unless you provide a commit range - (<kernel-type>..<bsp>-<kernel-type>), kernel.org history + Unless you provide a commit range + (<kernel-type>..<bsp>-<kernel-type>), kernel.org history is blended with Yocto Project changes. @@ -301,27 +301,27 @@ # determine the change history of a particular file > git whatchanged <path to file> - + # determine the commits which touch each line in a file > git blame <path to file>
- +
Show a Particular Feature or Branch Change - Developers use tags in the Yocto Project kernel tree to divide changes for significant - features or branches. - Once you know a particular tag, you can use Git commands + Developers use tags in the Yocto Project kernel tree to divide changes for significant + features or branches. + Once you know a particular tag, you can use Git commands to show changes associated with the tag and find the branches that contain - the feature. + the feature. - Because BSP branch, kernel.org, and feature tags are all + Because BSP branch, kernel.org, and feature tags are all present, there could be many tags. - The git show <tag> command shows changes that are tagged by + The git show <tag> command shows changes that are tagged by a feature. Here is an example that shows changes tagged by the systemtap feature: @@ -339,7 +339,7 @@ You can use many other comparisons to isolate BSP and kernel changes. - For example, you can compare against kernel.org tags + For example, you can compare against kernel.org tags such as the v3.4 tag.
@@ -350,29 +350,29 @@ Another common operation is to build a BSP supplied by the Yocto Project, make some - changes, rebuild, and then test. + changes, rebuild, and then test. Those local changes often need to be exported, shared or otherwise maintained. Since the Yocto Project kernel source tree is backed by Git, this activity is - much easier as compared to with previous releases. - Because Git tracks file modifications, additions and deletions, it is easy + much easier as compared to with previous releases. + Because Git tracks file modifications, additions and deletions, it is easy to modify the code and later realize that you need to save the changes. - It is also easy to determine what has changed. + It is also easy to determine what has changed. This method also provides many tools to commit, undo and export those modifications. - This section and its sub-sections, describe general application of Git's - push and pull commands, which are used to - get your changes upstream or source your code from an upstream repository. - The Yocto Project provides scripts that help you work in a collaborative development - environment. + This section and its sub-sections, describe general application of Git's + push and pull commands, which are used to + get your changes upstream or source your code from an upstream repository. + The Yocto Project provides scripts that help you work in a collaborative development + environment. For information on these scripts, see the - "Using Scripts to Push a Change - Upstream and Request a Pull" and - "Using Email to Submit a Patch" + "Using Scripts to Push a Change + Upstream and Request a Pull" and + "Using Email to Submit a Patch" sections in the Yocto Project Development Manual. @@ -380,7 +380,7 @@ There are many ways to save kernel modifications. The technique employed depends on the destination for the patches: - + Bulk storage Internal sharing either through patches or by using Git @@ -391,7 +391,7 @@ - Because of the following list of issues, the destination of the patches also influences + Because of the following list of issues, the destination of the patches also influences the method for gathering them: @@ -405,24 +405,24 @@ Bulk Export - This section describes how you can "bulk" export changes that have not - been separated or divided. - This situation works well when you are simply storing patches outside of the kernel - source repository, either permanently or temporarily, and you are not committing + This section describes how you can "bulk" export changes that have not + been separated or divided. + This situation works well when you are simply storing patches outside of the kernel + source repository, either permanently or temporarily, and you are not committing incremental changes during development. This technique is not appropriate for full integration of upstream submission because changes are not properly divided and do not provide an avenue for per-change - commit messages. - Therefore, this example assumes that changes have not been committed incrementally + commit messages. + Therefore, this example assumes that changes have not been committed incrementally during development and that you simply must gather and export them. # bulk export of ALL modifications without separation or division - # of the changes + # of the changes $ git add . - $ git commit -s -a -m <msg> + $ git commit -s -a -m <msg> or $ git commit -s -a # and interact with $EDITOR @@ -447,8 +447,8 @@ This section describes how to save modifications when you are making incremental commits or practicing planned sharing. - The examples in this section assume that you have incrementally committed - changes to the tree during development and now need to export them. + The examples in this section assume that you have incrementally committed + changes to the tree during development and now need to export them. The sections that follow describe how you can export your changes internally through either patches or by using Git commands. @@ -456,7 +456,7 @@ During development, the following commands are of interest. - For full Git documentation, refer to the Git documentation at + For full Git documentation, refer to the Git documentation at . @@ -476,15 +476,15 @@ - Distributed development with Git is possible when you use a universally + Distributed development with Git is possible when you use a universally agreed-upon unique commit identifier (set by the creator of the commit) that maps to a - specific change set with a specific parent. + specific change set with a specific parent. This identifier is created for you when you create a commit, and is re-created when you amend, alter or re-apply - a commit. + a commit. As an individual in isolation, this is of no interest. However, if you - intend to share your tree with normal Git push and + intend to share your tree with normal Git push and pull operations for distributed development, you should consider the ramifications of changing a commit that you have already shared with others. @@ -492,7 +492,7 @@ Assuming that the changes have not been pushed upstream, or pulled into - another repository, you can update both the commit content and commit messages + another repository, you can update both the commit content and commit messages associated with development by using the following commands: @@ -502,7 +502,7 @@ - + Again, assuming that the changes have not been pushed upstream, and that no pending works-in-progress exist (use git status to check), then you can revert (undo) commits by using the following commands: @@ -521,12 +521,12 @@ You can create branches, "cherry-pick" changes, or perform any number of Git operations until the commits are in good order for pushing upstream - or for pull requests. - After a push or pull command, + or for pull requests. + After a push or pull command, commits are normally considered "permanent" and you should not modify them. If the commits need to be changed, you can incrementally do so with new commits. - These practices follow standard Git workflow and the kernel.org best + These practices follow standard Git workflow and the kernel.org best practices, which is recommended. It is recommended to tag or branch before adding changes to a Yocto Project @@ -535,26 +535,26 @@ reference point to facilitate locating and exporting local changes. - +
Exporting Changes Internally by Using Patches This section describes how you can extract committed changes from a working directory by exporting them as patches. - Once the changes have been extracted, you can use the patches for upstream submission, + Once the changes have been extracted, you can use the patches for upstream submission, place them in a Yocto Project template for automatic kernel patching, or apply them in many other common uses. This example shows how to create a directory with sequentially numbered patches. - Once the directory is created, you can apply it to a repository using the - git am command to reproduce the original commit and all + Once the directory is created, you can apply it to a repository using the + git am command to reproduce the original commit and all the related information such as author, date, commit log, and so forth. - The new commit identifiers (ID) will be generated upon re-application. - This action reflects that the commit is now applied to an underlying commit + The new commit identifiers (ID) will be generated upon re-application. + This action reflects that the commit is now applied to an underlying commit with a different ID. @@ -581,19 +581,19 @@ $ git format-patch -o <save dir> <commit id> $ git format-patch -o <save dir> <rev-list> - -
+ +
Exporting Changes Internally by Using Git - This section describes how you can export changes from a working directory + This section describes how you can export changes from a working directory by pushing the changes into a master repository or by making a pull request. - Once you have pushed the changes to the master repository, you can then + Once you have pushed the changes to the master repository, you can then pull those same changes into a new kernel build at a later time. - + Use this command form to push the changes: @@ -604,7 +604,7 @@ For example, the following command pushes the changes from your local branch - yocto/standard/common-pc/base to the remote branch with the same name + yocto/standard/common-pc/base to the remote branch with the same name in the master repository //git.mycompany.com/pub/git/kernel-3.4. $ git push ssh://git.mycompany.com/pub/git/kernel-3.4 \ @@ -613,7 +613,7 @@ - A pull request entails using the git request-pull command to compose + A pull request entails using the git request-pull command to compose an email to the maintainer requesting that a branch be pulled into the master repository, see for an example. @@ -622,7 +622,7 @@ changes, but are not covered in this document. -
+
@@ -636,12 +636,12 @@ This method allows easy review and integration of the changes. Before sending patches for review be sure you understand the - community standards for submitting and documenting changes and follow their best practices. + community standards for submitting and documenting changes and follow their best practices. For example, kernel patches should follow standards such as: - Documentation/SubmittingPatches (in any linux + Documentation/SubmittingPatches (in any linux kernel source tree) @@ -651,30 +651,30 @@ The messages used to commit changes are a large part of these standards. Consequently, be sure that the headers for each commit have the required information. For information on how to follow the Yocto Project commit message standards, see the - "How to Submit a + "How to Submit a Change" section in the Yocto Project Development Manual. If the initial commits were not properly documented or do not meet those standards, - you can re-base by using the git rebase -i command to + you can re-base by using the git rebase -i command to manipulate the commits and - get them into the required format. + get them into the required format. Other techniques such as branching and cherry-picking commits are also viable options. - Once you complete the commits, you can generate the email that sends the patches - to the maintainer(s) or lists that review and integrate changes. - The command git send-email is commonly used to ensure - that patches are properly + Once you complete the commits, you can generate the email that sends the patches + to the maintainer(s) or lists that review and integrate changes. + The command git send-email is commonly used to ensure + that patches are properly formatted for easy application and avoid mailer-induced patch damage. The following is an example of dumping patches for external submission: - # dump the last 4 commits + # dump the last 4 commits $ git format-patch --thread -n -o ~/rr/ HEAD^^^^ $ git send-email --compose --subject '[RFC 0/N] <patch series summary>' \ --to foo@yoctoproject.org --to bar@yoctoproject.org \ @@ -690,17 +690,17 @@ When you want to export changes for import into another - Source Code Manager (SCM), you can use any of the previously discussed + Source Code Manager (SCM), you can use any of the previously discussed techniques. - However, if the patches are manually applied to a secondary tree and then - that tree is checked into the SCM, you can lose change information such as + However, if the patches are manually applied to a secondary tree and then + that tree is checked into the SCM, you can lose change information such as commit logs. This process is not recommended. Many SCMs can directly import Git commits, or can translate Git patches so that - information is not lost. + information is not lost. Those facilities are SCM-dependent and you should use them whenever possible.
@@ -710,15 +710,15 @@ Working with the Yocto Project Kernel in Another SCM - This section describes kernel development in an SCM other than Git, + This section describes kernel development in an SCM other than Git, which is not the same as exporting changes to another SCM described earlier. - For this scenario, you use the OpenEmbedded build system to + For this scenario, you use the OpenEmbedded build system to develop the kernel in a different SCM. The following must be true for you to accomplish this: The delivered Yocto Project kernel must be exported into the second SCM. - Development must be exported from that secondary SCM into a + Development must be exported from that secondary SCM into a format that can be used by the OpenEmbedded build system. @@ -728,7 +728,7 @@ Depending on the SCM, it might be possible to export the entire Yocto Project - kernel Git repository, branches and all, into a new environment. + kernel Git repository, branches and all, into a new environment. This method is preferred because it has the most flexibility and potential to maintain the meta data associated with each commit. @@ -750,11 +750,11 @@ - You could now relocate the CVS repository and use it in a centralized manner. + You could now relocate the CVS repository and use it in a centralized manner. - The following commands illustrate how you can condense and merge two BSPs into a + The following commands illustrate how you can condense and merge two BSPs into a second SCM: $ git checkout yocto/standard/common-pc/base @@ -768,7 +768,7 @@
Importing Changes for the Build - + Once development has reached a suitable point in the second development environment, you need to export the changes as patches. @@ -782,12 +782,12 @@ Creating a BSP Based on an Existing Similar BSP - This section overviews the process of creating a BSP based on an + This section overviews the process of creating a BSP based on an existing similar BSP. - The information is introductory in nature and does not provide step-by-step examples. + The information is introductory in nature and does not provide step-by-step examples. For detailed information on how to create a new BSP, see - the "Creating a New BSP Layer Using the yocto-bsp Script" section in the - Yocto Project Board Support Package (BSP) Developer's Guide, or see the + the "Creating a New BSP Layer Using the yocto-bsp Script" section in the + Yocto Project Board Support Package (BSP) Developer's Guide, or see the Transcript:_creating_one_generic_Atom_BSP_from_another wiki page. @@ -796,42 +796,42 @@ The basic steps you need to follow are: Make sure you have set up a local Source Directory: - You must create a local - Source Directory - by either creating a Git repository (recommended) or + You must create a local + Source Directory + by either creating a Git repository (recommended) or extracting a Yocto Project release tarball. Choose an existing BSP available with the Yocto Project: - Try to map your board features as closely to the features of a BSP that is - already supported and exists in the Yocto Project. - Starting with something as close as possible to your board makes developing - your BSP easier. - You can find all the BSPs that are supported and ship with the Yocto Project - on the Yocto Project's Download page at + Try to map your board features as closely to the features of a BSP that is + already supported and exists in the Yocto Project. + Starting with something as close as possible to your board makes developing + your BSP easier. + You can find all the BSPs that are supported and ship with the Yocto Project + on the Yocto Project's Download page at . Be sure you have the Base BSP: - You need to either have a local Git repository of the base BSP set up or + You need to either have a local Git repository of the base BSP set up or have downloaded and extracted the files from a release BSP tarball. Either method gives you access to the BSP source files. - Make a copy of the existing BSP, thus isolating your new + Make a copy of the existing BSP, thus isolating your new BSP work: Copying the existing BSP file structure gives you a new area in which to work. Make configuration and recipe changes to your new BSP: Configuration changes involve the files in the BSP's conf - directory. - Changes include creating a machine-specific configuration file and editing the - layer.conf file. + directory. + Changes include creating a machine-specific configuration file and editing the + layer.conf file. The configuration changes identify the kernel you will be using. - Recipe changes include removing, modifying, or adding new recipe files that + Recipe changes include removing, modifying, or adding new recipe files that instruct the build process on what features to include in the image. Prepare for the build: Before you actually initiate the build, you need to set up the build environment - by sourcing the environment initialization script. - After setting up the environment, you need to make some build configuration + by sourcing the environment initialization script. + After setting up the environment, you need to make some build configuration changes to the local.conf and bblayers.conf files. Build the image: - The OpenEmbedded build system uses BitBake to create the image. - You need to decide on the type of image you are going to build (e.g. minimal, base, + The OpenEmbedded build system uses BitBake to create the image. + You need to decide on the type of image you are going to build (e.g. minimal, base, core, sato, and so forth) and then start the build using the bitbake command. @@ -851,8 +851,8 @@ - You can use the above Git command to report modified, removed, or added files. - You should commit those changes to the tree regardless of whether they will be saved, + You can use the above Git command to report modified, removed, or added files. + You should commit those changes to the tree regardless of whether they will be saved, exported, or used. Once you commit the changes you need to rebuild the kernel. diff --git a/documentation/kernel-manual/kernel-manual.xml b/documentation/kernel-manual/kernel-manual.xml index 99d71843bf..8714c07744 100644 --- a/documentation/kernel-manual/kernel-manual.xml +++ b/documentation/kernel-manual/kernel-manual.xml @@ -2,7 +2,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ %poky; ] > - @@ -10,13 +10,13 @@ - - + - + @@ -73,7 +73,7 @@ - Permission is granted to copy, distribute and/or modify this document under + Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. @@ -99,6 +99,6 @@ --> -