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>
I added three new glossary entries for how the build process
figures out the image size. Entries are for IMAGE_ROOTFS_SIZE,
IMAGE_OVERHEAD_FACTOR, and IMAGE_ROOTFS_EXTRA_SPACE.
I still need to create a usage section for this topic.
Likely this will be in the development manual in a new chapter
I am thinking about.
Fixes [YOCTO #1110] partially.
(From yocto-docs rev: ec6b9d77d10a95f0a2d460dca3cf8eab5dfbf0c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I created a new section in the "Technical Details" chapter of
the YP Reference Manual to deal with licensing. I migrated the
existing section on tracking licenses from the "Extending YP"
chapter into this section. The new section now includes that info
as well as the new information here.
Fixes [YOCTO #576]
(From yocto-docs rev: b0d04bf99838d64e71ccd43d587d6641aaa26038)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some general edits up to section 3.4.
(From yocto-docs rev: 5bcd22b6372017c4f78b18035193879890ed8244)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cleaned up some areas. Fixed use of "uprev" term for consistency.
(From yocto-docs rev: 2d0c4d3c28a218f6302aee8ff2841420fbde410d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Richard reviewed the new sections and had a couple comments. There
was one technical error and he also wanted YP worked out when it was
being used in the context of the code that was doing the work here.
So I replaced with more generic terms or specifically called out
BitBake as the responsible software.
(From yocto-docs rev: 40343bf30b8492757f81bc0274d46931318f7120)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more information about how BitBake actually runs a task.
The information has to do with how tightly BB controls the execution
environment of the build tasks to prevent contamination from the
build machine from leaking into the task execution environment.
This tight control actually causes some unexpected behavior during
builds. For example, when a user exports and BB_ENV_EXTRAWHITE
an environment item such as CCACHE_DIR, the effects of the environment
item never make it to the BB task execution environment. They only
make it to the data store. The user actually has to take some extra
steps to export that environment item into the task execution environment.
The added information I put into the "Running a Task" section describes
these extra steps.
Fixes [YOCTO #689]
Reported-by: Wolfgang Denk <wd@denx.de>
(From yocto-docs rev: 182aa61693c2c7de8331569c30cbb8f41dad2315)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the tips and tricks section to include two sub-sections.
The first if the debugging stuff from Richard's email. The
second section is how to invalidate a section of the sstate
cache on a per-class basis.
Fixes [YOCTO #1500]
(From yocto-docs rev: 7493f5e7ec641e7cd79f8e3e6c045cadf7a6999c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
More work on this bug for sstate. This commit represents the third
pass through the new chapter four (Technical Details) that is
dedicated to YP components and sstate at the moment. The material
is unreviewed by Richard as of yet.
(From yocto-docs rev: 3c0e5bac288c05ea3fd93b1d1d5866895c5c2d1e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed "versions" to "Versions" in the title.
(From yocto-docs rev: 9bcec4f41df6e89b35be8e073fb970af2e2e53a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Beefed up the introductory paragraph and I re-ordered the "Making and
Maintaining Changes" section towards the end of the chapter.
(From yocto-docs rev: b166fbfdccc971f077f9d0e598604f761a820b4f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Beefed up the introductory paragraph a bit.
(From yocto-docs rev: be1716f393b5f8dd963275f49951ac7553eb3381)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a reference to the YP development manual in the introductory
paragraph.
(From yocto-docs rev: 84761f2a705cd0c3bf730b9f13fd21ca318c0494)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The list that describes the organization of the book needed the
"Technical Details" chapter added.
(From yocto-docs rev: f94d4b2626c1a2e2bf3f6d033222ab1b35c3efde)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Long-term strategy for the YP Reference Manual is that it contains
reference material and not "how-to-information". A step in this
direction is to isolate any discussions on components and other
areas of YP that need talked about. So to start with, I have created
a new chapter for now named "Technical Details" that so far has
a discussion of some components and shared state. This is a
step in the direction of making this manual a reference manual and
not a "how to" manual.
Changes included removing redundant material from the 'usingpoky.xml'
chapter and also adding the new chapter 'technical-details' into the
'poky-ref-manual.xml' file used for the make.
(From yocto-docs rev: 567823392d903016d314ae9fcc1b4d7abf59d9ae)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed some comments that were buried in the file that were
notes for working on the sstate section.
(From yocto-docs rev: 697b621db627c680318060091cf57cd5fc74148d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First draft of a re-write to the "Running a Build" section to try
and satisfy YOCTO #1500. I segmented the section into three areas
rather than a single area. This allowed me to create a sub-section
for the sstate stuff where it could be addressed on its own. I sent
the draft out to Richard and Mark H. and got feedback from RP that
is going to cause further changes. Thus, I am committing this partial
change.
(From yocto-docs rev: 4a99bcbda85ede0bd9490002c08461cc834b7518)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A new glossary description for LICENSE_DIR. This variable extends
the COMMON_LICENSE_DIR that YP uses to find license text during
the build.
Reported-by: Elizabeth Flanagan <elizabeth.flanagan@intel.com>
(From yocto-docs rev: b96736e88e1432e9c8b3b2eb5385e1193d66f3f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added explanation about this class being configurable for
generating warnings or errors through use of the WARN_QA and
ERROR_QA variables. Also provided a list of tests that can
be tested for.
Fixes [YOCTO #1773]
Reported-by: Mark Hatle <mark.hatle@windriver.com>
(From yocto-docs rev: a114ec3fd4f21ebf4dfd1d5c960d606e0db193f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The URL for the edision tarball was old and had been locked down in
the manual too early. It changed and now this fixes it.
(From yocto-docs rev: c1668e41babd7ef592dc26271943c99bacc3f181)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the Bug Tracking section to include rudimentary use of
Bugzilla for entering a new bug.
Fixes [YOCTO #237]
(From yocto-docs rev: 8f2702444812c9dc25195340acebbaae15cd59d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New glossary entry added.
Reported-by: Darren Hart.
(From yocto-docs rev: 03845586f7331630bd1d9b5eebb9df9eccbd05a0)
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>
I replaced the link with the URL that uses 'downloads.yoctoproject.org....'
(From yocto-docs rev: fef7ca4f2a549fabc1932a40a46cf0c6c834074f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
the name was off. It was 'yocto-eglibc-x86_64-i586-toolchain-1.1.tar.bz2'.
Really, the name is
'poky-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2'.
(From yocto-docs rev: 3d051f3e814f27f661ce153b66735f75a4152d04)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the link to be 'download.yoctoproject.org/releases/yocto/yocto-1.1'
I also fixed the text that indicated 'i586' as a directory for the
32-bit machines. The real directory name is 'i686'.
(From yocto-docs rev: fc08acdce64bac7c2b3d4689e16cf06e70f6cbe5)
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>
Tom Zanussi provided a review up through part of the "model"
chapter. I have implemented his comments mosty verbatim.
Reported-by: Tom Zanussi
(From yocto-docs rev: 693d4fadd4b34ffef9953fb1850d381ff7c028a3)
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>
Robert identified several wording issues. Fixes applied.
(From yocto-docs rev: 9c1ed58a1ecdd620246970419ed58b53f95cf2ec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert identified this broken link to the stable Yocto Releases.
As Reported by: Robert P. J. Day
(From yocto-docs rev: e42a501df2ca44030f99f017b8c532b03db62f55)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert found five instances where I missed the correct usage of
"BitBake."
(From yocto-docs rev: 0819076e8677accd157497ed4fa33ebab2528044)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Michael Tomer from Koko Fitclub reported that the link to the
ADT Installer tarball was broken. Fixed the link.
As Reported by: Michael Tomer <michael.tomer@kokofitclub.com>
(From yocto-docs rev: 891fc3123f73a7b856207e0cdef32821f0cd90a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I increased the font size and darkened the type up for footnote
text.
(From yocto-docs rev: d43e99137c350d68484df6c0a361804d8ccd2877)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several notes were not producing a line-break betweent he end
of the note and the start of the next paragraph. Most work, but
for some reason these did not. It is a mystery to me.
(From yocto-docs rev: 2c87e0cb781b6d94297dc558504f869bd54a6ad0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
For HTML formatting I added a new element to format the footnote
to pt-8 font.
(From yocto-docs rev: e0dd425a60ca6e1b75406c7711295e732cacebb9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Tom Zanussi's suggestion, we added a footnote to the paragraph
instructing the user on build problems for the example. I don't
have clean fonts in the HTML version of the output. I am still working
on figuring that out.
Reported by: Tom Zanussi
(From yocto-docs rev: 30fe7bd239292ed92f76fbc2f1fad62469f7fe9b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some wording changes to keep things accurate. Also inserted some
" " characters in some headings to force an extra space between
normal font and courier font words. It appears the PDF version of
the generated manual shoves these words together with no intervening
space. Looks like hell.
Reported by: Tom Zanussi
(From yocto-docs rev: 5dcb9ae99f1752599fd56a276ccafd79a52334f8)
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.
Broken link to the YP website's Download page. Fixed.
(From yocto-docs rev: cffba12b611a350652cb7ae0c49c6a6c809593df)
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.
Two corrections identified by Robert. One is a wrong reference to the
tarball needed for the example. The other is a more complete description
of what the appendix is trying to accomplish.
(From yocto-docs rev: 387c6cbd84bafd7f15c064a8e801d0750b0b4007)
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.
Robert indicated that it was a bit of a search to find the tarball
for the example. Tom suggested that we have some text that helps
to locate the Crown Bay no-emgd tarball for edison. I added some
clarifying text to help.
(From yocto-docs rev: d21120bbae81f58a9816cf56c61181d287afd295)
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.
Robert was working through this BSP example in the development manual
and ran into some problems and some confusion in areas. This launched
a long "help-desk" session with Tom Zanussi. In addressing Robert's
issues, Tom decided to make a run through of the example as it was
written. For the most part the example was sound but needed some
technical tweaks as well as some expansion of the text to make things
clearer. Tom submitted the patch that addressed these concerns.
Scott Rifenbark reviewed the patch and further modified some of the
writing to make it consistent with the existing writing in the manual.
(From yocto-docs rev: deda08b372c02889398d24ae7159f8b2fbe3c8cf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two typos fixed.
(From yocto-docs rev: 6d99eb7f728b812be37a3865cbebd3c4cb4b67be)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Two small corrections for better wording. A mis-spelling also
fixed.
(From yocto-docs rev: 915ec9f9adbde86008ffb086ac81a435d5910733)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert suggested some minor wording changes that are good.
(From yocto-docs rev: 50822bc3722e2f3b0a73ed837842ddc5c7595c7b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Scott Rifenbark
Robert P. J. Day
Tom Zanussi