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: 92616f73ce31505e11f3193b1350acc875003649)
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>
Occurrences in many manuals and one figure.
(From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences
of the DISTRO_NAME variable had to be checked to see if they really
should be using the "NO_CAP" variable instead. Output and actual
branch names are case-sensitive.
(From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The term "meta-toolchain" is legacy now. I went through and removed
its use except for where it appears still as output from the
oe-init-build-env script.
(From yocto-docs rev: 1cc134060459278997d57f1293f54091c5404d85)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Removed some eMenlow stuff
* Cleaned up the description of the BSP structures we have now.
* Various links fixed into the SDK manual.
* Other minor fixes.
(From yocto-docs rev: 5e45005d7ff2254df2754a5ea2d7efd7f1c19a42)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was a complete re-write of the YP Quick Start in an attempt
to streamline it, remove unecessary detail, and make it flow better
with the examples. In doing so, many manuals were affected due to
section headings being renamed, information being moved, etc. Here
is a list of the changes by manual:
Makefile - Removed two figures from TARFILE list for the
yocto-project-qs.
Added building-an-image.png to the ref-manual TARFILE list.
Added using-a-pre-build-image.png to the adt-manual TARFILE
list.
Repositioned 'eclipse' in the adt-manual TARFILE list.
adt-manual: Fixed a cross-reference so that it goes to the new
'Building Images' section that is within the YP QS.
Added new section 'Example Using Pre-Build Binaries and
QEMU' to hold the information that was formerly in YP QS.
dev-manual: Removed a cross-reference into the YP QS that promised how
to configure the most efficent build.
Changed a cross-reference into the YP QS from 'The Packages'
to 'The Build System Packages'.
Changed a cross-reference into the YP QS from 'Building an
Image' to 'Building Images'.
Changed a text reference from the YP QS to the adt-manual.
Moved the bit about getting YP files by using the YP website
from the YP QS to the dev-manual.
Changed a cross-reference into the YP QS from 'Using Pre-Built
Binaries and QEMU' to 'Example Using Pre-built Binaries and
QEMU', which was moved to the adt-manual.
ref-manual: Changed a cross-reference into the YP QS from 'What You
Need and How You Get It' to 'Setting Up to Use the Yocto Project'.
Moved the note about if your system has oss4-dev in the
packages area in the YP QS to the appropriate area in the
ref-manual.
Moved the introduction information regarding building an image
along with the figure from YP QS to the ref-manual's section on
building images.
toaster-manual: Changed a cross-reference into the YP QS from 'What You
Need and How You Get It' to 'Setting Up to Use the Yocto
Project'.
yocto-project-qs: Complete rewrite that changed many section headings and
removed much detail, which was placed in other manuals.
(From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This practice is not good. I had one in the manual. I reworded
the text to not use that term in a link.
(From yocto-docs rev: 53636ae7370827945b31d11785410dd44670bb91)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Repositories, Tags, and Branches" section had some wording
that described how branches are maintained in the poky repo that
made it hard to maintain in the doc from release to release. I had
a list of past releases by name and as such would have to update
it every release to make it reflect the last set. Well... this
is not the best way to do this and proved out as it slipped through
the cracks for the YP 1.8 release. Consequently, I recast the text
so it is "release proof".
(From yocto-docs rev: b6e27d06df58a43bb767e9616ccf3c0711e83cf6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some stuff about "poky" meaning the default distribution
when using YP and the poky git repository to build an image.
(From yocto-docs rev: bd534a5bdf405044c8f1a60ee9e251bff2a0e53c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added text to note how this term is used, what makes up the
OE BS, and how the term "build system" is used in general.
(From yocto-docs rev: 2af0a59a84fd1cf6d23db29f470cb5644f962746)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list of terms had a "build system" term that basically
described the OpenEmbedded build system. I dumped this entry
in favor of "OpenEmbedded build system." I updated the term's
description to cover the generic term "build system" for no
confusion.
(From yocto-docs rev: 0ada8348a2ace6ce99e640d1c1f21812188151d5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I applied (in spirit) the changes here... Some literal and some
with changes.
(From yocto-docs rev: 0ccf8a43264981accbe42f729c723804e5b69b72)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Replaced angled bracket items for user-supplied variables
with the <replaceable></replaceable> tags.
(From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the creation of the new chapter that documents the 51 tasks
defined by the OpenEmbedded build system, the dev-manual had
many first-instance occurrences of do_* task names that could
be cross-referenced to the new sections. I have added these links.
(From yocto-docs rev: 78f91987b0ad9906571ec7888334301492361822)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2444]
Several areas affected by the reference BSP "beagleboard"
being replaced by "beaglebone".
(From yocto-docs rev: 2f02b570e1ebcf0469871b67a029b65fa8b285f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did not eliminate this variable but rather changed the description
to indicate that it has been deprecated and that the user should now
use a PR Service to do this stuff. There were several areas in the
YP manual set that used the variable in code. I just deleted those
lines from the code.
(From yocto-docs rev: 88a075e6306349e5f8c0d53b5288ef1e64956cd3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5442]
Updated the TMPDIR variable to call out the scenario where a user
might want to separtely set TMPDIR to a local drive and thus be
able to have the Build Directory on NFS.
Updated the "Build Directory" term with a note indicating that by
default, TMPDIR is inside the Build Directory and thus cannot be
on NFS. However, the user is able to by-pass that per setting
TMPDIR separately outside of the Build Directory.
(From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4601]
Added a couple notes saying that you need to be in matching
branches for meta-intel and poky.
(From yocto-docs rev: 02bd63829b1d98f21183a10707753e9767bfe68e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The changes are a result of a detailed read-through prior to
releasing YP 1.6. The changes are varied and random.
(From yocto-docs rev: 04c09abf96a04c3ffeea8cdf7be8e1bb1b9055c6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to add a cross-reference anchor tag to the term in Chapter
3 and then the link itself.
(From yocto-docs rev: 227c8ce85f4a8e81f14582cdc7c54b5b832d3aa0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After adding "Package Group" definition as the original "Task"
definition, we needed to create a new definition for the term
"Task".
(From yocto-docs rev: b6eae9242bf488d3f086e496b52d8422ad31feb6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: faa7206b2f67a26c1366fe997cd092aed7e9f85e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The examples went stale. Two out of three did not work. I have
provided new examples that work.
Reporte-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0a3695f3f6a5b31617f4a5da960677f87733b825)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistent use of the way directory names were
handled throughout the YP documentation. I have scrubbed the
set and replaced many instances such as the following:
meta/<something> replaces /meta/<something>
poky replaces ~/poky (except in some very specific examples)
I basically got rid of leading slash characters.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ae2e451ed8f61484d04b30017021912c4493a441)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Partial fix to the tarball removal issue. I rewrote parts of
this term's definition to slightly de-emphasize tarball expansion
as a method to set up the Source Directory on the local machine.
(From yocto-docs rev: 2fb1e569129e9942ca4a99fe7f73de02ccbd1876)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
This is a partial fix to the removing tarball setup method issue.
I have modified the "Yocto Project source Repositories" section to
de-emphasize the tarball installation method for poky and meta-intel.
We cannot remove these obviously because the download page of the
website gives the use access to tarballs. Also, the Index of
Releases basically does the same thing. So, we can't ignore the
fact that they are there. So, I added a note basically saying we
recommend the Git method for creation of poky and meta-intel on the
development system.
(From yocto-docs rev: 7843ea5e592582f74a02536ec4057067c43eb507)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found a couple broken links. Also, noticed the yp-download figure
was out of date. Especially in the Figures folder of the mega-manual.
(From yocto-docs rev: 2e55faca221186d157dd5f77d048f1b2b90d5d91)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The main changes are captured in a new section devoted to the
oe-init-build-env-memres script within the ref-structure.xml
file and in the variables.xml file in a BBSERVER variable entry
in the glossary.
All other changes were necessary to integrate the new functionality
into areas where running the setup script are discussed. Before
this feature, there was a single setup script (oe-init-build-env).
Consequently, wordings and such were designed exclusively for this
single method. With the introduction of a second possible method
to initialize the build environment, tweaks to many sections were
needed. Beside the wording tweaks, appropriate cross-referencing
was also needed.
All these changes cover the integration of the new feature.
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4912]
Throughout the manual set, various areas talk about the Linux
distributions we support and the required packages among other
items that are tied to a distro. Debian had been missing except
from the list in the ref-manual that shows the releases we test
against.
I have attended to all areas where Debian needs to be mentioned
now.
Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: 2004567821add745d320106b0dc6cccb4f73b605)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered a random ":S" and ":" character in front of a
couple of list items. Must have been a wandering cursor
situation during an edit session.
(From yocto-docs rev: b81412e255ca90e850bce61ef7f9927692f0fcb5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Based on observations from the various mailing lists, it is obvious that
bugzilla issues are almost always referenced using square brackets.
(From yocto-docs rev: 10b51afe7db62b8eb6e29bd1dd1ba4edb4320f83)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This term description has been reduced to an introduction only.
The real details are now in the ref-manual. This term now simply
is introduced and the reader is referred to the ref-manual
section.
(From yocto-docs rev: 4d53a25e1871d793d5c38eba4d1f8715c989cb4d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The definition simply states it is sometimes used for
"Cross-Development Toolchain".
(From yocto-docs rev: 477c2f88694feb148111dc69907945d267056eaf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After a build, the license data is found in ${TMPDIR}/deploy/licenses not
${TMPDIR}/deploy/images/licenses.
Reported-by: Trevor Woerner <twoerner@gmail.com>
(From yocto-docs rev: 7f9b3d842f0f68bd0c005a20d38f1b26aef11387)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed the statement saying that checking out a Git repository
is a backup of the repo. Technically, that is not true. It would
be more of a clone operation. The statement was superfluous anyway
so I decided to remove it altogether.
Reported-by: Trevor Woerner <twoerner@gmail.com>
(From yocto-docs rev: 081bd0119f8c17a3932485857b6846dcb6998ee1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Tracking Bugs" section mentions how to enter a bug using
Bugzilla. I added a new step just before the step that says
to submit the bug that tells the user to be sure to copy the
correct people. The link goes to the section that describes
how to figure out who is responsible for code.
(From yocto-docs rev: 64e58402490267a339c9bade969850da50f39cf1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided three ways to dig out the information on who might
be contaced about a change or patch to an area of code:
1. See the "maintenance.inc" file.
2. Examine BSP README files or the MAINTAINERS file (for BSP)
3. Use the 'git shortlog -- <filename> command to see who
has committed the bulk of the changes for a particular file.
(From yocto-docs rev: 0757a2edddb55bcce2ea1507501220c3097f0a22)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Scott Rifenbark
Robert P. J. Day
Trevor Woerner
Trevor Woerner