diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2010-11-24 13:23:46 -0800 |
---|---|---|
committer | Saul Wold <Saul.Wold@intel.com> | 2010-12-10 22:01:10 -0800 |
commit | 5b10a72004e3474bbab7fe7f0474b40f45e9aed8 (patch) | |
tree | f3357a2e2ef84945cd08d573cbbc5824131146c9 /documentation | |
parent | db8214415bf9f6c64c834f3f15adee0530f03ea6 (diff) | |
download | poky-5b10a72004e3474bbab7fe7f0474b40f45e9aed8.tar.gz |
documentation/kernel-manual/yocto-project-kernel-manual.xml: Removed sections not fit for 0.9 release.
These sections were commented out after a review by Bruce Ashfield. They
need to be revisited as we continue with the 1.0 work.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/kernel-manual/yocto-project-kernel-manual.xml | 94 |
1 files changed, 47 insertions, 47 deletions
diff --git a/documentation/kernel-manual/yocto-project-kernel-manual.xml b/documentation/kernel-manual/yocto-project-kernel-manual.xml index b1693500fc..6d93975019 100644 --- a/documentation/kernel-manual/yocto-project-kernel-manual.xml +++ b/documentation/kernel-manual/yocto-project-kernel-manual.xml | |||
@@ -332,7 +332,7 @@ kernel are: | |||
332 | <listitem><para>the presentation of a seamless git repository that blends Yocto Project value with the kernel.org history and development</para></listitem> | 332 | <listitem><para>the presentation of a seamless git repository that blends Yocto Project value with the kernel.org history and development</para></listitem> |
333 | </itemizedlist> | 333 | </itemizedlist> |
334 | </para> | 334 | </para> |
335 | <para> | 335 | <!--<para> |
336 | The tools that construct a kernel tree will be discussed later in this | 336 | The tools that construct a kernel tree will be discussed later in this |
337 | document. The following tools form the foundation of the Yocto Project | 337 | document. The following tools form the foundation of the Yocto Project |
338 | kernel toolkit: | 338 | kernel toolkit: |
@@ -343,7 +343,7 @@ kernel toolkit: | |||
343 | <listitem><para>kgit*: Yocto Project kernel tree creation and management tools</para></listitem> | 343 | <listitem><para>kgit*: Yocto Project kernel tree creation and management tools</para></listitem> |
344 | <listitem><para>scc : series & configuration compiler</para></listitem> | 344 | <listitem><para>scc : series & configuration compiler</para></listitem> |
345 | </itemizedlist> | 345 | </itemizedlist> |
346 | </para> | 346 | </para> --> |
347 | </section> | 347 | </section> |
348 | </section> | 348 | </section> |
349 | 349 | ||
@@ -367,18 +367,18 @@ kernel toolkit: | |||
367 | <itemizedlist> | 367 | <itemizedlist> |
368 | <listitem><para>Tree construction</para></listitem> | 368 | <listitem><para>Tree construction</para></listitem> |
369 | <listitem><para>Build strategies</para></listitem> | 369 | <listitem><para>Build strategies</para></listitem> |
370 | <listitem><para>Series & Configuration Compiler</para></listitem> | 370 | <!-- <listitem><para>Series & Configuration Compiler</para></listitem> |
371 | <listitem><para>kgit</para></listitem> | 371 | <listitem><para>kgit</para></listitem> --> |
372 | <listitem><para>Workflow examples</para></listitem> | 372 | <listitem><para>Workflow examples</para></listitem> |
373 | <listitem><para>Source Code Manager (SCM)</para></listitem> | 373 | <listitem><para>Source Code Manager (SCM)</para></listitem> |
374 | <listitem><para>Board Support Package (BSP) template migration</para></listitem> | 374 | <!-- <listitem><para>Board Support Package (BSP) template migration</para></listitem> --> |
375 | <listitem><para>BSP creation</para></listitem> | 375 | <listitem><para>BSP creation</para></listitem> |
376 | <listitem><para>Patching</para></listitem> | 376 | <listitem><para>Patching</para></listitem> |
377 | <listitem><para>Updating BSP patches and configuration</para></listitem> | 377 | <listitem><para>Updating BSP patches and configuration</para></listitem> |
378 | <listitem><para>guilt</para></listitem> | 378 | <!-- <listitem><para>guilt</para></listitem> |
379 | <listitem><para>scc file example</para></listitem> | 379 | <listitem><para>scc file example</para></listitem> --> |
380 | <listitem><para>"dirty" string</para></listitem> | 380 | <listitem><para>"dirty" string</para></listitem> |
381 | <listitem><para>Transition kernel layer</para></listitem> | 381 | <!-- <listitem><para>Transition kernel layer</para></listitem> --> |
382 | </itemizedlist> | 382 | </itemizedlist> |
383 | </para> | 383 | </para> |
384 | 384 | ||
@@ -404,7 +404,7 @@ following sections. | |||
404 | </para> | 404 | </para> |
405 | <para> | 405 | <para> |
406 | As a reminder, it is envisioned that a ground up reconstruction of the | 406 | As a reminder, it is envisioned that a ground up reconstruction of the |
407 | complete kernel tree is an action only taken by Yocto Project staff during an | 407 | complete kernel tree is an action only taken by Yocto Project team during an |
408 | active development cycle. When an end user creates a project, it takes | 408 | active development cycle. When an end user creates a project, it takes |
409 | advantage of this complete tree in order to efficiently place a git tree | 409 | advantage of this complete tree in order to efficiently place a git tree |
410 | within their project. | 410 | within their project. |
@@ -420,8 +420,9 @@ The general flow of the project specific kernel tree construction is as follows: | |||
420 | 420 | ||
421 | <itemizedlist> | 421 | <itemizedlist> |
422 | <listitem><para>the kernel-cache under linux/wrs/cfg/kernel-cache</para></listitem> | 422 | <listitem><para>the kernel-cache under linux/wrs/cfg/kernel-cache</para></listitem> |
423 | <listitem><para>kernel-*-cache directories in layers</para></listitem> | 423 | <!-- <listitem><para>kernel-*-cache directories in layers</para></listitem> --> |
424 | <listitem><para>configured and default templates</para></listitem> | 424 | <listitem><para>recipe SRC_URIs</para></listitem> |
425 | <!-- <listitem><para>configured and default templates</para></listitem> --> | ||
425 | </itemizedlist> | 426 | </itemizedlist> |
426 | 427 | ||
427 | <para>In a typical build a feature description of the format: | 428 | <para>In a typical build a feature description of the format: |
@@ -433,8 +434,7 @@ The general flow of the project specific kernel tree construction is as follows: | |||
433 | shipped kernel is located.</para></listitem> | 434 | shipped kernel is located.</para></listitem> |
434 | 435 | ||
435 | <listitem><para>extra features are appended to the top level feature description. Extra | 436 | <listitem><para>extra features are appended to the top level feature description. Extra |
436 | features can come from the command line, the configure script or | 437 | features can come from the KERNEL_FEATURES variable in recipes.</para></listitem> |
437 | templates.</para></listitem> | ||
438 | 438 | ||
439 | <listitem><para>each extra feature is located, compiled and appended to the script from | 439 | <listitem><para>each extra feature is located, compiled and appended to the script from |
440 | step #3</para></listitem> | 440 | step #3</para></listitem> |
@@ -444,7 +444,7 @@ The general flow of the project specific kernel tree construction is as follows: | |||
444 | need to be applied to the base git repository to completely create the | 444 | need to be applied to the base git repository to completely create the |
445 | "bsp_name-kernel_type".</para></listitem> | 445 | "bsp_name-kernel_type".</para></listitem> |
446 | 446 | ||
447 | <listitem><para>the base repository (normally kernel.org) is cloned, and the actions | 447 | <listitem><para>the base repository is cloned, and the actions |
448 | listed in the meta-series are applied to the tree.</para></listitem> | 448 | listed in the meta-series are applied to the tree.</para></listitem> |
449 | 449 | ||
450 | <listitem><para>the git repository is left with the desired branch checked out and any | 450 | <listitem><para>the git repository is left with the desired branch checked out and any |
@@ -470,7 +470,7 @@ history with additional deployment specific patches. Any additions to the | |||
470 | kernel become an integrated part of the branches. | 470 | kernel become an integrated part of the branches. |
471 | </para> | 471 | </para> |
472 | 472 | ||
473 | <note><para>It is key that feature descriptions indicate if any branches are | 473 | <!-- <note><para>It is key that feature descriptions indicate if any branches are |
474 | required, since the build system cannot automatically decide where a | 474 | required, since the build system cannot automatically decide where a |
475 | BSP should branch or if that branch point needs a name with | 475 | BSP should branch or if that branch point needs a name with |
476 | significance. There is a single restriction enforced by the compilation | 476 | significance. There is a single restriction enforced by the compilation |
@@ -482,7 +482,7 @@ kernel become an integrated part of the branches. | |||
482 | its branch from, with the right name, in its .scc files. The scc | 482 | its branch from, with the right name, in its .scc files. The scc |
483 | section describes the available branching commands in more detail. | 483 | section describes the available branching commands in more detail. |
484 | </para> | 484 | </para> |
485 | </note> | 485 | </note> --> |
486 | 486 | ||
487 | <para> | 487 | <para> |
488 | A summary of end user tree construction activities follow: | 488 | A summary of end user tree construction activities follow: |
@@ -532,8 +532,7 @@ relevant values from the board template, and a kernel image is produced. | |||
532 | The other thing that you will first see once you configure a kernel is that | 532 | The other thing that you will first see once you configure a kernel is that |
533 | it will generate a build tree that is separate from your git source tree. | 533 | it will generate a build tree that is separate from your git source tree. |
534 | This build dir will be called "linux-<BSPname>-<kerntype>-build" where | 534 | This build dir will be called "linux-<BSPname>-<kerntype>-build" where |
535 | kerntype is one of standard, cg`` | 535 | kerntype is one of standard kernel types. This functionality is done by making |
536 | e, etc. This functionality is done by making | ||
537 | use of the existing support that is within the kernel.org tree by default. | 536 | use of the existing support that is within the kernel.org tree by default. |
538 | </para> | 537 | </para> |
539 | <para> | 538 | <para> |
@@ -545,7 +544,7 @@ has their own separate build directory. | |||
545 | </para> | 544 | </para> |
546 | </section> | 545 | </section> |
547 | 546 | ||
548 | <section id='scc'> | 547 | <!-- <section id='scc'> |
549 | <title>Series & Configuration Compiler (SCC)</title> | 548 | <title>Series & Configuration Compiler (SCC)</title> |
550 | <para> | 549 | <para> |
551 | In early versions of the product, kernel patches were simply listed in a flat | 550 | In early versions of the product, kernel patches were simply listed in a flat |
@@ -672,9 +671,9 @@ Each feature description can use any of the following valid scc commands: | |||
672 | </itemizedlist> | 671 | </itemizedlist> |
673 | 672 | ||
674 | </para> | 673 | </para> |
675 | </section> | 674 | </section> --> |
676 | 675 | ||
677 | <section id='kgit-tools'> | 676 | <!-- <section id='kgit-tools'> |
678 | <title>kgit Tools</title> | 677 | <title>kgit Tools</title> |
679 | <para> | 678 | <para> |
680 | The kgit tools are responsible for constructing and maintaining the Wind | 679 | The kgit tools are responsible for constructing and maintaining the Wind |
@@ -702,7 +701,7 @@ guilt is not required, but is provided as a convenience. Other utilities such | |||
702 | as quilt, stgit, git or others can also be used to manipulate the git | 701 | as quilt, stgit, git or others can also be used to manipulate the git |
703 | repository. | 702 | repository. |
704 | </para> | 703 | </para> |
705 | </section> | 704 | </section> --> |
706 | 705 | ||
707 | <section id='workflow-examples'> | 706 | <section id='workflow-examples'> |
708 | <title>Workflow Examples</title> | 707 | <title>Workflow Examples</title> |
@@ -724,7 +723,7 @@ This section contains several workflow examples. | |||
724 | A common question when working with a BSP/kernel is: "What changes have been applied to this tree?" | 723 | A common question when working with a BSP/kernel is: "What changes have been applied to this tree?" |
725 | </para> | 724 | </para> |
726 | <para> | 725 | <para> |
727 | In previous Yocto Project releases, there were a collection of directories that | 726 | In some projects, where a collection of directories that |
728 | contained patches to the kernel, those patches could be inspected, grep'd or | 727 | contained patches to the kernel, those patches could be inspected, grep'd or |
729 | otherwise used to get a general feeling for changes. This sort of patch | 728 | otherwise used to get a general feeling for changes. This sort of patch |
730 | inspection is not an efficient way to determine what has been done to the | 729 | inspection is not an efficient way to determine what has been done to the |
@@ -981,10 +980,10 @@ preserved. Note that new commit IDs will be generated upon reapplication, | |||
981 | reflecting that the commit is now applied to an underlying commit with a | 980 | reflecting that the commit is now applied to an underlying commit with a |
982 | different ID. | 981 | different ID. |
983 | </para> | 982 | </para> |
984 | <para> | 983 | <!--<para> |
985 | See the "template patching" example for how to use the patches to | 984 | See the "template patching" example for how to use the patches to |
986 | automatically apply to a new kernel build. | 985 | automatically apply to a new kernel build. |
987 | </para> | 986 | </para> --> |
988 | </section> | 987 | </section> |
989 | 988 | ||
990 | <section id='export-internally-via-git'> | 989 | <section id='export-internally-via-git'> |
@@ -998,7 +997,7 @@ same change can then be pulled into a new kernel build at a later time using thi | |||
998 | </literallayout> | 997 | </literallayout> |
999 | For example: | 998 | For example: |
1000 | <literallayout class='monospaced'> | 999 | <literallayout class='monospaced'> |
1001 | > push ssh://openlinux.windriver.com/pub/git/kernel-2.6.27 common_pc-standard:common_pc-standard | 1000 | > push ssh://git.mycompany.com/pub/git/kernel-2.6.27 common_pc-standard:common_pc-standard |
1002 | </literallayout> | 1001 | </literallayout> |
1003 | A pull request entails using "git request-pull" to compose an email to the | 1002 | A pull request entails using "git request-pull" to compose an email to the |
1004 | maintainer requesting that a branch be pulled into the master repository, see | 1003 | maintainer requesting that a branch be pulled into the master repository, see |
@@ -1136,14 +1135,15 @@ Once development has reached a suitable point in the second development | |||
1136 | environment, changes can either be exported as patches or imported into git | 1135 | environment, changes can either be exported as patches or imported into git |
1137 | directly (if a conversion/import mechanism is available for the SCM). | 1136 | directly (if a conversion/import mechanism is available for the SCM). |
1138 | </para> | 1137 | </para> |
1139 | If changes are exported as patches, they can be placed in a template and | ||
1140 | automatically applied to the kernel during patching. See the template patch | ||
1141 | example for details. | ||
1142 | <para> | 1138 | <para> |
1139 | If changes are exported as patches, they can be placed in a recipe and | ||
1140 | automatically applied to the kernel during patching. | ||
1143 | </para> | 1141 | </para> |
1142 | <!--<para> | ||
1144 | If changes are imported directly into git, they must be propagated to the | 1143 | If changes are imported directly into git, they must be propagated to the |
1145 | wrll-linux-2.6.27/git/default_kernel bare clone of each individual build | 1144 | wrll-linux-2.6.27/git/default_kernel bare clone of each individual build |
1146 | to be present when the kernel is checked out. | 1145 | to be present when the kernel is checked out. |
1146 | </para> | ||
1147 | <para> | 1147 | <para> |
1148 | The following example illustrates one variant of this workflow: | 1148 | The following example illustrates one variant of this workflow: |
1149 | <literallayout class='monospaced'> | 1149 | <literallayout class='monospaced'> |
@@ -1161,11 +1161,11 @@ The following example illustrates one variant of this workflow: | |||
1161 | # will be checked out and built. | 1161 | # will be checked out and built. |
1162 | > make linux | 1162 | > make linux |
1163 | </literallayout> | 1163 | </literallayout> |
1164 | </para> | 1164 | </para> --> |
1165 | </section> | 1165 | </section> |
1166 | </section> | 1166 | </section> |
1167 | 1167 | ||
1168 | <section id='bsp-template-migration-from-2'> | 1168 | <!-- <section id='bsp-template-migration-from-2'> |
1169 | <title>BSP: Template Migration from 2.0</title> | 1169 | <title>BSP: Template Migration from 2.0</title> |
1170 | <para> | 1170 | <para> |
1171 | The move to a git-backed kernel build system in 3.0 introduced a small new | 1171 | The move to a git-backed kernel build system in 3.0 introduced a small new |
@@ -1238,7 +1238,7 @@ That's it. Configure and build. | |||
1238 | if this naming convention isn't followed your feature description will | 1238 | if this naming convention isn't followed your feature description will |
1239 | not be located and a build error thrown. | 1239 | not be located and a build error thrown. |
1240 | </para> | 1240 | </para> |
1241 | </section> | 1241 | </section> --> |
1242 | 1242 | ||
1243 | <section id='bsp-creating-a-new-bsp'> | 1243 | <section id='bsp-creating-a-new-bsp'> |
1244 | <title>BSP: Creating a New BSP</title> | 1244 | <title>BSP: Creating a New BSP</title> |
@@ -1326,7 +1326,7 @@ development. | |||
1326 | </para> | 1326 | </para> |
1327 | </section> | 1327 | </section> |
1328 | 1328 | ||
1329 | <section id='cloning-an-existing-bsp'> | 1329 | <!-- <section id='cloning-an-existing-bsp'> |
1330 | <title>Cloning an Existing BSP</title> | 1330 | <title>Cloning an Existing BSP</title> |
1331 | <para> | 1331 | <para> |
1332 | Cloning an existing BSP from the shipped product is similar to the "from | 1332 | Cloning an existing BSP from the shipped product is similar to the "from |
@@ -1426,9 +1426,9 @@ In this technique the .scc file in the board template is slightly different | |||
1426 | This has the advantage of automatically picking up updates to the BSP | 1426 | This has the advantage of automatically picking up updates to the BSP |
1427 | and not duplicating any patches for a similar board. | 1427 | and not duplicating any patches for a similar board. |
1428 | </para> | 1428 | </para> |
1429 | </section> | 1429 | </section> --> |
1430 | 1430 | ||
1431 | <section id='bsp-bootstrapping'> | 1431 | <!-- <section id='bsp-bootstrapping'> |
1432 | <title>BSP: Bootstrapping</title> | 1432 | <title>BSP: Bootstrapping</title> |
1433 | <para> | 1433 | <para> |
1434 | The previous examples created the board templates and configured a build | 1434 | The previous examples created the board templates and configured a build |
@@ -1518,10 +1518,10 @@ Make changes, import patches, etc. | |||
1518 | the relevant branches and structures and the special build options are no | 1518 | the relevant branches and structures and the special build options are no |
1519 | longer required. | 1519 | longer required. |
1520 | </para> | 1520 | </para> |
1521 | </section> | 1521 | </section> --> |
1522 | </section> | 1522 | </section> |
1523 | 1523 | ||
1524 | <section id='patching'> | 1524 | <!-- <section id='patching'> |
1525 | <title>Patching</title> | 1525 | <title>Patching</title> |
1526 | <para> | 1526 | <para> |
1527 | The most common way to apply patches to the kernel is via a template. | 1527 | The most common way to apply patches to the kernel is via a template. |
@@ -1943,7 +1943,7 @@ This section shows an example of transforms: | |||
1943 | </literallayout> | 1943 | </literallayout> |
1944 | </para> | 1944 | </para> |
1945 | </section> | 1945 | </section> |
1946 | </section> | 1946 | </section> --> |
1947 | 1947 | ||
1948 | <section id='tip-dirty-string'> | 1948 | <section id='tip-dirty-string'> |
1949 | <title>"-dirty" String</title> | 1949 | <title>"-dirty" String</title> |
@@ -1995,7 +1995,7 @@ integrated and validated Yocto Project kernel. | |||
1995 | <para> | 1995 | <para> |
1996 | The next few sections describe the process: | 1996 | The next few sections describe the process: |
1997 | </para> | 1997 | </para> |
1998 | <section id='creating-a-custom-kernel-layer'> | 1998 | <!-- <section id='creating-a-custom-kernel-layer'> |
1999 | <title>Creating a Custom Kernel Layer</title> | 1999 | <title>Creating a Custom Kernel Layer</title> |
2000 | <para> | 2000 | <para> |
2001 | The custom kernel layer must have the following minimum | 2001 | The custom kernel layer must have the following minimum |
@@ -2015,9 +2015,9 @@ The kernel layer can optionally include an override to the base | |||
2015 | Yocto Project Linux BSP to inhibit the application of BSP specific | 2015 | Yocto Project Linux BSP to inhibit the application of BSP specific |
2016 | patches. If a custom BSP is being used, this is not required. | 2016 | patches. If a custom BSP is being used, this is not required. |
2017 | </para> | 2017 | </para> |
2018 | </section> | 2018 | </section> --> |
2019 | 2019 | ||
2020 | <section id='git-repo-of-the-transition-kernel'> | 2020 | <!-- <section id='git-repo-of-the-transition-kernel'> |
2021 | <title>git Repo of the Transition Kernel</title> | 2021 | <title>git Repo of the Transition Kernel</title> |
2022 | <para> | 2022 | <para> |
2023 | The kernel build system requires a base kernel repository to | 2023 | The kernel build system requires a base kernel repository to |
@@ -2055,9 +2055,9 @@ place. Creating this repository is as simple as: | |||
2055 | > git clone ‐‐bare <path to temp_kernel/temp_kernel default_kernel | 2055 | > git clone ‐‐bare <path to temp_kernel/temp_kernel default_kernel |
2056 | </literallayout> | 2056 | </literallayout> |
2057 | </para> | 2057 | </para> |
2058 | </section> | 2058 | </section> --> |
2059 | 2059 | ||
2060 | <section id='building-the-kernel'> | 2060 | <!-- <section id='building-the-kernel'> |
2061 | <title>Building the Kernel</title> | 2061 | <title>Building the Kernel</title> |
2062 | <para> | 2062 | <para> |
2063 | Once these prerequisites have been met, the kernel can be | 2063 | Once these prerequisites have been met, the kernel can be |
@@ -2072,9 +2072,9 @@ indicated in the transition kernel's cache (or templates) applied. | |||
2072 | The kernel build will detect the non-Yocto Project base repo and | 2072 | The kernel build will detect the non-Yocto Project base repo and |
2073 | use the HEAD of the tree for the build. | 2073 | use the HEAD of the tree for the build. |
2074 | </para> | 2074 | </para> |
2075 | </section> | 2075 | </section> --> |
2076 | 2076 | ||
2077 | <section id='example'> | 2077 | <!-- <section id='example'> |
2078 | <title>Example</title> | 2078 | <title>Example</title> |
2079 | <para> | 2079 | <para> |
2080 | This example creates a kernel layer to build the latest | 2080 | This example creates a kernel layer to build the latest |
@@ -2120,7 +2120,7 @@ non fatal warnings will be seen. They can be fixed by populating these | |||
2120 | files in the kernel-cache with valid hardware and non hardware config | 2120 | files in the kernel-cache with valid hardware and non hardware config |
2121 | options. | 2121 | options. |
2122 | </para></note> | 2122 | </para></note> |
2123 | </section> | 2123 | </section> --> |
2124 | </section> | 2124 | </section> |
2125 | </section> | 2125 | </section> |
2126 | 2126 | ||