Commit Graph

255 Commits

Author SHA1 Message Date
Scott Rifenbark
4c0e713b81 kernel-dev: Applied review feedback
Various edits for review feedback on the manual in general.

(From yocto-docs rev: 218061535b5bed326331d00eee6f514c81299238)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:51 +01:00
Scott Rifenbark
e99b83f4b0 Documenation: Updated "Usually October" to "October 2017" string
The string in the manual revision table needed updated across the
set except for the kernel-dev manual.

(From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
65013d1579 kernel-dev: Updated Title Page.
Using Scotty's Documentation Services, INC. and Scott Rifenbark
as the author.  Added a note in the note box to send an email to
the yocto@yoctoproject.org discussion group or log into the freenode

(From yocto-docs rev: 657ef0a09a72c023dd2ab523ff3c7ad1e7a2efea)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
ba33c69b24 kernel-dev: Updated Tree Construction section with review feedback.
(From yocto-docs rev: c28b349a972d81d3b60bf1b0de48d837fbc76cdb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
6ca1a37dfb kernel-dev: Added KMACHINE and MACHINE descriptions for using metadata
Needed to remove an old example that was showing how two BSPs could
share the same KMACHINE value.  I replaced it with corei7-based
machines.  Also noted that KMACHINE is for kernel mapping only
whereas MACHINE is for the layer's BSP machine type.

(From yocto-docs rev: c1dad2815b6fd1ed78e0dce0fecb422f342eaf14)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
39c520e77b kernel-dev: Removed note about KTYPE being optional in future.
(From yocto-docs rev: 2ecf347fe5b9f60d29a5624bab2f57a7278fa9ab)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
540324a82f kernel-dev: Updated what the manual covers to include appendices
(From yocto-docs rev: 1782241165aa09ab3d3ecf66a91a355555f5f42b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
453a619dc6 kernel-dev: Updated lists for formatting consistency
(From yocto-docs rev: 7fe10c067219eccdbfd8d99223cdb38b84d7d2a5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
d7ad579ce5 kernel-dev: Updates to "Working With Your Own Sources"
Formatting changes for the list.

(From yocto-docs rev: df1201085408eec45d8fbf649e80437299daa0e8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
cb9150394d kernel-dev: Edits to "Build Strategy" section.
This section was written before the yocto-kernel-cache strategy
existed and was thus incorrect.  I updated it with how I understand
things to work.

(From yocto-docs rev: 629f24c9312a168ddcd28b0d9dde92ff06068483)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
766770aa35 kernel-dev: Updated Tree Construction section
The section was using the "meta-*" stuff, which is not how it
is done any longer.

(From yocto-docs rev: c9d95e85a832a38c3fd099a728693af3fa708d50)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:34 +01:00
Scott Rifenbark
398a00a74c kernel-dev: Minor updates to the "Kernel Maintenance" appendix.
(From yocto-docs rev: eabeff4611d447be12af64f0f44c218c69da3409)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
214c692889 kernel-dev: Minor edits to the "Advanced Kernel Concepts" appendix
(From yocto-docs rev: 645b642965ffcbb12f171e11a53b4efe5d0fd756)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
732f317002 kernel-dev: Changed title for advanced metadata chapter
Introduced the "yocto-kernel-cache" term into the title.

(From yocto-docs rev: ca74c49e2809851bb22bbe0d68830127d7bba4e9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
42303c0d9f kernel-dev: Miscellaneous Edits to Advanced Metadata chapter
(From yocto-docs rev: 74e27b697efa7ea7ecc1d1d59266b537dd70ae98)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
dc2f2ae714 kernel-dev: Updated example in metadata outside recipe-space
Went from 4.4 kernel to 4.12.

(From yocto-docs rev: 4cf2710a381925b8bf13536c1f8da3d12938fffe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
99151aef77 kernel-dev: Updates to "Using Kernel Metadata in a Recipe"
This section had some old emenlo examples and was a little
confusing.  I removed the old examples and inserted some new
wordings to help smooth it out.

(From yocto-docs rev: 365129e0cd37772f404d96a51eb498210e4f1ee9)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
bace1910d9 kernel-dev: Additions to the "Overview" section.
I provided some background on two repositories: yocto-kernel-cache
and yocto-kernel-tools.

(From yocto-docs rev: 1741d6efd4ff8364a55d546897cab5e7cdee6da5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
429719213d kernel-dev: Updates to "Kernel Metadata Syntax" section
Scrubbed this section to bring it up to speed with more modern
BSP examples and better explanation of the types of Metadata
used.

(From yocto-docs rev: ba009de68a3786f83d9c3c9debffa8b811479786)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
8dc04d54e0 kernel-dev: Updates to where kernel metadata is found
"cfg" and "features" used to reside in the linux-yocto-x.x repo
under meta.  They are now in a separate repo named
yocto-kernel-cache.  I rewrote a couple spots that incorrectly
referenced the old location.

(From yocto-docs rev: e643fc3df46658b8bcf9cdc12a78b527988b63a6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
946fac468e kernel-dev: Edits to the iteratively modifying source code section
This section has merged into a single topic now.  It still needs
work but it is gathered under one heading for now.

(From yocto-docs rev: 660ed8b64dedbab5400c84ec3759cea77c899c40)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
721991dd4f kernel-dev: Removed a comment block
(From yocto-docs rev: d6cf2730a9acc9c5bfd3071794269b4e3e7273b6)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
fae276ea09 kernel-dev: Eliminated "Generating Configuration Files" section.
This section was largely redundant now.  The small things that did
add value I placed in other areas of the chapter 2.  One was a new
section on expanding variables using bitbake -e.  Another was a bit
about the defconfig file.  And a small procedure on how to create
config fragments using the "diffconfig" command was retained.

Links from the dev-manual and the ref-manual were adjusted as well.

(From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
2e21a56a8a kernel-dev: Added "Validating Configuration" section
Provided a new section on how to validate the configuration of the
kernel.

(From yocto-docs rev: 25f43d1baeff7d571fc60c7edca957d4ce6d6357)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
77a52d0b10 kernel-dev: Edits to "Fine-Tuning the Kernel Configuration File"
This section needed some formatting to conform to the list structure
used throughout the manual.

(From yocto-docs rev: b6e6b66014963c1628c50e09787fdd46a45867b1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
025cbf0168 kernel-dev: Moved "dirty" kernel procedure up a level
This procedure needed to be pulled out of the section that was/is
called "Using an Iterative Development Process".  The section on
how to deal with "dirty" kernel version strings is a procedure
in its own right.  It is now up a level.

(From yocto-docs rev: cd8834fa8d77ac750b06c3367aee577c80dcc64e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:33 +01:00
Scott Rifenbark
d48af3ed21 kernel-dev: Removed "kernel-dev-examples.xml" file.
File not used.

(From yocto-docs rev: 208bc193b02f4644e12c7d143d20ddafc5169907)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Scott Rifenbark
b55b22b4bf kernel-dev: removed old "kernel-dev-examples.xml" chapter.
This chapter is not used and was commented out.  I deleted the
comment block.

(From yocto-docs rev: c805d1034b9f9bed5990cd2bcb3a9088e3d0d542)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Scott Rifenbark
b8dfb03764 kernel-dev: Updated kernel configuration section
A lot of rewriting here in this section to get it up to speed.
Also, moved that final section on determining hardware and
non-hardware features into an appendix where it belonged.

(From yocto-docs rev: 752e80d6ae8f81a0de7743b11b010d0ef36b314b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Scott Rifenbark
c801d0425d kernel-dev: Updated "in-tree" defconfig example.
Section "Using an 'In-Tree' defconfig File" updated to use a
more syntactically correct KBUILD_DEFCONFIG_KMACHINE example.

(From yocto-docs rev: 64e6b16703fa3ce9ac8db25de8089d32ac7aeafc)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
de671802c8 dev-manual: Compatibility program and moving kernel configuration
Should have been two commits but I forgot to do them separately.

1. I updated the YP Compatible Program section.

2. I moved the "Configuring the Kernel" section from the dev-manual
   to the kernel-dev manual.

(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26 11:18:59 +01:00
Scott Rifenbark
8f7df8648a kernel-dev: Edits to the devtool kernel development method.
Changes based on a run through of the procedure.

(From yocto-docs rev: 0a526bb15f597843d1e5da1eeca0a952c6c5016f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
b103ff6ba7 documentation: Purged "oe-init-build-env-memres" from docs
Fixes [YOCTO #11968]

Purged all occurrences of the "oe-init-build-env-memres" script
from the YP documentation set.  Occurrences in a lot of places.
The BBSERVER variable was also impacted and had to have the
definition updated.

(From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
2efe56a06f kernel-dev: Added note about running a clean build with a patch
Put this note at the end of the traditional kernel development
flow.  A way for the user to verify that the patch was applied
for a subsequent build.

(From yocto-docs rev: 598a518cd92980e1781649a3ed30ac585327dc0f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
294dddb6d3 kernel-dev: Updates to the traditional kernel development flow section.
(From yocto-docs rev: d81143d6ae27e2e360f923bde8e578e583a969a1)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
0767740f32 kernel-dev: Updates to creating a layer section.
(From yocto-docs rev: a57ba3f227831225a544df1ab774422364b91d6f)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
0d70911d4e kernel-dev: Updates to layer creation steps for kernel examples.
(From yocto-docs rev: 8044f6e255905f3e4798d20e6e89aaa93d2892fb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
379713e97b kernel-dev: Added some cross-references to layer creation.
(From yocto-docs rev: 67658657d10ae1e243a27ff8b3df60f31ccd9740)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
46d9bd0076 kernel-dev: Updated 4.4 to 4.12 for kernel example in layer
(From yocto-docs rev: ba8dd3676e3800b8356b7de948ceeb6e4cba4bbf)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22 17:53:44 +01:00
Scott Rifenbark
082dcd0163 kernel-dev: Updates to the kernel flow procedures
(From yocto-docs rev: b8baf67ece6e80884fa198ddd51715c329822f28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
b64872f9ab kernel-dev, mega-manual: kernel dev flow fig update and chapter revs
Updated the kernel development flow diagram to have an arrow from
the repositories to the box that says you need to clone the
kernel repository.  Also, provided some wording changes in the
end of the chapter.

(From yocto-docs rev: c77cff4f7b0795d5429dc47c2ad63aec6d19d513)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
0b929b558b kernel-dev: Updated list of kernel repositories to have 4.12 and cache
I added the linux-yocto-4.12 kernel repository and the linux-yocto-cache
repository to the list of Yocto Linux Kernel repositories in the
Source Repositories.

(From yocto-docs rev: 88fedda0fa4a4dfc468f0dc404fa9f04390cbed7)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
f2d4f77afb kernel-dev: Updates to the kernel patch examples.
Switching to kernel version 4.12.  Pulled some old commented
stuff out.

(From yocto-docs rev: c0a5c886256d3477ddaf670df4939bec1c73152e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:19 +01:00
Scott Rifenbark
ccbfdd795e kernel-dev: Added the host prep for kernel dev to the chapter.
(From yocto-docs rev: 7343f1108808bb3be182af58325f9e3195ff4d8e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Scott Rifenbark
d4be6ea72a kernel-dev: Updates to the intro chapter
I moved the flow diagram up higher and completely removed
the procedures to get the build host ready for kernel
development.  Those are now in the common tasks chapter.

Lots of rewriting

Signen-off-by: Scott Rifenbark <srifenbark@gmail.com>

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Scott Rifenbark
2bfabb5539 kernel-dev: Updated the kernel flow diagram
Had to account for devtool and traditional kernel methods
now.

(From yocto-docs rev: 74580d9a61fa012406059ba2a3348d38fdc24d4c)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13 18:00:18 +01:00
Scott Rifenbark
ee5bce2d11 kernel-dev: Removed bad reference for creating patches.
We do not want to mix traditional kernel development with
kernel development using devtool.  This reference implied that
was okay to do.

(From yocto-docs rev: 38c3a5d3b47e15880ca10ed30ae4a450ecc851cd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
bfe0fba09c kernel-dev: Added output to kernel clone example.
(From yocto-docs rev: d5880262ab74499fbeef620af7907ee6e5d328fd)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
cce4bf737e kernel-dev: Removed bare clone stuff for trad. kernel dev.
Bare clone setup is no longer recommended or necessary for
traditional kernel development.  All that is required is to
clone the kernel Git repo locally.

(From yocto-docs rev: cbe6d79da4fc2d5bba530b0fe6abead7783bdfbe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00
Scott Rifenbark
59764811d0 kernel-dev: Some cleanup of the output for the kernel flow ex.
(From yocto-docs rev: 30bbe308339ad0665d59d8238e9420d1d594332e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02 00:52:49 +01:00