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 section needed some more information. It referenced the yocto-kernel
script and menuconfig. I added references to the appropriate areas of
YP documentation for these. I also changed wordings to that it is
apparent that .config is created by menuconfig when changes are saved.
(From yocto-docs rev: bd1a3f6fa0268635f52bc77d9b35b5110b18a9f8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Adding Luna and dropping Juno. Pretty much went through the
"Working With Eclipse" section and dropped Juno and added
Luna. A major deletion was the BitBake Commander section using
Hob. Todor told me to drop this section completely. Note that
I also added a couple new YoctoProjectTools that appear on the
menu: SystemTap and yocto-bsp.
(From yocto-docs rev: b63ec6c706f41dc4666c2fd79d797962c35f8baa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I found a link that is processed by the mega-manual.sed file correctly
but for the situation it does not resolve right. The link is a
"naked" link. In other words, it doesn't have a #<tag> part.
When the .sed file sees these types of links, no hyperlink is
generated. I found a case in the dev-manual where I reference the
Toaster Manual in general and would like a link that would take the
user there. So, I had to add a #<tag> part to the link in the XML
(From yocto-docs rev: ab11e9822b5ec1b0f7138f1419ce9c340f6f27ad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I don't like these. I fixed it up.
(From yocto-docs rev: 2267fc3353563a249cc9bf16ec0bf4d5930ddaa9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I put this in the intro list for the section that presents various
ways to use YP.
(From yocto-docs rev: 05f924f799a1f1396bf7154b298aabc3d06ad1d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was incorrectly stated as 'bitbake -c install' in two
places. I substituted the correct string.
(From yocto-docs rev: fe54de82cff054d4319c635a0ddba2de7cc6ebd6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied review edits from Paul Eggleton.
(From yocto-docs rev: 4815556b6c9f45ce230afede7cb3b2aadf0bef1c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Trevor wrote a nice paper (tutorial) on the use of devtool that I found
to be very helpful in developing the information for this new workflow.
I decided to publicly credit this effort with a small footnote near
the top of the section.
(From yocto-docs rev: 97d234f2d535f85e5a50ac4e7f0c0a79579cd004)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul Eggleton reviewed the section.
(From yocto-docs rev: 82d9750b4349b3c54f73118ec7d65f0bb96e3f7a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Schedule did not permit support for Luna to complete. So, I
backed out the half-complete changes to support this version of
Eclipse.
(From yocto-docs rev: 1ca893766047f30ffbb0c99e51e575ea1302e7bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7460]
There was a single occurrence of specifically calling out that PR
needed to be manually incremented in the workflow section of the
manual. It was step 8 of the Quilt flow. I deleted this step.
Previous edits to the set have included extensive instruction on using
a PR Service, which is basically what replaces the need for manually
updating PR as it was in the past.
(From yocto-docs rev: d8db2175225be45cb3f2b4d11f8281c5b1f40ad4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7386]
Apparently, copying HTML displayed commands that have a
double dash created through "‐‐" in the docbook source
causes some issues in the shell. I have scrubbed the manual set
to replace any "‐‐" strings with "--".
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: e88b813b71d7d6d8acd8a8638f2db71265145b64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First edits to update this section to support the Luna version of
Eclipse. I weeded out Juno, which leaves Luna as the preferred
version and Kepler as a second version if they don't want to update
to Luna.
(From yocto-docs rev: 4f2dc237aa3498402cdf637ac2e85fdf0c3bf8a0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Modified the area from which the Eclipse Git repository is located.
This has changed.
(From yocto-docs rev: ec2bf4125877b28dae0681c8b578c7bebec5a5b6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These kernels are unsupported for the 1.8 release. They will still
show up in the YP source repos but the recipes are removed from the
poky area. Updated all references appropriately.
(From yocto-docs rev: a9adc071409fd31dabc3affec12350c300312600)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits help place the two sections within the new organization
that basically splits out the devtool and quilt methods as ways
of modifying your source code.
(From yocto-docs rev: 1dc2e8783d9774bb98a30e06d114f1c9bfb85b71)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Completed draft of the new devtool material. This commit affects
some linking and figures across the YP doc set.
* Added the build-workspace-directory.png file to both the
dev-manual and the mega-manual.
* Updated the Makefile to include the new figure in the TARFILE
for dev-manual and mega-manual.
* Re-did the section organization to pull the quilt and finding
source file out of the "Modifying Source Files" section.
(From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7029]
I was missing the "sysroots" part of the path. I added this
to the pathname.
(From yocto-docs rev: 077efc8063ed01ef4067f7e71912dd52c1f6a4a6)
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: ea4489f856417d70b54a7e38da32e068cbd54cbf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the second round of review edits from Paul Eggleton.
Minor fixes.
(From yocto-docs rev: 2c7c45c8f09b724e92e8b59fe47834226b44b4fb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the full set of first draft revision edits for the
new migration section for 1.7. Comments from Paul Eggleton.
(From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed the linux-yocto 3.4 kernel from the list in the
section describing which kernels we support. Also, added
the 3.17 linux-yocto kernel to the list.
(From yocto-docs rev: 41f57a9abe1201ed2fb657f8441c97f86f75200a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I replaced user-supplied variables with <replaceable></replaceable>
tags to get proper formatting. I inserted several references
to the new QEMU chapter for help using QEMU. I updated a note
on the BSP available so that it is a bit more generic and not so
dependent on an exact list within meta-intel and the source
repositories.
(From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The recipe should be named "foo_1.3.0.bb" instead of
"foo_1.3.0-r0.bb".
(From yocto-docs rev: c34c3ea05d550fc85ab04036856704a7c04fd64c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These types of references cannot span multiple lines. If they
do then mega-manual.sed will not process the link in the
mega-manual.html file.
(From yocto-docs rev: 8a06542c0f1fee503eda12052adddaaf9c94ca91)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I scrubbed the manual set for appropriate places to reference into the
do_clean* type tasks. Found and added several occurrences.
(From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was inconsistency on how we refer to a task name throughout
the YP manual set. The proper way is "do_<taskname>". Some
occurrences did not include the "do_" prefix. These have been
fixed.
(From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2444]
Replaced a couple instances where routerstationpro was found. This
reference BSP is no longer there and has been replaced by
edgerouter.
(From yocto-docs rev: 7ba629cc677310f04a17636e140142695242c5d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Fixes [YOCTO #5766]
In the ref-manual, I added "Eclipse" use in the title for the
"Graphics Support" packages because the "xterm" package is required
for graphics support across all distributions.
In the dev-manual, I specifically called out the need for "xterm"
as a host package at the top of the section describing workflow
with Eclipse. I also updated the cross-reference links to the
host package and Linux distro requirements to point into the
ref-manual, which is more comprehensive, than into the QS.
(From yocto-docs rev: d3405be506fcb113f01d4fcba4631db80a1ed5dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several items taken care of here. Of note are the retiring
of three BSPs (Chief River, N450, and sys9* stuff).
Also of note is that Kepler recommended version is now 4.3.2 and
not 4.3. The interface changed a bit as well in the section
for installing that stuff.
(From yocto-docs rev: 61bf82c1e68156d32a81e4c76dbb29db14665ffb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5814]
I placed a brief note in the section where it talks about adding
a project to an Eclipse project that states you can't use special
characters in the project name.
(From yocto-docs rev: a03b5849394a6ca3a787b444d95fa49b9db36dd5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the description to match that which is used in the
WORKDIR variable.
(From yocto-docs rev: 7d9071c2bb99e7c3f3eeae9ddf0abc34563c6725)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* is it technically correct to say there are now 5 BSPs? as in, does
genericx86-64 count as a new BSP distinct from genericx86? [aside: are
there any plans for a MIPS64 BSP?] - rpjday
MIPS64 is under development. - scottrif
* if scott is up for it, a couple more variables for the variable
glossary might be BASE_WORKDIR and TARGET_VENDOR, which i would have
added to that variable list but they don't appear in the glossary
- rpjday
Noted. - scottrif
(From yocto-docs rev: fae6f8baebedaa72f5e37b4f1a39a9accf9b196c)
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 #5203]
This was reviewed by Alex and an ordering change was needed due
to the order of how things are created during the workflow.
(From yocto-docs rev: 0c630fed9f9a609c1ca13359efe47cad6f60e00b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This site has disappeared and I don't think there is a
replacement.
(From yocto-docs rev: 711488b664e1da7f3a4c64af3fbd4012bfb44d56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Partial fix for [YOCTO #5368]
Updated the figure to not have the tarball method in there
for setting up poky repo locally. Also, added specific references
to the environment setup scripts.
(From yocto-docs rev: 7c6ececaf8eb987206567077f42213dbe4cdc4f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5203]
Adding a BB Commander project location that is the same as your
Eclipse workspace causes an error. I have added a note warning
the user to not do this.
(From yocto-docs rev: 0eca6618be8e4765b8513fb5951257ec17cdd355)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a step on making sure they have Oracle JDK in there
to the section that builds the plugin. Also, removed the
third method to install the plugin.
(From yocto-docs rev: cfd2b88717a709049155a8ff15134b617fc6e172)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
YP 1.5 default kernel is 3.10. This is a change from 3.8 in
the previous release. This change affected several areas of
the documentation.
1. The BSP Guide had a crownbay BSP structure that did not
account for the new default.
2. The yocto-bsp tool output still asked for the 3.8 kernel
as the default.
3. The recipes-bsp section had 3.8 used and had some bad
listings that had to be changed.
4. The recipes-graphics section had 3.8 used and also had some
stuff supporting two versions of the graphics (emgd and
noemgd). I had to pull the emgd stuff.
5. There were miscellaneous spots in the dev-manual that were
referencing 3.8 as the default kernel. Particularly the
list that shows what kernel repositories we have. That needed
updating.
(From yocto-docs rev: 9826ce760884f2ce5a4eb72c6a731a85cd6f2b2b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First pass at changes to support Eclipse Kepler 4.3 release.
(From yocto-docs rev: 265bc3f4ae3442b2fd0490d0f4558c7a584cb31c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Robert P. J. Day