I integrated the terms "BitBake" and "Poky" into the first
paragraph. BitBake was not there. And Poky was not really defined
in any meaningful way. Also added some cross-reference linking
to the terms in the dev-manual.
(From yocto-docs rev: 14159d400ef51eb4cc5b0b9c03a608b84c20f278)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The first occurrance of this term should at least have a cross-
referencing link.
(From yocto-docs rev: 773c942fd64e4d6025fbef0838d5c7136ef35035)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did the following to the yocto-project-qs.xml file:
* I integrated some cross-referencing to the BitBake User Manual in
a few spots.
* I fixed a few grammar items.
* I also noted the super user system uses four cores.
I did the following to poky.ent:
* Added a new variable for links into the BitBake User Manual.
Variable is YOCTO_DOCS_BB_URL.
(From yocto-docs rev: 3eba14c0dc9e71dfcf967d76e4525b26ac02c9c2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I re-cast the section where we describe getting a copy of of the
Yocto Project such that we recommend cloning poky now.
Aside from this change, I found some other minor tweaks that needing
fixing.
(From yocto-docs rev: f10fc4afabddce8bd6296e83c4fecbbbd4683140)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I do not use these in the documentation.
(From yocto-docs rev: 856c523a487fe0cd4674c69333a87b29b50d87c2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Scott Rifenbark
Timo Mueller