summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-06-06 13:25:18 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-06-21 12:59:47 +0100
commit7fde327c8560e2af13b9bfe17672c93bddd190c7 (patch)
treee1454d1c11fadf26b7f514d2993dec88d065fa4d
parent3863499572402e4dc1cdf1cd7de25348f5e91154 (diff)
downloadpoky-7fde327c8560e2af13b9bfe17672c93bddd190c7.tar.gz
kernel-dev: Fix the locations of .config and source directory
The locations of the kernel .config file and source direcotry moved a couple releases ago. Updated the documentation accordingly. Also added a note explaining how to check the expansion of variables, which servs a couple of purposes: * For curious readers, shows them how to understand where these variables come from and how they are used. * For suspicious readers, shows them how they can verify that the variables in the documentation are actually correct. Author: Tom Zanussi <tom.zanussi@linux.intel.com> (From yocto-docs rev: af3613b6178122b9e5452529a087143b3fe98495) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml27
1 files changed, 22 insertions, 5 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index ab7f80fbe4..3d874aa92a 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -383,9 +383,10 @@
383 383
384 <para> 384 <para>
385 The resulting <filename>.config</filename> file is 385 The resulting <filename>.config</filename> file is
386 located in 386 located in the build directory,
387 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the 387 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink><filename>}</filename>,
388 <filename>linux-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink><filename>}-${<ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink>}-build</filename> directory. 388 which expands to
389 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename><filename>/linux-</filename><filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink><filename>}-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink><filename>}-build</filename>.
389 You can use the entire <filename>.config</filename> file as the 390 You can use the entire <filename>.config</filename> file as the
390 <filename>defconfig</filename> file as described in the 391 <filename>defconfig</filename> file as described in the
391 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section. 392 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section.
@@ -393,6 +394,16 @@
393 see the 394 see the
394 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" 395 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>"
395 section in the Yocto Project Development Manual. 396 section in the Yocto Project Development Manual.
397 <note>
398 You can determine what a variable expands to by looking
399 at the output of the <filename>bitbake -e</filename>
400 command:
401 <literallayout class='monospaced'>
402 $ bitbake -e virtual/kernel
403 </literallayout>
404 Search the output for the variable in which you are
405 interested to see exactly how it is expanded and used.
406 </note>
396 </para> 407 </para>
397 408
398 <para> 409 <para>
@@ -511,8 +522,14 @@
511 </literallayout> 522 </literallayout>
512 Taking this step ensures you have the sources prepared 523 Taking this step ensures you have the sources prepared
513 and the configuration completed. 524 and the configuration completed.
514 You can find the sources in the 525 You can find the sources in the build directory within the
515 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}/linux</filename> directory. 526 <filename>source/</filename> directory, which is a symlink
527 (i.e. <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink><filename>}/source</filename>).
528 The <filename>source/</filename> directory expands to
529 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename><filename>/linux-</filename><filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink><filename>}-${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></ulink><filename>}-build/source</filename>.
530 The directory pointed to by the
531 <filename>source/</filename> symlink is also known as
532 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></ulink><filename>}</filename>.
516 </para> 533 </para>
517 534
518 <para> 535 <para>