Added a bit more information to the wording where it talks about
creating a Git Repository if you are going to contribute back
into YP. This change was suggested by Robert P. J. Day and
was submitted to me in the form of a patch. For reasons unknown
to me the patch Hunk failed even though I believe I had things
saved and applied correctly. I had to resort to applying it by
hand. I ended up doing a bit of re-writing on the suggested
change to clean it up.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 94f90c91e6b1d13bebc7a434210452f222ef0317)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Several topics in the "Common Tasks" chapter really fit better in
the "Newbie" chapter. I moved these sections out. I also combined
information from the section on submitting changes from the
"Common Tasks" and the "Newbie" chapter to live in the "Newbie"
chapter only.
(From yocto-docs rev: 90fa8c125e545c57a5a994dd59715b73c5c4882f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Removed redundant link to manual.
(From yocto-docs rev: 7e7bc327237cae2be3c67e5b711548a16c4d8648)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new section on managing layers. This is a sub-section that
completes the new layers section.
(From yocto-docs rev: 551f36a75485d0b3ecbd69d94fc359cfa42c875d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The change to the dev-manual-newbie.xml file was minor. I added
a link anchor for the term "metadata."
The change to the dev-manual-common-tasks.xml was extensive. I have
added an entirely new section on layers called "Understanding and
Using Layers." The new material has several sub-sections.
Information was based on emails from Paul Eggleton.
(From yocto-docs rev: 4fb34abd60180fc2482ddb9f62e476763cee7679)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I renamed the "BitBake Layers" section in the YP Development
Manual to "Understanding and Creating Layers." Renaming the
section broke three cross-references in the YP documentation
manual set. I applied fixes to the references.
(From yocto-docs rev: 93f4f5dfb61ed48047a40f5bbbc3f5e844c7c2f4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The "BitBake Layers" section was grossly mis-positioned. It appeared
in the "Making and Maintaining Changes" section. I have moved the
layer section to the very front of this chapter. It is fundamental
to know about layers and how to create your own custom layers.
(From yocto-docs rev: 410154f6e0a1e1f3ebc05d3f45ed2ce6f71cc618)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new section on building from an external source tree.
This addition was driven by a need through two community members
whose feedback was picked up by Darren.
Reported-by: Inaky Perez-Gonzales <inaky.perez-gonzales@intel.com>
Reported-by: Mohamed Abbas <mohamed.abbas@intel.com>
(From yocto-docs rev: c9548803f58e5055d6686dbc16c94308296ccf2a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added a reference anchor to the spot in the dev-manual for the
"Yocto Project Source Repositories".
Other changes were to the bsp guide and were general edits to the
"Linux Kernel Configuration" section.
(From yocto-docs rev: def35923199d48c879ff06a68f81b5cd28d55185)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Updated all the CSS style sheets so that the Note, Warning, Tips,
Caution, etc. boxes are not so prominant.
(From yocto-docs rev: 451568553e9620c1e247c2f67b0665b184c3300b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Throughout the manual there is a specific term to refer to the
YP build directory: "Yocto Project Build Directory." This term
was being loosely referred to and was not consisten in linking to
the actual term definition in the Terms chapter. All this is
fixed.
(From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
changed bblayer.conf to conf/bblayer.conf and also correctly referred
to the Yocto Project Build Directory.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
(From yocto-docs rev: 64dffc2a4e587f198d44b0ed0cea269bfa16d3be)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Had to back off a bit on the use of the term "working directory".
Paul clarified that it was okay to use the term "temporary source code
location" when talking about where the source code for a package was
located.
(From yocto-docs rev: 8d3f7613f32f1ce91c9d53e2db3c36448abb5a82)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Implemented Paul Eggleton's latest set of review comments to the
"Modifying Temporary Source Code" section.
(From yocto-docs rev: cd43c642308ba7c049e6ba79befa471673c078e7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
More edits to the "Finding the Temporary Source Code" section as
pointed out by Paul Eggleton.
(From yocto-docs rev: 2987abe413687e216c4fe38d1db855409a595dab)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied Paul Eggleton's review comments. Basically trying to clarify
what is the S variable and what is the WORKDIR variable when
determining where unpacked source files are.
(From yocto-docs rev: e139e441653fa00309de204b7ad9f5a7ad7bdcb8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in the real link to the YP Source repositories instead of a
click "here" thing. Put in a reference to the BSP Layer section
from the term layer. Fixed a grammar type.
(From yocto-docs rev: 6b3b63480f948dad2c5101deedb8deafad291728)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added some text to explain where the meta-intel repo can be
found within the YP source repositories. Also provided a link
back to the start of the BSP Guide.
(From yocto-docs rev: 79d513d010637e4a684da64b363ed8d957f06640)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added text so the user could locate the poky-extras Git Repository
within the YP Source Repositories.
(From yocto-docs rev: 3778a768ae30e323be0e84b55778040ebe89a3ad)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a reference into the YP Source Repositories so the user knows
where our supported Linux Yocto Kernels are. Also, corrected a
mistake in the working about copying the bare clone.
(From yocto-docs rev: 76f3d59dd9e0b30644415f33158d71ec6932fb4f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added some clarity on where the poky Git repository comes from
with regard to the YP source repositories.
(From yocto-docs rev: 29c0b095daa39256b69cd35f744136d97a239cc3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Paul Eggleton's review comments on the "Modifying Temporary Source
Code" section have been applied.
(From yocto-docs rev: 8f17f9e556e7027d8aba1fe69d614d17cdbcc054)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Complete re-write to the "Modifying Temporary Source Code" section,
Section 4.4. This strategy now comprises telling the user where
this temporary source code is, how to change it within a Quilt
workflow, and how to change it within a Git workflow.
I consulted with Paul Eggleton quite a bit to come to this conclusion
that the section needed more attention.
(From yocto-docs rev: 8c6c80121c1eeb1ec6f79e1efb6aa27aa9fd111f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied some edits of Paul Eggleton's.
(From yocto-docs rev: ef5a82d429480c3820db93f0b7207d7e470454af)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I combined the section on changing package source code and
the section on changing package source code with quilt into one
over-arching section named "Modifying Package Source Code."
The section on Quilt was sort of a stand-alone section but Paul
Eggleton suggested that it is a natural follow-on. So I put the
two sections in as sub-sections.
(From yocto-docs rev: ae4d3cf99e27f74b151939d2f5a2b440b91ac6d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the review comments from both Paul Eggleton and Joshua
Lock for the "Modifying Package Source Code" section.
Reported-by: Paul Eggleton <paul.eggleton@intel.com>
Reported-by: Joshua Lock <joshual.lock@intel.com>
(From yocto-docs rev: 276c13517c7edda8407fdf82c36d14029c5fcee4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new section called "Configuring the Kernel." This is the
how-to counterpart for the concepts part created in the kernel
manual. The section consists of three sub-sections:
"Using menuconfig", "Creating Config Fragments", and
"Fine-tuning the Kernel Configuration File." Primary source for
information on this section was Bruce Ashfield. He has this section
for review.
(From yocto-docs rev: 3ac718bc69b4914c41a0bb94134c085964ee71a7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I beefed up the definition for the term "Yocto Project Build
Directory." I included the TOPDIR role and also expanded the
discussion on how it is created and the control the user has
over it.
(From yocto-docs rev: d00f30708ccd5fb9e1fc3c8e5240e0ab7a892fe0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
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>
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>
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>
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>
Scott Rifenbark