I discovered some artifacts and inconsistencies with how the YP
Quick Start was made. I made the following changes:
1. Changed the structure of the QS from "article" to "book"
as it is a separate book. This change doesn't fix anything
but it does bring the XML file closer to passing validation.
2. Removed the <abstract></abstract> tag. This tag was in place
simply to display the PNG file for the Yocto logo in the upper
right part of the first page. After turning the QS into a
book from an article, the title could be displayed as a PNG
file similar to the other books. This change solved two issues:
1) removed the empty "abstract" element from being displayed in
both the mega-manual and the PDF version, and 2), brought the
author and look of the first page into line with other YP
manuals.
3. Removed the old PNG file used to display the Yocto logo at
the top of the QS. This file was removed from both the
yocto-project-qs and mega-manual "figures" directories.
4. Added a new "yocto-project-qs-title.png" file to both the
yocto-project-qs and mega-manual "figures" directories.
5. Updated the "qs-style.css" file's .authorgroup element to
match and behave like the other YP manuals. This effectively
correctly displays the title PNG file for the QS.
6. Updated the Makefile area where the TAR files are made for
both the yocto-project-qs and the mega-manual. I had to
substitute in the new PNG file for the QS one and had to
add the title PNG to the mega-manual part.
(From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The DocBook type at the top of the file indicated chapter
when the actual block of XML is article. I changed it to article
to be consistent.
(From yocto-docs rev: 5350426c11abc2fa4b1418a2d215cd8814745ef9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Added some text associated with the screencast we link to that
calls out the fact that the screencast is somewhat dated but
still useful.
* Replaced all user input in examples so that they are formatted
using the <replaceable></replaceable> tags.
* Fixed a few places so that they use better and clearer wording.
(From yocto-docs rev: f99536a7581ef9b8b57a446b65e4ebb902b4e4b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a reference that was not linking to the manual but
was instead referencing the Source Directory structure.
(From yocto-docs rev: aae3fb868e95ef2dbd548a5f9d1ea61a013190cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Conflicts:
documentation/ref-manual/ref-variables.xml
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #5566]
For the dev-manual, I created a new section called "Working
with Source Files." In the section, I cover how to set up mirrors
and also how to pre-fetch source using the bitbake -c fetchall
<target> command.
For the yocto-project-qs, I removed the mirror information in the
"Super User" section, which became redundant with the new section
now in the dev-manual. I also, removed the fetchall variation of
the bitbake command. Both areas reference into the new section of
the dev-manual now.
(From yocto-docs rev: f314061e3e752d35ea85ed16a60f7f9292180921)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have put the disk space requirements up in the general area
describing host system requirements. This specific note for
sato images is redundant and no longer needed.
(From yocto-docs rev: 3cb054c34c62771ae01be6f46817f3b489395867)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the general requirement of 50 Gbytes of free disk space
to the host requirements. The information was somewhat buried
later on in the manual.
(From yocto-docs rev: aeb8a9988626404fcee60758fe7ae808b31af145)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was mixing the "50GB" and "50 Gbytes" strings. Throughout the
set I have tried to use "xx Gbytes" form. Fixed a "xxGb" form
that I found.
(From yocto-docs rev: 40dfc6ab1c5c928bedc301ce323af08aa0b7be59)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2444]
I swapped out the hardware names for the example in the
"Super User" section. Beagleboard is no longer shipped with the
YP. It has been replaced by Beaglebone.
(From yocto-docs rev: b71ecd4f24dd4c1804c9e8c26aedacbdfaa694a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #4866]
Updated the main area where it talks about needing the right
versions of Git, tar, and Python. You can get this set up using a
couple methods. I documented both.
The changes in the FAQ and in the QS are basically notes that point
to that section for more information.
(From yocto-docs rev: 1b64c7c271303ecf10ec85c8a2cd5a0d909f1151)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This command was wrong.
(From yocto-docs rev: bea7cae5651163e4121b0f5dedeb7d3c6de40705)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #2528]
The defaults for BB_NUMBER_THREADS and PARALLEL_MAKE are now
automatically set to the build host's number of processor cores.
I updated the "Building and Image" section in the Quick Start
to state that. I also updated the PARALLEL_MAKE variable.
(From yocto-docs rev: 2069c96d2410605c089da4eede2c7b4f9a7b704a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 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>
Scott Rifenbark
Maxin B. John
Timo Mueller