Fixes [YOCTO #12370]
Moved the "Yocto Project Components" section from the ref-manual to
the overview-manual. This material falls into the "concepts" area
and is being moved from the ref-manual. One link in the
yocto-project-qs was affected and updated. Oh... another link in the
ref-manual for a variable also fixed.
(From yocto-docs rev: 75ced485bb223373591eb41d1b343d0c2b315345)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
I had a section on Wick Plug-Ins in the ref-manual in the
"technical details" chapter. This section has been combined with the
section on using Wic that lives in the dev-manual. This move creates
a single section on using Wic to create Wic-partitioned images.
The section was moved out of the ref-manual and merged into the
dev-manual Wic section.
(From yocto-docs rev: 8724049141c9a793312dcf5ff5c3425948d1cbd0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
The section on the x32 psABI topic was in the "technical details"
section of the reference manual. This section combined conceptual
and "how to" information for x32 psABI. I moved the conceptual
information to a new chapter in the overview-manual. I moved the
"how-to" information to a separate topic in the dev-manual. This
resulted in the mega-manual being updated to take on a new chapter
for the overview-manual (overview-concepts.xml). No links were
affected.
(From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pulling out some introductory information from the old "Introduction"
chapter of the ref-manual has isolated the system requirements and
term definitions sections. I have decided to create a new chapter
for terms as they are a reference item. This leaves system requirements
also alone as a new chapter. So, I dumped the introduction.xml chapter
in favor of the two new chapters.
(From yocto-docs rev: 35c41b3008845c94e10be19b37409b0d1a469ff5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
Moved an introductory section for YP that was in the ref-manual
to the beginning of the YP environment chapter of the overview-manual.
Had to move a figure and update the makefile as well as adjust some
links.
(From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had tried using a #-type target for some links designed to go
to the top of the sdk-manual. It was not working out so I removed
the targets. The links now render benign for the mega-manual as
they should and render hot for the individual manual as they should.
(From yocto-docs rev: 05e20792fa6c93618499f06adfa2d4b82f24275a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I failed to copy the updated sdk-manual title figure to the
mega-manual/figures directory when the sdk-manual title had changed.
This was causing the title of the sdk-manual in the mega-manual
to render as the old one.
(From yocto-docs rev: cb111620cdce90d8f2f7e14a918a2307e81fe705)
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>
I neglected to change the string for matching purposes in the SDK
line when the SDK manual title changed. This was causing links to
that manual where there is no specific #<target> to not be resolved
correctly.
I also removed a redundant line for the yocto-project-qs manual. It
was appearing in two places.
(From yocto-docs rev: dcc0d5a98af93eded676e7b4cb684f60d2cf9d3a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When I pushed the commit for the new YP Overview Manual, I
failed to exclude the HTML, TGZ, and eclipse/ files for the
new manual. I have removed them from the system here.
(From yocto-docs rev: 5cc47ba18bad4b0d3a90befd8744bf93489afcd6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12370]
I added all the mechanics for this new "Yocto Project Overview Manual".
For now, the manual builds and publishes into the 2.5 area. I used
"overview-manual" for the folder name. Makefile properly builds the
new manual. The mega-manual.sed file processes links for the new manual.
The mega-manual.xml file includes the new manual. The poky.ent file
includes a new ENTITY link for the overview manual. All pieces are in
place.
With this commit, just an overview chapter exists. The remaining content
needs to be developed.
(From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The sections in the introductory chapter of the ref-manual are better
served as part of the dev-manual. These sections are about accessing
YP source files using various methods (i.e. source repositories,
index of releases, and nightly builds). I have integrated that
information into the dev-manual where the information was also being
treated.
(From yocto-docs rev: d3a97b1f9367d5bb5370974c8c5c0404df86724a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #12419]
Updated the example to use http://my.server as the base.
(From yocto-docs rev: c61769ce2cd7fafbd5f1b349ecf9ac75dbae1a6f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Links to the section in the BSP manual for how to create a new
BSP layer using 'bitbake-layers' were needing fixed.
(From yocto-docs rev: 150612925421b09e84f85514e65e58d179e5be46)
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>
Changed the way the YP QS looks. The QS now has numbered sections
rather than just formatted section heads. This allows the reader
to better track the hierarchy of the sections. This feature has
been asked for before and I decided it was time to implement it.
One thing though, is I am not generating a full TOC at the head
of the book as is done in the other YP manuals.
Decided to add a manual title .PNG file. This required a new figure
file (ypqs-title.png) that needed to reside in the figures folder of
both the yocto-project-qs and mega-manual. Updates were required in
the Makefile to include the figure. Updates required in the
YP QS style sheet to display the figure. Basically, there were all
kinds of changes to get this title to show up properly in both the
YP QS and in the Mega Manual.
Turned the structure of the YP QS into a book now rather than an
article. This required creating a "qs.xml" file that has the actual
content.
(From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
File is not used.
(From yocto-docs rev: 83eb6d4decfe698a5f4be9c3c9792ef60e404323)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section was missing three of the summaries for the command when
you used --help to find out about it. I added these in to the section.
(From yocto-docs rev: ac9c58322b7f8533335a9d4379aa031bb1de7be6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Deprecation of yocto-layer occurred in 2.4. For 2.5, we do not
need to mention this fact in the note.
(From yocto-docs rev: 619b74422baf3b531e2fc3db50a95019178a1c09)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed wording on how the OpenEmbedded build system dynamically
generates do_image_* tasks as needed during image generation.
(From yocto-docs rev: 9df98d77a446cd5d27c4e87418117a904b1f4231)
Signed-off-by: Scott Rifenbark <srifenbark@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>
Made the title page notes consistent across the manual set.
Made the author group information consistent as well. It is better
that authorship is seen as a third party and not tied to Intel
Corporation.
(From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added information about how the build system dynamically creates
do_image_* tasks (e.g. do_image_ext4[depends]) when creating the
image. This is functionality that replaced IMAGE_DEPENDS_type.
(From yocto-docs rev: c977df506585aad1ade99c390bacc04b54eb0e48)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the sdk-manual changed. Many links were updated to
render to the correct book title.
(From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the sdk-manual changed and I had to update some external
links and references into the manual.
(From yocto-docs rev: fba92910fd91d1ca49bc6915820effb189f1852e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the SDK manual changed and there was one link to the
manual that needed fixed.
(From yocto-docs rev: 800d5106a25ce4e87b0468ec3ab03dd8a49f3082)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Change the name of the manual to "Yocto Project Application
Development and the Extensible Software Development Kit (eSDK)".
The "sdk-title.png" file was updated and all title information
was updated.
(From yocto-docs rev: 502a49a9e4f5e80efe16507391bc9d9618efefbd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
SDK manual title changes so the links into that manual needed updating.
(From yocto-docs rev: e59d1cb22d46b00e9413deb5c7a70a14be880dc1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This also affected a link in the dev-manual and some setup stuff
in the mega-manual and sdk-manual.xml file due to a new chapter
being introduced.
This section on the Eclipse stuff is big enough to warrant its
own chapter. I decided to pull it into a separate chapter of its
own.
(From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Image Generation" section, I was referencing these tasks
and did not have any cross-link to the actual tasks. I added them.
(From yocto-docs rev: da480933c59ddc3fe9fe4a881d4d0e21038a999b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In Step 4 of the "Running QEMU" section, the file suffix
"*.vmdk" is mentioned. "vmdk" has essentially become "wic.vmdk"
now. I updated the example.
(From yocto-docs rev: 5e17ccabfe8eb9d3b4316ceb41df17eddc7b0065)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "vmdk" image has essentially changed to "wic.vmdk". I updated
the description by replacing "vmdk" with "wic.vmdk".
(From yocto-docs rev: 24d0d9509361afe0d61449c7dd056f73318fc01a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Combined two note boxes into a single note box with bulleted list.
(From yocto-docs rev: 5684b6cf373ddc5b18e9e4ae4ae12cede30b8235)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This test was removed.
(From yocto-docs rev: 9defac2c0e0d808bc677bd6d115a72e4db6a554c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The manual title has changed to "Yocto Project Development Tasks
Manual".
(From yocto-docs rev: aa6b7959df1725257ee598f828d3e99e595308e5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated several files to change the title of the dev-manual from
the "Yocto Project Development Manual" to the "Yocto Project
Development Tasks Manual." Did some edits in the README and the
Makefile as well for completeness.
(From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found four links going to the dev-manual that should have benn going
to the ref-manual. These were for YP terms. Fixed them.
(From yocto-docs rev: 0c75eda3a772d8c40e381e44e563a5b79b3d0cb5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. I fixed a link to this title. Also, fixed several external
links that were going to the dev-manual and should have been going to
the ref-manual.
(From yocto-docs rev: 69c0832ea9378d097e85e23e45cec750b8c42042)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links that should have been to different places were overlooked.
I fixed these.
(From yocto-docs rev: a1681d065812546a573ed778141289a6b476cecd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Fixed the links for that. Also took care of some external
links that should have been internal.
(From yocto-docs rev: c1e108e2d13d83bcd6b28c8983336a93642c60a2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Fixed the links to that manual. Also, fixed external links
that should have been internal to the ref-manual.
(From yocto-docs rev: 76bc9f55e0947689213139927410418a188c893c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. I fixed those links and titles. Also fixed some external links
that should have been internal.
(From yocto-docs rev: a63abcacb2d21cf3f29eb881ce872b265162d2ad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. I fixed links to this manual. Also converted several external
links to internal.
(From yocto-docs rev: 3ec8452d4f847654096f68c90bf2f7003f5e585c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Fixed links for that. Also, fixed some external links that
should have been internal to ref-manual.
(From yocto-docs rev: 2369e8d1c1c4f376de0faf6ab02afdea79082d87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title of the dev-manual changed to the Yocto Project Development
Tasks Manual. I added that to the links. Also fixed several external
links that really should have been internal.
(From yocto-docs rev: ff2d0010530d6969b2ffd64e6d23c79a18d7f368)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual and I fixed those links. Converted links that should have
been internal to the ref-manual but were external to the dev-manual.
(From yocto-docs rev: 6de68b04ce1b921466a462dfa3f3485232aaf40d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Updated a link. Also, fixed a link to a term that should
have been internal to the ref-manual and not external to the dev-manual.
(From yocto-docs rev: 82a44632fd614db1ac00d2e2b4ec85ade77b9aff)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Updated the links. Fixed a few links that should have
been internal.
(From yocto-docs rev: 2125fa0b2a86b8bea0d0e76c4ca349d00bd86e71)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development Tasks
Manual. Updated all the links.
(From yocto-docs rev: 0ef55f6d379f9c7b37642d51683d807a5eb92253)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title changed to the Yocto Project Development
Tasks Manual. I updated the links.
(From yocto-docs rev: db42c7f2c1b8fb9037bf32ca957d4bd7444510ea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Dev-manual title has changed to the Yocto Project Development Tasks
Manual. I fixed these links. Also, had to fix a couple links
that were in an external <ulink> style whereas they should have
been in an internal style (<link>).
(From yocto-docs rev: da5317f802975eaf6b2c5d4026892e5f2051760a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Links were using the <ulink> style tag when they should have been
using the <link> style.
(From yocto-docs rev: 6c4a39537211ccb322f4ac1c8009ebabcd7b209d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual title has changed to the Yocto Project Development
Tasks Manual. I fixed links for this. Also, converted <ulink>
links that were going to internel areas of the ref-manual to
<link> format.
(From yocto-docs rev: bfe4b762ac1c1eb666636a7c2430b3e21787c531)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a couple links that were still going to the dev-manual when
they should have been going to the ref-manual. Updated the title
to the dev-manual for those links.
(From yocto-docs rev: 0cd84696a569af17a12bb939f203051e78d6fd48)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual name has changed to the "Yocto Project Development
Tasks Manual." I had to update some references to the manual.
(From yocto-docs rev: 64b5f18b953c89811a08f76a302e29e25ad2fb70)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added several first occurrences.
(From yocto-docs rev: fa369cfb539c86b59aaf0fff70d9034ea0620cba)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the dev-manual has changed to be the
"Yocto Project Development Tasks Manual". I have updated all the
areas in the kernel-dev manual that reference sections into the
dev-manual.
(From yocto-docs rev: f0309ab658a259637ba7f9301031887114ade988)
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>
Link to metadata term was not going to the ref-manual.
(From yocto-docs rev: 7a116ece403cb88977dfcce3006e2e1bb52b5df0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the redoing of the YP website, it was decided that the manuals
could only reference into the top-level and the top-level/documentation
URLs of the website. I removed all references to areas such as
projects (e.g. Toaster, VM, etc.) and any other URL that was not
the top-level landing page or the documentation page.
(From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Deleted the existing JSON chapter, and replaced it
with this new chapter.
(From yocto-docs rev: 86f9fb9c567310ecd1b06944c4c9107ec30df29c)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The content was obsolete. The new information is covered
in the new chapter "Configuring Toaster".
(From yocto-docs rev: 680273cb8fecea84297c3102c0b19fff5bcd9d88)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Documented new direct JSON API with four subsections to let
you remotely monitor Toaster.
(From yocto-docs rev: 8b18ccffbcfe896f878dd912ea39b14557426b2c)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is no longer a "loadconf" command
(From yocto-docs rev: 25c4385833c636bf4cff889ff6325b2a14f5fc14)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed two outdated sections, "Use the toasterconf.json File"
and "Edit the Configuration File" and replaced them
with "Use the Fixture Feature" section.
(From yocto-docs rev: 8a247836a958449836effac3600f6923c5289bb6)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Links to the top of a manual don't really work from the mega-manual.
I updated the manual links at the bottom of the yocto-project-qs
so that they go to the introduction sections of the appropriate
manual rather than attempting to go to the top of the manual, where
they don't render from within the mega-manual.
(From yocto-docs rev: e8e1c72b6c79065d86479d48974d1a188f4ebf30)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
"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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Section "Using an 'In-Tree' defconfig File" updated to use a
more syntactically correct KBUILD_DEFCONFIG_KMACHINE example.
(From yocto-docs rev: 64e6b16703fa3ce9ac8db25de8089d32ac7aeafc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Should have been two commits but I forgot to do them separately.
1. I updated the YP Compatible Program section.
2. I moved the "Configuring the Kernel" section from the dev-manual
to the kernel-dev manual.
(From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Recently a number of changes have happened on the implementation
side of some image formats, and a few have been renamed.
The u-boot image signing code is now always available and no
longer in a stand-alone file. The vmdk/mdi/qcow2 images have
been removed and are now just a conversion type that is applied
to wic images.
Reported-by: Tom Rini <trini@konsulko.com>
(From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes based on a run through of the procedure.
(From yocto-docs rev: 0a526bb15f597843d1e5da1eeca0a952c6c5016f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In several examples, hardcoded versions of release names and
versions were being used. I updated to use variables from
poky.ent so that examples would use most recent release.
(From yocto-docs rev: 53f8e92075cc34538f36d7fba392ea1ac9a6dd1f)
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>
Put this note at the end of the traditional kernel development
flow. A way for the user to verify that the patch was applied
for a subsequent build.
(From yocto-docs rev: 598a518cd92980e1781649a3ed30ac585327dc0f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered this item in the front of the glossary was commented
out and not showing up so the user did not have the option to
click on "N" to quickly get to the "N" entries, which did exist
and show up. Uncommented it and put the proper beginning "N"
variable in as the start.
(From yocto-docs rev: 6d51dfb9de53db1222f68a6f0325eaad1a12cd6b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the kernel development flow diagram to have an arrow from
the repositories to the box that says you need to clone the
kernel repository. Also, provided some wording changes in the
end of the chapter.
(From yocto-docs rev: c77cff4f7b0795d5429dc47c2ad63aec6d19d513)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the linux-yocto-4.12 kernel repository and the linux-yocto-cache
repository to the list of Yocto Linux Kernel repositories in the
Source Repositories.
(From yocto-docs rev: 88fedda0fa4a4dfc468f0dc404fa9f04390cbed7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Switching to kernel version 4.12. Pulled some old commented
stuff out.
(From yocto-docs rev: c0a5c886256d3477ddaf670df4939bec1c73152e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added in a sentence to point to the kernel-dev manual should
the user be interested in kernel development.
(From yocto-docs rev: cc47606af5b7eb2fdc669aa2c0c4dfbd930b8247)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the flow diagram up higher and completely removed
the procedures to get the build host ready for kernel
development. Those are now in the common tasks chapter.
Lots of rewriting
Signen-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to account for devtool and traditional kernel methods
now.
(From yocto-docs rev: 74580d9a61fa012406059ba2a3348d38fdc24d4c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11762]
Added a link from variable to new virtual providers
section.
(From yocto-docs rev: d87726cf4962ca093c63d23d9e04f41d448c9594)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
We do not want to mix traditional kernel development with
kernel development using devtool. This reference implied that
was okay to do.
(From yocto-docs rev: 38c3a5d3b47e15880ca10ed30ae4a450ecc851cd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bare clone setup is no longer recommended or necessary for
traditional kernel development. All that is required is to
clone the kernel Git repo locally.
(From yocto-docs rev: cbe6d79da4fc2d5bba530b0fe6abead7783bdfbe)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed spelling warning that was underlining "BSP" in the figure
(From yocto-docs rev: 354fe8c39057ab3aec24474ead65d2d13a5bb3b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A work-in-progress of an example that modifies the kernel
using the devtool. The procedure is not complete yet as it
does not run properly.
(From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The end of this section did not direct the user to the next
logical step for preparing a development host. I added a
paragraph to guide the user to the next area they would need
to read based on their development methods.
(From yocto-docs rev: 4a1aa7800e7bca82dddef0ed83e14e075b3aa9f2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #11970]
Updated the field description for "Specify Sysroot Location" to
note that the user can have this either downloaded or built and
the ramifications of using a downloaded root filesystem.
Updated the "Deploying and Debugging the Application" steps for
both supported Eclipse versions to tell the user what to do if
a browse operation fails or times out.
(From yocto-docs rev: 623000af186cb5632af551f95384d4c96d4d6c54)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added new description and created a link for an
existing occurance of the variable.
(From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated two instances of "sysroot-components" to
"sysroots-components".
(From yocto-docs rev: 035be964e6f345c058c1dacbb58b09745e8f827d)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
WIP at this point.
(From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the step to include proper links and verbiage for
setting up the system for YP development.
(From yocto-docs rev: d5d908847d66178a995d2be985c605e6a5c48d76)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The dev-manual had a place-holder section for getting the
build host ready for using YP and then doing kernel
development. This stuff is better suited for the actual
kernel development manual. I moved the section. Moving
created several broken links in the manual set that had to
be fixed.
In the dev-manual, I updated the introductory list to include
the newly moved kernel stuff.
(From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure "figures/kernel-overview-2-generic.png" was missing
the ".png" suffix in the TARFILES statment. This was throwing
an error during the make process for the manual. Probably an
error for quite some time and not noticed. I added the suffix
to remove the make early exit error.
(From yocto-docs rev: 00ad7874f8da149f193caeab8fd89bbf6d8132d7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the section on preparing a build host to use the
Eclipse IDE and placed it as introductory text for the
section that talks about getting the system ready for either
native Linux or CROPS use to use YP.
I also created as part of that list, links to the BSP manual
where I now talk about getting the system ready for BSP
development.
(From yocto-docs rev: f5b5d27ea5036792a96c0a42a3d7513a2a57a4b0)
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>
Moved the "Patching the Kernel" section, which was in the
dev-manual to the kernel-dev manual. During the move,
renamed the section to "Using devtool to Patch the Kernel".
This move bothered a lot of links so I had to fix them in
various manuals.
(From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The steps needed updated to reflect the introduction of CROPS
as a way to prepare a build host.
(From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These references now go to the ref-manual and not the
dev-manual.
(From yocto-docs rev: e58681488c307ba1daf2e10423e56b7d3ec486b8)
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>
Now that we have CROPS as an option, the step for preparing
your build host is condenced to include cloning poky. This
resulted in removal of step 2 and updating of the figure.
(From yocto-docs rev: 903d1f98b736a744de1d9c973f7a96b6a92049b5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section failed to mention the "yocto-layer create" script,
which is a simple way to create a layer. I have added this info
into the section by way of a "Tip" box.
(From yocto-docs rev: cf204f2b72b1da0104315f54cfe55c3f1eaf0f96)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced "recipe_work_directory" with "${WORKDIR}"
throughout the section.
(From yocto-docs rev: a961cf07cd18d06e0c6399a10dc40c0d4143c23f)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated text for sysroot terminology, and clarity.
Fixed a capitalization error.
(From yocto-docs rev: 4eea6497663efc937cddf4700298f5824ade7b47)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on recipe syntax that was buried in the creating a
new recipe section was really a reference on syntax. I have moved
it to the ref-manual.
(From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section about following best practices was more of a reference
section the way it was written. I recast the section and the
sub-sections such that it is a list of items to consider.
Also renamed the section to be more of an action section rather
than passive.
(From yocto-docs rev: 8b050a46c67a3d3e89d905cf028eec6ae370388a)
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>
I updated the wording to note that the steps are how to create
a layer without the aid of steps (i.e. by hand).
(From yocto-docs rev: 81800fa9ba0dd9ff439a43b286981eea51d4c87f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This style allows a writer to use the <para role='writernotes'>
tag to have text in the paragraph render in red.
(From yocto-docs rev: 65bb4edcd0a58ea8e17f28f9f5c13e2898c22745)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Because the YP development introductory information was moved to
the ref-manual, and the QS will get a CROPS section inserted,
the introductory section of the QS needed to be updated a bit.
(From yocto-docs rev: e173b762a74678cd660850e4f5bc28712c3d83ac)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The introductory stuff in the QS is really conceptual information and
needs to be in the ref-manual where YP is introduced. Regarding the
QS, all we really need to do is point to places where the reader can
go to find that stuff out.
Part of this move involved getting the diagram of the YP flow for
the environment from the QS to the ref-manual. That figure was
named "YP-flow-diagram.png". It was named "yocto-environment.png"
in the QS but I renamed it when moving it to the ref-manual. This
caused some edits to the "Makefile" to clean up the figure lists
for tarballs.
(From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced "python34-pip" package with "python3-pip"
in the list of required packages for CentOS' variable.
(From yocto-docs rev: 5d48ea7953169b4392d6caf0fb8f2f952479f033)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed duplicated package, "which" in list of
required packages for Fedora's variable.
(From yocto-docs rev: e016735fe7ef0d866d44df1100597ab3f3af7d5f)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The minimum version of tar is now 1.27. This was changed in both
the yocto-project-qs and ref-manual.
(From yocto-docs rev: b0fe513e08de860e94a3617fd62382430e321c77)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
At the end of the section that describes how to set up the
development machine for CROPS, I added some user links for more
information based on the type of container the use is interested
in.
(From yocto-docs rev: 6888d8454839bbb2ecdf96ce421c7d8723931d65)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Added content for steps to set up a native Linux host for using
the Yocto Project.
(From yocto-docs rev: d8a18d382c584dbdfa7f5f190a92cc7cde0f9601)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I took the section that described how to use a pre-built kernel
and run it through QEMU out. This is basically a QEMU usage
section and is not in that area. There were some QEMU speed
up items suitable for the QEMU concepts section in the ref-manual.
I put those in that area.
(From yocto-docs rev: b081013aa10b42e4eb88ed54940112c5ae106911)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I converted the QEMU section to a procedure. Also took the
tips section and created individual sections from that.
Cleaned up some areas in the QEMU conceptual section in the
ref-manual
(From yocto-docs rev: dfd3466be605fdd7438653bf54fd0df3594a5c50)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The dev-manual had a section on QEMU that combined a lot of
reference information and usage information. I took the reference
information out and moved it to the ref-manual into a new section
in the second chapter, "Using YP".
(From yocto-docs rev: 188596c576e357925383d0cc3bd2b0cdf41926ec)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section needed to be a step-by-step procedure.
(From yocto-docs rev: de4868c97c1199b39b3c3e68b4ff159f6546cd9e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Locating Pre-Built SDK Installers" was turned into
a procedure. I also added some information on the actual names
of the *.sh files.
(From yocto-docs rev: 548886d5a392164783596c0c04779aaffd6ac930)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated manual descriptions to fit current
manual structures.
(From yocto-docs rev: 81d8add49fd09deef432d9a0cc08c9f380c671ed)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11715]
Replaced all instances of MinnowBoard MAX with
MinnowBoard Turbot.
Updated Welcome section to include links to key
sections of quick start.
(From yocto-docs rev: ed55dcd80ef5edddacb2d288e0a6cbe85dccf964)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a rewrite of the section to get it into a procedural form.
Missing some technical information and needs a review but it is
the best that can be done at this time. The code for initrd is
not settled.
(From yocto-docs rev: 0fdef8c5fed6ac510d1604a677e6546494b4c96b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The description suggested the reader see the
meta/poky/conf/local.conf.sample.extended file for more understanding
on INITRAMFS_IMAGE. The actual file is
meta-poky/conf/local.conf.sample.extended.
(From yocto-docs rev: 80b474d3417e88a47d1317b2af6552698e907b80)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a figure for this simple build workflow that uses
BitBake from a Linux host. Also did a bit of re-writing.
A new figure was introduced so the Makefile had to be adjusted
to include that figure. The figure resides in the figures
directory of both the dev-manual and the mega-manual.
(From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The author of the book was still Intel Corporation. This
needs removed. I replaced it with "Scotty's Documentation
Services, Inc.".
(From yocto-docs rev: 14f1df18210a3dcb4b7174ddcad551aa9141696d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on the devtool workflow in the dev-manual was 99%
identical to what was in the sdk-manual. I have moved the
workflow procedure from the old "Model" chapter of the dev-manual
to be merged with what was in the sdk-manual. In truth, the
only things added were a note about devtool not being exclusive
to SDK development.
The result of moving (deleting) this section was that the "model"
chapter of the dev-manual went away. The devtool stuff, Quilt,
devshell, and python shell are all out now and there is no
chapter left. So, mega-manual had to be adjusted to not pull that
chapter in when building the dev-manual. I had to delete three
figures that were used in the flow. The figures were already
replicated in the sdk-manual. The figures were deleted from the
figures folder of both the dev-manual and the mega-manual.
I had to make sure all references to the old devtool stuf in the
YP doc set were adjusted.
(From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
These two sections can stand alone as tasks. I moved them to the
"Common Tasks" chapter.
(From yocto-docs rev: 60c810a9682f8a110fe7c7e4d0d40583a7d72735)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on useing Quilt can be a stand-alone task. I moved
it to the "Common Tasks" chapter.
(From yocto-docs rev: bb84b88fc8fc7f82e7bbe580d408ae7880f38d8b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This section can stand as a separate task. I have moved it to the
Common Tasks chapter.
(From yocto-docs rev: e4fb1ce8b160528aae0f192add614a595b2560a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some general cleanup and formatting.
(From yocto-docs rev: 8d4458f8fbe02cb8bfa78cbf18726cdd8126850a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The overview section of modifying the kernel needed to be in the
kernel-dev manual and not in the dev-manual. I moved it and took
care of all the links and external references throughout the YP
doc set. One figure was involved that had to be moved to the figures
folder in kernel-dev from dev-manual. That is why the Makefile had
to be edited.
(From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11731]
Updated examples to so they checkout by tag rather
than by branch name.
(From yocto-docs rev: 9dca9fdc315998612f4cd5c9c69e2b3e045562ad)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable: METAINTELVERSION and META_INTEL_REL_TAG
and DISTRO_REL_TAG
(From yocto-docs rev: f8be6ea137df9b5964e2cc3fed43cda39a3d27ec)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section that presented the Yocto Linux kernel file structure
resulting from a build using BitBake needed to be in the kernel-dev
manual. I moved it over. This required transferring over a
figure as well.
(From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section in Appepndix A was full of redundancies used to
explain how the Yocto Project kernel development team has set
up branching and kernel architecture. I consolidated a couple
sub-sections into just the necessary single section.
(From yocto-docs rev: e42efe28aec6bad3779c4b9ea58941272fb01651)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Appendix A of the kernel-dev had a subsection dedicated to just
saying Git was the SCM used by the YP team for development. Having
this information in a dedicated section was overkill. The information
is better as an "aside". I put the stuff in a note.
(From yocto-docs rev: 7e28686f946188daaf0480d4cd68e0e8ff854d37)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The information in the dev-manual kernel overview area really neeeds
to be in the Appendix on kernel structure in the kernel-dev manual.
I moved that informtaion to the appendix. Removal of one redundant
image was necessary from the dev-manual. The figure was literally
repeated in the kernel manual already under a different file name.
(From yocto-docs rev: 00ca68e760e41448c225fb1ca4a77f5201434b93)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I took the Yocto Linux kernel overview list of kernels out of the
dev-manual and moved them to the "Yocto Project Kernel Development
and Maintenance" section in Appendix A of the kernel-dev manual.
This is a much more logical area to introduce this type of Yocto
Linux kernel information.
(From yocto-docs rev: 0a5154cb4c23697f2b8e2341c8e1dc07362443d2)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Took the small reference section out for developing an image
using toaster. This was just a pointer to the toaster manual.
(From yocto-docs rev: 8dcce4411aaa5d1d8fe2c809166a947d0e38a97b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This section simply pointed to the SDK manual. Does not
need to be in the new "how-to" form of the dev-manual.
(From yocto-docs rev: 1cd842a323ba09ef69e14f56dca1c2a5576252ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put in some edits to be very clear on the state of the files
for the user when they check out by tag.
(From yocto-docs rev: 622d324e7f167f55a5de86ec7af65d7554f2aec8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Re-wordings to be clear about what the user is getting when
they check out a development branch of an upstream repository.
(From yocto-docs rev: deb6ecfd35a76760bc2270bbbc69aa232b0c8cc7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Clarified wording so reader understands they are checking
out the master branch by default.
(From yocto-docs rev: d1e77fff752d9960120340601bc2520c51c4f073)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Manual style dictates use of bold lead-ins for a numbered list.
(From yocto-docs rev: 32469dc0d61d755d0119a0374070221b0bd4bdfb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Manual list style requires steps to have bold lead-ins.
(From yocto-docs rev: 2d226cf6710853f7be8f0c3bd8b1eea72cb4eb7f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Formatting style need bold lead-ins for steps.
(From yocto-docs rev: b75337188e2346dd40004e22b45a2975f1d4cff3)
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]
Moved this section from the "Getting Started with the Yocto
Project" section. The topic is not really a getting started
topic. It is better suited in the "Common Tasks" chapter.
(From yocto-docs rev: d6cdade9066bdbce0596672978c178d2ec82c9a4)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I re-wrote the "Building Images" section into a "Performing
a Simple Build" section. A single link in the common tasks
chapter was affected by the section name change.
(From yocto-docs rev: de5a4cfa4f63538fe0a5ec0c2aacfb9222b70c4b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Was referencing the "Building Images" section when should have
been referencing the "Images" section in the ref-manual.
(From yocto-docs rev: 7340b358d57c110240e75c1164226144065120b7)
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]
Added a new procedure section for using the Downloads page from
the YP website.
(From yocto-docs rev: 7efb29dfa7a0960710ca7cf3983048f166c6a13f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This addition allows an author to use the following form to
highlight a paragraph in red.
<para role="writernotes">
Blah Blah Blah
</para>
(From yocto-docs rev: 40d646229e5ec9fa905a372be795120449f9f9dd)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I have added a new procedure on using the Index of Releases area
to get snapshots of various tarballs. I recommend that is not
the way you usually want to get files as using Git is recommended.
The section exists for completeness.
In the ref-manual, I cross-reference the procedures from the
associated conceptual areas.
(From yocto-docs rev: 812f344966966591d883fbebb4ae1f72c11dd483)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I created a new procedure for locating and viewing YP source
repositories using the GUI-based method. Created an anchor in the
ref-manual so I could reference the 'git clone' command.
(From yocto-docs rev: 2ae28682407039420f4fcca71a298e1dd34c81f0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
To move toward a "how-to" dev-manual, I am consolidating procedures
for locating and establishing local copies of YP source files into
a single heading. I set up a "Working With Yocto Project Source
Files" section. This will contain sub-sections to find the various
areas of YP files and how to clone and check out stuff.
(From yocto-docs rev: 87ff4ee41a50e8aed6b9c5402c51bb47f5a252a3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This material was being replicated across the Quick Start,
dev-manual, and ref-manual. I have created a single point in the
ref-manual that collects the disparate information that existed.
I deleted the entire section in the dev-manual since that book
is converting to a procedure manual and the very front of the manual
adequately mentions YP and provides pointers to where the user can
get more information.
The QS provides a more complete introduction of YP since it is a
QS.
(From yocto-docs rev: bd8093417af2d93556410d5482dad32c11a0a964)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11699]
Configuration example didn't work with "" around
baseurl. Removed "".
(From yocto-docs rev: c40d818fb92904b74e677749ee16c52716dd02a9)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added detail to the procedure about pushing a change to a
contrib directory and then requesting a pull using the scripts.
More detailed with examples.
Also, clarified some wording in the section about submitting a
patch through email.
(From yocto-docs rev: 76a358ba588b0f36d14aef0a68efe30c4e16746a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Example was incorrect. Fixed it.
(From yocto-docs rev: 7ae1c636e7a8c0448515f339476327bcaf21e63c)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
I updated both the introductory sections of the ref-manual and the
dev-manual. These need to work more tightly with the projected
YP documentation set.
(From yocto-docs rev: 6a28537d03fad8a53198edc7f9a6229f4e58e551)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I want this first section to be titled "Welcome" rahter than
"Introduction." It is more in line with the YP QS and the YP
ref manual.
(From yocto-docs rev: 113b82c589c93a33a2a956790668e8c0a28894ec)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the bit about using a VM if you don't have a Linux
machine to a note as it broke the natural flow of this section.
Also, inserted a link to the comprehensive list of links and
other documentation references to the existing list of
other information.
(From yocto-docs rev: 73750063580ef7bc20bd445adc3e2b0b01e2257f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed from "Pah-key" to "Pah-kee", which is more universal
and also matched what is used in the dev-manual terms section.
(From yocto-docs rev: 843e832f2416b0e3b0e9d941bf7755f206517603)
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]
Extensively updated the development environment section by
creating a task-oriented section.
(From yocto-docs rev: d440f0b5ceb1aca57a73d8bced515ae0bd3188f7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The section on how to submit a change was pretty much a procedure
section. I did some rewriting to make it more that way.
(From yocto-docs rev: d7edce9268ee5cae96c09c79fe34d5d2dbb701e0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered a mis-placed block of DocBook text that was
causing the string "bug-id" to appear in a random spot in the
"Patch Submission Details" section. Re-ording this block
fixed the problem.
(From yocto-docs rev: 6cf0e8ff0d2b176c1faf492c7bdd7d38e23e4c98)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
OE native script now requires a native tool as part
of the command line. I added that to the example.
Removed a bad help command at the end of the section.
(From yocto-docs rev: 5eb965ea51d669ee3bac01050b42bee984572199)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list of supported kernels was out of date.
Edited with updated information.
(From yocto-docs rev: b287f76905637834ec6342285b99abd2c5594597)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
This new section has three new procedures for now: 1)
cloning the poky repository, 2) checking out a branch
based on an upstream repository branch name, and 3)
checking out a branch based on an upstream tag name.
More to be added for other key repositories.
(From yocto-docs rev: 4cbcd952ba395b19be5374470a95630a4bc6ffa7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some formatting and some links
(From yocto-docs rev: a0881588fcf2314b6d7bcbfb7ee9b9d4d7a2ef2c)
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]
I moved the "Workflows" section to the ref-manual. This section is
primarily concepts and needs to be out of the dev-manual, which
is being reconstituted into a "how-to" manual.
(From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For development purposes, static libraries need to be
present only in the SDK. We do not need those static
libraries in the image for most scenarios. So, replace
IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation.
I updated the note to reflect this.
Suggested-by: Maxin B. John <maxin.john@intel.com>
(From yocto-docs rev: c05458c6614c38961d23db8f894d542bf93dbf09)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moved the "Licenses" section from the dev-manual to the ref-manual.
The information in the section is purely reference material and
does not belong in the dev-manual, which is being reconstructed
as a "how-to" manual.
(From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
I removed the sentence about throwing an error or warning.
(From yocto-docs rev: cfa3b1559122ec9e927ccd34afa0e26e877486f9)
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]
The "Open Source Philosophy" section that was in the dev-manual is
really conceptual reference information and has no place in the
dev-manual, which is being re-written to be a "how-to" manual. I
moved the section into the new "ref-development-environment.xml"
chapter.
No links were affected by this.
(From yocto-docs rev: 0a3e65bf7a23eec6e36a3cda3c2011b70aef325b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
The ref-manual needs expansion for the old "closer-look" chapter.
This chapter previously held a detailed look at what happens when
a user uses the YP to develop something. Now, the chapter needs
to also contain YP development environment concepts (e.g. open-
source philosophy, etc.), which are coming from the dev-manual.
Because of this, I renamed the "closer-look.xml" chapter to be
"ref-development-environment.xml". I also renamed the larger
section that was formerly the entire chapter into its own section
named "Development Concepts".
Both these changes caused a few links to break. I fixed all the
links from within the various manuals so they would find appropriate
targets.
I did some re-writing for introductory material to introduce the new
chapter and the section on "Development Concepts".
A new file ("ref-development-environment.xml") was added by basically
renaming the "closer-look.xml" chapter. And, the tracking for
"closer-look.xml" was deleted.
(From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some changes to better introduce this reference manual.
Clarified the best scenario for using the manual. Removed the
long list of manual descriptions as that can be referenced further
down in the manual.
(From yocto-docs rev: 8f4555aa387ab3bd3f90f5fcda1d343811ecc168)
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 dev-manual to
ref-manual broke all the links to the "Source Directory" term.
I fixed them.
(From yocto-docs rev: d3a206b141e0b0c623362622ec73bbf44118071a)
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 a single link to the "build-system-term"
id. I fixed it.
(From yocto-docs rev: 51bbfbb6030a5298fde1dc0e6f67332cfa59fae2)
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 links for the "cross-development-toolchain" term.
I have fixed these.
(From yocto-docs rev: f2d2b5936bd339d691ab859cbe3df86e3da58f0c)
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 caused many links local to that section to be
incorrect. I scrubbed the section and fixed all the links.
(From yocto-docs rev: 4b795159aa80184f26ff1181a564516840c373b2)
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 #11630]
The exhaustive list of useful links and references to other
YP documentation existed in the dev-manual. This is not the correct
place for this type of reference information. I have moved that
list to the ref-manual where it should be. The dev-manual now
simply provides a link into that section.
(From yocto-docs rev: eeceb597988134ced85aab4b9ddaeed923f17b03)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Reorganized the way the information about entering bugs using
Bugzilla is arranged in the documentation set. The dev-manual now
has a section that is purely procedural and steps the user through
the process of logging a new bug in the Bugzilla system. The
ref-manual has a conceptual section that introduces the YP
implementation of Bugzilla by simply telling the user what it is
and what what its purpose is.
(From yocto-docs rev: 4bfba345010be7bc2866b819b9754bb06f93c91f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The introductory paragraph for this figure was a cut/paste
problem from previous devtool figures.
(From yocto-docs rev: c02a2a57889bbdcd7e83ab9e2458397189bbb980)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Warning in step 5 indicated the wrong location for config file.
Updated with new location and referenced an illustration to
show an example.
(From yocto-docs rev: e853e5b89f1dbd7399909064b50bc59e06302560)
Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This paragraph had some links to old stuff. Removed the whole
paragraph.
(From yocto-docs rev: 95c1f348ed018c697cc996bc962787ede056b94b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This figure was a bit out of date. I updated a few of the file
names. Figure needs to reside in the Figures folder of both the
dev-manual and the mega-manual.
(From yocto-docs rev: 1e76477810b6be095f9ca190c9a8f0276ee4b8f9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the git config file to ~/.gitconfig
(From yocto-docs rev: 0d4f43944b911ee23dd03b5f503173478d6c396d)
Signed-off-by: Scott Rifenbark <scottrif@buzzcollectivemarketing.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes how to create a patch and send it via
email is really an ordered procedure. I recast the list of steps
using numbers instead of bullets.
(From yocto-docs rev: c2d2256ca6d8c8b837bae87a5bd8a3118553935c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Removed the example. It was not needed.
(From yocto-docs rev: 402bb173b00a665fb55a8f740a4dbe60ead57f25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11411]
Added a naming convention warning to the native.bbclass description
that is similar to the existing warning used in the description for
the nativesdk.bbclass.
(From yocto-docs rev: 2ceeb5416d439197e94640229e3685ab8b87e0fb)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
"configure" and "cmake" are not do_* tasks of BitBake. I updated
the formatting of these programs and removed links that were to
the tasks in the reference manual.
(From yocto-docs rev: 2605c7378f6b4b49c2e2baaf159fd2c289d83a1a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure that Scott Garman used for an old video cast is
much more appealing to the eye than the giant, square beast
the current manual was using. I have replaced the image.
The image is technically the same.
Because the mega-manual has to use a duplicate figure, I
put the new PNG files in the Figures directory for both the
yocto-project-qs and mega-manual books.
(From yocto-docs rev: ed64810e59110418d49fb6d3e61967fa62ab28c8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP doc set was using a link to an out-dated video that
showed how to configure and run Eclipse. The video was very
old and Jessica suggested just removing it. So, I replaced
all occurrences of the link to the up-to-date appendix in the
SDK manual that provides information on the latest supported
version of the Eclipse IDE.
(From yocto-docs rev: b4af1a79078352df5558e20c0b9cfa97fa141abc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link to the section on how to set up Eclipse had been broken
for a while. I fixed the link so that it goes to the appropriate
section (appendix) in the SDK manual.
(From yocto-docs rev: 873c2c53f661b18936595068d75b954e07774621)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated poky.ent to use 2.4 variables and numbering
Updated mega-manual.sed to use "2.4" string for links
Updated all manual revision tables to use "2.4" and
"Usually October, 2017" string.
(From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11600]
Made some technical corrections to the PACKAGECONFIG_CONFARGS
variable description in the glossary.
(From yocto-docs rev: c422783984748f170943eab418bfa7d0111fa352)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
Added a new description for the LAYERRECOMMENDS variable.
(From yocto-docs rev: 3004a5724c4ea7165e4f749f9c9237ee1fbd89f5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11579]
The syntax for specifying a layer version was incorrect. I
have added an explanation for the correct syntax and provided
an example.
(From yocto-docs rev: 5703fb2f8b9d3df408c596603b8b8416597fc67a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9001]
Updated the image-live class description to specifically mention
creating *.iso and *.hddimg images as "live" images. Provided more
explanation about usage through the NOISO and NOHDD variables.
Also, provided a cross-referencing link back to the updated
image-live class from the EFI_PROVIDERS variable.
(From yocto-docs rev: 788061b2911339c8396b798a0ab5635ab5bb89e1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11498]
I enhanced the description of the INHERIT variable's glossary
description to provide more detail. I also included a link into the
section of the BB manual where INHERIT is described.
(From yocto-docs rev: 663cde3cf05ebf564ff3a28cd37b696be2f91ad8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This scheme has changed due to recipe-specific sysroots making it
obsolete. Removed the entire section.
(From yocto-docs rev: c52a896829212863402e5532dd8fb7fe4c247fca)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The BB_SETSCENE_VERIFY_FUNCTION2 variable no longer exists. I removed
a link to the BB manual to this variable description, which no
longer exists. Also, removed a paragraph in the discussion around
setscene that talked about the variable.
(From yocto-docs rev: 1f8e3d53ee72c369cb1211332e074976737fd76b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This should be "gdbserver" when referred to generically.
(From yocto-docs rev: 83b2be50e34b0c07cce1f27b55e595752b80b3ea)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These depend on context. In general, "DNF" is the preferred
terminology unless directly referring to an application or such.
(From yocto-docs rev: 29012a8f8e21b964e1ea6d32841dffa8dae7df9f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed to add cross-links into the glossary for various variables.
(From yocto-docs rev: 45acf78a2f99e8fda91042c2bee30094255e5a10)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Entry added for HOSTTOOLS and HOSTTOOLS_NONFATAL.
(From yocto-docs rev: c766920a13071c1bb46a195ea07be38962d2e12d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11411]
To help clear up the importance of the naming convention a user
must follow when creating a nativesdk-myrecipe.bb recipe that
inherits the nativesdk class, I placed a warning note at the end
of the section for the "nativesdk.bbclass" section.
(From yocto-docs rev: e6dc512aaeb0267c2c15c17a599c6950728b4547)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
Added the "iputils-ping" package to the list of essential host
packages.
(From yocto-docs rev: c6478419940405091d59312d22c45e3f32f9c94d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
Added this package to Ubuntu/Debina, Fedora, and OpenSUSE.
(From yocto-docs rev: e010d1abc083ed064c5340146bcac213286d973c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
I implemented various wording changes based on feedback from the
review. One section title changes so some links in the ref-manual
and the dev-manual needed updating as well.
(From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11310]
After a bit of deliberation.. it was decided that
"python3-expect" is not needed in the Debian, Fedora,
and OpenSUSE distros as an essential package. They are
gone.
(From yocto-docs rev: 07fcb23a03122e5f4f9bb2a32e585d9cba7d5d93)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes covered several areas. Version 2.3 of the YP now supports
recipe-specific sysroots and is not limited to machine-specific
as was prior releases. Manual changes were as follows:
dev-manual: "Sharing Files Between Recipes" - Wordings were changed
to support the new functionality.
ref-manual: do_prepare_recipe_sysroot task added to the list of
tasks described in "Configuration and Compilation".
ref-manual: Extensive re-write of the "staging.bbclass" section.
ref-manual: Added a section to the build structure for
build/tmp/work/tunearch/recipename/version/. This section breaks
down the recipe-specific subdirectories used to create (stage)
the sysroot.
ref-manual: New section (entry) for the do_prepare_recipe_sysroot
task in the task chapter.
ref-manual: Added a variable glossary description for the
SSTATE_SCAN_FILES variable.
In addition to these changes, I sprinkled in a liberal amount
of cross-referencing for the readers pleasure.
(From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
I applied some revisions to the related sections for incrementing
a binary package version and revision sections. Mainly clarified
terminology and pulled the sections into one single section head.
I also cleaned up referencing to all these sections throughout the
YP manual set (i.e. the ref-manual).
(From yocto-docs rev: 7deda18dd496cc383c5de71a10f2b11b1ca0688f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10995]
For the dev-manual, I added a new section on incrementing package
revision numbers that explains how the build system uses various
variables to create linearly numbered revisions for packages.
For the ref-manual, I cross-referenced into the new section from the
AUTOSRC and SRCREV variables.
(From yocto-docs rev: 53c3092e0f0293f4db0a88659abb4cf1c93f208c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8596]
Added a new section to describe the right way to use headers to
interface to a device or custom Linux kernel API. Too often a
user wants to modify the libc header file, which absolutely wrong.
This new section provides some guidance.
(From yocto-docs rev: 960c49bf6446398a9efb2d018d09d63b49e97196)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11274]
When a post-installation or pre-installation script uses tools that
have dependencies, you need to specify the tools using the new
PACKAGE_WRITE_DEPS variable. I added this information at the end
of the "Post Installtion Scripts" section in the dev-manual.
I also added a new variable entry for the PACKAGE_WRITE_DEPS variable
in the glossary.
(From yocto-docs rev: 4d130b63cba5ebabd4af52b62421d387a4b54353)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10887]
I placed a small paragraph at the end of the introduction to the
"Performing Automated Runtime Testing" section that points into the
new section on QA and testing infrastructure in the ref-manual.
(From yocto-docs rev: 493051e1770e07b89c19a1f235f1dd226610c77a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10887]
There needed to be an overview of the test and QA infrastructure
used by the YP development team for releases and that is visible
to the developer. I added a new section for this information into
the existing section on YP release processes.
(From yocto-docs rev: 17b3d6898b37bdbfbd23a333a4d659a9746696d0)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10596]
No information existed for the version 1.0 YP Compatibility Program
for layers. Additionally, the version 2.0 flavor is adding a script
as part of the application process. I put in a new section on the
whole topic. Also, integrated the information into relevant sections
with some cross-referencing.
(From yocto-docs rev: 6341705d4c08901b2657c489f4e995968db00d85)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10854]
Feedback from the review indicated that CentOS python3-pip and
python3-expect should be python34-pip. Did this change.
(From yocto-docs rev: ae307a183328b3c572e3f63c0274806af244c618)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9675]
I missed one occurrence of changing "smart" to "dnf" in the
Enabling Tests section. Corrected.
(From yocto-docs rev: b5106c7a38f51dbfea6d200072039f624be7ed3a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10350]
Based on Henry's assesment that the wording was unclear in some
spots, I did a little smithing to try and help.
(From yocto-docs rev: b52bb8d73071ad6b7a0956dec2f84a84ae1c7045)
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 #9675]
Various fixes to replace the "smart" package manager references
with "dnf".
(From yocto-docs rev: 721dc7fb637c4c03534eb19f61b0b08a7303826d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10898]
I altered the verbiage used to describe the inclusive nature of
the beginline and endline note to be clear to non-native English
speaker based on feedback.
(From yocto-docs rev: 5edf417cd044ded30d1f8366ac0cde336d0da016)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10854]
I added extra "yum" commands and a make command to deal with
some essential packages needed for CentOS distribution. These
packages were missing.
(From yocto-docs rev: 38ac6cf0165f7dd7bbfd583e218b6948dafae29c)
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>
The section in the dev-manual that introduces BSP Layers for the
first time was missing a general link to reference into the BSP
Guide to help the user understand BSP Layer structure. I added
a note.
(From yocto-docs rev: c515e30a551e96e11091c3850f7eed1b034abdad)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and
"Pyro", respectively.
Manual Head Files - Updated the manual history table with the
May release month.
(From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10898]
It is hard to get the exact start and end for included license text
during a LIC_FILES_CHKSUM operation. I updated the notes indicating
that the QA message returned upon failure includes the attempted
license text. The user can better adjust his LIC_FILES_CHKSUM
statement to then dig out the proper text.
(From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11017]
There is no current way to specify or list plug-in dependencies
when building a Wic image. The variable WKS_FILE_DEPENDS was introduced
to allow the user to use this in the recipe building the image.
I added a description and example of the variable to the ref-manual
variable glossary. I also cross-referenced the variable in the
"Plug-ins" section of the dev-manual to point to the variable for
more information.
(From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
