diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-01-25 14:18:23 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-01-27 13:56:05 +0000 |
commit | 347e99427fd2988ee3924b38d385c4403c332ea6 (patch) | |
tree | 26ed0eb67e4e6ee4b00209ee45e24ef495917f39 /documentation | |
parent | 9713fdcebe41940a0309ad8bfd09d674d200bce3 (diff) | |
download | poky-347e99427fd2988ee3924b38d385c4403c332ea6.tar.gz |
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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 17 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-intro.xml | 12 | ||||
-rw-r--r-- | 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 @@ | |||
1338 | </para> | 1338 | </para> |
1339 | 1339 | ||
1340 | <para> | 1340 | <para> |
1341 | For concepts on kernel configuration, see the | 1341 | For more information on kernel configuration, see the |
1342 | "<ulink url='&YOCTO_DOCS_KERNEL_URL;#kernel-configuration'>Kernel Configuration</ulink>" | 1342 | "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#changing-the-configuration'>Changing the Configuration</ulink>" |
1343 | section in the Yocto Project Kernel Architecture and Use Manual. | 1343 | section in the Yocto Project Linux Kernel Development Manual. |
1344 | </para> | 1344 | </para> |
1345 | 1345 | ||
1346 | <section id='using-menuconfig'> | 1346 | <section id='using-menuconfig'> |
@@ -1622,6 +1622,12 @@ | |||
1622 | in the Yocto Project Quick Start. | 1622 | in the Yocto Project Quick Start. |
1623 | </para> | 1623 | </para> |
1624 | 1624 | ||
1625 | <para> | ||
1626 | Also, for more information on patching the kernel, see the | ||
1627 | "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#applying-patches'>Applying Patches</ulink>" | ||
1628 | section in the Yocto Project Linux Kernel Development Manual. | ||
1629 | </para> | ||
1630 | |||
1625 | <section id='create-a-layer-for-your-changes'> | 1631 | <section id='create-a-layer-for-your-changes'> |
1626 | <title>Create a Layer for your Changes</title> | 1632 | <title>Create a Layer for your Changes</title> |
1627 | 1633 | ||
@@ -2606,6 +2612,11 @@ | |||
2606 | the most time in when doing X?" | 2612 | the most time in when doing X?" |
2607 | Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling | 2613 | Because the OpenEmbedded build system is well integrated with OProfile, it makes profiling |
2608 | applications on target hardware straightforward. | 2614 | applications on target hardware straightforward. |
2615 | <note> | ||
2616 | For more information on how to set up and run OProfile, see the | ||
2617 | "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>" | ||
2618 | section in the Yocto Project Profiling and Tracing Manual. | ||
2619 | </note> | ||
2609 | </para> | 2620 | </para> |
2610 | 2621 | ||
2611 | <para> | 2622 | <para> |
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 @@ | |||
103 | This guide defines the structure for BSP components. | 103 | This guide defines the structure for BSP components. |
104 | Having a commonly understood structure encourages standardization.</para></listitem> | 104 | Having a commonly understood structure encourages standardization.</para></listitem> |
105 | <listitem><para><emphasis> | 105 | <listitem><para><emphasis> |
106 | <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> | 106 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>:</emphasis> |
107 | This manual describes the architecture of the Yocto Project kernel and provides | 107 | This manual describes how to work with Linux Yocto kernels as well as providing a bit |
108 | some work flow examples.</para></listitem> | 108 | of conceptual information on the construction of the Yocto Linux kernel tree. |
109 | </para></listitem> | ||
110 | <listitem><para><emphasis> | ||
111 | <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>:</emphasis> | ||
112 | This manual presents a set of common and generally useful tracing and | ||
113 | profiling schemes along with their application (as appropriate) to each tool. | ||
114 | </para></listitem> | ||
109 | <listitem><para><emphasis> | 115 | <listitem><para><emphasis> |
110 | <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> | 116 | <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> |
111 | Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that | 117 | Eclipse IDE Yocto Plug-in</ulink>:</emphasis> 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 @@ | |||
17 | For an example on how to create a BSP, see the | 17 | For an example on how to create a BSP, see the |
18 | "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" | 18 | "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'>Creating a New BSP Layer Using the yocto-bsp Script</ulink>" |
19 | section in the Yocto Project Board Support Package (BSP) Developer's Guide. | 19 | section in the Yocto Project Board Support Package (BSP) Developer's Guide. |
20 | For more complete information on how to work with the kernel, see the | ||
21 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel | ||
22 | Development Manual</ulink>. | ||
20 | </para></listitem> | 23 | </para></listitem> |
21 | <listitem><para><emphasis>User Application Development:</emphasis> | 24 | <listitem><para><emphasis>User Application Development:</emphasis> |
22 | User Application Development covers development of applications that you intend | 25 | User Application Development covers development of applications that you intend |
@@ -230,13 +233,13 @@ | |||
230 | <para> | 233 | <para> |
231 | The remainder of this section presents a high-level overview of the Yocto Project | 234 | The remainder of this section presents a high-level overview of the Yocto Project |
232 | kernel architecture and the steps to modify the kernel. | 235 | kernel architecture and the steps to modify the kernel. |
233 | For a complete discussion of the kernel, see the | ||
234 | <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>. | ||
235 | You can reference the | 236 | You can reference the |
236 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section | 237 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" section |
237 | for an example that changes the source code of the kernel. | 238 | for an example that changes the source code of the kernel. |
238 | For information on how to configure the kernel, see the | 239 | For information on how to configure the kernel, see the |
239 | "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section. | 240 | "<link linkend='configuring-the-kernel'>Configuring the Kernel</link>" section. |
241 | For more information on the kernel and on modifying the kernel, see the | ||
242 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>. | ||
240 | </para> | 243 | </para> |
241 | 244 | ||
242 | <section id='kernel-overview'> | 245 | <section id='kernel-overview'> |
@@ -366,9 +369,9 @@ | |||
366 | </para> | 369 | </para> |
367 | 370 | ||
368 | <para> | 371 | <para> |
369 | Again, for a complete discussion of the Yocto Project kernel's architecture and its | 372 | Again, for additional information the Yocto Project kernel's |
370 | branching strategy, see the | 373 | architecture and its branching strategy, see the |
371 | <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>. | 374 | <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>. |
372 | You can also reference the | 375 | You can also reference the |
373 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" | 376 | "<link linkend='patching-the-kernel'>Patching the Kernel</link>" |
374 | section for a detailed example that modifies the kernel. | 377 | section for a detailed example that modifies the kernel. |
@@ -1272,7 +1275,11 @@ directory.</para></listitem> | |||
1272 | host can use, you must have <filename>oprofile</filename> version 0.9.4 or | 1275 | host can use, you must have <filename>oprofile</filename> version 0.9.4 or |
1273 | greater installed on the host.</para> | 1276 | greater installed on the host.</para> |
1274 | <para>You can locate both the viewer and server from | 1277 | <para>You can locate both the viewer and server from |
1275 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>. | 1278 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink> |
1279 | You can also find more information on setting up and | ||
1280 | using this tool in the | ||
1281 | "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>" | ||
1282 | section of the Yocto Project Profiling and Tracing Manual. | ||
1276 | <note>The <filename>oprofile-server</filename> is installed by default on | 1283 | <note>The <filename>oprofile-server</filename> is installed by default on |
1277 | the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> | 1284 | the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> |
1278 | <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> | 1285 | <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> |
@@ -1331,7 +1338,12 @@ directory.</para></listitem> | |||
1331 | performance counter registers. | 1338 | performance counter registers. |
1332 | Selecting either of these tools causes an RSE terminal view to appear | 1339 | Selecting either of these tools causes an RSE terminal view to appear |
1333 | from which you can run the tools. | 1340 | from which you can run the tools. |
1334 | Both tools refresh the entire screen to display results while they run.</para></listitem> | 1341 | Both tools refresh the entire screen to display results while they run. |
1342 | For more informationi on setting up and using <filename>perf</filename>, | ||
1343 | see the | ||
1344 | "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>" | ||
1345 | section in the Yocto Project Profiling and Tracing Manual. | ||
1346 | </para></listitem> | ||
1335 | </itemizedlist> | 1347 | </itemizedlist> |
1336 | </para> | 1348 | </para> |
1337 | </section> | 1349 | </section> |