Commit Graph

4479 Commits

Author SHA1 Message Date
Scott Rifenbark
59c64247f7 yocto-project-qs: Updated the "Next Steps" section
Provided better roadmapping into the kernel development manual and
more explanation of the dev-manual.

(From yocto-docs rev: 811e6ee07ee5e84400b90c18b251d8053000f859)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
07ec3f2f86 dev-manual: Added wic ls, rm, and cp example
Fixes [YOCTO #12191]

Put in a new example in the Wic section to highlight the use of the
'wic ls', 'wic rm', and 'wic cp' commands.

(From yocto-docs rev: 2bf316961d22d5dc2df2d849c50ec347d5f9db51)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
4320b808c2 ref-manual, dev-manual: Updated "Creating Partitioned Images" section title.
Added "Using Wic" to the section head because that is all we
talk about.  This affect three links in the ref-manual so I
fixed those as well.

(From yocto-docs rev: 0e4f245f2b872810e2e164a227900ca6aa313ab8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
cbe8009a17 dev-manual, ref-manual: Moved kickstart reference to ref-manual
This section was misplaced in the dev-manual and really needed to
be in the ref-manual.  I created a new chapter that follows the
devtool reference chapter and put the kickstart chapter there.

Links were needed to be fixed up and a new chapter in the
ref-manual named ref-kickstart.xml had to be created.

(From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6077ebbe80 ref-manual, dev-manual: Moved plug-in section for wic to ref-manual
Fixed links affected by the move.

(From yocto-docs rev: 250d312274788b0eebf3ae9143f2f89eafd4ab90)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
Scott Rifenbark
6cee5c8b9b ref-manual: Updated a cross-link to the creating partitioned images section
This link is going to a link that disappearing.  So had to re-route
it to a different spot.

(From yocto-docs rev: 8b2a3eafa10b1f6fdf034e6e13d0277c9a556170)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16 23:46:52 +01:00
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
0b75283fa9 ref-manual: Updated the FILESEXTRAPATHS variable
Added an example to show machine overrides.

(From yocto-docs rev: d0c54caf2a2a6ccb9a6fb38b77c9827b66b9ff10)

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
7cf82df8b0 dev-manual: Updated the plug-ins section.
(From yocto-docs rev: d1a4ff5ee177c7b9442d805b6e20a8ba8410d91d)

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
e746cc1c65 dev-manual: Updated Wic Kicstart examples.
(From yocto-docs rev: b5393e416c779aa9d4f5116cdea8d5fd09c21bd1)

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
3823b6edd3 ref-manual: Fixed typo
(From yocto-docs rev: eb16cc85e9a14e82d5416f6a4a3ebc9eff7c3057)

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
b8d329644f ref-manual: Fixed redundancy in MACHINE list for runqemu command
In the "runqemu Command-Line Options" section there is a bulleted
list showing options you can provide.  The "MACHINE" option lists
valid values and listed "qemux86" twice in the list.  I removed
one of them.

(From yocto-docs rev: 7831b60391544e9fca94b1fe299ec4cb57992222)

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
59ddd7c386 ref-manual: Added Debian GNU/Linux 9 (Stretch) to supported distros.
(From yocto-docs rev: f759827b163a844b4f9eb31b2a4ecea56d2aa004)

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
b402b283c8 dev-manual: Fixed broken link to "Images" section in ref manual.
(From yocto-docs rev: b5bc0f8d4be9746281d81555d7c90f66be285fe0)

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
50c8c730ad ref-manual: Updated Metadata term in Terms section
Provided a description for metadata in the context of the kernel
that ties it to the yocto-kernel-cache Git repository rather
than the old meta-* directories that were in the actual
kernel trees.

(From yocto-docs rev: 7105459bf687cad7d973d8bdffbc51c9ffcd9721)

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
f83991dc04 ref-manual: Updated KERNEL_FEATURES variable description
Added a more relevant example from the 4.12 Yocto Linux kernel
recipe.

(From yocto-docs rev: 98c40729b2b22a2ac8444d899848c05880cb920b)

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
94e71dea32 ref-manual: Updated KBRANCH variable description
The description had gone stale and was referencing a linux
yocto kernel we don't support and BSPs we don't support.  Updated
it.

(From yocto-docs rev: 5041a2a26d703a885437abcedb24c7600d5365cd)

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
Kristi Rifenbark
ab9f5a5300 ref-manual: Updated Added a New Recipe to Workspace Layer section
Fixes [YOCTO #11392]

Updated the section to document how to specify a branch,
tag, or revision when using devtool add with a remote
URL.

(From yocto-docs rev: 903b4a4e72908572a5f8b8c822869bbd0fe76ec9)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Kristi Rifenbark
3cc1668534 ref-manual: Updated devtool --help output
Fixes [YOCTO #11392]

(From yocto-docs rev: 30eb6ef13b85f7f5e1784dbdd6a54b1367be212d)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-06 12:06:32 +01:00
Kristi Rifenbark
adcb7b7e73 ref-manual: Added NOAUTOPACKAGEDEBUG to variable glossary
Fixes [YOCTO #11800]

(From yocto-docs rev: 789a11aee778f6082134102659b317bc6c155b4c)

Signed-off-by: Kristi Rifenbark <kristi.rifenbark@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
3ad1f402d9 ref-manual: Updated kernel example version in PREFERRED_VERSION.
(From yocto-docs rev: bc6960c01cffdc2cef7c9288db9daeed2c3e1a25)

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
0e7af54763 dev-manual: Updated compatible log program section.
Script name changed to "yocto-check-layer".

(From yocto-docs rev: 545a90dd2816c4e97dc70efc76c7cca49684c2d8)

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