Fixes [YOCTO #8368]
Apparently there is confusion on how to build a cross-toolchain
using Eclipse and the Yocto plug-in. Specifically on setting
the MACHINE variable, the bblayers.conf stuff, and the
preferences in Eclipse to find things. I added a couple key
things to the section that describes using the OpenEmbedded
build system to build out the toolchain.
(From yocto-docs rev: 68c399e2560600cb3a5951c93d51e2cf1f610ff9)
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>
The way to include tcf-agent now in an image that you are going to
remotely deploy and debug using the Eclipse IDE is to simply include
the eclipse-debug image feature as part of the image. I updated the
section around getting images to reflect this simple method.
Reported-by: Adam Lee <adam@gumstix.com>
(From yocto-docs rev: 9aec91d7f4fda558baa0e8a0290b42d76e735c63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the "Optionally Building a Toolchain Installer" section
to emphasize using 'bitbake <image> -c populate_sdk' as the method
for building outa toolchain. Before the change, equal emphasis was
put on for this preferred method and the 'bitbake meta-toolchain'
method.
(From yocto-docs rev: 447ad6167570bf1bd227771153de421d1154443d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4907]
I created a new section in the toolchain chapter of the adt-manual
called "optionally Using an External Toolchain". This provides
some fundamental information for the user that wants to use
an external toolchain. Additionally, it references Mentor
Graphics Sourcery toolchain as an example.
In the ref-manual, I updated the TCMODE variable description to
better integrate the MGC Sourcery toolchain as the overriding
example.
(From yocto-docs rev: 51e9c3b88f7e5a16da2aa101589b0f2612fff11d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mark Hatle reviewed the section and I updated some things based
off his input. A rewrite to the "Makefile-Based Projects" section
to get it technically correct. Also, removed all SDKROOT
documentation from both the adt-manual and ref-manual.
Fixes [YOCTO #7133]
(From yocto-docs rev: dd785777834611d94868a3774f2eb21ffc081b1a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133]
Edits to add more clarification for use and role of the
cross-toolchain environment variables established when a user
runs the cross-toolchain environment setup script.
(From yocto-docs rev: 2c3fa3a838a3a8970cd112935e903c96552ed06b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the ADKROOT, GDB, CROSS_COMPILE, and CONFIGURE_FLAGS
variables to the glossary. Also added appropriate cross-reference
links from the adt-manual to those new variables.
(From yocto-docs rev: 812367e3b915b99d900b7934c4d5d409f393e814)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7133] partially
At the end of the section that first mentions running the
environment setup script for the cross-toolchain, I added a list
of environment variables that are defined as a result of running
the script.
(From yocto-docs rev: f1b66a09676d1b5c055e7ae7e7cc9a7f45cb9b67)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note in the "Getting the ADT Installer Tarball" section has
a note that warns the user to be sure they have local.conf
properly configured before baking out the adt-installer. I
provided a linked cross-reference into the section of the
ref-manual that takes a closer look at user configuration.
(From yocto-docs rev: d13c044b65543a2f15fbda0266d2e30a14cfd19f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The intro to the "installing the ADT and Toolchains" section notes
that the user must source the cross-toolchain environment setup
script. I added a clause stating that this establishes environment
variables.
Fixes [YOCTO #7133] partially.
(From yocto-docs rev: e9777012d935ced8fd82209543569aaa70ab1832)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scrubbed out the occurrences of eglibc and replaced them with
glibc.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual I was using angled brackets to denote
user-supplied input. This is confusing so I changed to using
the <replaceable></replaceable> tag set.
(From yocto-docs rev: 79ec3f1b1330539ab2b3bdfb1c94e58c2d0feead)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The command said 'bitbake image....' where it would be better
to say 'bitbake <image>...'
(From yocto-docs rev: be90d647a298c88f6a1a69c66a0795dcdb5cb56b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the adt-manual in the "Optionally Building a Toolchain Installer"
setion, I added some basic advantage information for building a
toolchain installer using bitbake image -c populate_sdk.
In the ref-manual, I added cross-referencing to this basic information
in several strategic areas: "SDK Generation", the populate_sdk class
reference section, the populate_sdk_* class reference section, and the
"Cross-Development Toolchain Generation" sections.
Finally, I also put in documentation for a new class called
autotools-brokensep.
(From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied proper formatting as the reference is to the actual
command.
(From yocto-docs rev: b49cb8968a1f915b5dd52b4f38abc88319cc3f79)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some occurrences needed formatted into a <filename>bitbake</filename>
form as they are actual command references.
(From yocto-docs rev: e7bc7161613222374e39fdf7f09c460900d52441)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Needed a link to the term "BitBake". Also, reformatted the
occurrences of "BitBake command" into "<filename>bitbake</filename>
command as they are actual command references.
(From yocto-docs rev: 0a6540948edfca1f9c7c0b880d78252c5da0d8cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A customer reported a wrong and mis-leading sentence in the
"Configuring and Running the ADT Installer Script" section.
Jessica Zhang pointed this out. I have removed the sentence
altogether.
Reported-by: Jessica Zhang <jessica.Zhang@intel.com>
(From yocto-docs rev: 682906d0ed869faac149a742b028ba4f2c8c8e97)
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>
Documentation fix for [YOCTO #5347]
SDK created useing the "-c populate_sdk" will not support static
binary build without proper staticdev library packages.
I have added a note to inform the user about this limitation.
(From yocto-docs rev: 91409d77d68e55f4089cab3e7f48dd385dddff2e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section pretty much sucked. I did some re-writing and
created a list to better present the material and options.
(From yocto-docs rev: 4bd833d2a0f55865d9f35784fbfd3c00ebc2daea)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was a bit confusing. I added some lists to make
it clearer when this step is necessary. I also added some more
detail on where to find the setup script.
(From yocto-docs rev: 0518aeeb0b395c84233bace26fc3f40234e044b3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a grammar issue and provided some wording to make things
clearer for locating the Makefile.inc file.
(From yocto-docs rev: b734fddeb700a0e2e685e8453395653926dbabe6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added in some enhancements here:
1. Worded the local build environment setup stuff to include
the possibility of memory resident version of BB.
2. Make a better looking list.
3. Dumped the note about changing directories after running
your setup script.
(From yocto-docs rev: a19874c2b01a38b72fc02e9ae373c335f1dfbef7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section was not quite right for the installation method
after obtaining the tarball. There was some old stuff in there
and it didn't mention the fact that the script asks you what
directory you want to install into.
(From yocto-docs rev: b49c86a1a447a8d39b0054a480fb5d4b6f608297)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The path used for the toolchain was wrong. The string
"toolchain" appears in the path. I was not informed of this
before locking down 1.5 release doc changes. I have updated
the path in the "Using a Cross-Toolchain Tarball" section.
Occured twice.
(From yocto-docs rev: 307f570b3bc253ef110553d950c1f2a43396b908)
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 this issue.
This section demonstrated how to build the ADT Installer tarball
using BitBake by downloading the poky release tarball. I updated
the section to use the method where you use Git to clone the
poky repo and then check out the current release as a branch.
I also re-organized the section to read better.
(From yocto-docs rev: 116779a3fa776a4eeb283b238bc2b5fb7202ffb4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Poorly worded opening sentence for the "Getting the ADT Installer
Tarball" section. I re-wrote this to remove the confusing link
to the Index of Releases.
(From yocto-docs rev: c0c7a8f04040f0718366b268e2493320a00c84d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This now has the release_number as part of the name.
(From yocto-docs rev: e91b2a553e6f1e5ca007535d926af6df449ed20c)
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>
The way in which the toolchain installer scripts are named has
changed. I have updated two sections that describe this so that
the new naming scheme is used.
(From yocto-docs rev: 71b70a12c72bca7cad565b5d6f44b2c6b311844d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to Ross, we are not going to have gmae as part of the
toolchain installers. So, I removed a couple instances of the
filenames and then the mentioning of it when building the installer.
(From yocto-docs rev: 70407feda9382fa8226142881e18f282764638be)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed some wordings in the ADT manual to remove "Intel-based"
so as not to be biased.
Added "x86" to qualify the types of systems in the toolchain
examples.
Added minor wording to the IMAGE_TYPES variable.
Changed some wording for the IPK_FEED_URIS varilable.
(From yocto-docs rev: 1fa7e0000591bec7e3d0b682df02b95dbee3d4f1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
An improvement to expose the method by which the user gets a
toolchain installer. I placed this information in a section of
its own rather than having it buried in a note.
(From yocto-docs rev: a1c2bb48f47cee9ee8c5c079afbcf77a793ca791)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Now that a glossary entry for SDKMACHINE exists, I needed to
create some links to it where referenced in the ref-manual
and the adt-manual.
(From yocto-docs rev: 6efe13bcda22276e5ef71ebafff6f91961b34679)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes YOCTO #2645
Several changes to make sure that the default toolchain directory
(opt/poky) is understood as the default. I changed some wordings
to call it out as the default. Some examples I left alone as they
used /opt/poky but I clearly indicated that the example was using
the default installation directory.
I also updated the note in the manual that talks about alternatively
building the toolchain installer. Previously, it mentioned two
methods. I have added the third and most significant method that
uses bitbake image -c populate_sdk. This method creates a toolchain
installer that contains the matching sysroot.
(From yocto-docs rev: 2e5eeb7e0c9aa448149cc369572b31dbc1603e28)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2645]
In the section that describes how to build a toolchain using
bitbake meta-toolchain, I updated the note about the MACHINE
and SDKMACHINE variables. These needed to be pointed out
to the user as important variables for correct settings
before generating the toolchain.
I added a new section for the autotools-based programs that
now includes a simple "Hello World" example. This section
precedes the section that describes how to pass host options
to configure.sh.
(From yocto-docs rev: 9849e7b94d42a851f30f0fba8ae60916697956dd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note alerting the user to required host development packages
necessary for ADT installation and use was antiquated and did
not point to the new structure, which is in the YP Reference
Manual. I updated the information.
(From yocto-docs rev: edced821838391315fb2f12488cffec9f08eb78c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some minor edits to the book before locking down the
files for 1.3.
(From yocto-docs rev: 2b941103585a31b5dbcb65b784cc3381467ed697)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Turns out the .sh file that installs the tarball comes down without
executable permissions. I added a sentence in each manual instructing
the user to set the permissions to the script before attempting to
run it.
(From yocto-docs rev: c1699971b3e03893aa1af5033e19d8f5c0b21ff4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#2930]
You can now select the install location directory instead of
automatically going to /opt/poky. Some small edits to the
section that describes what happens when you fire off the
adt_installer script.
(From yocto-docs rev: 57f34c9b3a82222ed0ffc99e998614884b9a3486)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new paragraph to the section that talks about getting
images to state that if the user is not using or building a
core-image-*-dev type image and they want to develop against
their image, they need to be sure to include the development
packages in their image recipe.
Reporte-by: Jessica Zhang <jessica.zhang@intel.com>
(From yocto-docs rev: 8da6f6172d3ad27c1cf6d52fd3d029d75ec9d0fd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Scott Rifenbark
Maxin B. John