This link was going to the documentation. Also, the URL was
out dated.
(From yocto-docs rev: 0f8d4f934af4e29f93b501e215e49defda791071)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links in the section discussing Linux distro requirements to
wiki pages were terribly out of date. I have rewritten the note
to remove them.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 918e2e9d1146e828a2bbd16d8f5bad837effe088)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Partial fix for this issue. This section had two options for
setting up the Source Directory (tarball and cloned repo). I
removed the tarball option.
Also, I did some routine formatting as well as verified that
the example runs on a more recent Linux distro. Previously, the
example was confirmed and stated that it ran on 10.04 Ubuntu.
Well, this distro is not even in the supported list any longer
so I ran it on a 12.04 Ubuntu machine and stated that.
(From yocto-docs rev: 1203e083ec8f7ac91bd832a27273ab4afc5aa4c8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I messed up on a previous commit and didn't get the example
path correct. This fixes it.
(From yocto-docs rev: 6523a8f09343241c47af573c0eb2aabac0061358)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This note is bullshit. It was left over from like YP 1.3
release. I have removed it.
(From yocto-docs rev: a71f44e61913128d5914e852e7305c95a7fd87a2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered that the string "toolchain" is in the pathname of the
toolchain installers from the downloads area. This invalidated
the explanation of how the installer files are named and the
actual examples themselves. I fixed it all.
(From yocto-docs rev: d59b88ad8dbd4548cbb50d81d5ee174fc84e6bd4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Partially addresses this issue, which is removal of examples that
use a poky tarball. I changed the example so that it clones the
upstream poky repo and then checks out a local branch named for
the most recent release.
(From yocto-docs rev: 58bd7cf3a09ccbe63b5349edb3d68f35e9eab339)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5368]
Changes partially address this issue, which is the removal of
tarball installations for poky. The notes at the beginning of
the YP manuals suggested that the tarball version of a manual
might lag the version found on the website. Because we are
discouraging installing poky/documentation from a tarball now,
I have re-written the note to be generic and suggest simply that
for the most recent version of the manual associated with the
release, see the manual on the website.
(From yocto-docs rev: a5e96e7eb719e69bbcf2139af2e20230aedc4247)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5035]
By default, the DL_DIR does not get files from Git repositories
that are suitable for mirroring. There is a work-around by
using the BB_GENERATE_MIRROR_TARBALLS variable, which, when
set, causes the build system to generate tarballs for the
Git repositories and place them in the DL_DIR.
To address this, I added a new variable description for the
BB_GENERATE_MIRROR_TARBALLS varible, updated the DL_DIR
variable to indicate that "out-of-the-box" the YP puts suitable
mirror files into the DL_DIR for everthing except Git
repositories.
Some other sections were updated where discussion revolved around
pulling down source files. The QS had a spot where the
BB_GENERATE_MIRROR_TARBALLS variable was actually used in an
example. And, the expanded discussion on the BitBake process
had a couple spots that deserved a mention.
(From yocto-docs rev: 1539ff13222449ba60bfaaaac4fe1e8a795b0039)
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 QS did not have this legal blurg. I have added it in.
(From yocto-docs rev: a007c4176b64db6ebbfaf4723c7842603a49ed76)
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>
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>
Fixes [YOCTO #4996]
In section "Building an Image" the first Tip box has example
file location "poky-dylan-9.0-build/conf/local.conf". It should
be "poky-dylan-9.0/build/conf/local.conf".
This particular error had propagated into 1.4.1 and 1.4.2. I have
fixed all versions. This commit though is for the dylan HEAD, which
will show up with the 1.4.2 release. The best I could do for
1.4 and 1.4.1 was to pull local versions of the branch, fix,
rebuild and push to the website.
Reported-by: Juuso Korhonen <korhonen.jusso1@gmail.com>
(From yocto-docs rev: 8c42b68a4632ad9300232501c45fae61edd37475)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the directory to x86_64 from x86-64. Also specically
stated we support 32-bit and 64-bit stuff for x86 systems.
(From yocto-docs rev: 6338469059b7ac6547f53a2da973f76e338c5124)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4927]
Updated the wording to be less severe. The wording matches that
used in the ref-manual.
(From yocto-docs rev: d44cd9d6d01bad9aa5269730efae100c163e34f0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed the "-y" argument from the command to install required
CentOS packages.
Added a qualifier to the version of Python that you need for the
build system.
Removed the note about RHEL.
(From yocto-docs rev: 25cff75cd361ff5070b21a5ee4a241148c580d49)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4753]
The section that tells the user the basic Linux requirement has
been updated to mention the Git, tar, and Python minimum
requirements. There is a new section in the reference manual's
introduction area that describes how to create the buildtools
tarball if these requirements are not met. The changes I made
in the Quick Start now summarize the requirements and provide
a link to that new section in the YP Reference Manual.
(From yocto-docs rev: fcc61acab7e4a7ddde194aa2db21181778d5dcdf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1. Fixed broken links to the website downloads page.
2. Added a better link to the oe-init-build-env script.
3. Added a note about the image directory because I discovered
that the QEMU ones have the string "lib32" in prepended
to them.
(From yocto-docs rev: 38074bc97b94a23b115c44aa9f353205914f7cce)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Hi,
the generation of eclipse help files has been merged from the timo
branch to the master. Since the creation of the timo branch there have
been some changes to the master branch (e.g. new documentation,
renamed documentation).
This patch set does some cleanup for the renamed documentation and
adds eclipse help generation support to the new documentation.
01: Removes the 'the' from the document titles
02..04: Cleanup obsolete artifacts resulting from the merge
05..08: Add eclipse help generation for ref-manual
09..13: Add eclipse help generation for kernel-dev
14..18: Add eclipse help generation for profile-manual
Best regards,
Timo
This patch set originally contained 18 patches. I (Scott Rifenbark)
had to push these changes as two parts. This is the first part.
It does not include creation of the three cusomization files.
(From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section that describes an efficient way to set up the
build system to look in local areas for tarballs needed updated
so that PREMIRRORS was not the focus. The example used does
not even employ PREMIRRORS. So I changed wording to support
the example. I also added a mention of the PREMIRRORS variable
and a linked reference to it for more information.
(From yocto-docs rev: 7966942e2dfad85c2eb9480d7f706355871c40ab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The chunk.quietly option disables the output of the docbook
chunker. Creation of a new html file is now longer printed to the
console. This provides a much cleaner output of the eclipse makefile
target.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The fake title section is converted into a docbook
article.articleinfo. If used with a custom title page this will lead
to the excapt same output. But I will enable the creation of metadata
from this title information.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The quick start guide is currently not using a title information to
set the title of the document (e.g. article.title or
article.articleinfo.title).
As other output formats may use the title information to create
metadata this information has to be added to the document. To preserve
current style of the document a custom title page has to be used. With
this for instance 'article.title' can be used instead of the
fake-title section currently used, leaving the style intact.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the example to match the more elegant solution
provided in Robert P. J. Day's wiki.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 209d6205b4fc6a4010f440ba7e0e2018217a0a0b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two links to the wiki were pointing to diff pages and not the
actual pages.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 7339ea7b0a3869570c9097146a49dfd758527197)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed used of "Source Directory" and Build Directory.
(From yocto-docs rev: a4d79c5a7e73003fc99c274d876fbea453a80d20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created the new section in the reference manual that lists the
distributions that support YP.
Updated the section in the QS to reference the new section in
the reference manual.
(From yocto-docs rev: ff85945574466b2e6431fbaa0026cdea9d96ac9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO_#3180]
Final changes to the packages section. They were re-organized and
the set is complete and thus fixes this bug.
(From yocto-docs rev: 533b45c9d41330497bbd0da58b812a4738ba64a8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A few edits to the respective sections that talk about required
packages. Some wording changes for headless and graphics
supported systems. Also, re-inserted the note about older
CentOS systems.
Reported-by Paul Eggleton <paul.eggleton>
(From yocto-docs rev: 112370758cf41104ff04c4996d4a432e6bd54be1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reorganization of the packages section in the YP Quick Start.
These are now ordered still by distro but the listed packages
have been culled down to just the needed ones to run an
image on QEMU with graphical support.
A corresponding section in the reference manual now provides
the comprehensive list of packages for all supported distros.
The section in the reference manual is broken down by
distro and by function.
Finally, four new variables were introduced to track the
essential packages for each of the distros. The variables
are defined in poky.ent and follow the form
<distro>_HOST_PACKAGES_ESSENTIAL. This will make it so
we don't have to maintain this list of essential packages
in multiple places.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 839b441791980db82f4795454e976e606b486d25)
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>
A few minor corrections to fix some wordings.
(From yocto-docs rev: de71001992150da685a70389e28313df609d6521)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the example that builds an image so that it uses the
default build directory. It seems like the natural thing to do.
Also added a new poky.ent variable named OE_INIT_FILE. This
variable is set to the name of the build environment script
(From yocto-docs rev: f0db49e27e89aefb6d43a0b455c6ecc529399c27)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For 1.3 there is not longer a toolchain tarball. Instead, there
is a wrapper script that lets you install the tarball. This
fundamental usage model change caused several ripples throughout
the documentation set. I have changed wordings and examples
to reflect the new paradigm.
(From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2904]
Added glib-gettextize package to the list of required Fedora
packages.
(From yocto-docs rev: c46f8e46ad70bf979d2e51e58d461bcd9456b773)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
List frameworks we provide that are likely to be used by people these
days - Pimlico has been removed and GuPNP and Matchbox don't really
belong. Also slightly modify the sentence following so that it is clear
that these are optional.
In addition to Paul's patch, I cleaned up one of his sentences with
some simple grammar edits.
(From yocto-docs rev: 1cdeb057bab0d69fe6656e33e643962dd2086567)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3036]
Turns out the fakeroot package is not required for the Fedora
Linux distribution. I removed this to reverse the fix I did
earlier for YOCTO #3036.
(From yocto-docs rev: 6b22dda7fc7f07bd34d2a84e03308ae8ebcfbe9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3036]
Added fakeroot to the Fedora package list. Removed python-curses
package from the Fedora package list. Added python-curses package
to the OpenSUSE package list.
This fixes a previous commit where I accidentally added python-curses
to Fedora.
(From yocto-docs rev: 8e1b7a640886e6d39cf1e175611098555204a5f3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #3036]
I added the python-curses package to the list of required packages
for the Fedora distribution.
(From yocto-docs rev: 2929a0f97cd9be88580c0a80848b7fff327b4642)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had to rename individual style.css sheets to have book-specific
names. So style.css for the ADT manual becomes adt-style.css and
so forth. Turns out, this isn't really necessary for the solution
to create the mega-manual but I am leaving the changes as a
separate commit because it makes sense. It causes no disruption
to making the six YP manuals.
(From yocto-docs rev: 8cbdae1fe86988243f91dfd611c14f8a37007886)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For some odd reason the PNG filename for the YP logo did not end
in "p". I added the character so that the image is displayed.
(From yocto-docs rev: a6a4bcf9798be2bbf1be3922226ef83b7d6667d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The name of the ADT manual has changed to the "Yocto Project
Application Developer's Guide." This change had some ripple effect
regarding cross-references into the manual. These are now fixed.
(From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The string used for the link anchor for the "What You Need and
How You Get It" section in the YP QS used "resources". This
string is actually used as the chapter id for the resources
chapter in the YP ref manual. I changed the string in the QS
from "resources" to "yp-resourses" to make it unique. There was
one instance in the YP ref manual where a cross-reference to the
section occurred. I fixed that as well.
(From yocto-docs rev: 58c1e4e327cb489e037bbde170c4c495f4567392)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "faq" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).
(From yocto-docs rev: 6e090132823e3b121d00d9116b0693c922156b32)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-imagese" and "ref-features" appendices
to chapters and made any references in the doc set use the proper
term now (chapter).
(From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a bit of detail to the install toolchain example to explain
that the user needs to be in the root directory.
(From yocto-docs rev: afb294f6e0997b72f11d9e9d31b3b22d083c2dad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Mentioned at the very end of the beagleboard build that the image
can now be run on the target hardware.
Also, specically noted the local.conf file as "conf/local.conf" in
the build directory.
Reported-by: Kevin Strasser <keven.strasser@intel.com>
(From yocto-docs rev: a4b41c7f5e8e8017401961097e0df4b13458ac24)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor fixes to some links and some typos.
(From yocto-docs rev: 8d1f53bca404461f8edc526d5e144ef7d76f0594)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a scrub for the term "Yocto" and substituted appropriately.
This resulted in the term "Yocto Project build system" going away and
being replaced by "OpenEmbedded build system." The "Yocto Project
build directory" was replaced by "build directory." I also found a few
little things that were wrong like including the Debian distro in the
list of supported distros so I removed that. Finally, a spell check
produced a couple of fixes.
(From yocto-docs rev: 6957658982516aa4b0e4726c9344c46854aa11d3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The example showing how to use pre-built images, the toolchain, and
filesystem was off a bit. I changed some wording to indicate using the
.ext3 filetype of the filesystem. Previously it talked about expanding
the tarball version but the example has been changed to use .ext3.
Also, the environment setup file has been mis-named forever. It should
have i586 in it and not i686. And, finally, the image name does not
have a release number as part of the name.
(From yocto-docs rev: c9953c9bb716ae5be183020c5143152226bf1de5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Remove mercurial as this is no longer needed.
linuxdoc-tools was mentioned twice in the CentOS list.
We no longer support Fedora versions older than 15 so remove this note.
This commit applies to 1.2, 1.2.1, and 1.3.
(From yocto-docs rev: 4a7e8cc3d69d5c2f9aacedc5f7e2ff9657ef850f)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Need quotes around the INHERIT statement.
Reported-by: Frans Meulenbroeks <fransmeulenbroeks@gmail.com>
(From yocto-docs rev: 96f03be0d2595b4b788d8bb2110fe8801279f3f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The following packages no longer need to be installed on the host
system:
* python-psyco
* help2man
* cvs
* hg
Additionally, linuxdoc-tools was mentioned twice in the Fedora list.
(From yocto-docs rev: 89fc20a1a54f92165323cb2dbcfc5063c0205369)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a blurb about the Build Appliance to the start of the QS.
(From yocto-docs rev: b2766121c05740300fd5a6cea2f3b8a2f62db6e5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New section in the Packages area for CentOS.
(From yocto-docs rev: 7ee9f2d09fe9b83bccdf4b4f431672f34c31aca7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reading through the manual I discovered some inconsistencies with
how links were handled. I fixed this in both the QS and one anchor
in the FAQ appendix of the YP Reference Manual.
(From yocto-docs rev: 32444e839a1541ab2c02fa31cd094605d1a2429a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Super User" section I had the URL for the wget command
wrong. Replaced the "." character with a "/" character.
(From yocto-docs rev: 87ec41694d6665c0dbaaab94679b1f22335aa070)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: David Stewart <david.c.stewart@intel.com>
(From yocto-docs rev: 4df12f3437488f6d8dbfb54dd3de25f5636162c1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The git clone command did not work when the YOCTO_GIT_URL variable
was used. I removed the variable and hard-coded the command
into the example.
(From yocto-docs rev: 67f169a7e2540b27acfaf2fcdcc658ce189ec932)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new "expert" section at the end of the QS. I reference the
section right up front. This new section is an attempt to divert the
expert user away from most of the QS. The information was formed from
Robert P. J. Day's wiki at his crashcourse.com site.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b2981e9fcdd083e15194f520a4160938b02b1275)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I received a patch from Robert P. J. Day that had several changes.
Curiously, several did not apply. I think that the patch was
applied using a version other than the "latest" version. In
any case, I applied the changes that did need applied.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5af725001cf045040f83e1c891385692f8a3a287)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title for the Quick Start should be "The Yocto Project
Quick Start".
(From yocto-docs rev: d70c75674de959e3fe7d8b661dddefb0648ae89a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I lightened up the bacground box colors used for Notes, Tips, Warnings,
Cautions, etc. We had some feedback from the community that they heavy
dark boxes were taking away from the main text.
(From yocto-docs rev: d9b5da116bacb847e86c1f5029836308b8ce533c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
At the suggestion of Scott Garman, I added a link to his Getting
Started with the Yocto Project - New Developer Screencast Tutorial.
In doing so, the list of "other helpful things to read" was turned
into a list as there are three items now.
(From yocto-docs rev: f43c31d9bcd0e48aced86cc917d0af5f5a48d2e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jim Abernathy pointed out that the docs would not make on his
Ubuntu 11.10 machine without the xsltproc package. This package
was not listed as a required package. I added it to the YP
Quick Start.
Fixes [YOCTO #1933]
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: 0d4bcdd965e208588bbe283594d9d9528b87bf54)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jim Abernathy pointed out that the 'fop' package is not in the list
of packages. Not having 'fop' prevents the user from building the
PDF versions of the documentation. I added 'fop' to all three
distribution's package lists.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: f481361fbc3330a8f415be8cb992844c2f214ce3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Beth has created a scheme that uses a file named "poky.ent" that
contains a load of variables that can be used throughout the
documents for releases. The variables can be set in the poky.ent
file and then sucked in during the make process to specify
a release.
This commit adds the new file and the changes to the YP QS manual.
(From yocto-docs rev: b08dde630a4f0762d8cc62c5579f6917d93ee854)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Richard made a concerted effort to enable Dash usage in Poky and the sanity
check to detect it is no longer present. We should update the documentation to
reflect this development.
Specifically the section in the quickstart:
"If your distribution is Ubuntu, you need to be running the bash shell. You can
be sure you are running this shell by entering the following command and
selecting "No" at the prompt:
$ sudo dpkg-reconfigure dash
"
Is no longer required.
I have removed it.
Fixes [YOCTO #1820]
Reported-by: Joshua Lock <josh@linux.intel.com>
(From yocto-docs rev: 189a80571bb7a1afd53171d93273e7cc26460d63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A missing dependency surfaced during a build by community member Marc
Ferland on a Ubuntu system. The "shared-mime-info" package would not
build. Fix was to add the "libxml-parser-perl" package. So I added this
package as a requirement for the Ubuntu systems.
Reported-by: Marc Ferland
(From yocto-docs rev: 3922f2eb24f8f2089c6fdb48a88530af2b26f159)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Text that suggests setting the BB_NUMBER_THREADS and
PARALLEL_MAKE variables to speed build time has been updated to
suggest a setting of twice the number of host cores supported.
The 2x number came to light through a discussion on the project
mailing list initiated by Robert P. J. Day.
Reported-by: Robert P. J. Day
(From yocto-docs rev: 1846b41a595b7bd905ca828eaa04112d1533d7a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
During development, a footnote was added to the Development
manual. In order to get the footnote to display correctly, I
had to introduce a footnote element in the style sheet. This
commit propogates the style to the other manual CSS sheets.
(From yocto-docs rev: 0439b46620125f2cb26dff4e8c79fc479205133a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"www" was messing up the link. Removed it.
Reported-by: William Mills
(From yocto-docs rev: ae7074325c78385684c51c06e8a27686e6fa1d05)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There are many references to YP documentation throughout the
YP manual set. They used to have hard-coded links to the
current release (e.g. yoctoproject.org/docs/1.1 for Edison).
This created a situation where if you went to a document on
the website and clicked on a external reference to another
manual, you would redirect to the current manual on the website.
Really, you would want to go to the latest manual, which is
one that is under development. Changing the links to
"yoctoproject.org/docs/latest" makes the tip of master, which
is used for devloping the next release, always have references
to the manuals being developed and not back to the stable
released set of manuals.
This "latest" and "current" scheme for the links is not perfect.
What has to happen when the latest set of the manuals freezes
and becomes the next stable release, all the links in the docs
will need to be changed from "latest" in the URL to the new
release number. So for example, all the "latest" occurences
would need to be changed to "1.2". Then for the next cycle
as development begins again, the links need to be infused with
"latest" again.
(From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Split the instructions for getting the packages needed for Yocto
into sections that specifically support Ubuntu, Fedora, and openSUSE.
Also, added a couple packages to openSUSE. I did not implement a
suggested change to include a note indicating future support of
the dash shell since it probably is not good policy to document plans
as they change.
Reported-by: Darren Hart
(From yocto-docs rev: 3dbbb22ccdda1a7e809e61e19f5d04ab26e3499c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As Reported By: Robert P. J. Day.
Community member Robert P. J. Day scrubbed the Quick Start manual for Release
1.1. He found several areas that were incorrect. Many items were documented
pre-release and changed during the actual realeas. Naming conventions for
images and such had to be changed. Robert also found and suggested several
wording changes that resulted in clearer text.
I was not able to patch all the changes using the 'patch' command. I need to
work out some process issues still in order to apply patches directly to the
yocto-docs repository. Meanwhile, I hand-inserted the changes. Also, some
text changes were modified slightly by me to conform to the books style, etc.
Kudos to Robert for such a detailed look at the YP Quick Start.
(From yocto-docs rev: 6bc2e9c289a802f511441ca5b31ca6163e4fdfac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Community member Robert P.J. Day pointed out that the URL used to
reference the Edison tarball in the manual was incorrect. It was
pointing to the old Poky area and not the Yocto-1.1 area. I have
updated the example 'wget' command with the correct URL.
(From yocto-docs rev: ba9deb4717b72b4d75c18870106607b1770ac45b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I somehow had that having a host with multiple cores and threads could
be used to increase the build time. It obviously should have been
"decrease". Kudos to Bill Fishburn for finding this goof.
(From yocto-docs rev: 2cd0ac980f9191edd3d4874508fd8fc9f0531622)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The re-structuring of the web server that holds the documents created
some bad links. I thought I had gotten them all but apparently not.
this is a drawback of not being able to test things until after stuff
is done. In any case, I grepped through everything and this takes
care of it.
(From yocto-docs rev: cdbc3b3b7f6d6ff01024b977f966459cf414ad5c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I somehow had either dreamed the word "einstein" into the release
for 1.1 and had it in there as part of the tarball name, etc.
I have replaced this obviously with "edison."
Other edits involved making the references to outside documents
more consistent.
(From yocto-docs rev: 2407b7dd89712c489d515e97d44e3c7dc0b64d20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the section on the supported distribution section by including
a link to the wiki page that shows what distros we have tested and
their status.
(From yocto-docs rev: e66a18a13dc02af6a0846dd1ecf14aeafcbe5d61)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several manuals and areas were still referring to 'glibc' as the
GNU version of the Unix statndrd C library. We do not support this
any longer and now use 'eglibc' to build with. Notable changes were
in the required packages area of the QS manual. I also added a
bit in the reference guide saying how this release does not use
'glibc' to build with but rather 'eglibc'.
(From yocto-docs rev: c2c58914996d747c510706d78ecfd8f41c5e694d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I needed to reference the image differently for the pre-built section.
(From yocto-docs rev: 10568a0a8c4160af995089e481ccc2772e81d805)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was a final scrub of the manual. I updated all examples and links
to be current for what I think will be the 1.1 release. I also added
some cross-referencing into the YP dev manual that now exist.
(From yocto-docs rev: 4c10b0e04856817a1d03aee7a9ed6e4d5d73a3ac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>