Fixes [YOCTO #11630]
The "Yocto Project Source Repositories" section is purely conceptual
and thus does not belong in the reconstituted dev-manual, which is
converting to a "how-to" manual. I have moved this section to the
ref-manual under "The Yocto Project Development Environment" section.
Moving the section affected several things. Three figures that where
in the dev-manual were copied and moved to the figures folder of the
ref-manual. This required deleting them from the dev-manual and
adding them to the ref-manual.
The makefile had to be edited to move those figures into the ref-manual
and delete them from the latest version of the dev-manual in order for
the tarball of files to be correct when the manuals are made.
Links to anchors within the moved section had to be fixed in various
manuals. Links to the main section "id" had to be fixed to point
to the ref-manual manual.
(From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c)
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]
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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 #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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
