Commit Graph

35 Commits

Author SHA1 Message Date
Scott Rifenbark 1626fd50be documentation/poky-ref-manual/ref-bitbake.xml: Fix BB_ENV_EXTRAWHITE example
I changed the variable from BB_ENV_WHITELIST to BB_ENV_EXTRAWHITE
in the text before the example line.  I had the wrong variable
in there.

(From yocto-docs rev: f909a7336ae2f95baa751231beeae08081576e1f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:50 +01:00
Paul Eggleton cc8e7ccdf4 documentation/poky-ref-manual/ref-bitbake.xml: remove refs to Dates and Contacts
Update the BitBake "Preferences and Providers" section to remove
references to these two Pimlico applications that have been removed,
and tweak the example slightly so it is technically correct.

(From yocto-docs rev: 744624a40d02a859b3c526f5ea6657d32edd39c6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:49 +01:00
Paul Eggleton 84b3daaf50 documentation/poky-ref-manual: fix for rename of task to packagegroup
(From yocto-docs rev: da0c9fa6d43d32f59bd935ae0fee533fc94fda95)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:46 +01:00
Scott Rifenbark 64b9137b43 documentation: Fixed links to BitBake User Manual
Robert P. J. Day pointed out a link in the development manual that
was for the BitBake User Manual.  The link resolved to an old,
non-maintained version of BitBake documentation.  According to
Richard Purdie, the BitBake docs referenced should be the ones
that ship in the bitbake/doc/manual directory of poky.  The
YP docs had been using a variable named BITBAKE_DOCS_URL that
also resolved to the antiquated user manual site.  Consequently,
there were many links that needed fixed across both the YP
Development Manual and the YP Reference Manual.  Each of these
references now points in general to the bitbake/doc/manual
directory in poky for more information.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 12f77236b602e9ec43e845c8cec060ad342af19c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:45 +01:00
Scott Rifenbark 8f5af192c4 documentation/poky-ref-manual: Converted ref-bitbake to chapter
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-bitbake" appendix to a chapter and
made sure the single in the doc set use the proper term now
(chapter).

(From yocto-docs rev: 1086155dd6e67a9c75e99332a9ad122dc04ec7a1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark c20cdf677f documentation: Fixed the links to the BitBake Documentation page.
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: ddee80872afc567b9381387980f257b337f29ea1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark d9dc29ced6 documentation/poky-ref-manual: Removed artifacts for dev chapter
Removing the Development chapter resulted in some links being
re-defined to go to the YP Development manual.  Also, the
poky-ref-manual.xml file had to be altered to not include the
chapter.  Any sort of residual cleanup needed as a result of
getting rid of this chapter is handled in this commit.

(From yocto-docs rev: f8d113654b33ed5f6f1ba8e2d2e755b78033ddbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark 402383637b documentation/poky-ref-manual: Fixed various references to YP
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>
2012-07-17 10:54:09 +01:00
Scott Rifenbark 5966b44893 documentation/poky-ref-manual: Yocto Project scrub
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>
2012-07-03 14:55:03 +01:00
Scott Rifenbark 5df1753a15 documentation/poky-ref-manual/ref-bitbake.xml: Fixed directory name
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>
2012-03-26 23:30:29 +01:00
Robert P. J. Day 45bfc3e189 documentation/poky-ref-manual: changed "STAMPS" to "STAMP"
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>
2012-03-26 23:30:28 +01:00
Scott Rifenbark 15057c2986 documentation/poky-ref-manual: cleared up environment variable ambiguity
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>
2012-03-26 12:13:49 +01:00
Scott Rifenbark 9bdc18a820 documentation/poky-ref-manual: Converted to use poky.ent variables.
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>
2012-03-23 14:24:44 +00:00
Scott Rifenbark eb829f2768 documentation: Section change and cross-reference fixes
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>
2012-03-08 12:08:06 -08:00
Scott Rifenbark 9dc84b77ec documentation: Cross-referencing section fixed for consistency.
(From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:52 -08:00
Scott Rifenbark 797758c0d4 documentation/poky-ref-manual: Link updates
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>
2012-03-08 12:07:50 -08:00
Scott Rifenbark c7d2787588 documentation/poky-ref-manual/ref-bitbake.xml: Updated BitBake Running a Task
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>
2011-12-16 16:58:41 +00:00
Scott Rifenbark 684c35b7aa documentation: Changed all manual links to point to "latest"
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>
2011-11-25 15:24:17 +00:00
Scott Rifenbark 9d66278f9c documentation: scrubbed out 'glibc' and replaced with 'eglibc'
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>
2011-10-04 13:46:37 +01:00
Paul Eggleton e4e0d026c1 documentation: typo, spelling & minor grammar fixes
(From yocto-docs rev: a5b069b04979a566b08415cf27af2ad6abf90f2f)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Paul Eggleton 82fd0556c2 documentation: manpage -> help output
Replace the reference to this being the manpage.

(From yocto-docs rev: ebb689a8ccc2aaf5d21341c69899588e77d5172c)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:35 -07:00
Scott Rifenbark 32a860851c documentation/poky-ref-manual/ref-bitbake.xml: scrubbed for Poky
I swapped the Yocto Project for Poky throughout.  Some other general
edits were done.  I put in a reference to a spot to learn how to best
set the BB_NUMBER_THREADS variable.

(From yocto-docs rev: 2543a915957014a59e6c49a1cdde270725d47af3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:05 -07:00
Scott Rifenbark 7dbabd85ea documentation/poky-ref-manual/extendpoky.xml: Changed bitbake to BitBake (From yocto-docs rev: 2b95f152d40aacc7d88e755a27154dfb3153c6ee)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-07-21 10:59:20 +01:00
Richard Purdie e9b17e3fa7 Rename poky-image-* -> core-image-* and task-poky-* -> task-core-*
(From yocto-docs rev: 0feb6b8f9621087ba5fd77d3c8f3e23132c97187)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:45 +01:00
Scott Rifenbark 6a0d070add documentation/poky-ref-manual/ref-bitbake.xml: style tags updated
I got rid of the <filename class='directory'...> and
<filename class='extension'...> and replaced with simple
<filename>/</filename> pairs.

(From OE-Core rev: 1bcdaf8d3d39680c154144227ee2caca9a7bb3e5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:23 -07:00
Scott Rifenbark 1cd9b0cb5b documentation/poky-ref-manual/ref-bitbake.xml: BitBake parsing section update
In section B.1 (Parsing) it said that BBFILES variable by default
specified the direcotyr 'meta/packages/' as the place to look for .bb
files.  This directory is invalid and needed to be changed to
'meta/packages/'.

(From OE-Core rev: c48325b1f23201a1e7790bfd7c52191baf14878f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:22 -07:00
Scott Rifenbark da283ba65b documentation/poky-ref-manual/ref-bitbake.xml: type fixed
Section B.4 (The Task List) had the typo "taksks".  Changed to
"tasks."

(From OE-Core rev: 7cbd6bb020e16ceb1894a408852648a915f193f3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:19 -07:00
Scott Rifenbark 4ba1991c77 documentation/poky-ref-manual/ref-bitbake.xml: Grammar fix
Section B.2 (Preferences and Providers) had a grammar error.
It said "An common example is..."  I fixed it.

(From OE-Core rev: 6d04a9ff381b7771b6f080928d4416b76e76cbb0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:18 -07:00
Scott Rifenbark 3e56fd15e6 documentation/poky-ref-manual/ref-bitbake.xml: removed 'varname' style
I replaced varname style with filename style.  Looks better.  We have
too many styles.

(From OE-Core rev: 1b63d69c3c2e4b5561dc59d020b59d875420872f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:17 -07:00
Scott Rifenbark 732a117c77 documentation/poky-ref-manual/ref-bitbake.xml: Completed general edits.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:29 -08:00
Scott Rifenbark 9f4c630dbd documentation/poky-ref-manual: changes applied from a patch submitted by Cyril Humbert.
Cyril submitted a patch via email form for several spelling corrections.  The master docs, however, are not up-to-date with what I have on my contrib area.  Many of Cyril's corrections were already addressed.  A few were not and I have updated them here with this commit.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark 111f0678ee documentation/poky-ref-manual: General edits up the Parsing section.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:26 -08:00
Scott Rifenbark fcbacff683 documentation/poky-ref-manual: Changed spelling of bitbake to "BitBake" when used in text.
There is inconsistent use of how BitBake is spelled.  Sometimes it uses no capitalization, just a leading "B", or "BitBake".  I looked at the BitBake manual and it seems that "BitBake" is the correct way to refer to it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:25 -08:00
Richard Purdie 80eba26fb1 documentation/poky-ref-manual: Various tweaks to the text
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 15:07:06 +01:00
Richard Purdie 2208328791 handbook: Move into documentation directory
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
2010-10-15 11:55:59 +01:00