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>
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>
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>
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>
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 #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>
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 several links to the id "build-directory". I fixed
these to reference into the ref-manual now.
(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #11630]
Moving the "Yocto Project Terms" section from the dev-manual to
the ref-manual. Doing so caused all the links to the id
"bitbake-term" to break. These had to be individually fixed.
Discovered two unresolved references that were a consequence of
moving that section to the ref-manual. These were fixed as well.
(From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #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>
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>
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>
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>
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 #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 #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 #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>
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 #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>
Fixes [YOCTO #11048]
No documentation existed for telling the user how to create signed
RPM packages or for how to use signed package feeds. I have created
a new section on the topic to describe both scenarios.
(From yocto-docs rev: cbdde75f06b1fc190b8e4f7f93f302dc238e3e7f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section "Maintaining Open Source License Compliance During
Your Product's Lifecycle" had a vew minor typo things (e.g. duplicated
word and some formatting issues). I fixed these.
(From yocto-docs rev: 67beb658445e79129d8aae1739bb33c000367107)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10076]
The note on the title page for each manual was brief regarding
where to find the latest version of the manual. I updated the
note to have more detailed information on finding current,
alternate, and latest versions of the manual based on YP
releases.
(From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10905]
I updated the section with suggested improvements for completeness.
The section has been broken into more subsections and provides the
reader with more direction on mailing lists based on components
changed.
(From yocto-docs rev: f7c9010c14d96c64d00ca32e2e217d2dd1343919)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 98ebe9acccceea2b833c1372a3e664befd1b6aef)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10621]
bmaptool is integrated into the OpenEmbedded build system but is
not documented. I added a new section describing how to flash an
image to media using the tool. Also, updated a small section in the
Wic part of the manual that used "dd" to flash an example. I added
a bmaptool counterpart here and referenced the reader back to the
main new section.
(From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
Applied a couple review comments to the section to clarify where
to set key variables. Also fixed an incorrect variable name used
to specify the *.cpio file.
(From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10763]
The final example in the section describing how to create
the base recipe using receipetool create was wrong. I updated
it to use the -d option in addition to the -o opetion. I also
changed the description to match appropriately.
(From yocto-docs rev: 8cc6d5e21532eeaac0e6d9ace3e0b58803a9804e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7096]
We did not document how to create an initramfs image to be included
with a kernel build. Various variables sort of inferred the
knowledge. I created a new section in the "Common Tasks" section
of the dev-manual that describes how to create an initramfs image.
Also, I updated the kernel.bbclass reference section to point back
to the new "how-to" section.
Finally, I also created a bunch of cross-reference links from various
related variables back to the new "how-to" section.
(From yocto-docs rev: 289dfbd5d24241e42446a043104eecd6dca76f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term was incorrect and I have replaced it with the
term "partitioned."
(From yocto-docs rev: 50dd5c6994a2f799fdaf1ccbf7138b0074e981ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
new information on how wic works
(From yocto-docs rev: 7b6a54a593a678442541b1fa6847498a792183c7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10351]
I added a note to the "Post Installation Scripts" section of the
"Writing a New Recipe" section to call out the fact that the
RPM package manager will not install packages on the target when
any RPM post-install script returns a non-zero exit code when
the script is run on the target.
(From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10692]
I updated the STAGING_DIR variable description to have a reference
to the SYSROOT_DIRS variable as well as the "Sharing Files
Between Recipes" section of the dev-manual.
I also updated the "Sharing Files Between Recipes" section so
that the role of SYSROOT_DIRS is explained and actually used
in an example to add another directory.
(From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changes to the following:
* All manual revision tables to indicate a 2.3 release proposed
for April of 2017.
* Updated the poky.ent file so that all variables needed reflect
2.3 values.
* Updated the mega-manual.sed file so that processing of links in
the mega-manual work for a 2.3 release.
(From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string appeared in the text as "$(INC_PR).0". So, fixed
it to be proper with the curly braces.
(From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #10588]
This section was confusing due to the fact that it used an actual
set of IP addresses and image name where they should be clearly
called out as examples. Fixed it.
(From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new section in the "Common Tasks" chapter to support
the fact that BB can now build for multi-configurations.
(From yocto-docs rev: aa21aeb2f3d2f9d5a3a6e7175b7c6f13da5f608e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed [YOCTO #9481]
Complete re-write based on Mark Hatle's steps. I converted
from sub-sections to an ordered list.
(From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
Moved the last bullet item from the list that was about
DEPENDS to a note form above the list. This was done because
the stuff for DEPENDS is more general.
(From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10392]
People often needlessly put [noexec] on tasks, making the recipes
more complicated than they need to be. I updated the first bullet
item in this section to more clearly explain how to do this.
Also, added a new bullet item to the end to point into the DEPENDS
variable for more clarification.
(From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added string "October 2016" as the release date.
(From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10360]
Added a new section to reference into the OpenEmbedded Styleguide.
This will help people writing new recipes to conform to known
styles.
(From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
In the examples, I changes "IMAGE_FEATURE" to "IMAGE_FEATURES_append"
(From yocto-docs rev: 3fc2cc217a0a67b3e0739c6a235ab8e350c4b7c3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO 10323]
Made a code change to the example script that helps a user
locate GPL files.
(From yocto-docs rev: bd02012de75f0c30887d3a5bb4aa219703a3ee1c)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10323]
In the Providing the Source Code section, I replaced the 3-line
code example that returns GPL files. The bits I put in are a
script that does the trick. The 3-line example was not working.
(From yocto-docs rev: a07873d46b5135555961499c6ce8f0b6b8bf2c8f)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9166]
I applied some review comments to the section. Pulled some stuff
out that did not apply.pdated the devpyshell section
(From yocto-docs rev: 7300358570de4da94ff5f22afd30128ef8dd0f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I applied some review comments for the section on using GDB
on the target for debugging. Included a new note on optimizations
considerations.
(From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9166]
In the dev-manual, I added a new section titled "Using a
Development Python Shell." This section is similar to the
section that talks about using devshell. The section is
tied to a reference section on the do_devpyshell task.
In the ref-manual, I entered a new task reference for the
do_devpyshell task. It is brief and references into the
new section in the dev-manual.
(From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9554]
I added a new section titled "Debugging with the GNU Project
Debugger (GDB) on the Target" that provides requirements for
this type of debugging.
(From yocto-docs rev: 5d15c6c5f2030395f9faea8a5ef3ead1b98042d8)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9285]
Altered the wording to more accurately reflect the issue.
(From yocto-docs rev: 66cda9997a6c17752903a0b5600fb8cae98566e9)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8631]
These fixes cover the following:
* New glossary entry for SYSROOT_DIRS
* New glossary entry for SYSROOT_DIRS_NATIVE
* New glossary entry for SYSROOT_DIRS_BLACKLIST
* New section titled "Sharing Files Between Recipes" in the
dev-manual's "Writing a New Recipe" section.
(From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
