Fixes [YOCTO_#3396]
Spaces in file and directory names is an issue for the build
system and throws an error when sourcing the environment
setup script. I added key notes in several areas of the doc
set. I also added some cross-references to the oe-init-build-env
section in some other areas where running the script is discussed.
(From yocto-docs rev: 1d102e91ba77391096749bd7df6c05b2b695b33f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
First draft of this new section. Information based on Paul
Eggleton's wiki.
(From yocto-docs rev: b459d68ab7dd51b258fd378ad15260cba4522dc4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I improved the wording such that it is not confusing between the
information in reference manual's section on running a build and
the general overview presented in the YP Quick Start.
(From yocto-docs rev: 17e2fc34941612589b8ddf3314a4760e9c2f402d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
various changes as required.
(From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The way I refered to the YP Quick Start was inconsistant.
I have made edits to remove these.
(From yocto-docs rev: d9487c60db23861e8a9dd2c81ac46d4960abd462)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter. I changed the "ref-imagese" and "ref-features" appendices
to chapters and made any references in the doc set use the proper
term now (chapter).
(From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I did a scrub for "Yocto Project" and found some that could be
changed.
(From yocto-docs rev: 985062b6a9320e8a3ca3d3dafb6516db4fbc5bd5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The section on "Dependency Graphs" failed to mention the
package-depends.dot file among the files. Added this file to the
list.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 0ebf8ddf54e146454d6f300f790964decaeec6a9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I have changed as many "Yocto Project" terms as possible so that
better reflect reality.
(From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
(From yocto-docs rev: 3f05eca756cb70adbaa639d2b677f88ae720ba4a)
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>
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>
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>
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>
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>
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>
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>
Several manuals and areas were still referring to 'glibc' as the
GNU version of the Unix statndrd C library. We do not support this
any longer and now use 'eglibc' to build with. Notable changes were
in the required packages area of the QS manual. I also added a
bit in the reference guide saying how this release does not use
'glibc' to build with but rather 'eglibc'.
(From yocto-docs rev: c2c58914996d747c510706d78ecfd8f41c5e694d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Darren provided me with some feedback on the logging mechanism
section for both Python and Bash.
(From yocto-docs rev: 7dddadf8caba01d3ef1046be52a1435eeaed60a3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This machine is out of date. I replaced both occurences with
"qemux86", which is more relevant to YP.
(From yocto-docs rev: 8fe6feccc25f594a444b5177d1192899b3cbdd9c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Per Darren's feedback on this new section I updated changes based
on his comments.
(From yocto-docs rev: a5bbba42ec0da5b2f83f7a64ac8eef466e9c89b3)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
The -b option is not required to show the environment used to build a
specific package; usually the best practice is to specify the package
name alone.
(From yocto-docs rev: d59772fd7edd76dbc8018479c072badb591601c3)
Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I added emphasis to a bulleted list and I also updated a section title
to reflect Yocto Project instead of Poky.
(From yocto-docs rev: f967aff5c0a0047ef44145c6a95da84e57c255b1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Each of these chapters needed the title changes to reflect Yocto
Project and not Poky.
(From yocto-docs rev: a6d8d01b20af334ca9950c4287d61a728532f652)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
General re-write to make the chapter Yocto Project friendly.
Weeded out the references to "Poky."
(From yocto-docs rev: ac4fc6082f458e5ee60962693ee332bbf1e3c1a9)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
YOCTO #1001 - created a new section to address this issue. This is the
first draft. Darren to provide review comments.
(From yocto-docs rev: fc2aee572cc3e620684533a12a2d8436dc0abe32)
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 manual the "‐‐" docbook statement
does not display correctly. I changed this to "--".
(From yocto-docs rev: b0596e0ce370d6c6e1680e89d9c5a5b9da26dd93)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In the section 2.1.1 BitBake I added a paragraph at the end of the discussion
about BitBake explaining the benefits of the '-k' and '--continue' options.
(From yocto-docs rev: 409e01cedbe8d93c29856fa2a49d5f9db91f5201)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
In chapter 2 where we talk about building images I added a new
note indicating that the user should not switch around using different
GPL versions when trying to rebuild an image as it can cause dependency
failures.
(From OE-Core rev: f84441dbcc8254062d55d2452d3d6f4bc6f907fe)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
[BUGID# 873] - Added a note in the Images Appendix indicating that
building an image without GPLv3 components is only supported for
base and minimal images. Also put the two changes you have to do
to the local.conf file for the build.
Added a note in the second chapter in the section on building images.
The note indicates the same as in the appendix but does not go into the
local.conf file detail.
(From OE-Core rev: c7960a2e820d7ddb8649ab0b27b3f04843f7af0d)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I made some minor edits.
(From OE-Core rev: bb6fbb484ec912aabca77fd4d124c97fc7f956e1)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Forgot to search for "Bitbake" occurances. These are now changed
to "BitBake."
(From OE-Core rev: 982826b61bf68244fad46ef52b5a203e648e330b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Fixed a grammar problem and then did a search and replace for
"bitbake" to replace with "BitBake".
(From OE-Core rev: a25074cf7f3383ea3963c4dabb9507af34f2e3df)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
I am using "xxxxxx" task as the way to call out a specific task in the
text. Previously a mix of <function>xxxxxx</function> and the "xxxxxx"
methods were being used.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Removed a couple of redundant </ulink> tags.
Also indented the literallayout text by five spaces for formatting.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
I completed general edits to the second chapter of the poky reference
manual. These edits went from section 2.4.5 through the end of the
chapter. They consist of text rewrites for more active voice and follow
general technical writing principles.
I completed the same types of edits in the third chapter of the manual
from the beginning through section 3.3.2.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Extensive language and consistency edits being applied to the manual.
During the 0.9 push I did not have time to make a pass through the
document.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Scott Rifenbark
Paul Eggleton
Robert P. J. Day
Richard Purdie
Richard Purdie