summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-05-12 08:35:41 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-07-28 18:02:29 +0100
commit64d74562a19093ed56b63e8bc89e0b30de9bd311 (patch)
tree35acda612a1783121bf497d3f2786e8ebe228f86 /documentation
parent3d2f2b6bdbde2d872a0e0743607f4b6784a320c0 (diff)
downloadpoky-64d74562a19093ed56b63e8bc89e0b30de9bd311.tar.gz
dev-manual: Updates to kernel configuration in the "Kernel Modification Workflow" section
This section needed some more information. It referenced the yocto-kernel script and menuconfig. I added references to the appropriate areas of YP documentation for these. I also changed wordings to that it is apparent that .config is created by menuconfig when changes are saved. (From yocto-docs rev: bd1a3f6fa0268635f52bc77d9b35b5110b18a9f8) 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-model.xml56
1 files changed, 36 insertions, 20 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index fd0d156494..03eb5f1176 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -491,28 +491,44 @@
491 changing source files. 491 changing source files.
492 However, if you have to do this, you make the changes to the files in the 492 However, if you have to do this, you make the changes to the files in the
493 Build Directory.</para></listitem> 493 Build Directory.</para></listitem>
494 <listitem><para><emphasis>Make kernel configuration changes 494 <listitem><para><emphasis>Make kernel configuration changes if applicable</emphasis>:
495 if applicable</emphasis>: 495 If your situation calls for changing the kernel's
496 If your situation calls for changing the kernel's configuration, you can 496 configuration, you can use
497 use the <filename>yocto-kernel</filename> script or <filename>menuconfig</filename> 497 <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#generating-configuration-files'><filename>menuconfig</filename></ulink>,
498 to enable and disable kernel configurations. 498 which allows you to interactively develop and test the
499 Using the script lets you interactively set up kernel configurations.
500 Using <filename>menuconfig</filename> allows you to interactively develop and test the
501 configuration changes you are making to the kernel. 499 configuration changes you are making to the kernel.
502 When saved, changes using <filename>menuconfig</filename> update the kernel's 500 Saving changes you make with
503 <filename>.config</filename> file. 501 <filename>menuconfig</filename> updates
504 Try to resist the temptation of directly editing the <filename>.config</filename> 502 the kernel's <filename>.config</filename> file.
505 file found in the Build Directory at 503 <note><title>Warning</title>
506 <filename>tmp/sysroots/&lt;machine-name&gt;/kernel</filename>. 504 Try to resist the temptation to directly edit an
507 Doing so, can produce unexpected results when the OpenEmbedded build system 505 existing <filename>.config</filename> file, which is
508 regenerates the configuration file.</para> 506 found in the Build Directory at
509 <para>Once you are satisfied with the configuration changes made using 507 <filename>tmp/sysroots/<replaceable>machine-name</replaceable>/kernel</filename>.
510 <filename>menuconfig</filename>, you can directly compare the 508 Doing so, can produce unexpected results when the
511 <filename>.config</filename> file against a saved original and gather those 509 OpenEmbedded build system regenerates the configuration
512 changes into a config fragment to be referenced from within the kernel's 510 file.
513 <filename>.bbappend</filename> file.</para></listitem> 511 </note>
512 Once you are satisfied with the configuration
513 changes made using <filename>menuconfig</filename>
514 and you have saved them, you can directly compare the
515 resulting <filename>.config</filename> file against an
516 existing original and gather those changes into a
517 <link linkend='creating-config-fragments'>configuration fragment file</link>
518 to be referenced from within the kernel's
519 <filename>.bbappend</filename> file.</para>
520
521 <para>Additionally, if you are working in a BSP layer
522 and need to modify the BSP's kernel's configuration,
523 you can use the
524 <ulink url='&YOCTO_DOCS_BSP_URL;#managing-kernel-patches-and-config-items-with-yocto-kernel'><filename>yocto-kernel</filename></ulink>
525 script as well as <filename>menuconfig</filename>.
526 The <filename>yocto-kernel</filename> script lets
527 you interactively set up kernel configurations.
528 </para></listitem>
514 <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>: 529 <listitem><para><emphasis>Rebuild the kernel image with your changes</emphasis>:
515 Rebuilding the kernel image applies your changes.</para></listitem> 530 Rebuilding the kernel image applies your changes.
531 </para></listitem>
516 </orderedlist> 532 </orderedlist>
517 </para> 533 </para>
518 </section> 534 </section>