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>
Scott Rifenbark