From 347e99427fd2988ee3924b38d385c4403c332ea6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 25 Jan 2013 14:18:23 -0600 Subject: [PATCH] dev-manual: Scrub for correct YP manual cross-references. I went through and got rid of all references to the old YP Kernel Architecture and Use Manual and replaced with appropriate references to the new YP Linux Kernel Development Manual. I also laced in appropriate references into various sections of the new YP Profiling and Tracing Manual. Also, updated the list of resource manuals to reflect the new manual set (addition of kernel-dev and profile-dev and removal of kernel-manual). (From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 17 +++++++++--- documentation/dev-manual/dev-manual-intro.xml | 12 ++++++--- documentation/dev-manual/dev-manual-model.xml | 26 ++++++++++++++----- 3 files changed, 42 insertions(+), 13 deletions(-) diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 6c406dad53..425b05a03b 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1338,9 +1338,9 @@ - For concepts on kernel configuration, see the - "Kernel Configuration" - section in the Yocto Project Kernel Architecture and Use Manual. + For more information on kernel configuration, see the + "Changing the Configuration" + section in the Yocto Project Linux Kernel Development Manual.
@@ -1622,6 +1622,12 @@ in the Yocto Project Quick Start. + + Also, for more information on patching the kernel, see the + "Applying Patches" + section in the Yocto Project Linux Kernel Development Manual. + +
Create a Layer for your Changes @@ -2606,6 +2612,11 @@ the most time in when doing X?" Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling applications on target hardware straightforward. + + For more information on how to set up and run OProfile, see the + "OProfile" + section in the Yocto Project Profiling and Tracing Manual. + diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml index dca24602ed..1086c778bd 100644 --- a/documentation/dev-manual/dev-manual-intro.xml +++ b/documentation/dev-manual/dev-manual-intro.xml @@ -103,9 +103,15 @@ This guide defines the structure for BSP components. Having a commonly understood structure encourages standardization. - Yocto Project Kernel Architecture and Use Manual: - This manual describes the architecture of the Yocto Project kernel and provides - some work flow examples. + Yocto Project Linux Kernel Development Manual: + This manual describes how to work with Linux Yocto kernels as well as providing a bit + of conceptual information on the construction of the Yocto Linux kernel tree. + + + Yocto Project Profiling and Tracing Manual: + This manual presents a set of common and generally useful tracing and + profiling schemes along with their application (as appropriate) to each tool. + Eclipse IDE Yocto Plug-in: A step-by-step instructional video that diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 442cab3036..0694682c90 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -17,6 +17,9 @@ For an example on how to create a 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. + For more complete information on how to work with the kernel, see the + Yocto Project Linux Kernel + Development Manual. User Application Development: User Application Development covers development of applications that you intend @@ -230,13 +233,13 @@ The remainder of this section presents a high-level overview of the Yocto Project kernel architecture and the steps to modify the kernel. - For a complete discussion of the kernel, see the - Yocto Project Kernel Architecture and Use Manual. You can reference the "Patching the Kernel" section for an example that changes the source code of the kernel. For information on how to configure the kernel, see the "Configuring the Kernel" section. + For more information on the kernel and on modifying the kernel, see the + Yocto Project Linux Kernel Development Manual.
@@ -366,9 +369,9 @@ - Again, for a complete discussion of the Yocto Project kernel's architecture and its - branching strategy, see the - Yocto Project Kernel Architecture and Use Manual. + Again, for additional information the Yocto Project kernel's + architecture and its branching strategy, see the + Yocto Project Linux Kernel Development Manual. You can also reference the "Patching the Kernel" section for a detailed example that modifies the kernel. @@ -1272,7 +1275,11 @@ directory. host can use, you must have oprofile version 0.9.4 or greater installed on the host. You can locate both the viewer and server from - . + + You can also find more information on setting up and + using this tool in the + "OProfile" + section of the Yocto Project Profiling and Tracing Manual. The oprofile-server is installed by default on the core-image-sato-sdk image. Lttng2.0 ust trace import: @@ -1331,7 +1338,12 @@ directory. performance counter registers. Selecting either of these tools causes an RSE terminal view to appear from which you can run the tools. - Both tools refresh the entire screen to display results while they run. + Both tools refresh the entire screen to display results while they run. + For more informationi on setting up and using perf, + see the + "perf" + section in the Yocto Project Profiling and Tracing Manual. +