Fixed the way we refer to a BSP name. It is really
"meta-<bsp_root_name>" rather than "meta-<bsp_name>". The
name is the whole string and not just the root name.
Also added a tip on ordering the layers in the BBLAYERS
variable in the bblayers.conf file. Order is important.
(From yocto-docs rev: 9c56238295f5631c496377616ea98b860253e6f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I took out the sections at the end of the manual that talked
about the yocto-kernel tool. This tool is no longer maintained
and there is no equivalent tool. I also fixed the yocto-bsp
tool to be the bitbake-layers tool. This involved some
consolidation of sections.
I fixed some links in the kernel-dev and toaster-manual.
(From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated this section with minor edits.
(From yocto-docs rev: 1bc1dcda5fbab4a66737653164222f4fc5a7289c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section had several out-of-date items. They are all up
to date now.
(From yocto-docs rev: 247f3eceeccc645a1b556aea433d4cf66399e962)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made changes to sync the raspberrypi BSP example to what is
really in the source directories. It was pretty out of date.
Made some minor edits to the sections describing the framework
of the BSP.
(From yocto-docs rev: b222d0988cb365cb1943ee1857e5cfd6b9fe173a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some edits to make the section more up-to-date. Dumped
minnow as a BSP example for raspberrypi.
(From yocto-docs rev: a40515bad28d07d736e1ddd1832c19b074749d53)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added more relevant information around the discussion of BSP
layers.
(From yocto-docs rev: 8ca439b0bbfdcf390edb723fd12e8a00d90024e3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When I converted the Yocto Project Overview Manual to the Getting
Started With Yocto Project Manual, I updated the strings for
references from "&YOCTO_DOCS_OVERVIEW_URL" TO
"&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command
that did not take into account the text the might follow the link
by saying "see such-and-such section in the Yocto Project Overview
Manual." So, I had to hand fix these.
Additionally, since I have moved a deeper concepts chapter that
was in the getting-started manual to a new Yocto Project Concepts
chapter, many of those links changed had to really go to the new
manual instead. Those were fixed.
(From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation involved removing the overview-manual and replacing it
with the getting-started manual. All links to the string
"&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with
"&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed
files used to create the manual with prefixes suited for the
new manual name, which is "Getting Started With Yocto Project".
The style sheet for the new manual needed updating to display the
new .PNG image for the title page. The mega-manual file had to
be updated to include the files. The mega-manual.sed file had
to be updated to include the new manual and not use the overview
manual.
(From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The "Licenses" section in the technical details chapter of the
ref-manual was concepts and needed moved to the new overview-manual.
Some links were broke during the move and they were fixed in the
BSP and dev-manual.
(From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Added a new chapter to the newly created Yocto Project Overview
Manual. This chapter originated from the YP Reference Manual and
was the old chapter 3, which talked a lot about various concepts.
This information is better suited for the new overview manual.
The change involved moving the entire chapter and renaming it.
This move of the content affected many, many external references
and links into the old area. Consequently, I had to recast all
these links from the different manual.
Changes also included fixing the mega-manual.xml file so that it
would include the new overview manual as part of it.
Many figures had to be relocated as part of the move as well. This
meant deleting them from the ref-manual/figures folder and putting
them into the overview-manual/figures folder.
(From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section needs input from engineering.
It is incomplete, but as best as it can be for now.
(From yocto-docs rev: 1212f1eeebd23cb11c63889f3ee602e761450967)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto-layers script is being deprecated in the 2.4 YP release
and the preferred script is now bitbake-layers. In particular, the
section that talks about creating a general layer was using
yocto-layers create. I have replaced it with bitbake-layers
create-layer command.
The bsp-guide and kernel-dev manual had links that used (in the
case of kernel-dev) and referenced yocto-layers. I had to change
these to reflect using bitbake-layers create-layers.
(From yocto-docs rev: 73ec4d0c8c2c093b7c9df86038d132f0da975273)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to all links to the dev-manual. This manual is now named
"Yocto Project Development Tasks Manual". There were some bad links
fixed as well. I had some links to some terms that used to be in the
dev-manual but are now in the ref-manual. Somehow they slipped by.
I have fixed those as well.
(From yocto-docs rev: b303190dd1234a7b83e0cd6217c69a449715062b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
The YP Development Manual had some build host preparation steps
as part of the chapter that talks about getting a host ready
for using YP. These steps are better suited in the BSP Guide.
I moved them there and filled out the steps to be more complete.
(From yocto-docs rev: 2277812d0dd411a103a4a4252d4cb90c471901c9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the introduction of CROPS as a way to set up the build
system, I had to alter the first bullet of the BSP workflow
list and the figure.
(From yocto-docs rev: f1db3db4053142619c62629d4b05023f0b148e6c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did some rewriting for clarity in the "Using .bbappend Files
in Your Layer" section. The section needed to be retitled so
focus on the layer aspect of .bbappend files. Also, while I
was in there, I did more work on the prose in general.
Also had to fix some links in the bsp, kernel, and ref manuals
that linked into the section whose name I changes.
(From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moved the section on BSP Development workflow from the dev-manual
into the bsp-guide. This procedure needs to live in the BSP
guide.
Many links had to be fixed.
(From yocto-docs rev: fbf06240f83221929aea237660146e0076207f6a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The chapter on setting up YP has been completely re-written to
move towards a "how-to" manual. This involved touching every
aspect of the chapter. All subsections now have procedures
surrounding set up stuff. There are some development sections that
still need fleshed out.
Many, many links and references in other chapters were affected.
These have been fixed.
A couple style-sheet (*.css) files were also updated to support the
"writernotes" style, which renders paragraph text in red.
(From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I changed the section heading for the section that describes how
to make a change to the YP. It was passive. I need it to be
active and in line with the "how-to" dev-manual.
(From yocto-docs rev: 340e1b6ab9806ec11ec894d4472bc2c937c2b058)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The "Git" section in the dev-manual is really about concepts.
There are a couple of examples that might or not might be
allowed to ultimately stay. I have moved the section to the
ref-manual. If those examples get replicated in the new
dev-manual, I will update the "Git" section further. For now,
however, these remain in this moved section.
(From yocto-docs rev: 2e4b87fdab29c13ce0d2314e50c93e37404b6f7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 broke several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
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]
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>
Fixes [YOCTO #10385]
The output was incorrect for the default kernel type. In the
Krogoth branch, the output uses 4.1 and the text indicates 4.4.
In the master branch it was the same as well. This commit fixes the
master branch to use the default 4.8 kernel in both the example output
and the text.
(From yocto-docs rev: a76d1cc91883dcd58743f2cd2626917e51419cb1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Occurrences in many manuals and one figure.
(From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Probably should have committed these separately but....
* Updated the BSP guide to use an example that we support.
I removed the eMenlow stuff completely.
* Fixed poky.ent so the 15.0.0 stuff is used for the variables.
This supports the 2.1 release.
(From yocto-docs rev: 598b261725235b6f160561db22bd9f31ec721066)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hob and the packageinfo class have now been removed from the
code base. This patch removes all references to:
* Hob
* meta-hob
* packageinfo and
* BBLAYERS_NON_REMOVABLE
from the documentation.
So long, Hob, and thanks for all the fish.
(From yocto-docs rev: 6a1ba2761d5c2ec1072616ce3d791787f1b1b2a7)
Signed-off-by: Belen Barros Pena <belen.barros.pena@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A link was going to an old YP page that talked about patch
style guide stuff. That page simply redirects the user to a
styleguide of the OE. I fixed the link in the manual to go
directly to that page now.
(From yocto-docs rev: 913c30eae42e89cc6f8dd99026594c2843985c58)
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>
Version 1.8 drops support of the 3.10 and 3.17 kernels. The
emenlow example was using the 3.10 kernel recipe as a showcase
and it also listed the recipe in the directory structure. I
removed it. Additionally, the yocto-bsp create command was
prompting for the user to accept the default 3.17 kernel. I changed
that to 3.19.
(From yocto-docs rev: 03bf66e961400b27b7e31d4a25776a11ce5719fd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This note provides a bit of a warning or tip regarding naming
BSP layers. The letter of the law dictates that you don't
need to prepend a BSP layer name with the string "meta-".
However, scripts exist in OE where the naming convention is
assumed.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0375349fdd3cd5ff8a54db8124d5cdc02133ff12)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Crown Bay is short on life so I swapped it out for the eMenlow.
(From yocto-docs rev: 6d5394c12a374463cb1d5215af88178b63a5b8c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The yocto-bsp and yocto-kernel tool output for the examples
were updated to be current.
(From yocto-docs rev: a05b1df35c7518027b1eb73f9ea2b6a3d00dca43)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way the explanation for adding the BSP-specific files did
not take into account for layers that might support multiple
machines versus a layer not supporting multiple machines. I added
more explanation that covers both scenarios to be clear.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3f00f0bb830665f8711c68aa6110b8399e867345)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Crown Bay BSP now only supports VESA graphics. Because of
this, some of the examples in several areas of the BSP hierarchy
were wrong. Changed accordingly.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b61f013a086a9135a86eedf2884fd1b07f798165)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Update the choices and version numbers of the "yocto-bsp" section
of the BSP guide to match the current development utilities.
(From yocto-docs rev: 0f8472ffa2bc3ae762587c4e2345a4d9850608ed)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
