summaryrefslogtreecommitdiffstats
path: root/documentation/kernel-dev
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-01-12 03:47:30 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:20 (GMT)
commitac5cee5ea11c348f80a4713d90bc93244bb9da28 (patch)
tree9f6c04d3f66de945cd061c5bb196756655e46c33 /documentation/kernel-dev
parentfcfa410e43820778f235c66340aa1850ffaadd2c (diff)
downloadpoky-ac5cee5ea11c348f80a4713d90bc93244bb9da28.tar.gz
kernel-dev: transitory edits.
(From yocto-docs rev: 89e6335e0e9d23a6df581ccd5f55c2a7673050cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/kernel-dev')
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml72
1 files changed, 3 insertions, 69 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 1b19c08..3645a5a 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -437,7 +437,7 @@
437 still make use of the Yocto Project Linux kernel tooling by 437 still make use of the Yocto Project Linux kernel tooling by
438 working with your own sources. 438 working with your own sources.
439 When you use your own sources, you will not be able to 439 When you use your own sources, you will not be able to
440 leverage the existing 440 leverage the existing kernel
441 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> and 441 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> and
442 stabilization work of the linux-yocto sources. 442 stabilization work of the linux-yocto sources.
443 However, you will be able to manage your own Metadata in the same 443 However, you will be able to manage your own Metadata in the same
@@ -448,7 +448,8 @@
448 448
449 <para> 449 <para>
450 To help you use your own sources, the Yocto Project provides a 450 To help you use your own sources, the Yocto Project provides a
451 linux-yocto custom recipe that uses 451 linux-yocto custom recipe
452 <filename>linux-yocto-custom.bb</filename> that uses
452 <filename>kernel.org</filename> sources 453 <filename>kernel.org</filename> sources
453 and the Yocto Project Linux kernel tools for managing Metadata. 454 and the Yocto Project Linux kernel tools for managing Metadata.
454 You can find this recipe in the 455 You can find this recipe in the
@@ -539,73 +540,6 @@
539 </para></listitem> 540 </para></listitem>
540 </orderedlist> 541 </orderedlist>
541 </para> 542 </para>
542
543 <para>
544 Original Text:
545 <literallayout class='monospaced'>
546If you find yourself unable to work with one of the Linux kernel versions
547supported by existing linux-yocto recipes, you can still make use of the Yocto
548Project Linux kernel tooling while working with your own sources. You will not
549be able to leverage the existing meta-data and stabilization work of the
550linux-yocto sources, but you will be able to manage your own meta-data in the
551same format as the linux-yocto sources which will facilitate converging with
552linux-yocto on a future mutually-supported kernel version.
553
554The linux-yocto-custom recipe, located in the poky repository at:
555
556 meta-skeleton/recipes-kernel/linux/linux-yocto-custom.bb
557
558is provided as an example recipe which uses kernel.org sources and the Yocto
559Project Linux kernel tools for managing meta-data. To get started, copy this
560recipe to your layer and provide it with a meaningful name, such as
561linux-yocto-myproject_3.5.bb, where 3.5 is the base version of the Linux kernel
562you will be working with. In the same directory, create a matching directory,
563e.g. linux-yocto-myproject to store your patches and configuration files.
564
565Edit the following variables in the recipe as appropriate for your project:
566
567 o SRC_URI
568 o LINUX_VERSION
569 o LINUX_VERSION_EXTENSION
570 o SRCREV
571 o PR
572 o PV
573 o COMPATIBLE_MACHINE
574
575The SRC_URI should be a git repository, using one of the supported git fetcher
576protocols (file, git, http, etc.). The skeleton recipe provides an example
577SRC_URI as a syntax reference.
578
579Set LINUX_VERSION to the Linux kernel version you are using, such as "3.6.3".
580
581LINUX_VERSION_EXTENSION is used to define the Linux kernel CONFIG_LOCALVERSION
582which will be compiled in to the resulting kernel and visible via the uname
583command.
584
585Set SRCREV to the commit ID you wish to build from.
586
587Treat the PR as you would the PR of any other recipe. Increment it to indicate
588to the build system that the recipe has changed.
589
590The default PV assignment is typically adequate. It combines the LINUX_VERSION
591with the SCM revision (from the SRCPV variable) and results in a string
592something like:
593
594"3.4.11+git1+68a635bf8dfb64b02263c1ac80c948647cc76d5f_1+218bd8d2022b9852c60d32f0d770931e3cf343e2"
595
596While lengthy, this extra verbosity helps ensure you are building from the exact
597sources you intend.
598
599Finally, the default COMPATIBLE_MACHINE assignment for linux-yocto-custom is set
600to a regular expression matching only the empty string, "(^$)". This will
601trigger an explicit build failure. You must change it to match a list of the
602machines supported by your new recipe, such as "(qemux86|qemux86-64)"
603
604With that in place, you can continue to customize this recipe as you would the
605existing linux-yocto recipes. See Section 2.2 Modifying an Existing Recipe for
606details.
607 </literallayout>
608 </para>
609 </section> 543 </section>
610 544
611 <section id='incorporating-out-of-tree-modules'> 545 <section id='incorporating-out-of-tree-modules'>