Commit Graph

57 Commits

Author SHA1 Message Date
Scott Rifenbark d7c5376946 kernel-dev: Provided better wording for recipe-space metadata section
Fixes [YOCTO #10946]

Based on feedback, I made some minor rewrites to a sentence describing
when you need to use a different form to get BitBake to pick up
hierarchical data as kernel data.

(From yocto-docs rev: 65fcd23826e9a69152933f84cb3f8bac650cd4e5)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31 12:14:18 +01:00
Scott Rifenbark ed0d609c7c bsp-guide, kernel-dev: Updates to how kernel metadata is found
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>
2017-03-31 12:14:17 +01:00
Scott Rifenbark d9f2938921 kernel-dev: Reorganized Kernel Metadata Location and Syntax sections
It seems that the two sections "Kernel Metadata Location" and
"Kernel Metadata Syntax" were flipped regarding their order of
apperance in the kernel-dev manual.  I belive that syntax should
be first and then followed by a discussion on the location.  I
have swapped these section's ordering in the manual.

(From yocto-docs rev: 167b088f459c7128bdc1abddd0b948be8f3bf5fe)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00:00
Scott Rifenbark 3f06074a0d kernel-dev: Corrected linking format for two variables.
Convention is to avoid using hyperlinks for variables that appear
in <literallayout>/</literallalyout> coded blocks.  I removed the
links for the KERNEL_FEATURES and LINUX_KERNEL_TYPE variables,
which appeared in a literal block and put the links into the
context of the description.

(From yocto-docs rev: 3384f67e4b9f15e8f96297ceb2aafc63a5994d22)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24 23:44:03 +00:00
Scott Rifenbark f30bfe990a kernel-dev: Updated the "Kernel Metadata Location" section.
Fixes [YOCTO #8272]

I re-wrote the section to basically consider kernel metadata
coming from either inside the recipe (recipe-space) or from
outside the recipe, which would be like a "kernel-cache".
The re-write eliminated the term "in-tree" regarding where
kernel metadata could reside.

(From yocto-docs rev: d358c00fbb779328bd472494023ecb802da15d59)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06 23:11:57 +01:00
Robert P. J. Day f67d4960b3 kernel-dev: Fixed missed shortcut
(From yocto-docs rev: 3f9c25820bb93f8efb6eaf415e9d7a9545832a7c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-10 11:08:35 +00:00
Scott Rifenbark 78cecf7a20 kernel-dev: Updates to the "Using Kernel Metadata in a Recipe" section.
Changed out the example to use some bits from the meta-xilinx layer
instead of the emenlow layer.

Reported-by: Robert P. J. Day <crashcourse.ca>
(From yocto-docs rev: 477c62877f5882538176d0f9c8a10fc4cf878628)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-10 11:08:35 +00:00
Robert P. J. Day a79cdb51b8 bsp-guide, kernel-dev, ref-manual: KERNEL_FEATURES should refer to .scc files.
Tweak a number of doc lines so that the KERNEL_FEATURES variable
refers directory to .scc files, and does not take advantage of
potentially confusing shortcuts.

(From yocto-docs rev: 6236fb098fc2d518f6f4f63e16b19a06a775d2d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:41 +00:00
Scott Rifenbark dc56adb5fb kernel-dev: Substituted "emenlow" example for "fri2"
(From yocto-docs rev: 786f647bfb0aca98be64a5515c1cc3b645c85d3e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:40 +00:00
Scott Rifenbark 0401f07f9e kernel-dev: Added quotes around a section cross-reference.
(From yocto-docs rev: e8b4b8239c2d7ae6a5989e0f3ab82b25ccd34ae9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:39 +00:00
Scott Rifenbark 14316cf39f kernel-dev: Fixed variable formatting.
(From yocto-docs rev: f2264bc3a61c284f01e68feea86858e46bf1594d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:39 +00:00
Scott Rifenbark 4a5f13760b kernel-dev: Swapped out fri2 BSP for emenlow BSP in example.
In the "Using Kernel Metadata in a Recipe" section, the example
called out "fri2" as an example BSP that shares the same KMACHINE.
This was true last release of meta-intel but is no longer true.
I used "emenlow" now as it seems to be like "fri2" was before
the "fido" release.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 65516ed8f31752288eeaaacc6279f808a3a8a8df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:37 +00:00
Scott Rifenbark e7e533028b kernel-dev: Scrubbed out the 3.4 kernel references.
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>
2015-03-06 10:44:34 +00:00
Scott Rifenbark a8f21965eb kernel-dev, ref-manual: Edits to KBRANCH.
Applied some edits to the areas where KBRANCH is discussed.
Clarified that setting it is not optional any longer.

(From yocto-docs rev: 4d0b2d92140d066048d9ff36453c7ea589eebe55)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:33 +00:00
Scott Rifenbark 8ced82e8b2 kernel-dev, ref-manual: Scrubbed out the KBRANCH_DEFAULT variable.
This variable is out.  There were some references to deal with.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: fcdd5de04c722ebde2d3f236310c46a251cf1afc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-03-06 10:44:33 +00:00
Scott Rifenbark d6e89e7122 kernel-dev: Scrubbed and fixed all user-supplied input formatting.
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>
2014-10-18 16:15:30 +02:00
Scott Rifenbark 9f1c18e22a dev-manual, kernel-dev: Replaced routerstationpro with edgerouter.
Fixes [YOCTO #2444]

Replaced a couple instances where routerstationpro was found.  This
reference BSP is no longer there and has been replaced by
edgerouter.

(From yocto-docs rev: 7ba629cc677310f04a17636e140142695242c5d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-08 14:20:15 +01:00
Scott Rifenbark 338b500fa8 bsp-guide, kernel-dev: Added Cross-references to "BitBake" term
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>
2014-03-30 10:18:38 +01:00
Scott Rifenbark 6bf4106edd kernel-dev: Updated the in-tree metadata section
Fixes [YOCTO #5065]

I added a blurb at the end of the section that talks about in-tree
metadata.  The blurb addresses situations where the user has changed
the metadata but not updated the corresponding SRCREV variables
in the kernel receipe.

(From yocto-docs rev: 5d3dc0e6ebc40b937c3f3ef397e2c94e7cb3b69b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:42 +01:00
Scott Rifenbark 4f41a86018 dev-manual, kernel-manual: Added links to THISDIR variable
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>
2013-05-31 08:19:20 +01:00
Scott Rifenbark 77e10791c3 kernel-dev: Spell checked the files and fixed appropriately.
(From yocto-docs rev: 0b9510d009f6437179c3848fc14c94af07ab99e2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:20 +01:00
Scott Rifenbark a3e4478288 kernel-dev: Removed a development note that was for Bruce Ashfield.
(From yocto-docs rev: e78c2bd1ac07dbe7344e4bb0a6089f1bee7ea5ad)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 55ae73c68b kernel-dev: Removed the "don't" contraction.
(From yocto-docs rev: 8e95cfe286de36d2beace01fd885e220f4044aeb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 9bf1cde472 kernel-dev: Eliminated a redundant paragraph.
Noticed the exact same paragraph at the beginning of Chapter 3
that also appears in the introductory text for the manual.

(From yocto-docs rev: 431cb58ca144bbf5aa49caa7dc2b728c3c92fe66)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17 22:34:19 +01:00
Scott Rifenbark 5053b65416 kernel-dev: General edits and links added.
Many links added to the glossary variables that were introduced
in the manual.

Also provided general edits as I found them.

(From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark b43b8efcff kernel-dev: Edits to the SCC reference section.
(From yocto-docs rev: 51872ec247e93f9dd7b7c12ee32191565c30ebfa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:21 +00:00
Scott Rifenbark 29d5511d02 kernel-dev: Edits to Advanced Metadata chapter
Removed all the orginal text.

(From yocto-docs rev: 8a3b11fb6936574edb4fd0daf60d21ee2c2ccd8f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:21 +00:00
Scott Rifenbark c9f796dbd7 kernel-dev: Re-write of the "Organizing Your Source" section.
A serious pass through this system to reorganize it.

(From yocto-docs rev: f13abc59730d78e5ffa5bce3d38519f8fc4c127f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:18 +00:00
Scott Rifenbark 5b1098dc0b kernel-dev: Intermediary edits to the "branches" section.
(From yocto-docs rev: d12e98f4b80feb1538b51cd9e3a8c204c86f13fc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:18 +00:00
Scott Rifenbark b663741f7f kernel-dev: Edits in the Branch section.
simple edits.

(From yocto-docs rev: 3f73e53c9bdbe71f04400aedc042f19a48ea62bb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:18 +00:00
Scott Rifenbark 7eccfa6849 kernel-dev: Created super section for Branches.
The sections for "Machine Branches" and "Feature Branches" really
should be encapsulated within a section on branching.  Much of
the text in the "Machine Branches" section presents the rationale
behind both types of branches.  I have created a larger section
to contain these and will edit the text to fit.

(From yocto-docs rev: c7c67f5867f22ebbbd49cab79bb2d4e52422ecac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:17 +00:00
Scott Rifenbark f42c87a1ac kernel-dev: Removed recursive include statement from examples.
Three instances of *.scc files were recursively including themselves.
These .scc files needed to have their names changed to a file
that indicated hardware support only.

(From yocto-docs rev: f1c347f8f63141807084ac0a2bd3b64e138315cb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:17 +00:00
Scott Rifenbark b56df9790e kernel-dev: Re-write of the "BSP Description" section.
First re-write of this section.  Terminology is an issue here.
Dumping the term "ktype" for good.

(From yocto-docs rev: e5ee05c5bfec2a0c62b89245efbe248a66b66288)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:17 +00:00
Scott Rifenbark 03dce08b4e kernel-dev: Re-write of the "Kernel Types" section.
First real re-write of this section.

(From yocto-docs rev: 636a852d4748904df6794bef391f7f5ef3db3c0f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:17 +00:00
Scott Rifenbark 48f8d9c2cc kernel-dev: Re-write of the "Features" section.
first real re-write of this section.

(From yocto-docs rev: 09a9d0978d939f40782179f9fd46ccd7b999c262)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:16 +00:00
scott-lenovo 472d58a06e kernel-dev: First re-write of the "Patches" section.
(From yocto-docs rev: 64e2b623e040efeefdef572024c867a57a883f24)

Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:16 +00:00
scott-lenovo 76f1ffe77a kernel-dev: Edits to the "Configuration" section.
First real re-write of this original text.

(From yocto-docs rev: a6d16b61057df8ed811cf1f5f27c5f9e08be1108)

Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:16 +00:00
scott-lenovo d176d86a4c kernel-dev: edits to the "Kernel Metadata Syntax" section.
First real re-write of this section.

(From yocto-docs rev: 41c79da0832c0b290b21cc2aff87091d7243fafa)

Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:16 +00:00
scott-lenovo 545f79bfdd kernel-ref: Edits to Recipe-Space Metadata" section.
This is the first serious re-write of the text from the
original.  Edits to make it more readable.

(From yocto-docs rev: 21c77fdfc9ae1a02b1d02fb113324c96c6aecb5e)

Signed-off-by: scott-lenovo <scott-lenovo@ubuntu.(none)>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:15 +00:00
Scott Rifenbark b63272cc16 kernel-dev: General edits to "Kernel Metadata Location" section.
First real pass at cleaning up the text.

(From yocto-docs rev: a550e96780b5be191a576bbb20ef28a36b20e0bc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:15 +00:00
Scott Rifenbark ced75cec41 kernel-dev: Edits to using metadata in a recipe section.
General edits to clarify the writing.

(From yocto-docs rev: 0510ab0faf81e0ac1c931863337eb217581c66ed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:15 +00:00
Scott Rifenbark f9a8256553 kernel-dev: General edits during re-write.
(From yocto-docs rev: 7fc9b1bdeb63c32252a243ab21e31ba25779bb1b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:14 +00:00
Scott Rifenbark 467cb3d32e kernel-dev: Edits to the introduction chapter.
I did some re-writing for better understanding based on what I
know.

(From yocto-docs rev: fc3adb037ac07a90dfbba6b76643391480e0bce5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:14 +00:00
Scott Rifenbark 5b2ed2a5fa kernel-dev: Formatted the "SCC Reference" section.
(From yocto-docs rev: d688741743ff3ffeaf387dffc728af40331e8933)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:12 +00:00
Scott Rifenbark ece3e83e8b kernel-dev: Formatted "Feature Branches" section.
(From yocto-docs rev: 6225075b08b3585532e60c9aebc0903a4509e51f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:12 +00:00
Scott Rifenbark 49166264bd kernel-dev: Formatting "Machine Branches" section.
(From yocto-docs rev: 30a0d3c1ef3d91221ce3f90a3fd2f4b93bff1c30)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:12 +00:00
Scott Rifenbark fe1b20f80a kernel-dev: Formatted the "BSP Descriptions" section.
(From yocto-docs rev: 9cfccb3372f47094479fb0a5ad095cf2b46f906e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:11 +00:00
Scott Rifenbark d675ef0878 kernel-dev: Formatted "Kernel Types" section.
Also put in the initial text for the next section, which
is "BSP Descriptions."

(From yocto-docs rev: 0c9b0475d9c1a97c7b00df325dad0c830e30444b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:11 +00:00
Scott Rifenbark caacd30b27 kernel-dev: Formatted "Features" section.
(From yocto-docs rev: 500ae50979dad7f730d8c0a5e987c608422f3c71)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:11 +00:00
Scott Rifenbark 1fa2beffa1 kernel-dev: Formatted the "Patches" section.
(From yocto-docs rev: e7de7e806d4cd02e4b5c8cb1ac237809bef5144e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:11 +00:00