The /build/tmp/stamps directory was incorrectly referred to as the
"STAMP" directory. Fixed it.
(From yocto-docs rev: e434b3d555f7bea0b4576c6cf0d638e3e3fe664c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Variable was incorrect in the manual.
(From yocto-docs rev: d1ddb06cdcec48ab64df3a03f3ef845da0b13c80)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 2ef9f6cc3cccff9d84709b3c3d9ce8e8c1daae41)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
One last clarification of what type of environment variable we
are talking about here.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 18c537d96bde8fac7f62071585b71aed05037410)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Some instances in the manual where it was not clear on whether
the subject was a shell environment variable or a BitBake
environment variable. I cleared these up.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 123bb91a3954c98378cdd8bba0a35311eb53f37a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Another instance of possible confusion between a shell
environment variable and a BitBake environment variable.
I cleared this one up.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: e02596d940434806820f071218d2eb89c872cf3c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There is confusion in the manual regarding shell environment
variables and BitBake environment variables. I fixed this
instance to specify shell environment variable.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: f6cd520323e12124217975cff09d03a6f5e03936)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Addressed all issues specified by [YOCTO #2025] except for the
very first one that says bring the versions up to 1.2. This will
be accomplished by the poky.ent bump at release time.
Fixes [YOCTO #2025]
(From yocto-docs rev: 926e5635d8cd74fff7e00002108ce8c039252203)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added information about Hob to the introduction part of this
chapter. The chapter is going to have a section that introduces
and speaks a bit about the Hob.
(From yocto-docs rev: dd98b3132ff4660397c37a223af8c4c2835a5276)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Grammar, style, and formatting edits applied to the "BSP
Licensing Considerations" section.
(From yocto-docs rev: 9809e0b5081bdc4f27d7d949930c409575a9a083)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied a couple small corrections to the re-write of the
"Enabling Commercially Licensed Recipes" section. These small
corrections were suggested and caught by Tom Zanussi.
Reported-by: Tom Zanussi <tom.zanussi@intel.com>
(From yocto-docs rev: ce9218386ec265f7eec2ec5916b09a6776b3077b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
"The LICENSE_FLAGS mechanism can now be used to meet the special
license requirements needed by some BSPs. Update the documentation to
reflect the current BSP licensing mechanisms.
Also add a new blurb about the time-limited kernel."
- Tom Zanussi
I applied this patch verbatim and will check and clean up text
as needed.
(From yocto-docs rev: d05a7ddbc0d6017e5a8be2b3e0117f53e30a204b)
Signed-off-by: Tom Zanussi <tom.zanussi@intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied and modified patch. Modifications included grammar, active
voice, formatting, links, section creation, etc.
(From yocto-docs rev: 76dc10138161124846c0752c251028ba16c45d7c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The git clone command did not work when the YOCTO_GIT_URL variable
was used. I removed the variable and hard-coded the command
into the example.
(From yocto-docs rev: 67f169a7e2540b27acfaf2fcdcc658ce189ec932)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The style for the note, caution, warning, and tip headings was a bit
over-bearing. Feedback from the community indicated that those words
needed to be in a smaller, less noticeable font. I created the style
so that the font's size is about half of what it was and I also changed
the color to match the other headings.
(From yocto-docs rev: f54c6274e1972c52ba17d7ebd2ba84bf6d59c105)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new "expert" section at the end of the QS. I reference the
section right up front. This new section is an attempt to divert the
expert user away from most of the QS. The information was formed from
Robert P. J. Day's wiki at his crashcourse.com site.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: b2981e9fcdd083e15194f520a4160938b02b1275)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Implemented Richard Purdie's changes for the "Checksums (Signatures)
section. I also performed a spell-check on the chapter and found several
rogue words that I corrected.
Fixes [YOCTO #2024]
Reported-by: Richard Purdie <richard.purdie@intel.com>
(From yocto-docs rev: 3025ee64bc0f046abe87f95f1e8b9092a6079798)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Created a new glossary entry for the variable ALLOW_EMPTY.
(From yocto-docs rev: 35e3693c9f6b3f2842cfde55703a1fa1d1f27345)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added information that describes the relationship between
poky/documentation and yocto-docs/documentation. For developers,
they need to know to work from the yocto-docs Git repository
and not to rely on the poky/documentation Git repository, which
can lag behind the other one.
(From yocto-docs rev: 0cbc781d3e9544c9920fdaf4548d882dd79b3d6c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added more information to the YP Term "Append Files."
(From yocto-docs rev: e1a7e9b0a790d394e237a0972140107d11178408)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Put in a link to reference another example of using a .bbappend
file.
(From yocto-docs rev: b5a5433506adfe46276584e51dc19fc153ea098d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed text that described how a config file was referenced.
(From yocto-docs rev: 29846fcb4fd6f90452023e1f627ef76f1a056ac6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Edits to better describe what a .bbappend file is.
(From yocto-docs rev: 81527358615c229a9161568a30785221c9f081ff)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Provided a clearer full name for .bbappend files.
(From yocto-docs rev: 4ee07af442c26aa06a6b295df758f41838b407df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Minor edits to the BSP Guide, the Development Manual, and the
Kernel Manual to address [YOCTO #1717], which noted confusion
over the kernel manual when a user was trying to find kernel
configuration information.
The fix for this bug involved several areas. I had previously
created a new section called "Kernel Configuration" in the kernel
manual and "Configuring the Kernel" in the YP Development manual.
There were several rounds of feedback from Bruce Ashfield.
This commit represents the final touches on the three manuals to
address the bug.
Fixes [YOCTO #1717]
(From yocto-docs rev: de8f85753ad1d6dde66adb6bb4cb09e9528c7cd6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Layer section review comments from Paul Eggleton added.
(From yocto-docs rev: a536fe1635dbe9157e86995e7a78568e41a75957)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Implemented Paul Eggleton's review comments for the "Understanding
and Using Layers" section.
(From yocto-docs rev: ec376754f63122a1bd31d47e153ee3e872aac0b5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed all the hard links to use appropriate variables from the
file poky.ent.
(From yocto-docs rev: 9a6267d0d843dc47c1171eba6200387901b77df4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The YOCTO_PYTHON-i686_DL_URL and YOCTO_PYTHON-x86_64_DL_URL
variables were both not resolving.
(From yocto-docs rev: f5e0a2f618daf77f1437a710ce98e88cc0533fd8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I converted the hard links to use the variables as established
in the file poky.ent.
Also, Cleaned up some bad text in the term "Yocto Project Files."
Looks like a cut-and-paste problem.
(From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section describing how to set up meta-intel has been re-written
to provide more information about this Git repository and why
it is important. Also, added information explaining why user
should use the same set up method (tarball or Git repo) as used
to set up the YP files tree.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 53fbfc59f0183a6b8474ed643302faffef79356b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Conversion of hard links to use the variables set up in the file
documentation/poky.ent.
(From yocto-docs rev: edbacc1b57f02c31ff6eaee666245be83fb17543)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Applied the review comments from Paul Eggleton for the new section
on "Understanding and Using Layers."
(From yocto-docs rev: 6bf5854dd355afdbc01c4c4fb94a4062bd9eae20)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I received a patch from Robert P. J. Day that had several changes.
Curiously, several did not apply. I think that the patch was
applied using a version other than the "latest" version. In
any case, I applied the changes that did need applied.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 5af725001cf045040f83e1c891385692f8a3a287)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>
Added glossary entries for FILESPATH and FILESEXTRAPATHS. Although
the user is not supposed to manually edit FILESPATH, the entry is
necessary I feel in order to better understand the FILESEXTRAPATHS
variable.
(From yocto-docs rev: 67357174148859ace6bf605c3ebc0bf49b761753)
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>
I tried to implement some comments by Richard on the B glossary
entry and the externalsrc.bbclass section. The comments were a bit
confusing to me but the gist of it was I mis-interpreted Richard's
comments on supporting separate directories for B and S. I had
indicated that autotools-based recipes did this by default, which
was wrong. What was confusing to me is where the comments should
be. I ended up putting them in both areas of the reference manual.
(From yocto-docs rev: a2ddc17bd003b116e593f7df0f59d86cfa0e1cd9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Changed the examples to use "=+" instead of "=".
(From yocto-docs rev: 19958be932ea6401f355f119474da5dd4ac179f9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
There was a broken cross-reference to the YP development manual.
Fixed it.
(From yocto-docs rev: ed89eb1af507a656ff0ef16019d31db639eb5c36)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Initial file.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 37fea0686161333338ca79710e0bf75a67b14c5f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The title for the Quick Start should be "The Yocto Project
Quick Start".
(From yocto-docs rev: d70c75674de959e3fe7d8b661dddefb0648ae89a)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added two new variable entries. This is part of the fix needed
as a result of the feedback from two Community members inside
Intel whose feedback was initially reported by Darren Hart.
Reported-by: Inaky Perez-Gonzales <inaky.perez-gonzales@intel.com>
Reported-by: Mohamed Abbas <mohamed.abbas@intel.com>
(From yocto-docs rev: ccabb9c905e7a1c9a211f805f8a326048903b7b0)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Added a new class description for externalsrc.bbclass. This
addition was driven by feedback from two community members
inside Intel whose feedback was picked up by Darren Hart.
Reported-by: Inaky Perez-Gonzales <inaky.perez-gonzales@intel.com>
Reported-by: Mohamed Abbas <mohamed.abbas@intel.com>
(From yocto-docs rev: 1217d26993f9e5f3e6914e366b1fed34debbd242)
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>
I added a bit more to the note about BSPs that do not have a
formfactor entry. The note was vague. Explanation provided
by Tom Zanussi.
(From yocto-docs rev: 997832850cf01d83bf3b799a5a6e7f5c902d9a8f)
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>
I lightened up the bacground box colors used for Notes, Tips, Warnings,
Cautions, etc. We had some feedback from the community that they heavy
dark boxes were taking away from the main text.
(From yocto-docs rev: d9b5da116bacb847e86c1f5029836308b8ce533c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
At the suggestion of Scott Garman, I added a link to his Getting
Started with the Yocto Project - New Developer Screencast Tutorial.
In doing so, the list of "other helpful things to read" was turned
into a list as there are three items now.
(From yocto-docs rev: f43c31d9bcd0e48aced86cc917d0af5f5a48d2e8)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Made some minor edits. I also discovered that the information
describing where tuning files reside was not real helpful.
In particular, tuning files are not limited to the
meta/conf/machine/include directory. For example, the Crown Bay
BSP layer includes a tuning file from the meta-intel Layer.
(From yocto-docs rev: 3a76ccc4f645f03a6e888b7eb53fa9bc7bfb255e)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I was introducing each area of the sub-sections by saying
"You can find these files in the Yocto Project Files ....",
which really isn't accurate. This structure is a BSP structure
or layer. I am not referring to it as such.
(From yocto-docs rev: f13a89bc7812106abd4ef95dfdccfa48eae11af6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I brought the example Crown Bay structure up to speed with the
state in the YP source repositories. I also made a couple minor
edits.
(From yocto-docs rev: 23dbd76952c79b1b3a28b731bef218f4cabfd8fb)
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>
I added a small section at the start of chapter to define a
BSP Layer, note where the YP keeps them, and note that meta-intel
is somewhat of a "super" layer as it contains several BSP layers
of its own.
(From yocto-docs rev: 2e044072660d3f675612e01e3871d6a4fb0894bd)
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>
Added more information to the "S" glossary entry. Provided
an example.
(From yocto-docs rev: c36896c167d1721647d756210611667c4351b31b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The edits add much more information to the WORKDIR variable in the
glossary. There are some examples and it now shows how the
actual working directory is derived.
(From yocto-docs rev: 8b3e671f6088a2fb2d6f496cee979567cf0f222e)
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>
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>