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-06 22:53:35 +0100
commit9c75c64cb99a3d5103b7bb4e2a700e5bb5af516b (patch)
treeeb732c97330d67ec39dbe66f9b4dc7a2a31abc95
parent25d8fac2d30f658d56ee2d27e299a560b6731299 (diff)
downloadpoky-9c75c64cb99a3d5103b7bb4e2a700e5bb5af516b.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: a4f92870e70cb625f2987a59aff3f460457b4889) 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 261471c46b..a9aafd3c21 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -384,9 +384,10 @@
384 384
385 <para> 385 <para>
386 The resulting <filename>.config</filename> file is 386 The resulting <filename>.config</filename> file is
387 located in 387 located in the build directory,
388 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}</filename> under the 388 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink><filename>}</filename>,
389 <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. 389 which expands to
390 <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>.
390 You can use the entire <filename>.config</filename> file as the 391 You can use the entire <filename>.config</filename> file as the
391 <filename>defconfig</filename> file as described in the 392 <filename>defconfig</filename> file as described in the
392 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section. 393 "<link linkend='changing-the-configuration'>Changing the Configuration</link>" section.
@@ -394,6 +395,16 @@
394 see the 395 see the
395 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" 396 "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>"
396 section in the Yocto Project Development Manual. 397 section in the Yocto Project Development Manual.
398 <note>
399 You can determine what a variable expands to by looking
400 at the output of the <filename>bitbake -e</filename>
401 command:
402 <literallayout class='monospaced'>
403 $ bitbake -e virtual/kernel
404 </literallayout>
405 Search the output for the variable in which you are
406 interested to see exactly how it is expanded and used.
407 </note>
397 </para> 408 </para>
398 409
399 <para> 410 <para>
@@ -512,8 +523,14 @@
512 </literallayout> 523 </literallayout>
513 Taking this step ensures you have the sources prepared 524 Taking this step ensures you have the sources prepared
514 and the configuration completed. 525 and the configuration completed.
515 You can find the sources in the 526 You can find the sources in the build directory within the
516 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}/linux</filename> directory. 527 <filename>source/</filename> directory, which is a symlink
528 (i.e. <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-B'><filename>B</filename></ulink><filename>}/source</filename>).
529 The <filename>source/</filename> directory expands to
530 <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>.
531 The directory pointed to by the
532 <filename>source/</filename> symlink is also known as
533 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></ulink><filename>}</filename>.
517 </para> 534 </para>
518 535
519 <para> 536 <para>