Fixes [YOCTO #10451]
The example that writes the image to bootable media did not seem
to work when using 'mkefidisk.sh'. It does work using 'dd'. I changed
the procedure to use 'dd'.
(From yocto-docs rev: 27a70c88f987cee731584618d76c40a878f35a75)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9667]
The actual command in the example to build the image for
Minnow MAX should be for 'core-image-base'. I changed it to
be that.
(From yocto-docs rev: 9aca9cceee543eea278390059ccff0761758b55e)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9667]
The example that built the image out for the MinnowBoard MAX was
buiding a core-image-minimal. This was not ideal. I have fixed
it so that several types of images are suggested as examples with
a reference to the Images chapter in the ref-manual. The actual
command now builds out core-image-base.
(From yocto-docs rev: 588f9c06bf5dbad253826825dd2a9a67c89f3219)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the minimum requirement for YP 2.2 release.
(From yocto-docs rev: 0aebdd8556a6e5a52c0caf28dc97c1872b40e950)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #10178]
Previously, YP did not support Python 3.0. We mentioned that
in the manual in several places as a requirement for running YP.
I removed this exclusion in the following areas:
* yocto-project-qs - the section that tells what version of
Python you need.
* ref-manual - the section that tells what version of Python
you need.
* ref-manual - the FAQ entry about not having the right version
of Python.
(From yocto-docs rev: 5a0d3ac1c2a4154b93dc925b8074bc9243a86faf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This minimum Git requirement is now version 1.8.3.1.
(From yocto-docs rev: c68aa31442f7ac58a6f597f3074416afaab95882)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences
of the DISTRO_NAME variable had to be checked to see if they really
should be using the "NO_CAP" variable instead. Output and actual
branch names are case-sensitive.
(From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #9386]
Added some missing information:
* Added instruction to be in the poky directory before cloning
the meta-intel repository.
* Removed the "source" part of the string for the bitbake-layer
command.
* Added text to describe that the user needs to be sure that the
same branches are in play for poky and meta-intel before they
launch the build.
(From yocto-docs rev: 65461624691a566a5849c6d9df7b269c3de2eba7)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Fixed some wordings
* Fixed some links for consistency
(From yocto-docs rev: 9737ba3a572140bec892ffb555241a2259bd517a)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the "Building Images" section, we just plow into the command
line experience without giving any indication of a GUI option
through which to try out the Yocto Project. I updated the
paragraph introducing the build stuff by presenting the command
line method or a GUI method via Toaster.
(From yocto-docs rev: c7d0b2e1c3f9746bdcf2ba8ded71ee14cfa17e58)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8914]
I added more detail on the types of information covered in
both the dev-manual and the ref-manual bullets of the section.
Also made the distinction between reference material and
non-reference material.
(From yocto-docs rev: e61e0bc4797c18c85ffa697d9fc0f003007746b3)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8696]
Turns out the 'dnf' command is not yet supported for CentOS
as it is for Fedora, I changed the 'dnf' command back to
'yum'. Also, there were some essential packages that needed
to be added to CentOS. Finally, there was a slight
inconsistency in the Fedora list of essential packages and the
ones for supporting Graphics. I had a redundant listing of
one of the packages. I took that out of the Graphics area and
left it only in the essentials area.
(From yocto-docs rev: dde72542ca87bfdd82d713f90938a41c83ac8a4d)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #8159]
Fedora and CentOS have deprecated "yum" and have come up with
"dnf" as the package manager. This happened at the end of
2014. I have replaced the occurrences in the manual
appropritely.
(From yocto-docs rev: 14c80ecc8d6a4f9bf355dd84657d339782da83f0)
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 customization layers were pointing to Sourceforge site for the
XSl files needed to build the manuals. Throuhgout time, this site
has failed me enough to warrent trying to get these XSL files from
some other source. Rather than ship the XSL files with the YP release,
we decided to create some mirrors and point the customization files
there.
(From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
GNOME Mobile no longer applies. I updated text to use the
GTK+ wordings.
(From yocto-docs rev: 09e67479f470ca4b21f532c5fc96f36d3bf1a39d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixes [YOCTO #7535]
Removed this from two places.
(From yocto-docs rev: d169ce99610745e8c1b4b53d898f526e557af665)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The docs are not building on CentOS and we think it is due to the
XSL templates being called for the Eclipse parts. I located all
the "current" templates and switched them out for "1.76.1" version
as are used by the mainstream doc builds.
(From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The note alerts users to issues building QEMU when the build system
has the oss4-dev package installed.
Fixes [YOCTO #7382]
(From yocto-docs rev: 0f189ca7567e3e646808d5360fdb1499df8605c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some changes based on input from a new user. Basically,
added a bit more explanation in a few spots and some suggestions
on where to read or go next after concluding the two basic
quick-use sections.
(From yocto-docs rev: 5381f1202957e171d16d97332b40e8d363828a20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Using the 1.76.1 version in all the customization layers so
the manual revision tables will build with boxes.
(From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338)
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>
The way the old manual set had worded the use of the
BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS
had become depricated. It suggested a lot of user intervention
to get these variables set to have the build system utilize
optimal parallelism. The change a while back to the build system
where the variables are set to the number of build host cores
now makes the variables automatically be set to their best
values. I have gone through the manual set and changed wordings
appropriately to reflect this.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
When you "make" the mega-manual, there were four tags across the
various manuals where the same string "id='intro'" occurred. This
causes warnings during the make process. I updated the strings to
be unique. There are no cross-references to these so no collateral
issues were caused.
(From yocto-docs rev: d0e770e0ad797031a75e2373a41723408b4b051c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I need to get back to how it was working and then fix the table
box issue from there. Using the 1.76.1 stylesheets makes the
build too long for the manuals and sometimes the XSL sheets do
not load.
(From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This fixes the issue where the lines for the manual revision table
are not appearing. For some reason they do not appear when building
the docs using Ubuntu 14.10 and the "current" XSL transformation
files. So, I backed up to the 1.76.1 version, which is the nearest
version where the issue does not surface.
(From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This reverts commit 914c482bd89071ab34b3381e3bd8065f871cc047.
I had to revert this change because it broke the footnote behavior.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Creation of a PDF version of the YP Quick Start is not supported.
The <mediaobject></mediaobject> code appears in the manual for
that purpose only. It is ignored during HTML generation. Thus,
I have removed it from the file. The image is actually displayed
through the <authorgroup> definition, which is located in the
CSS stylesheet.
(From yocto-docs rev: 322ae6450dfac9b2054b33334898a078fdd20902)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 #5772]
Updated each manual's CSS style sheet to contain a style for
how the permalink symbol looks on its own and how it looks
when a user hovers over it with the mouse.
(From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5)
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>
Fixes [YOCTO #6430]
The style sheets were carrying over old .PNG files that are not
part of the manuals. I have removed the statements that were
using them.
(From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d)
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 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>
