Commit Graph

39 Commits

Author SHA1 Message Date
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
Scott Rifenbark cc07a5e350 kernel-dev: Formatted the "Configuration" section.
(From yocto-docs rev: 2b3be91ffdc6c27306f381cf083f4b3e805c2d38)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:10 +00:00
Scott Rifenbark ef4d985329 kernel-dev: Formatted "Metadata Syntax" section.
(From yocto-docs rev: 24fda5393103dd6dba2f7e58d023172dc2ee48ff)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:10 +00:00
Scott Rifenbark e8dabb0228 kernel-dev: Formatting "In-Tree Metadata" section.
(From yocto-docs rev: 92e9a5c6c6a3a416e3e8718d8e02f72025ad355c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:10 +00:00
Scott Rifenbark 4158e19d36 kernel-dev: Format of the "Recipe-Space Metadata" section.
(From yocto-docs rev: 6db7f35316b5cc513c17d454237e13548911b6bb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:09 +00:00
Scott Rifenbark 7f62af0d12 kernel-dev: Formatting of the "Metadata Location" section.
(From yocto-docs rev: 8ea651b8a15980421123809a1612dafe4d22ac2f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:09 +00:00
Scott Rifenbark ea6d5be3ce kernel-dev: First edits to chapter 3 intro and section 3.1.
(From yocto-docs rev: bb640ebcfd99eaf3944711edc813a4bd39aa3753)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:09 +00:00
Scott Rifenbark 5cbeb84006 kernel-dev: Created file structure for new kernel-dev manual.
(From yocto-docs rev: 25be3ebb7713b875c4ec6e3723961b7dd860295d)

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