A work-in-progress of an example that modifies the kernel
using the devtool. The procedure is not complete yet as it
does not run properly.
(From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
WIP at this point.
(From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual had a place-holder section for getting the
build host ready for using YP and then doing kernel
development. This stuff is better suited for the actual
kernel development manual. I moved the section. Moving
created several broken links in the manual set that had to
be fixed.
In the dev-manual, I updated the introductory list to include
the newly moved kernel stuff.
(From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual. During the move,
renamed the section to "Using devtool to Patch the Kernel".
This move bothered a lot of links so I had to fix them in
various manuals.
(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section failed to mention the "yocto-layer create" script,
which is a simple way to create a layer. I have added this info
into the section by way of a "Tip" box.
(From yocto-docs rev: cf204f2b72b1da0104315f54cfe55c3f1eaf0f96)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual
to the ref-manual broke the links to the "Metadata" term.
I fixed these.
(From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual. Doing so caused all the links to the id
"bitbake-term" to break. These had to be individually fixed.
Discovered two unresolved references that were a consequence of
moving that section to the ref-manual. These were fixed as well.
(From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10946]
There was insufficient information in the combination of the
BSP Guide and the Kernel Development Manual on just how to locate
and use kernel metadata.
* bsp-guide - Removed the detailed append file example for the
kernel recipe. This is moved now to the chapter in the kernel
manual that describes append files.
* kernel-dev - Placed the example from the BSP Guide into the
section that describes kernel append files. Cleaned up some
terminology issues throughout chapter 3. Added information
about how BitBake picks up kernel metadata when the metadata
is in a hierarchical directory and not just a simple *.scc
file.
(From yocto-docs rev: 1048acb7127e77ca9c1f524a208fe25344fcb57c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Fixes [YOCTO #4047]
I went through and fixed a few areas where reviewers said there
was "quirky" phrasing. They might have been right in a few
places.
(From yocto-docs rev: 66fb97838f338ed3f787ec18f62702ef726ceffc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4047]
I added a new section describing how to add kernel features
from within a kernel recipe through the KERNEL_FEATURES
variable and the SRC_URI statement.
(From yocto-docs rev: d30925c65e3f49b2ba481f1e7f9cac98fe86f6af)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Better placement of this link. It did not need to be in the
<literallayout> example.
(From yocto-docs rev: 53c33ea4cc929e016812f0d3aac0d302758dc0f8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7474]
There was not a strong tie between .config file discussions
for the kernel between corresponding menuconfig sections in
the kernel-dev and dev-manual manuals. I added a cross-
reference link in the kernel-dev manual to help tie this
information together.
(From yocto-docs rev: bbeb7b0f48be6c2bdb6c6031ce0476d6d2081f94)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added some detail about what really happens when you use the
'make defconfig' command when working with your own sources.
Fixes [YOCTO #6611]
(From yocto-docs rev: 653c7726e024dcaa908127f0df1d1856f26f4ff0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Fixes [YOCTO #6611]
Added a new step to the "Working With Your Own Sources" section
so that the user is aware of needing to provide a defconfig file
or configuration fragments to the SRC_URI variable when working
with the yocto-linux-custom.bb recipe.
(From yocto-docs rev: dd25274979f689ae9135158279080add19a98393)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the new section "Using an "In-Tree" defconfig File"
section. This section addresses the ability to not use the
default location for defconfig files, which is usually in the
metadata layer. The section describes how to use the
KBUILD_DEFCONFIG variable.
Fixes [YOCTO #7474]
(From yocto-docs rev: d68f7b47d974d94177b344247056778742f57786)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7474]
The "Generating Configuration Files" section has a procedure that
starts with a step to complete a build at least through the
kernel configuration task. This is needed but we could use a
bit of explanation here. I added some rationale behind why you
should do this.
(From yocto-docs rev: 63df3474f4ed211dd6b7d1cf4f4e90bbc92c2595)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Tweak the manual to refer to the name of the kernel build directory as
it is listed precisely in linux-yocto.inc.
(From yocto-docs rev: f8c762e42a67bd84b733a5ae2512581af805a76b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Substituted a more correct build directory path in the
example by providing
"${WORKDIR}/linux-${PACKAGE_ARCH}-${LINUX_KERNEL_TYPE}-build"
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 818493d7ee5fc6c1750f20e5cea22a3816c8675c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This kernel is not supported and is ancient. Many of the examples
were referencing this kernel. I switched to use the 3.19 version.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ba04c4f11a02b4562994d5d79838cd2cf90efc7e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some small changes to clarify how to change the configuration.
(From yocto-docs rev: fce7c97abb69f15142dbadf90a90965a49ec3e0e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 198ce97a1158237056f035ade555ce04a6031c56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 4d85a363602eeb8c5f52064af9ffa1a47e541470)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the manual I was using angled brackets to denote user-supplied
input values. This was confusing so I changed to using the
<replaceable></replaceable> tag pair.
(From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3729]
I made an editing pass through this section. Found some minor
corrections.
(From yocto-docs rev: 314ec3a066de7328b6c6893ce33cc0e5faa8700a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks. Found and added several occurrences.
(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistency on how we refer to a task name throughout
the YP manual set. The proper way is "do_<taskname>". Some
occurrences did not include the "do_" prefix. These have been
fixed.
(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3729]
I have made an attempt at understanding this and creating
a section that describes the steps the user needs to take in
order to build out-of-tree modules on the target device when
running an SDK image. I created a new section called
"Building Out-of-Tree Modules on the Target". Basically,
the user needs to be on the target and change to a directory
and then create some scripts before attempting to build these
types of modules on the target.
(From yocto-docs rev: e0754ae6dbc5dc07fb6707fe4b71ecd95c8180dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was an occurrence of the do_compile task mentioned in the
manual. I have added a cross-reference link from it to the new
section in the ref-manual.
(From yocto-docs rev: 0981ca8ca9856063d4daeaae155aabdfd1c7dcc8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made sure that the first occurrence of each "BitBake" term linked
into the "BitBake" term as defined in the dev-manual.
(From yocto-docs rev: 83e6e43d13cf5447b8ef65836d532abbb1f8b15e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Add a new step about how to use diffconfig task to create
kernel config fragments.
Scott fixed some grammar in one of the sentences after applying the
patch.
(From yocto-docs rev: 5b7ccdbf708cbeebc2d8dc91db129fb35aabdcdd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
FILESEXTRAPATHS_prepend example is missing essential trailing
colon.
(From yocto-docs rev: 6287fee9fba7173cdd22fc9bbd4378367c75627f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is now a glossary description for the THISDIR variable
in ref-manual. I added some cross-reference links to the
variable in key places of these two manuals.
(From yocto-docs rev: 0d0f756c142c506a66ebc6a1a33e9f124dafd333)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pointed out by Robert P. J. Day that I was using the wrong
FILESEXTRAPATHS example for an append file. I failed to include
the "_prepend" part of the variable. Also, the wording based
on the example made some assumptions and was not entirely
accurate. The changes I put in made the section very specific.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 659c5a9c41a92f469ea0ea3630e11b4ba2df8f56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert P. J. Day pointed out some implied meanings in this section
that indicate configurations from .config are exclusive somehow
from configurations applied through config fragments. That is
not the case. I have inserted a note to clear up that implied
meaning.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5ac27e8a2aea662a8e70dda0e852b5ea401b8b00)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section had some problems. It failed to mention the
need to extend FILESPATH by using FILESEXTRAPATHS.
(From yocto-docs rev: e627cf21242a62fb23e93fdae61e8cfce32082a9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Further down in the section, a second occurrence of ${FILES}
needed changed.
(From yocto-docs rev: 0212a1ebfef4c5a6a0ae76410f7753bbc41d3e82)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was inaccurately referencing the ${FILES} directory when
it should be talking about a "files" directory created in the
user's layer where the kernel .bbappend file resides.
(From yocto-docs rev: 2af3a71db6e6d99b9aa4b710e21f3f3bacff0b82)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-worded the title for "Set Up Your Layer for the Build."
This resulted in a lone link from the kernel-dev manual changing.
(From yocto-docs rev: bf797a9ad4b40ded6bd3b4dc8cc3d8ac702f05a6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The user needs to have YP 1.2.2 release or forward for the
examples in the book to work. I have added a note indicating
such.
(From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "-dirty" String section from the old YP Kernel Architecture
and Use Manual was moved to section 2.3 of the manual. It needs
to find the right area to be put in (AR for Darren). I added the
AR text to the top of the section so it would not fall through
the cracks.
(From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
