Re-write of the section describing how to update package source
code. I added some rationale to the process and provided more
detail regarding where to find the source files and the naming
scheme behind it. The new section is on review so changes could
occur.
(From yocto-docs rev: 2a1d37a87abb82c66a0ad3fc39d5da9f2f5b1b7e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Last edits to the "Git" section and the bulleted item that defines
the term "Yocto Project Files." These edits were from a review of
Joshua Lock.
Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: 57cbb06aac566e02bb2e2a1ad05c3ff6dbb0359c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the example that shows the linux-yocto_3.0.bbappend file the
commit IDs are pretty much random and taken at the time I wrote
the section. I have provided a qualifying statement before the
example to explain that the commit ID strings in the manual's
example could differ from those in the actual file in the YP
source repository.
(From yocto-docs rev: f31278a7ebc4271a6cb75da6891d2d9bf82d41f3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section is the first attempt at a new, high-level discussion
of Linux Yocto Kernel configuration. The section is supposed to
introduce the concepts only and leave the "How to" stuff for other
areas of the documentation. I have thrown this section out to the
Yocto Projects Discussion list for feedback. It will change.
(From yocto-docs rev: 8d0eabe88e50d1a16fda4b845267c4ee240ce540)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The reference for changing a BSP configuration was going to the
kernel manual. This was an old reference. That information had
been pulled from the kernel manual and is now in the BSP appendix
of the YP Development Manual. I updated the reference to point
there.
(From yocto-docs rev: 20b386c522b1fedc2249ac72f151192ff69d098a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Crownbay commit ID's used in the example did not match what
is in the YP source repository for meta-intel. I updated them
to match.
(From yocto-docs rev: c090119f59b9f1fe8caebeea8ba61c6c1252a892)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added "tasks" to the bullet item that says the manual describes
common development models. Now with the "Common Tasks" chapter
in here the intro needed tweaked.
(From yocto-docs rev: 8faa6308dbee2138f404d18c6d384b9af7bad5cb)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Broken link fixed.
(From yocto-docs rev: 6c9102ed8651ab93de46781dede05b2312d102d7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made another pass through the document and cleaned up some
mistakes and also removed redundant links to manuals where I had
already provided a link to the specific section.
(From yocto-docs rev: 5da8ffe100127f5fe4bfd2b478f177d6bef3a968)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Moving the "Common Tasks" section from the YP Reference Manual into
the YP Development Manual upset a bunch of links. I have corrected
these links.
(From yocto-docs rev: 69ee73c59958aaab6f6370231c65300d1d8c92f8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Pulling the "Common Tasks" chapter fromt YP Reference Manual
broke many links. Each of these links had to be repaired so that
the link is to the YP Develepment Manual now, where the chapter
was moved to.
(From yocto-docs rev: 08176135b8ac856b8cf7872300ce41ada87fa486)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated dev-manual.xml to include the new common tasks file
'dev-manual-common-tasks.xml' and updated poky-ref-manual.xml
to not have the file 'extended.xml'. This reflects the new
chapter swap between the YP reference manual and the YP
development manual.
(From yocto-docs rev: 978e3be4f20b0a95cf124ce1a9136016a3e71da1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I am moving the "extended.xml" file from the YP Reference Manual
to the YP Development Manual. This will be the basis for a common
tasks chapter that talks about common things developers do.
(From yocto-docs rev: 874b3a399c69e5eabf5001a5df5a3064a6d1f0ec)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the tarball and Git repo example in section where user
is getting the source files. I was not using the default
Yocto Project Files top-level name for the tarball method.
Reported-by: Joshua.lock <joshua.lock@intel.com>
(From yocto-docs rev: 770c6799ea58df3d81df8f466f1bb9878532a995)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I split the Git section into a couple sub-sections. One talks
about concepts and the other is the section on simple commands.
Hopefully the concepts section now addresses the confusion
people are having over branches, tags, etc.
Also changed the definition of the term "Yocto Project Files"
based on some input by Joshua Lock.
(From yocto-docs rev: d76a9942dd12e6bd3ccba5331039477b26c02379)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the example to use a different kernel (linux-yocto-3.0-1.1.x)
and the example that creates the bare clone and the copy of the
bare clone to use better names that are more easily distiguishable:
linux-yocto-3.0-1.1.x.git and my-linux-3.0-1.1.x-work, respectively.
(From yocto-docs rev: b1366d35155121f5aa576715541036304c99f13b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits help explain the differences between local YP files
created through a tarball extraction vs cloning a Git repository.
(From yocto-docs rev: ed368800c3e9ece71d27d6d690f0ddc264a4c2da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to the section describing how to set up the YP files before the
BSP example. I am working with Joshua Lock on these to settle them
down. The edits are trying to establish understanding between a
Git repository and a tarball... just what the user has a hold of
after getting the files by either method.
Reported-by: Joshua Lock <joshua.lock@intel.com>
(From yocto-docs rev: ddb8333ea2f9898b7016ca01887e1acdc0581c06)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Final edits to the new CONFFILES entry and an updated more robust
FILES entry in the glossary. These two entries are good examples
of the depth of detail we should have for all glossary entries.
Kudos to Paul Eggleton for tirelessly working with me to get the
descriptions just right.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 88e9836a964a9057aaf6ac472b4fb09981a069ac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added descriptions for 'core-image-rt', 'core-image-rt-sdk', and
'core-image-gtk-directfb'. These were apparently missing.
Fixes [YOCTO #1921]
Reported by Shane Wang <shane.wang@intel.com>
(From yocto-docs rev: b83f9fa2a2de867ef9973b84aa1bec94e8071e45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
According to Richard Purdie this is a nasty variable and people
find it hard to use. I removed the glossary entry for it.
Reported by: Richard Purdie <richard.purdie@intel.com>
(From yocto-docs rev: 602ec3ea42700b8baff096689c732cadec3e5797)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Second editing pass to these glossary entries based on Paul
Eggleton's review.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 690043a7b239479c948e1219dcb44751570cc624)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor tweaks to this glossary entry as requested by Richard Purdie.
Reported by: Richard Purdie <richard.purdie@intel.com>
(From yocto-docs rev: df39b52a89e0ac99d16c8ce1f0f37a284dc5e08a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new glossary entry fro CONFFILES and I updated the existing
description for FILES. These two variables are inter-twined. FILES
was a one-liner and definitely needed expansion.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 6788128c459ccf04f932c2273aca1e6b88f0def0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No longer applicable according to Paul Egglegton.
Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com>
(From yocto-docs rev: 503884d2e3b49bd8102fc64f5487361dae0160aa)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These are transitory and related to bug 1717 (the kernel manual
is confusing). Slow going on this stuff. The edits are notes only.
(From yocto-docs rev: f4a8cdb710b91892ae73eea41f6059fd9159c4cc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is confusion as to how to set up the Git repository and be
sure you have the snapshot of the release. I have changed the
description to use a tag rather than the branch names. The
stuff is out for review with Josh.
(From yocto-docs rev: 2521873e1bf8e1ad398fae4b7297f8746a34258f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The information surrounding the central download directory was
pretty scant. Jim Abernathy pointed this out in an email sent to
me. As a start, I have added quite a bit more information to
the glossary description for DL_DIR. Part of that added information
is a pointer to the FAQ entry that describes exactly how the
build system gets source files. Then, in the YP Development Manual
in the section that introduces the build process, I added several
references to various variables that are set in the local.conf
file prior to kicking off the build.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: 4d7835a3bff5bd054301fa9ab6954c11c88dad58)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the glossary entry for the IMAGE_INSTALL variable.
It was not complete. I also updated the section that describes
how to modify the image through the local.conf file. These
edits are out on review with Richard and could undergo some
further tweaks.
Fixes [YOCTO #1897]
(From yocto-docs rev: 41124cdd9e69b9f17300a609cce2ae4c9ce57b54)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is a proposed section to describe how to customize an image
through variable setting in the local.conf file. It is incomplete
but needs to be checked out and discussed.
(From yocto-docs rev: f995b01e9ec9dd12b62e514802000a7b76fe3126)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a glossary entry for BBMASK.
Fixes [YOCTO #1935]
Reported by: Gary Thomas <gary@mlbassoc.com>
(From yocto-docs rev: 4406a8b0b85ac15070e2ccb1c57ef9801827a7f7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some clarifying edits to the section that describes how
the YP team constructs the kernel repositories (the tree). There
were some things that just weren't clear.
(From yocto-docs rev: 127f0c8c89ec9b926a4ff348acc39a73f41e6fe7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the start of a new section on configuration. It is mostly
writer's notes at this point. More to be added later.
(From yocto-docs rev: db41de4ebd7040f507c5a43739f1a25d7e1d9623)
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 docs would not make on his
Ubuntu 11.10 machine without the xsltproc package. This package
was not listed as a required package. I added it to the YP
Quick Start.
Fixes [YOCTO #1933]
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: 0d4bcdd965e208588bbe283594d9d9528b87bf54)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several redundant links existed to manuals that are not required to
be linked. The actual link takes the reader to the section being
referenced. Then, after the link, the manual is referenced. Previously,
the manual was also linked. We don't need these links to the manuals.
(From yocto-docs rev: 579f4efd765dc20b38e1b022ae4b7a98a8fa53cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered that the figures used in this manual differ depending
on the branch. There are two figures that are different. Thus,
the TARFILES variable in the makefile needed to be conditionalized.
If it is not, then the process that makes the tarball throws errors
because it cannot find the two figures from the other branch.
To fix this I introduced the 'BRANCH' variable. It is to be used
only when you make or publish the YP Development Manual. And, you
only use it to specify 'edison'. If you are building from the 'master'
branch you don't need to use it.
Comments in the file have been updated to explain usage.
(From yocto-docs rev: a404eadbeeb6eb7476d8739bd07ecd071e9ff7da)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
Robert ear-marked some links to point to downloads.yoctoproject.org.
He also made several wording changes that resulted in better language
and in a couple of cases fixed incorrect subject/verb usage.
(From yocto-docs rev: 9106619c4264c2669be041c1e6d6124e022ab2d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert isolated a few technical errors and made some other wording
suggestions. I took the technical corrections and modified one
of his suggested wording changes.
(From yocto-docs rev: 3c6bbae05cdf2265e04d967050354ce75d62b4e2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Open-source changed to open source (no hypen). Broken URL fixed for the
1.1 release notes.
(From yocto-docs rev: d34df01aef674448d4cc06cfe4ff63cab764fe64)
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.
Community member Robert P. J. Day scrubbed the Quick Start manual for Release
1.1. He found several areas that were incorrect. Many items were documented
pre-release and changed during the actual realeas. Naming conventions for
images and such had to be changed. Robert also found and suggested several
wording changes that resulted in clearer text.
I was not able to patch all the changes using the 'patch' command. I need to
work out some process issues still in order to apply patches directly to the
yocto-docs repository. Meanwhile, I hand-inserted the changes. Also, some
text changes were modified slightly by me to conform to the books style, etc.
Kudos to Robert for such a detailed look at the YP Quick Start.
(From yocto-docs rev: 6bc2e9c289a802f511441ca5b31ca6163e4fdfac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Community member Robert P.J. Day pointed out that the URL used to
reference the Edison tarball in the manual was incorrect. It was
pointing to the old Poky area and not the Yocto-1.1 area. I have
updated the example 'wget' command with the correct URL.
(From yocto-docs rev: ba9deb4717b72b4d75c18870106607b1770ac45b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I somehow had that having a host with multiple cores and threads could
be used to increase the build time. It obviously should have been
"decrease". Kudos to Bill Fishburn for finding this goof.
(From yocto-docs rev: 2cd0ac980f9191edd3d4874508fd8fc9f0531622)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was not able to get to Bruce's comments he submitted to me for the
"Model" chapter of the development manual. His comments consisted of
various tweaks to terminology I used and the inclusion of some additional
technical information. This commit addresses all his comments for
the review.
(From yocto-docs rev: 206a22e1ccf077360974f18295b6df455cd50545)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Discovered a missing section for installation of the Eclipse Yocto Plug-in.
This information is critical to the release. Jessica discovered the problem.
New section added that describes how to install the plug-in as a standard
"New Software" installation from within the Eclipse IDE.
(From yocto-docs rev: d4976ec56d39813a72519387897023f65a5884f6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The re-structuring of the web server that holds the documents created
some bad links. I thought I had gotten them all but apparently not.
this is a drawback of not being able to test things until after stuff
is done. In any case, I grepped through everything and this takes
care of it.
(From yocto-docs rev: cdbc3b3b7f6d6ff01024b977f966459cf414ad5c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The restructuring of the web site where we store manuals broke some
links that were cut-and-pasted in from older work. These slipped by
me so not changing them would direct the user to a 1.0 version of
the externally referenced manual rather than the 1.1 version.
I also got rid of a visible "WRITER'S NOTE" in the document that
was left behind.
(From yocto-docs rev: 1508826312a2fe35e5d693821a4c7737baafcb2e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had to add some changes to the way we invoke qemu to show multiple
processor support. I needed the qemuparam "-smp 2". There are
other minor edits as well.
(From yocto-docs rev: 508863634ce537b0936f8e44f87b90bef678c122)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I somehow had either dreamed the word "einstein" into the release
for 1.1 and had it in there as part of the tarball name, etc.
I have replaced this obviously with "edison."
Other edits involved making the references to outside documents
more consistent.
(From yocto-docs rev: 2407b7dd89712c489d515e97d44e3c7dc0b64d20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the pathnames for kernel 3.0 from 2.37
(From yocto-docs rev: 220ce5fbb3663940b5940445190d30d98f58a438)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor edits for the kernel example.
(From yocto-docs rev: 01e9f01662efad746fbfc34820b6efeb34affecd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After greping through the documentation directory, I addressed
all the <ulink> statements that used to have yocto-1.0 in the URL.
They are now yocto-1.1.
(From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I re-ran the exmaples to set up various Git repos and updated the output.
Also fixed a bad tarball name from edison-1.1 to edison-6.0
(From yocto-docs rev: 6538d588fa35986ff301a22d327af73c337ec43c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made a pass through the book to clean up all areas in preparation to
running the examples again. Most changes were punctuation, manual
section reference formats, and wordings.
(From yocto-docs rev: 0d054f79c82ddc204938dea187312d1a80d0a2e1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
More changes to the internal section references. Using <link> rather than
<xref> to get rid of the section number in the reference.
(From yocto-docs rev: 4351fd4898c517e25235611893b1cd059cbcc2f8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I am using a certain form to reference other sections in the current
or other manual. I updated the references to follow this form.
(From yocto-docs rev: 2ba41ac2f355dbe66af19e356f9246b7485585b5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made several changes based on feedback from Jessica Zhang.
1. Removed "SDKVERSION" as a way of identifying the directory in
which a toolchain tarball is installed. I replaced with "1.1"
2. Cleaned up the bitbake command verbage to consistently use
'bitbake' command.
3. Cleaned up an erroneous reference to the toolchain environment
setup scripts. I was referring the user to the oe-init-build-env
area.
4. Changed wording to indicate that the toolchain tarball is generated
after running bitbake rather than installing the toolchain.
5. Replaced the gmae tarball file used in an example to be the
regular taball.
(From yocto-docs rev: f7c3e4f4a666121a29825099d451eab1accb0616)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed the bernard examples used when creating Git repos to reflect
the edison release.
(From yocto-docs rev: d345cb08905e7f5e21b1649af5e876317cc68931)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I changed several small things in the example as I worked through it
once again. The commit IDs changed for using the atom-pc kernel.
Also the command to build the sato image can no longer use 'live'.
(From yocto-docs rev: faff1e7f21b5059dfe708c6a3d83116c7349fe55)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
No need to use the long command to restart Eclipse. It will have
been restarted as part of the procedure. I updated the last paragraph
to simply point the user off to the next section.
(From yocto-docs rev: bca280e74f81a0401c520c8a59e9e07e16f28b8b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes are for installing the YP Eclipse plug-in using a built out
ZIP file.
(From yocto-docs rev: ea50f63d448b4ff6026a9334440058511782461d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Feedback from Richard Purdie inserted. I made an edit pass for
style to Richard's re-write.
(From yocto-docs rev: e5bb08e966614c610e6357642b3b2d1522332f7f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some slight edits to configuring the Eclipse IDE and the
procedure to install the plug-in from the zip file. This is not
complete yet.
(From yocto-docs rev: 96de3d21946d64e6b877f067912da8677c3d373a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This section used the term "tree construction" somewhat out of context.
The section really focuses on what the build process and the user does
prior to compilation. I changed wording to indicate the tree is
validated to be sure that the SRC_URI point to the right stuff and
that the BSP build branch exists.
(From yocto-docs rev: e6332d5045b21354b53bbbe1203f9d52d4d97964)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made a few corrections to the section describing how to build
the tcf-agent into non-sdk images.
(From yocto-docs rev: e78dc3b3d3dd443506e78651cf9673358577c21d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP only ships one pre-built image that has the tcf-agent built
into it - core-image-sato-sdk. There are a couple methods that exist
to create images that do not normally have this agent so that they
will have it. I updated the "Getting the Images" section to
contain those steps. Lianhao and Jessica Zhang were the technical
resources for these changes. These changes are the first draft.
(From yocto-docs rev: 85432e4892c3fe924bf90961f89e8edfd9693e84)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I created a section on how to prepare for and use the multilib
feature. The information is leveraged off the "Multilib" wiki page
at http://wiki.yoctoproject.org/wiki/Multilib. This is the first
draft of the changes. I expect corrections.
(From yocto-docs rev: 8cf41c90f772018f4f144d63df911912cc298d70)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated a link that was an autobuilder link to be
http://www.yoctoproject.org/downloads/yocto-1.1/machines.
(From yocto-docs rev: 91a4056a285b53f8c73494e8af88d9a98d6d61e0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the title pages for the ADT, BSP, Dev, and Ref manuals to
contain the Oct 6 release date for the books. Also, changed the
author field for the BSP guide to include Tom Zanussi as well
as Richard Purdie.
(From yocto-docs rev: 301da0a5b305e4b332397bb67f6a6a77751991d2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I went through and made sure examples are relevant, wording is correct,
large blocks of unused text was removed, and some references included
to other YP documents.
(From yocto-docs rev: 2231082530dd9cecc234f5f024c4e246afb2968d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added this variable description in the glossary.
(From yocto-docs rev: 12a9e5b4dfc399ff2037355aa1062f907a62e76d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Paul Eggleton he suggested that the wording we had about YP focusing
on the GNOME Mobile environment was misleading now. It was in there in the
original version of the FAQ but with time has become outdated. I simply
removed the "GNOME" part and left the part that mentions about YP
being a stable
environment and well-suited for the embedded mobile environment.
(From yocto-docs rev: cc7103eda3fd77d89cecfffa23f0f798aa512132)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the example I use for the BSP structure I use the Crown Bay
BSP. I neglected to include any explanation of the recipes-core
directory. I have added some description around this area.
(From yocto-docs rev: ba56c86e5a4aa3fbf23b12d26ffe35a3b6193a78)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the section on the supported distribution section by including
a link to the wiki page that shows what distros we have tested and
their status.
(From yocto-docs rev: e66a18a13dc02af6a0846dd1ecf14aeafcbe5d61)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new subsection to the section that talks about how to install
the YP eclipse plug-in. According the Jessica, we should document
this method for installing the plug-in.
(From yocto-docs rev: dea5b1dacc16c08d61356e95bece2aec581dd16d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This is the second pass for re-documenting RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIALS_EXTRA_RDEPENDS, MACHINE_ESSENTIALS_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS. These
variables are in dire need of better explanations and examples.
(From yocto-docs rev: cc60bd4c50c7b19209dae06307aec26e962cf476)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did complete rewrites of RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIAL_EXTRA_RDEPENDS, MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS. These are
sent out for review but these changes represent the first attempt
to clear up confusion on how the six variables are used and relate
to each other.
(From yocto-docs rev: 1d93707fb9383d51322e96eb521e96fcac8bcc47)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided better descriptions of these variables and some examples on
how to use them.
(From yocto-docs rev: 3a5cce8c9ba02f90b3554a6f800f69c2e8e77911)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a more robust description and provided a couple of usage
examples.
(From yocto-docs rev: b8b842b57cc003f1351a551041fe4b3de2fcbfd6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added sterner wording on usage and provided an example.
(From yocto-docs rev: 32e07fafadb602b93c9f7b8a78e5baf4c7e1ab5e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the description of POKYLIBC to note the variable is not supported
and provided a link to TCLIBC. I added the entry for TCLIBC, which
was missing.
(From yocto-docs rev: d76a1ddb79577a3e121df3d590fb601b5e5fbb98)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Noted that POKYMODE is no longer supported and provided link to TCMODE.
Added richer description to TCMODE.
(From yocto-docs rev: a7a326c2c8f4c5f29f3a9723a6895a7113a78357)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some minor re-wordings to give some context on how to use these special
files and the variable to point to them.
(From yocto-docs rev: 4482b42f4a224bada7a0fa5fe4821a753ba55d80)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added the directory where the list of know licenses are in the YP
files structure (meta/files/common-licenses).
(From yocto-docs rev: 6a8db1a5ac653dbc8730e61293221c0b0890888d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Paul Eggleton's suggestion I updated the description of this
variable. Some minor wording changes as well as covering two
automatic handling features.
(From yocto-docs rev: 15be3502ca20f657051e02d698b459328328fb14)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several manuals and areas were still referring to 'glibc' as the
GNU version of the Unix statndrd C library. We do not support this
any longer and now use 'eglibc' to build with. Notable changes were
in the required packages area of the QS manual. I also added a
bit in the reference guide saying how this release does not use
'glibc' to build with but rather 'eglibc'.
(From yocto-docs rev: c2c58914996d747c510706d78ecfd8f41c5e694d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a new section to the "Adding a Package" section. This section
describes how to define the *.a files for when you create a library
that has static linking. Response to a comment from Paul Eggleton.
(From yocto-docs rev: 64499006ecd1e6b7573f1955a2f6e2f1a9564ce8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New section per Paul Eggleton's request.
(From yocto-docs rev: ffedb53e5c706cffb83978f1704a606d29233e36)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
New variable for images that use the ipkg packaging system. These
are packages you don't want to install even when the recipe calls
for it.
(From yocto-docs rev: 78d53b5da4bbd6889a34be8a1c795a5658cb6b1e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I fixed the insane.bbclass description to say that it checks for common
problemos that occur during runtime and not build time. Also got rid of the
"ever-increasing" statement as that is not true according to Paul Eggleton.
Added many new .bbclass files to the commented out section of the
undocumented classes as well as removed a bunch.
(From yocto-docs rev: c341951185d5af6576718f8ada057afcca923e6e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I noted that the developer should remove this option from
EXTRA_IMAGE_FEATURES before they create a production image.
(From yocto-docs rev: 8de6c789d1a1ed5e721c16f53bb27de18ae88238)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
YOCTO #1504: Added a note indicating what to do if the configure
script complains about --with-libtool-sysroot option.
(From yocto-docs rev: 575f4057ddfc2774a62bf349fd05d62b79dd278b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes are the second edit pass for the new section.
There are some minor changes.
(From yocto-docs rev: 6c81617a2782d2f02d4900a68dd4e8c6eeb70fa1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General edits up through the BSP and Kernel overview sections. I also put
in place holder text and began on the application development over
section.
(From yocto-docs rev: 9c1b681ff253b469bffc355f0a938643997d85d4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is an example whose output exceeds the PDF manual version's
page width. I had to artificially break the line up.
(From yocto-docs rev: d8a5714a2f8193c1efc8a7080b8f6e0744da610a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to the dev-manual-model.xml chapter for general improvements.
Also had to update the figure that shows the kernel development flow.
(From yocto-docs rev: 2aacccb03d167eac74a1b45c39a9edac160efc7f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a note indicating where you can find the maintainer for yocto
code. Suggestion by Robert Berger.
(From yocto-docs rev: 8e55cc4c460582964b0267b4f43c14e7100f17fe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
somehow I lost three or four changes that are credited to Robert
Berger (Community Member). I have re-introduced them here.
(From yocto-docs rev: a23564ada0e072bea63739aeb1eb5c66d595e728)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I provided a link to the OpenEmbedded wiki page created by Mark Hatle
that provides good guidelines on how to create well-formed commit
messages.
(From yocto-docs rev: ea7b0100a7b45c369cb67daa0705dcc5acef40c8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General pass-through for consistency in referencing sections.
Also, added Darren Hart's review comments for the "Submitting a
Change" section. I added more about the mailing lists and how to
submit a proper commit message.
(From yocto-docs rev: d9c8f5db8c862b1be724915cc43da6d12b88b97d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I updated the mailing lists to be more specific and to be formatted
differently.
(From yocto-docs rev: 50b5cf2d331b120cfa9de0ba77ea1da1240d42e4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied consistent section referencing formats. Also cleaned up some
terminolgy for the YP Git repo.
(From yocto-docs rev: fa3cbb835b61158357d3f6fb9ebe017b9ba405cf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some indentations applied. Also, a few minor changes to some
wordings.
(From yocto-docs rev: a166f41a5bbf3590d8a2fabbee267bdd190f19dd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I needed to reference the image differently for the pre-built section.
(From yocto-docs rev: 10568a0a8c4160af995089e481ccc2772e81d805)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This was a final scrub of the manual. I updated all examples and links
to be current for what I think will be the 1.1 release. I also added
some cross-referencing into the YP dev manual that now exist.
(From yocto-docs rev: 4c10b0e04856817a1d03aee7a9ed6e4d5d73a3ac)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These changes reflect corrections resulting from Jessica Zhang's review
of the sections.
(From yocto-docs rev: c3fed39bc3909c38424e7e72c40471dcb0053c8d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
After working through this stuff I was still confused as to how to
guide the user toward proper toolchain installation and on what they
needed to do for collecting their kernel and filesystem images.
These changes included some information on when and how to extract
the rootfs when the user is booting to NFS. Plus some other
general items like the significance of meta-toolchain-sdk as
compared to meta-toolchain.
(From yocto-docs rev: 2cc88b5193888a074ffd87cb253b9cfe08146877)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I had definitions for "The Yocto Project Files" and "The Yocto
Project Build Tree" in this chapter. They were misplaced. I have
deleted them and moved them to the development manual.
(From yocto-docs rev: 9238e75abc4578043fd625b3796b86d42204e16f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I moved the terms "Yocto Project Files" and "Yocto Project Build
Tree" into this development manual. They were previous defined
in the ADT manual. It makes more sense to have them where with other
terms.
(From yocto-docs rev: 2133110fd280db8cfbe998e6b46cdee0b260e777)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made changes to the section titles so they have quotes around them
for easier reading in the PDF manual.
(From yocto-docs rev: 5bea470682c3d834f30ab0d2fcba148ea33d653f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a development writer note and I noted that running a project
as an eclipse application pops a new instance of Eclipse.
(From yocto-docs rev: 6408ff7f4d59a0e535e560c7c0c63a3f373c640b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a couple of writer notes for development purposes. I also
formated the section title references so they have quotes around them
for easier reading in the PDF verison.
(From yocto-docs rev: 37adb580cf6c1369da43fc4ef7aaa4cc1cee0e5c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
fixed some section naming conventions and minor wordings.
(From yocto-docs rev: 768d386c135c57ed3573e08bac72cad47fa101ce)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The information in the "Contributions" section has been migrated to
a "Submitting a Change" section in the YP Development Manual.
I re-wrote this section here to simply make a general statement
about how you can submit a change and then provided a reference
link to the appropriate section in the dev manual.
(From yocto-docs rev: 038caebb2815a8f09d35e99d5a2a0be76b05cacf)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on submitting a change was very sparse and incomplete.
I have significantly upgraded this section to provide more details.
(From yocto-docs rev: af43bb1e4902c45afb5ac4b0f099877acd7a81a2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made several edits here. There is some mystery as to which changes
are actually part of this commit. I did a 'git diff' and am only seeing
one small change. If I later find they are not there I will delete the
file and replace with a back up I saved prior to submitting this commit.
(From yocto-docs rev: 62c63b3a812eaf92ca2bffa5714a6d327ac32d64)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a type and also qualified the ability of YP as a testing environment.
(From yocto-docs rev: e158615eba04709e05cccaf29238bde6c9843671)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some clarification on the ability for testing. The wording as
it was implied that the YP provided a complete testing framework,
which is not true.
(From yocto-docs rev: e40b39179c69b69f012f231009131b1efa7e732b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I discovered that in order to remotely deploy and debug an image from
Eclipse you have to have a Sato image. I added text to the note about
getting or building the image specifying that requirement.
(From yocto-docs rev: 060de7f6082bc3dbfa0f7d4e25b2933f15a61fc0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
These edits are extensive and cross into two files: adt-prepare.xml
and adt-eclipse.xml. This is the first pass of a large re-write
to bring the examples up-to-date using the preferred version of
the Eclipse IDE (Indego 3.7). Much has changed.
(From yocto-docs rev: 57c1f905c6d66268a498e013193d003596f2303d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This bug was filed by Gary Thomas and was requesting more information
on the "hows" and "whys" of setting up your own package repositories.
At this point, I have added information to help the user understand
build performance issues when choosing between the RPM and IPKG packaging
systems. Likely, there is more that needs to be added to fully address
this bug.
For now, I added explanations in the packaging class and glossary areas
of the YP reference manual, a new paragraph in the YP QS just prior to
firing off a build, and a new bit of information in the configuring
PMS in the ADT Manual.
(From yocto-docs rev: d0025f862cb85ca741787b4737dca286e3ebfb45)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated the variable name of the adt_installer.conf file that points to
the IPKG repo. This changed for 1.1. Also made some small edits.
(From yocto-docs rev: 893b8b2f4bed8d4fce9a876e2184b3f5b9b004c0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a link to the getting setup section of the YP dev manual for
help on setting up the YP files.
(From yocto-docs rev: 13832465de69bc41ddcc5e5696e707be8a3b6c5a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I performed general edits to this chapter as well as addressed the two
items for the YOCTO #1419, which was re-opened. These included
specifying oprofile version 0.9.4 required and the note that
oprofile-server is only installed by default in the core-image-sato-sdk
image.
(From yocto-docs rev: fdca6458d9cd431052126d31f6eb4396c3327982)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made a pass through the manual and made some general formatting changes,
updated some links in anticipation for the 1.1 release.
(From yocto-docs rev: f2d3a012fbe4e8db3cf07e5497acfdf732e55d97)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Because the Crownbay uses both EMGD and non-EMGD statments in the
linux-yocto_3.0.bbappend file I had to do some explaining. It turns out
you don't really need to just delete or comment out the non-applicable
statements.
I also adjusted some wording around the tuning file example. This file
I assumed was in the conf directory of the meta-crownbay directory.
It is really in the meta/conf/machine/include directory.
(From yocto-docs rev: 3f82656f7ffb392333f8cf59abf1414af5da512b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Jim Abernathy ran into an error in the BSP example. The error had the
BBFILES_COLLECTIONS_mymachine in it (incorrect). It needs to be
BBFILES_COLLECTIONS.
(From yocto-docs rev: 267a385aa5ab0eb46cf583db418cbbcab1e8b89b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Darren provided me with some feedback on the logging mechanism
section for both Python and Bash.
(From yocto-docs rev: 7dddadf8caba01d3ef1046be52a1435eeaed60a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Dave Stewart said that good coding practice is to set the variables
before any print statements. So I moved one statement above the
example printk statements.
(From yocto-docs rev: bad0537a5a6472fb3fef06de9763990a0c352e25)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Feedback per Dave Stewart added to clarify which two important
configuration files need editing.
(From yocto-docs rev: f37ade7f0d31ae6284c3bfee184c88b523f5fe69)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
these are new figures to support the "Modifying the Kernel" conceptual
section.
(From yocto-docs rev: 1a0ecc104479b54a8122e3de2b30694fac8d7e73)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Complete re-write of this section based on feedback from Dave Stewart.
Dave's comments centered around not being able to understand the overall
concepts of the Git repositories, the source areas on the host, etc.
I have added several illustrations and written around them to try and
better explain the kernel storage system in Git used by YP and how
that tranlates into host-resident code that the developer ultimately
uses and the Poky build system uses for the build.
(From yocto-docs rev: 4e37f68f77261f6519426fb81ba407c456f8d1a1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added 'xterm' as a required package to both Debian-based and RPM-based
hosts.
(From yocto-docs rev: 0a933001bd8c546a5d4960842c5e897061d09369)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
YOCTO #1419: I have re-worded the informational bullet on the OProfile
tool to indicate that you must have version 0.9.4 or greater of the
oprofile-viewer in order to have usable data on the host.
(From yocto-docs rev: 44fabbf8015b9bb624a5d70336a4440bd73c2c34)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The file used a lot of crown bay stuff that had gone old.
I have updated the sections and used the latest Crown Bay
files.
(From yocto-docs rev: 67b119d66bacd0870f18a124bacabf32d65b6f3b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This machine is out of date. I replaced both occurences with
"qemux86", which is more relevant to YP.
(From yocto-docs rev: 8fe6feccc25f594a444b5177d1192899b3cbdd9c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Robert Day correctly pointed out that the usage comments in the Makefile
were not exactly accurate. The VER argument is necessary only if you
are going to publish a document to the YP website. I updated the usage
comments accordingly.
(From yocto-docs rev: dd033227af0f88e45b539b92be8f1321fcd4f975)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Darren's feedback on this new section I updated changes based
on his comments.
(From yocto-docs rev: a5bbba42ec0da5b2f83f7a64ac8eef466e9c89b3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is a section in the YP ref manual that gives reference type information
on adding a machine. This type of information is detailed well in the
BSP example appendix in the development manual. I don't want to completely
eliminate the information in the YP ref manual as is suggested by the
910 bug. I think referencing it in the dev manual for now works.
(From yocto-docs rev: e55dd8228d1376c9df01e320163862ddf35a5156)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on how to contribute changes to the YP resides in this
development guide. I took additional information from the YP reference
manual and merged it into the section here.
(From yocto-docs rev: 945dd29417cf51044332114e499b08fe24ef3077)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YP reference manual had an appendix that included reference or
resource information such as mailing lists, bugzilla link, and
IRC chat stuff. This type of information is best suited for the
introductory area of the development manual.
(From yocto-docs rev: a5576ed0d3360cdb32070ade6577cb7687923b10)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This chapter was quite old as it had not been touched since the original
Poky Handbook days. I re-wrote the sub-sections with today in mind.
(From yocto-docs rev: e59bede734a8fe3e9b41698e2b42ba487ec80595)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In general, the term Poky can be replaced by "the Yocto Project."
The term Poky can be used as a term for the Yocto Project build system.
I left it in place for a few areas where it was easy and would not
be confusing.
I also performed general rewrites for the FAQ.
(From yocto-docs rev: bb24bcf21311c68576fb8c3fec86ad8303f557f2)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was incorrectly referring to SRCDATE variables in a context that should
have been SRCDATE destinations.
(From yocto-docs rev: eb255d9369b5bb3905a586433d472fd100c737dc)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>