Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them. However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2. After merging them to my yocto-docs/master
branch I fixed some issues.
(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These documents do not have titles when showing up on the website; set
the title tag value so that they do.
(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In anticipation of 1.1 I have changes several filenames that
had "1.0" to include "1.1" instead. I am unsure if the names are
correct at this time. I will need to check them when the release is
created.
(From yocto-docs rev: ae50f920c5cf18f6c0494280a453feb41ef56d83)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the PDF version of the manual the "‐‐" docbook statement
does not disply correctly. I changed them to "--".
(From yocto-docs rev: 8aea27a6de1ca2d5dffc84cfb7a26d29c3eb0e8d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the PDF version of the manual the "‐‐" docbook command
does not display. I changed this to "--".
(From yocto-docs rev: b5f42fad0c7447a480e0557988f868ef4833abbf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Errors caught by Robert P. J. Day:
1. An extra ">" character removed.
2. Overly long commands changed to use the continuation symbol.
(From yocto-docs rev: e84b7d5a46817fdc9c0f55242840989cbe8494c7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Also added some general punctuation edits.
(From yocto-docs rev: e9a689655c6e88e735944084e5dda32800a6e6ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Note mentions possible differences between docs in the released
tarball and docs on the website. Suggests website for latest
docs.
(From yocto-docs rev: 29426ab131a319b764f82da8a11cb4d9b590c3b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "Poky Tree Mode" has been replaced with "Build System Derived
Toolchain". SDK Root Mode has been replaced with Stand-alone
Prebuilt Toolchain.
(From yocto-docs rev: 453f7c030e6d7625d382563e2f2ec569f76e95eb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Used clearer wording.
(From yocto-docs rev: faa35ea8cdb1747ba2b6b7717d1881830bed175b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated wording to reflect proper use of build tree terminology.
(From yocto-docs rev: 82b47279b55b6d15bf260e0903505fe578c985c9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the command examples so the variables contained underscore
characters.
(From yocto-docs rev: 34bfceb14a04c5fa026486f33d32df7c21f8c742)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Armed with a better understanding of sysroot I made some edits to
help better define what is going on with the various sysroot
variables in the adt installer configuration file.
(From yocto-docs rev: 2b63e1f0f57c701eb38de7f9b9057567786b9899)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Small correction to refer to sysroot instead of root filesystem
in opening paragraph.
(From yocto-docs rev: e9af5bbd69ab9421a97ce87d5210d31838e93151)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note indicating where you can get sample kernels and
filesystems suitable for QEMU had a wrong path. I added
"machines" to the path. Also made a wording change.
(From yocto-docs rev: 75261eb7a44dcc990a817b5b59323042c38b6839)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example command I used to setup the cross-toolchain environment
was incorrect. I added the "1.0" to it.
(From yocto-docs rev: b8bb60ec69296e9c927735f3fca86013e8b2624e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Significant re-write to every section in this chapter except the
"Setting Up the Environment" and "Kernels and Filesystem Images"
chapters. I established some terms to communicate the build and
source trees and the build and source top-level directories for
YP. These terms had not been consitently communicated. I also
stepped through each of the three methods by which a user can
install ADT (and the cross-toolchain) and meticulously documented
the steps. The result is a much more complete and clear set
of procedures.
(From yocto-docs rev: 37076a07ccc748ceb416c4bc3a57b698f6e8d80a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided more detail in the section that introduces QEMU and tells
how it is made available to the user.
(From yocto-docs rev: 9145fee2d550af57669120b1b413585b69ab14bc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The manual previously defined the "ADT" as the toolchain, the sysroot,
QEMU, and user-space tools. This definition was creating some confusion
when it came to installing the "ADT". Namely, some of the items you
don't even install, such as the user-space tools. So I recast the
definition of ADT to mean the cross-toolchain and sysroot. I cast the
other items as part of the overall development environment.
(From yocto-docs rev: 6ee891660d3b6bf6e2a3f4b5a872ade7a007ce02)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added an entry to represent the Yocto Project 1.0.1 Release into
the manual history table for all of the manuals except the Yocto
Project Quick Start, which does not have a table.
(From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes fix the following issues:
1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.
This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual
Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>
The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.
(From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda)
Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed the hardcoded name from the publish script.
(From yocto-docs rev: 31f4b6c46944deb055f44fdbe2bdd93b97331849)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several changes made so that the HTML and PDF files as well as the
CSS style sheet and any PNG figures get published to the Yocto
Project website in the ADT Manual directory. This fixes BUGID#_956
regarding the ADT Manual.
(From yocto-docs rev: 4dde2130b6ee6816f2cf012fc488c972bdd668c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This figure is not used in the manual. I removed it.
(From yocto-docs rev: 3fb4d33727f24382a96e4ad8fe110706af113be1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the publish statement so that the HTML and PDF files will
be published to the Yocto Project website.
(From yocto-docs rev: 3b09ca5ee4e1919dbc72d680064083271dec544c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Substituted 'pokylinux.org' with 'yoctoproject.org' in an URL
to locate the OProfile viewer and server.
(From OE-Core rev: 6e2553b07be5f06a68f0967775111d7598d9404f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a stray "0.9" in an URL for the Yocto source downloads.
I changed it to 1.0.
(From OE-Core rev: 82890a85c0422aa6b081497be394aa756da567b2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The link to autotools was incorrect. It had 'www' in the URL
when it should not have. it is now
'http://download.eclipse.org/technology/linuxtools/update/'
(From OE-Core rev: 56965da0631d4619282b5548fc19118429183507)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the URL that points to the Yocto Eclipse Plug-in to
http://www.yoctoproject.org/downloads/eclipse-plugin/1.0.
(From OE-Core rev: 6657ee7563efecdaa091ef614c5c1e20a2a4665e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a note in the "Installing the ADT" section (2.1) saying that
if you need to build the ADT tarball you can use
'bitbake adt-installer'. I also changed the location of the
toolchain from '...yocto-0.9' to '...yocto-1.0'. Finally,
I changed the host sub-directory in the toolchain directory
from 'i586' to i686'.
(From OE-Core rev: 18124c5065fc570e672d068e915e0f476d20379c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the revision history box for the manual to state the release
and the release date.
(From OE-Core rev: 15f5307f78899a10358ef426cadf5bc792d11d88)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jessica flip-flopped on the need for the Autotools plug-in that was
removed from the manual. I have re-inserted the instructions for adding
this plug-in in as part of the Eclipse set up.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section 4.1.3.4 discusses custom options for when you want to run
a QEMU image. Jessica felt that we needed to stress the fact that
the options "serial", "nographic", and "kvm" must all appear outside
of the angled brackets.
(From OE-Core rev: 845770e12b6ed51db3179f42de6b8deacdff5093)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Section 4.1.2 lists plug-ins that need to be installed prior to installing
the Yocto Plug-in for Eclipse. I removed the Autotools plug-in
requirement per Jessica Zhang's instructions.
(From OE-Core rev: 94e3971c95e0549a0857f07e1a38d7b7628f0022)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Paul Eggleton
Beth Flanagan
Saul Wold