From 926d70f9b90e6624578655a0af35db36203b8bdb Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 1 Jun 2015 08:31:54 -0600
Subject: kernel-dev: Added kernel-devsrc information for building on target

I added a clarifying paragraph at the start of the section that talks
about building on the target hardware.  Included kernel-devsrc and
rationale for why a user would even do this (it is not normal).

(From yocto-docs rev: 5c42f981e9e54ae286b5ea5faf4dd29486c6350c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/kernel-dev/kernel-dev-common.xml | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

(limited to 'documentation/kernel-dev')

diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index e5e26bc513..532e2e87a6 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -735,13 +735,27 @@
         <section id='building-out-of-tree-modules-on-the-target'>
             <title>Building Out-of-Tree Modules on the Target</title>
 
+            <para>
+                While the traditional Yocto Project development model would be
+                to include kernel modules as part of the normal build
+                process, you might find it useful to build modules on the
+                target.
+                This could be the case if your target system is capable
+                and powerful enough to handle the necessary compilation.
+                Before deciding to build on your target, however, you should
+                consider the benefits of using a proper cross-development
+                environment from your build host.
+            </para>
+
             <para>
                 If you want to be able to build out-of-tree modules on
                 the target, there are some steps you need to take
                 on the target that is running your SDK image.
                 Briefly, the <filename>kernel-dev</filename> package
                 is installed by default on all
-                <filename>*.sdk</filename> images.
+                <filename>*.sdk</filename> images and the
+                <filename>kernel-devsrc</filename> package is installed
+                on many of the <filename>*.sdk</filename> images.
                 However, you need to create some scripts prior to
                 attempting to build the out-of-tree modules on the target
                 that is running that image.
@@ -759,7 +773,9 @@
                 Because all SDK image recipes include
                 <filename>dev-pkgs</filename>, the
                 <filename>kernel-dev</filename> packages will be installed
-                as part of the SDK image.
+                as part of the SDK image and the
+                <filename>kernel-devsrc</filename> packages will be installed
+                as part of applicable SDK images.
                 The SDK uses the scripts when building out-of-tree
                 modules.
                 Once you have switched to that directory and created the
-- 
cgit 1.2.3-korg