I had added some edison-specific figures and they needed to
be included in the TARFILE variable for the YP development manual.
The fix now makes the TARFILE variable all-inclusive for all
.PNG files regardless of branch. Consequently, there can be
some missing files when the manual is made but the errors are okay.
I documented the exceptions above the variable.
(From yocto-docs rev: 500d4102c5496cb834b93378242599715810386a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Poor flow for the config_smp example. Upon reading this example
it did not stand well on its own. I added some text, albeit
redundant but necessary I felt, so that the example would stand on
its own.
(From yocto-docs rev: f8c0c9469eae0788f1bfba309deefb4e03d4bc29)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jim Abernathy pointed out an area where the bitbake command is
run from the top-level poky directory. This is incorrect and the
user should run this from the build directory. I changed the
instance so that the example instructs the user to either run the
environment setup script first, which would place him into the
build directory. I also reinforced it by adding supporting text
saying that you should run the bitbake command from the build
directory.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: b111e5e4faa6d4e5e99f48b886aeb72bb12e2914)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jim Abernathy pointed out that the 'fop' package is not in the list
of packages. Not having 'fop' prevents the user from building the
PDF versions of the documentation. I added 'fop' to all three
distribution's package lists.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: f481361fbc3330a8f415be8cb992844c2f214ce3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The links to the 32-bit and 64-bit Python tarballs in
miscsupport were broken. I fixed them.
(From yocto-docs rev: cc50d1ea3155cf1dd8d060c2c361b99b4f7d0d8e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Bad wording fixed to describe the changes to PATH when the setup
script is run.
(From yocto-docs rev: 0f2ae72edfab2a96cb5f82fac641f3b6fa364f36)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The menu for the YoctoTools in Eclipse moved from underneath
"Windows" to the top level. I fixed the reference to reflect
that change in the GUI.
(From yocto-docs rev: 10142812f55bce849b31c38337b0a731d71d2ba0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the wording in an example to use "menu" instead of
the incorrect "navigator pane".
(From yocto-docs rev: 751ac717d17356a77cd3967f9214be74a7bad910)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a bit more information to the third step of the
example that reconfigures a project.
(From yocto-docs rev: e21ebe5b665b50705fa863436e83af6cbd00eb5d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I removed a redundant link to the QS manual.
(From yocto-docs rev: 44ab96f9eaad8e57de760e2612e1a92bfe2ea898)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I worked through these methods and discovered a bit more on how
they actually work and when the user would use a given method.
The updates reflect this new knowledge.
(From yocto-docs rev: aa588a2bd2c28cc42db3a539ca5aba7233612de7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed redundant link for referencing a section of a different
manual.
(From yocto-docs rev: 5a78f2c4453944e750a0250f585bcb0614dbcbf6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the PDF version of the reference guide there were several glossary
variables that did not format correctly. The issue is that the two-
column list had instances where the variable name overruns the
variable description. I added an extra line return for these cases.
(From yocto-docs rev: bef1a8dfdc0529b270102d0336a7bd6d1500b68c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made another pass over the variables that affect the root filesystem
size generation. The changes are based on review feedback from both
Saul and Joshua.
(From yocto-docs rev: ccd569d7e464a219a1a3ff9b063e431ba3c946de)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added text to show how to unpack the generated ADT Installer
tarball.
(From yocto-docs rev: 32e7413623a5b43484d402989f892527e4a0fc48)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In resolving a commit conflict I accidently inserted some "1.1.1"
strings in some URLs where they should have been "latest". I fixed
these back.
(From yocto-docs rev: a78a28f317b426413ec0bd8c4115d5e69f609283)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The figure that shows the kernel repos needed the git push
command fixed. There was no ":" character in it.
(From yocto-docs rev: 4add1c83a8e3f4fec9ec6b678e31e259c700c077)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to update the figure again and I updated the surrounding
text.
(From yocto-docs rev: ed0aea8ad3670aace1eb51ca7a72e75a4c129fba)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the picture that shows the index of releases. they renamed
this from index of downloads.
(From yocto-docs rev: 38ffbb3138fa43fcb44456e6b6f46dc78cc87a14)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is note instructing the user to delete unused .bbappend files
or comment out the COMPATIBLE_MACHINE statements in those unused
files before running the build in the example. the note was not
clear about the COMPATIBLE_MACHINE statement in the .bbappend file
that is actually being used. I edited the text to be clear about
that.
(From yocto-docs rev: 73ed4df6f312c25103c41a1ee1dcdb9f7114ca45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the console output created when you create the bare clone
and the copy of the bare clone.
(From yocto-docs rev: cc6290e416fb113f687645517bccf3f6f177395e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the console output returned when you set up the
poky-extras repo.
(From yocto-docs rev: f0fe9a6e04f72c727562719244719ce1058256e4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found a link that had a spacing problem and should not have
been linking to the manual in general. Fixed the spacing problem
and removed the links to the book in general.
(From yocto-docs rev: ce274c0290c4f8998bb682f8d84f5ee456837c62)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Found another broken link to the Git documentation. They must have changed
this stuff up. So I set the link to point to the appropriate area in
the Git Community Book. Talks about distributed workflows.
(From yocto-docs rev: f81d6bbff20629b2b3af73ef53f471090b9d828b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
there was a link to some Git documentation referencing workflows that
apparently had gone stale. I replaced the reference with a link to
the Git Community Book.
(From yocto-docs rev: 7a2cbe4c45eb9bb53d5ddbc014bd6005c2844d56)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The Git Workflow was missing a pull line from the second (bottom) contrib
box into the project's master Git repository. I added the line.
(From yocto-docs rev: e7e2f92a92cec3798395470595ba1a2beaf36575)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Beth has created a scheme that uses a file named "poky.ent" that
contains a load of variables that can be used throughout the
documents for releases. The variables can be set in the poky.ent
file and then sucked in during the make process to specify
a release.
This commit adds the new file and the changes to the YP QS manual.
(From yocto-docs rev: b08dde630a4f0762d8cc62c5579f6917d93ee854)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Richard made a concerted effort to enable Dash usage in Poky and the sanity
check to detect it is no longer present. We should update the documentation to
reflect this development.
Specifically the section in the quickstart:
"If your distribution is Ubuntu, you need to be running the bash shell. You can
be sure you are running this shell by entering the following command and
selecting "No" at the prompt:
$ sudo dpkg-reconfigure dash
"
Is no longer required.
I have removed it.
Fixes [YOCTO #1820]
Reported-by: Joshua Lock <josh@linux.intel.com>
(From yocto-docs rev: 189a80571bb7a1afd53171d93273e7cc26460d63)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
A missing dependency surfaced during a build by community member Marc
Ferland on a Ubuntu system. The "shared-mime-info" package would not
build. Fix was to add the "libxml-parser-perl" package. So I added this
package as a requirement for the Ubuntu systems.
Reported-by: Marc Ferland
(From yocto-docs rev: 3922f2eb24f8f2089c6fdb48a88530af2b26f159)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Scott Rifenbark