Commit Graph

459 Commits

Author SHA1 Message Date
Scott Rifenbark
91911f600f documentation/poky-ref-manual/ref-images.xml: removed links to section
Three cross-references to the section "External Development
Using the Meta-Toolchain" were removed.  This section is going
away in the YP Reference Manual.  There is no replacement section
that makes sense so the cross-reference is removed.

(From yocto-docs rev: 97ed489c335d6d2782cc3ed684fce92c78b4fec8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:26 +01:00
Scott Rifenbark
857b2d45f6 documentation/poky-ref-manual/development.xml: Removed pre-built section
Removed the section about developing binaries using QEMU.  This section
is better placed in the YP Development Manual.

(From yocto-docs rev: 83a4e84b69051f217993d80b525e9d07d64d1c6d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-06-15 17:18:26 +01:00
Scott Rifenbark
fcea677c80 documentation/poky-ref-manual/ref-images.xml: images defined
Fixes [YOCTO #2459]

I provided better definitions to the -dev and -sdk image types.
They now call out host development and target development.

(From yocto-docs rev: bd2c0db27d7eb038931550a96752f961ea6b1d9c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31 21:16:54 +01:00
Scott Rifenbark
0bf437b2b2 documentation/poky-ref-manual/ref-images.xml: Updated core-image-sato-dev
The description had reference to a toolchain, which is evidently not
true.  I have re-worded the description so that it does not mention
inclusion of the toolchain.

Reported-by: Wolfgang Denk <wd@denx.de>
(From yocto-docs rev: 5a918d7d20133b85badd082c81cfe4af18709316)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31 21:16:53 +01:00
Scott Rifenbark
0957740660 documentation: Added manual history for 1.3
Added entries for the Manual History table for upcoming 1.3 docs.

(From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-05-31 21:16:53 +01:00
Scott Rifenbark
f79aa01630 documentation: Updated Manual Revision Tables again.
After some discussion from Song and Richard, the dates in the
manual revision table has been updated to "April 2012" for the
1.2 release.

(From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23 23:04:47 +01:00
Scott Rifenbark
564e311a8d documentation: Manual Revision Tables updated
Five tables updated for the five manuals that have the tables.
Used "May 2012" as the date.

(From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23 23:04:46 +01:00
Scott Rifenbark
6b64283afe documentation/poky-ref-manual/ref-images.xml: added link
added the link for the Build Appliance page to the description of the
self-hosted image.

(From yocto-docs rev: 719ba4308489b29eefa7f08ddffb65bd5e41fc2c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-23 23:04:45 +01:00
Scott Rifenbark
16645ccf1c documentation/poky-ref-manual/ref-images.xml: Added self-hosted image
I added the self-hosted-image to the list of images.

(From yocto-docs rev: a8265cb523705a374d23bf60aab5b7969ad937fc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-18 16:41:15 +01:00
Scott Rifenbark
853c5613ac documentation: Run-through changes for 1.2
Reading through the manual I discovered some inconsistencies with
how links were handled.  I fixed this in both the QS and one anchor
in the FAQ appendix of the YP Reference Manual.

(From yocto-docs rev: 32444e839a1541ab2c02fa31cd094605d1a2429a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-04-12 12:35:47 +01:00
Scott Rifenbark
241140d0eb documentation: Added TBD entry to 1.2 manual history table.
There needed to be an entry in all the manual history tables
that indicated this version of the manual is for 1.2 but is
WIP.

Reported-by: Rudolf Streif <rudolf.streif@linux.com>
(From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-28 16:53:34 +01:00
Scott Rifenbark
75f557655b documentation/poky-ref-manual/ref-variables.xml: added CORE_IMAGE_EXTRA_INSTALL
New variable added to the glossary.  This variable replaces the
deprecated POKY_EXTRA_INSTALL.

(From yocto-docs rev: ad764fdd11440c6a46a783c7df38f8445189712f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 23:30:30 +01:00
Robert P. J. Day
c3aef261a6 documentation/poky-ref-manual: Removed some deprecated variables.
Delete reference manual glossary entries of obviously dead/renamed
variables:

 * PACKAGE_SUMMARY
 * PACKAGE_DESCRIPTION
 * POKY_EXTRA_INSTALL (renamed to CORE_IMAGE_EXTRA_INSTALL)
 * POKYMODE (renamed to TCMODE)
 * POKYLIBC (renamed to TCLIBC)
 * SHELLCMDS
 * TERMCMD
 * TERMCMDRUN

In addition, fix some "link"s to not refer to any of the above.

(From yocto-docs rev: 146084b8b0bab5e5333b7da7d6eb1dc90e118eba)

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:30 +01:00
Robert P. J. Day
d5318a3358 documentation/poky-ref-manual: Typos fixed.
(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>
2012-03-26 23:30:29 +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
df7e75fff3 documentation/poky-ref-manual/technical-details.xml: typo fixed.
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>
2012-03-26 23:30:28 +01:00
Scott Rifenbark
db529f9f7d documentation/poky-ref-manual/development.xml: another env var clarification
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>
2012-03-26 12:13:49 +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
264e5978e4 documentation/poky-ref-manual/ref-structure.xml: Clearer reference to variable
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>
2012-03-26 12:13:49 +01:00
Scott Rifenbark
ceaf19ff67 documentation/poky-ref-manual/ref-structure.xml: Clearer variable ref
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>
2012-03-26 12:13:49 +01:00
Scott Rifenbark
4096fb2d01 documentation/poky-ref-manual/development.xml: Typo fixed.
(From yocto-docs rev: ae3c0156d026daa5ab9c96958f7e833b2f1ed410)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 12:13:48 +01:00
Scott Rifenbark
453ec12896 documentation/poky-ref-manual/technical-details.xml: Nitin's review
Applied comments from Nitin's review.

Reported by: Nitin Kamble <nitin.a.kamble@intel.com>
(From yocto-docs rev: b1fafd19c20f762daa80480618319ab8afd97227)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 12:13:48 +01:00
Scott Rifenbark
c3fe9d7a36 documentation/poky-ref-manual/technical-details.xml: new x32 section added.
(From yocto-docs rev: 78f8b0367b3e5bbc71712f71fe87367d929424c8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-26 12:13:48 +01:00
Scott Rifenbark
67c83a8c08 documentation: Updated all style sheets for down-sized notes.
(From yocto-docs rev: c4188d6daa81d8309ba71c5b9c3dde5b10ea730e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-23 14:24:51 +00:00
Scott Rifenbark
2e0b9014e2 documentation/poky-ref-manual/technical-details.xml: Review comments
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>
2012-03-23 14:24:50 +00:00
Tom Zanussi
9332e39d86 documentation/poky-ref-manual/technical-details.xml: Licensed recipe edits
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>
2012-03-23 14:24:49 +00:00
Scott Rifenbark
3b95307126 documentation/poky-ref-manual/technical-details.xml: Fix Checksums section
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>
2012-03-23 14:24:48 +00:00
Scott Rifenbark
f99aa9453e documentation/poky-ref-manual/ref-variables.xml: New ALLOW_EMPTY variable
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>
2012-03-23 14:24:48 +00: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
7431a70248 documentation: Updated copyright notices to 2012.
(From yocto-docs rev: a270fe40606ccbef5c453bb77f009306a7bdfb93)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:08:08 -08:00
Scott Rifenbark
4db23d6000 documentation/poky-ref-manual/ref-variables.xml: New glossary entries
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>
2012-03-08 12:08:06 -08: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
7018654853 documentation/poky-ref-manual: Review edits on B and externalsrc.bbclass
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>
2012-03-08 12:08:05 -08:00
Scott Rifenbark
e95d81a8bf documentation/poky-ref-manual/ref-variables.xml: Changed examples
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>
2012-03-08 12:08:05 -08:00
Scott Rifenbark
b206901b2a documentation/poky-ref-manual/development.xml: Fixed cross-reference
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>
2012-03-08 12:08:05 -08:00
Scott Rifenbark
05cff8adcb documentation/poky-ref-manual/ref-variables.xml: B and BBCLASSEXTEND
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>
2012-03-08 12:08:04 -08:00
Scott Rifenbark
36e3daf7f9 documentation/poky-ref-manual/ref-classes.xml: New externalsrc class
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>
2012-03-08 12:08:04 -08:00
Scott Rifenbark
b0b5224ab0 documentation: Edits to all style.css files
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>
2012-03-08 12:08:03 -08:00
Scott Rifenbark
484cc84043 documentation/poky-ref-manual/ref-variables.xml: Formatting changes.
(From yocto-docs rev: a83964d7e96986c473ef1a4a7b46e5383c9316ad)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:59 -08:00
Scott Rifenbark
280addd637 documentation/poky-ref-manual/ref-variables.xml: Fixed typo.
(From yocto-docs rev: a22b8b2de69b7603ef18bc13e0ac05a919b80199)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:55 -08:00
Scott Rifenbark
c8d0effb67 documentation/poky-ref-manual/ref-variables.xml: Update S variable
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>
2012-03-08 12:07:55 -08:00
Scott Rifenbark
e1b3ba8c95 documentation/poky-ref-manual/ref-variables.xml: Edits to WORKDIR glossary
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>
2012-03-08 12:07:55 -08:00
Scott Rifenbark
5feff482a7 documentation/poky-ref-manual/ref-variables.xml: New TMPDIR glossary term.
(From yocto-docs rev: e3be42d820e0ddc1b365034f41b03cf678001659)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:55 -08:00
Scott Rifenbark
a562fa6bd0 documentation/poky-ref-manual/ref-variables.xml: new TOPDIR glossary entry.
(From yocto-docs rev: 04bca6669972d8f8a9f4ecfbe2403fa669bf2b33)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:54 -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
f908723bc6 documentation: top-level manuals edited for new structure
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>
2012-03-08 12:07:50 -08:00
Scott Rifenbark
a8108a2f17 documentation: File swap
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>
2012-03-08 12:07:50 -08:00
Scott Rifenbark
e71d0af563 documentation/poky-ref-manual/ref-variables.xml: CONFFILES and FILES edits
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>
2012-03-08 12:07:48 -08:00
Scott Rifenbark
7a5fa33974 documentation/poky-ref-manual/ref-images.xml: Added three core-images
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>
2012-03-08 12:07:48 -08:00
Scott Rifenbark
7b03d42f85 documentation/poky-ref-manual/ref-variables.xml: removed DISTRO_EXTRA_RDEPENDS
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>
2012-03-08 12:07:48 -08:00
Scott Rifenbark
8769a255d7 documentation/poky-ref-manual/ref-variables.xml: Edits to CONFFILES and FILES
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>
2012-03-08 12:07:48 -08:00
Scott Rifenbark
25cd1baf8c documentation/poky-ref-manual/ref-variables.xml: Edits to IMAGE_INSTALL
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>
2012-03-08 12:07:47 -08:00
Scott Rifenbark
2e5e02a905 documentation/poky-ref-manual/ref-variables.xml: Added CONFFILES and FILES
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>
2012-03-08 12:07:47 -08:00
Scott Rifenbark
739dad2f19 documentation/poky-ref-manual: Removed ROOT_FLASH_SIZE from document.
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>
2012-03-08 12:07:47 -08:00
Scott Rifenbark
62907f76bc documentation: More information about DL_DIR added.
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>
2012-03-08 12:07:46 -08:00
Scott Rifenbark
ddaf79d4d4 documentation/poky-ref-manual/ref-variables.xml: Fixed broken reference.
(From yocto-docs rev: 21d5f4558289290bf890e1669f5f45307dd17550)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-03-08 12:07:46 -08:00
Scott Rifenbark
ba0e818504 documentation/poky-ref-manual: Updates to IMAGE_INSTALL
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>
2012-03-08 12:07:46 -08:00
Scott Rifenbark
2a0a3d631a documentation/poky-ref-manual/extendpoky.xml: proposed section
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>
2012-03-08 12:07:46 -08:00
Scott Rifenbark
57f3951f29 documentation/poky-ref-manual/ref-variables.xml: new BBMASK glossary entry
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>
2012-03-08 12:07:45 -08:00
Scott Rifenbark
4110fa7f7e documentation/poky-ref-manual/faq.xml: Fixed links to python
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>
2012-03-08 12:07:43 -08:00
Scott Rifenbark
83e8921c06 documentation/poky-ref-manual/ref-variables.xml: PDF formatting fixed.
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>
2012-03-08 12:07:41 -08:00
Scott Rifenbark
2df457033b documentation/poky-ref-manual/ref-variables.xml: updates to rootfs variables
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>
2012-03-08 12:07:41 -08:00
Scott Rifenbark
03df4ce093 documentation/poky-ref-manual/ref-variables.xml: image size glossary
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>
2012-01-06 12:13:12 +00:00
Scott Rifenbark
01d5729e13 documentation/poky-ref-manual: Enabling recipes with commercial license requirements
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>
2012-01-06 12:13:12 +00:00
Scott Rifenbark
b281fd127b documentation/poky-ref-manual/technical-details.xml: edits per Richard Purdie
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>
2011-12-16 16:58:41 +00: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
64d5176865 documenation/poky-ref-manual/technical-details.xml: Shared State
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>
2011-12-16 16:58:40 +00:00
Scott Rifenbark
2ce852ad7b documentation/poky-ref-manual/technical-details.xml: more on YOCTO #1500
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>
2011-12-16 16:58:40 +00:00
Scott Rifenbark
4378fd205c documenation/poky-ref-manual/technical-details.xml: Some general edits.
(From yocto-docs rev: b806511994d0673475939db2690a3aeec7389609)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-12-16 16:58:40 +00:00
Scott Rifenbark
93a78f4b42 documentation/poky-ref-manual/extendpoky.xml: Fixed typo
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>
2011-12-16 16:58:40 +00:00
Scott Rifenbark
5e1255f809 documentation/poky-ref-manual/extendpoky.xml: intro changed and order changed
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>
2011-12-16 16:58:39 +00:00
Scott Rifenbark
9f31ba93dd documentation/poky-ref-manual/usingpoky.xml: updated intro paragraph
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>
2011-12-16 16:58:39 +00:00
Scott Rifenbark
7098ae12df documentation/poky-ref-manual/introduction.xml: Added reference
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>
2011-12-16 16:58:39 +00:00
Scott Rifenbark
31ddf65775 documentation/poky-ref-manual/introduction.xml: added new chapter
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>
2011-12-16 16:58:39 +00:00
Scott Rifenbark
a191e6e048 documentation/poky-ref-manual: New chapter introduced
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>
2011-12-16 16:58:38 +00:00
Scott Rifenbark
9a99147c91 documentation/poky-ref-manual/usingpoky.xml: Removed comments
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>
2011-12-16 16:58:38 +00:00
Scott Rifenbark
d122e37be3 documentation/poky-ref-manual/usingpoky.xml: partial for YOCTO #1500
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>
2011-12-16 16:58:08 +00:00
Scott Rifenbark
4ae4f1d553 documenation/poky-ref-manual/ref-variables.xml: added LICENSE_DIR
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>
2011-12-16 16:58:08 +00:00
Scott Rifenbark
162359688e documentation/poky-ref-manual/ref-classes.xml: insane.bbclass updated
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>
2011-12-16 16:58:07 +00:00
Scott Rifenbark
ac174aaeba documentation/poky-ref-manual/ref-variables.xml: EXTRA_IMAGEDEPENDS added.
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>
2011-11-25 15:24:19 +00:00
Scott Rifenbark
affc8b985a documentation: BB_NUMBER_THREADS and PARALLEL_MAKE suggestions
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>
2011-11-25 15:24:19 +00:00
Scott Rifenbark
68f1fa0d30 documentation: Added footnote element to the stylesheets
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>
2011-11-25 15:24:17 +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
Robert P. J. Day
c8fd49ab90 documentation/poky-ref-manual: Minor wording fixes
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>
2011-11-25 15:24:16 +00:00
Scott Rifenbark
90aff1ce68 documentation/poky-ref-manual/introduction.xml: Fixed broken link
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>
2011-11-25 15:24:16 +00:00
Robert P. J. Day
8c230114dd documentation: Standardized on spelling of BitBake
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>
2011-11-25 15:24:15 +00:00
Scott Rifenbark
24fd69a90e documentation/poky-ref-manual/extendpoky.xml: punctuation fixed.
(From yocto-docs rev: d419a193032f0aa7fec74389ba224ff4f59be342)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-31 22:37:08 +00:00
Scott Rifenbark
6943f792e7 documentation/poky-ref-manual/resources.xml: Fixed YP term usage.
(From yocto-docs rev: e486c90e6f3ad6b19b99b09b19fc16093dcf0af4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-31 22:37:08 +00:00
Scott Rifenbark
2923cc23d1 documentation: Cleaned out bad links and replaced with good
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>
2011-10-14 00:31:11 +01:00
Scott Rifenbark
f54a78c891 documentation: Fixed links for yocto-1.1
After greping through the documentation directory, I addressed
all the <ulink> statements that used to have yocto-1.0 in the URL.
They are now yocto-1.1.

(From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-06 18:41:47 +01:00
Scott Rifenbark
47b82c7db8 documentation/poky-ref-manual/extendpoky.xml: multilib edits
Feedback from Richard Purdie inserted.  I made an edit pass for
style to Richard's re-write.

(From yocto-docs rev: e5bb08e966614c610e6357642b3b2d1522332f7f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:44 +01:00
Scott Rifenbark
8d689e378a documentation/poky-ref-manual/extendpoky.xml: Multilib section added
I created a section on how to prepare for and use the multilib
feature.  The information is leveraged off the "Multilib" wiki page
at http://wiki.yoctoproject.org/wiki/Multilib.  This is the first
draft of the changes.  I expect corrections.

(From yocto-docs rev: 8cf41c90f772018f4f144d63df911912cc298d70)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:42 +01:00
Scott Rifenbark
14be63e635 documentation: Updated title pages.
Updated the title pages for the ADT, BSP, Dev, and Ref manuals to
contain the Oct 6 release date for the books.  Also, changed the
author field for the BSP guide to include Tom Zanussi as well
as Richard Purdie.

(From yocto-docs rev: 301da0a5b305e4b332397bb67f6a6a77751991d2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:42 +01:00
Scott Rifenbark
11f9e74190 documentation/poky-ref-manual/ref-variables.xml: updated KERNEL_FEATURES
(From yocto-docs rev: 37a9cea71139ceda1d2a7da639f5555414ef497b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:42 +01:00
Scott Rifenbark
c47f8ed57d documentation/poky-ref-manual/ref-variables.xml: updates to KERNEL_FEATURES.
(From yocto-docs rev: ec1e2d71c576fe1c12031371de89a71770cebb1d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:41 +01:00
Scott Rifenbark
c89ebd806c documentation/poky-ref-manual/ref-variables.xml: Added KERNEL_FEATURES
Added this variable description in the glossary.

(From yocto-docs rev: 12a9e5b4dfc399ff2037355aa1062f907a62e76d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:41 +01:00
Scott Rifenbark
c0334472e2 documentation/poky-ref-manual/faq.xml: Removed wording that focues on GNOME
Per Paul Eggleton he suggested that the wording we had about YP focusing
on the GNOME Mobile environment was misleading now.  It was in there in the
original version of the FAQ but with time has become outdated.  I simply
removed the "GNOME" part and left the part that mentions about YP
being a stable
environment and well-suited for the embedded mobile environment.

(From yocto-docs rev: cc7103eda3fd77d89cecfffa23f0f798aa512132)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:40 +01:00
Scott Rifenbark
1bc65c7320 documentation/poky-ref-manual/ref-variables.xml: Variables updated
This is the second pass for re-documenting RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIALS_EXTRA_RDEPENDS, MACHINE_ESSENTIALS_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS.  These
variables are in dire need of better explanations and examples.

(From yocto-docs rev: cc60bd4c50c7b19209dae06307aec26e962cf476)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:39 +01:00
Scott Rifenbark
0fb1d6e620 documentation/poky-ref-manual: Updates to several variables.
I did complete rewrites of RDEPENDS, RRECOMMENDS,
MACHINE_ESSENTIAL_EXTRA_RDEPENDS, MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS,
MACHINE_EXTRA_RDEPENDS, and MACHINE_EXTRA_RRECOMMENDS.  These are
sent out for review but these changes represent the first attempt
to clear up confusion on how the six variables are used and relate
to each other.

(From yocto-docs rev: 1d93707fb9383d51322e96eb521e96fcac8bcc47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:39 +01:00
Scott Rifenbark
5e06b9a4ed documentation/poky-ref-manual/ref-variables.xml: update RDEPENDS and RRECOMMENDS
Provided better descriptions of these variables and some examples on
how to use them.

(From yocto-docs rev: 3a5cce8c9ba02f90b3554a6f800f69c2e8e77911)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:39 +01:00
Scott Rifenbark
435e0ac611 documentation/poky-ref-manual/ref-variables.xml: update PREFERRED_VERSION
Added a more robust description and provided a couple of usage
examples.

(From yocto-docs rev: b8b842b57cc003f1351a551041fe4b3de2fcbfd6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:39 +01:00
Scott Rifenbark
12b10aafa8 documentation/poky-ref-manual/ref-variables.xml: update PREFERRED_PROVIDER
I added sterner wording on usage and provided an example.

(From yocto-docs rev: 32e07fafadb602b93c9f7b8a78e5baf4c7e1ab5e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:39 +01:00
Scott Rifenbark
f0ea446127 documentation/poky-ref-manual/ref-variables.xml: update TCLIBC and POKYLIBC
Changed the description of POKYLIBC to note the variable is not supported
and provided a link to TCLIBC.  I added the entry for TCLIBC, which
was missing.

(From yocto-docs rev: d76a1ddb79577a3e121df3d590fb601b5e5fbb98)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:38 +01:00
Scott Rifenbark
225a20b39d documentation/poky-ref-manual/ref-variables.xml: updates TCMODE and POKYMODE
Noted that POKYMODE is no longer supported and provided link to TCMODE.
Added richer description to TCMODE.

(From yocto-docs rev: a7a326c2c8f4c5f29f3a9723a6895a7113a78357)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:38 +01:00
Scott Rifenbark
78ddcae27f documentation/poky-ref-manual/ref-variables.xml: edits to FILESYSTEM_PERMS_TABLES.
Some minor re-wordings to give some context on how to use these special
files and the variable to point to them.

(From yocto-docs rev: 4482b42f4a224bada7a0fa5fe4821a753ba55d80)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-10-04 13:46:38 +01:00
Scott Rifenbark
bc9951a147 documentation/poky-ref-manual/ref-variables.xml: updated RDEPENDS
Per Paul Eggleton's suggestion I updated the description of this
variable.  Some minor wording changes as well as covering two
automatic handling features.

(From yocto-docs rev: 15be3502ca20f657051e02d698b459328328fb14)

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
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
Scott Rifenbark
87566447aa documentation/poky-ref-manual/extendpoky.xml: New section on static library
I added a new section to the "Adding a Package" section.  This section
describes how to define the *.a files for when you create a library
that has static linking.  Response to a comment from Paul Eggleton.

(From yocto-docs rev: 64499006ecd1e6b7573f1955a2f6e2f1a9564ce8)

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
Scott Rifenbark
fe209e4fa4 documentation/poky-ref-manual/ref-variables.xml: added FILESYSTEM_PERMS_TABLES
New glossary variable entry added.

(From yocto-docs rev: f9a214fa7714b9ca4741ac0c56d40e2d8a390292)

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
Scott Rifenbark
49ed1cab3b documentation/poky-ref-manual/ref-classes.xml: documented useradd.bbclass
New section per Paul Eggleton's request.

(From yocto-docs rev: ffedb53e5c706cffb83978f1704a606d29233e36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 18:00:00 +01:00
Scott Rifenbark
46bd7cbdc5 documentation/poky-ref-manual/ref-variables.xml: added BAD_RECOMMENDATIONS
New variable for images that use the ipkg packaging system.  These
are packages you don't want to install even when the recipe calls
for it.

(From yocto-docs rev: 78d53b5da4bbd6889a34be8a1c795a5658cb6b1e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 18:00:00 +01:00
Scott Rifenbark
315cb8ebcf documentation/poky-ref-manual/ref-classes.xml: fixed insane.bbclass added others
I fixed the insane.bbclass description to say that it checks for common
problemos that occur during runtime and not build time.  Also got rid of the
"ever-increasing" statement as that is not true according to Paul Eggleton.

Added many new .bbclass files to the commented out section of the
undocumented classes as well as removed a bunch.

(From yocto-docs rev: c341951185d5af6576718f8ada057afcca923e6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 18:00:00 +01:00
Scott Rifenbark
5a23ec28c2 documenation/poky-ref-manual/ref-variables.xml: debug-tweaks qualified
I noted that the developer should remove this option from
EXTRA_IMAGE_FEATURES before they create a production image.

(From yocto-docs rev: 8de6c789d1a1ed5e721c16f53bb27de18ae88238)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:59 +01:00
Scott Rifenbark
13f312a6dc documentation/poky-ref-manual/resources.xml: Updates to mailing lists.
I updated the mailing lists to be more specific and to be formatted
differently.

(From yocto-docs rev: 50b5cf2d331b120cfa9de0ba77ea1da1240d42e4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:58 +01:00
Scott Rifenbark
8995698ddb documentation/poky-ref-manual/resources.xml: re-wrote Contributions
The information in the "Contributions" section has been migrated to
a "Submitting a Change" section in the YP Development Manual.
I re-wrote this section here to simply make a general statement
about how you can submit a change and then provided a reference
link to the appropriate section in the dev manual.

(From yocto-docs rev: 038caebb2815a8f09d35e99d5a2a0be76b05cacf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-25 17:59:57 +01:00
Scott Rifenbark
99cb233e0c YOCTO #1088: documentation - Added text to partially address package bug
This bug was filed by Gary Thomas and was requesting more information
on the "hows" and "whys" of setting up your own package repositories.
At this point, I have added information to help the user understand
build performance issues when choosing between the RPM and IPKG packaging
systems.  Likely, there is more that needs to be added to fully address
this bug.

For now, I added explanations in the packaging class and glossary areas
of the YP reference manual, a new paragraph in the YP QS just prior to
firing off a build, and a new bit of information in the configuring
PMS in the ADT Manual.

(From yocto-docs rev: d0025f862cb85ca741787b4737dca286e3ebfb45)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-09-02 23:38:52 +01:00
Scott Rifenbark
31acde62ad documentation/poky-ref-manual/usingpoky.xml: Edits per Darren Hart
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>
2011-09-02 23:38:50 +01:00
Scott Rifenbark
fdbc652b08 documentation/poky-ref-manual: Removed "spitz" machine example.
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>
2011-08-30 17:27:39 +01:00
Scott Rifenbark
4a39412086 documentation/poky-ref-manual/ref-features.xml: typos fixed.
(From yocto-docs rev: b2c9750abec8429d665996231ddd16359e168c47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:38 +01:00
Scott Rifenbark
d67201e600 documentation/poky-ref-manual/usingpoky.xml: Updated logging mechanism
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>
2011-08-30 17:27:37 +01:00
Scott Rifenbark
ba3069c9c6 YOCTO #910 - documentation/poky-ref-manual/extendpoky.xml: point to dev manual.
There is a section in the YP ref manual that gives reference type information
on adding a machine.  This type of information is detailed well in the
BSP example appendix in the development manual.  I don't want to completely
eliminate the information in the YP ref manual as is suggested by the
910 bug.  I think referencing it in the dev manual for now works.

(From yocto-docs rev: e55dd8228d1376c9df01e320163862ddf35a5156)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:37 +01:00
Scott Rifenbark
ffbed4c03a documentation/poky-ref-manual/resources.xml: re-write for today's world.
This chapter was quite old as it had not been touched since the original
Poky Handbook days.  I re-wrote the sub-sections with today in mind.

(From yocto-docs rev: e59bede734a8fe3e9b41698e2b42ba487ec80595)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:36 +01:00
Scott Rifenbark
dd92838748 documentation/poky-ref-manual/faq.xml: Scrubbed for term Poky.
In general, the term Poky can be replaced by "the Yocto Project."
The term Poky can be used as a term for the Yocto Project build system.
I left it in place for a few areas where it was easy and would not
be confusing.

I also performed general rewrites for the FAQ.

(From yocto-docs rev: bb24bcf21311c68576fb8c3fec86ad8303f557f2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:36 +01:00
Scott Rifenbark
0e87c3e01e documentation/poky-ref-manual/extendpoky.xml: Changed targe link title.
(From yocto-docs rev: c8d5570ba9f6180bba3c2b618d0b401c0fdb86ce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-30 17:27:35 +01:00
Scott Rifenbark
9ca6806de9 docuementation/poky-ref-manual/ref-structure.xml: Changed SRCDATE reference
I was incorrectly referring to SRCDATE variables in a context that should
have been SRCDATE destinations.

(From yocto-docs rev: eb255d9369b5bb3905a586433d472fd100c737dc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:59:55 -07:00
Scott Rifenbark
b5fc6d78cb documentation/poky-ref-manual/faq.xml: Edits to scrub for Poky
(From yocto-docs rev: 089575ceb618199fbeccad1a4e7b7bd19eb5ad7f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:59:30 -07:00
Scott Rifenbark
8e0ba4e638 documentation/poky-ref-manual/faq.xml: Edits to scrub for Poky
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:55:44 -07:00
Scott Rifenbark
d02e56fd14 documentation: Changes to Paul Eggleton's edits for various manuals.
Paul sent me a bunch of minor edits and technical corrections
for the ADT, BSP, Development, and YP reference manual.
Most changes were taken as he submitted them.  However, some
formatting conventions were not followed in the commits he made
to yocto-docs/paule/docs2.  After merging them to my yocto-docs/master
branch I fixed some issues.

(From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:38 -07:00
Paul Eggleton
88dfc936dc documentation: clarify specifying a specific package with -e
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>
2011-08-24 19:49:37 -07:00
Paul Eggleton
954444f1d3 documentation: update documentation for SRCREV variable
* Add note about specifying a full revision ID to prevent querying the
  remote server on every parse
* Mercurial also supports this variable

(From yocto-docs rev: 47ce273dd751b0ae32b5c53310b6aedc4dade2ef)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton
1e18d85170 documentation: set titles for all documents
These documents do not have titles when showing up on the website; set
the title tag value so that they do.

(From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton
cf65497076 documentation: update BBFILE_* variable documentation
* Add documentation of LAYERVERSION, LAYERDEPENDS and new layer priority
  behaviour
* Improve some wording

(From yocto-docs rev: be7c10f3b8b35ff231e5974a48936e66fd49fcbc)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton
75fc3840aa documentation: update for directdisk/live image changes
-live and -directdisk image have been removed; add a tip about using the
live option in IMAGE_FSTYPES to build any image as a live image.

(From yocto-docs rev: ef7c508a4073c4f04c2368420e64a5d6620c8fbc)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:37 -07:00
Paul Eggleton
23a7eec172 documentation: update TERMCMD/TERMCMDRUN documentation
* xterm is now the default
* Konsole from KDE 4.x will no longer work due to changes in behaviour

(From yocto-docs rev: 031a619ca19dbc2011a4df7bba1c332f2770e15d)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton
547ba60f85 documentation: ensure all examples have LIC_FILES_CHKSUM
We really need to have LIC_FILES_CHKSUM in all of our example recipes,
because it is now mandatory.

(From yocto-docs rev: 76998b7c54246e0505cf01b21d65d04ab285f1f0)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton
3906b60791 documentation: improve LIC_FILES_CHKSUM documentation
Document that LIC_FILES_CHKSUM is mandatory, when gets validated, and
improve some wording.

(From yocto-docs rev: ca878d7b0c84812ef29bbaf5894c96dd89500ec9)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07:00
Paul Eggleton
88c16945fa documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESS
This variable was renamed (to match OE) in the Yocto 1.1 development
cycle.

(From yocto-docs rev: 5cda8fe3b5dd18b629ccd13427da3b5743ae66ce)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-24 19:49:36 -07: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
Paul Eggleton
6ca8903629 documentation: correct QT to Qt
(From yocto-docs rev: 37ac4cbd61bc8c891aa6dc05baf632a0a4bfd906)

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
d02f6b0c23 documentation/poky-ref-manual/ref-variables.xml: Fixed links
The links to the lettered divisions of the glossary do not work.
I changed them to the first entry for each lettered area.

(From yocto-docs rev: b7692bcfa19fb940a050c0cf72dc2f7e427b8ba7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:08 -07:00
Scott Rifenbark
94638de796 documentation/poky-ref-manual/ref-varlocality.xml: Reformatted
This appendix had poor organization.  I re-organized it according
to configuration and recipe context.  The sub-sections break out much
more nicely now.

(From yocto-docs rev: 7a3a7b3a7b4861122194ea0a78c16af531f0078b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark
61d65d11df documentation/poky-ref-manual/introduction.xml: Title changed.
(From yocto-docs rev: 244c632812f10a3dc79eb814caf1449c50655e36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark
638ffa90db documentation/poky-ref-manual/ref-variables.xml: Fixed default format
In the document, several variables state their default values. I set the
formatting to surround a default value with double quotes in all cases.

I also fixed a typo for "RECOMMEDNS"

(From yocto-docs rev: 3da85f54df6fd4ad64d5be2cc9ae0e6dd50a68f5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:07 -07:00
Scott Rifenbark
70bd76e658 documentation/poky-ref-manual/ref-variables.xml: Scrubbed for Poky
I also fixed formatting and some minor wordings.

(From yocto-docs rev: b1bbfe89cb250ef5267fb16635dc41338aab0c59)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark
7a59fbde96 documentation/poky-ref-manual/ref-variables.xml: partial edits.
(From yocto-docs rev: e8300735591f0b47aff64200a2dff477b5bfd9b2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark
87f4bfd0a3 documentation/poky-ref-manual/ref-features.xml: Cleaned up list formatting.
(From yocto-docs rev: 1813848d673dedae6b918676eec1f3926ee630f2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark
5b171729f2 documentation/poky-ref-manual/ref-images.xml: Reformats of the Docbook code.
(From yocto-docs rev: 8b334782415a428724023af0e6ee8a0ee5aa79f6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:06 -07:00
Scott Rifenbark
95ef8d7a2e documentation/poky-ref-manual/ref-classes.xml: Scrubbed for Poky
I changed the "Poky" references to "the Yocto Project" and performed
general edits where necessary.

(From yocto-docs rev: a7ef3e7d5c792bde5231b9302e614cb7b5db81b7)

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
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
39de08c105 documentation/poky-ref-manual/ref-structure.xml: Scrubbed for Poky and edits
I converted "Poky" to "the Yocto Project."  I also updated several examples.
In particular the build/tmp/work example.

(From yocto-docs rev: eb82bc36904f502fb4f314ff05eb86cff27ce0b6)

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
cde376cc04 documentation/poky-ref-manual: Removed figures from file structure.
The poky-beaver.png, poky-log.svg, and white-on-black-yp.png
figures are not used and do not need to be in the file structure
for this manual.

(From yocto-docs rev: c2217102813fc0a72922bf2baf24e07184cf24e3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark
ec6b3071eb documentation/poky-ref-manual/figures/ss-sato.png: deleted figure.
(From yocto-docs rev: 29a5c1da4695fc8a5979c3d095f87879c0b267ce)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:04 -07:00
Scott Rifenbark
10ddfd6f51 documentation/poky-ref-manual/extendpoky.xml: scrubbed for Poky
Converted to Yocto Project from Poky.

(From yocto-docs rev: 0263e8b29efeff051184ce1700da9559ea511faf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark
776834d63b documentation/poky-ref-manual/development.xml: Garman's partial review comments
(From yocto-docs rev: 329401ac13e60381ca74a617ae398586cbd5dfed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark
ed4caadd13 documentation/poky-ref-manual/development.xml: updates for YP terms
I updated the profiling sections to reflect Yocto Project rather than
Poky.

(From yocto-docs rev: 4f2c3bc93d97a6a8676fdd14ff9061bb92bdf5c9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:03 -07:00
Scott Rifenbark
90d5834ad2 documentation/poky-ref-manual/usingpoky.xml: small edits to list and title
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>
2011-08-23 18:47:02 -07:00
Scott Rifenbark
e384051ded documentation/poky-ref-manual/introduction.xml: re-write for YP
I re-wrote and reorganzied this chapter to reflect the book as
a Yocto Project Reference Guide.

(From yocto-docs rev: ef3c3955ab0cedb57d9ae48041ed94806fe34001)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark
7f9b16defb documentation/poky-ref-manual/resources.xml: Changed title
Changed the title to refelect the Yocto Project and not Poky.

(From yocto-docs rev: 151c1925659e986b27866fed5abfcba96744b204)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:47:02 -07:00
Scott Rifenbark
8aa163ba69 documentation/poky-ref-manual: Changed top-level titles
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>
2011-08-23 18:47:02 -07:00
Scott Rifenbark
295b855fc9 documentation/poky-ref-manual/usingpoky.xml: re-write for Yocto
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>
2011-08-23 18:47:01 -07:00
Scott Rifenbark
00d483d65a documentation/poky-ref-manual/usingpoky.xml: YOCTO #1001 - new section added
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>
2011-08-23 18:47:01 -07:00
Scott Rifenbark
96f0c57a0a documentation/poky-ref-manual/development.xml: re-write of software dev section
This is a comprehensive pass through this entire section that incorporates
understanding given to me by Scott Garman.  I have added more detail and
text that helps the non-developer understand what is fundamentally going
on.

(From yocto-docs rev: 124c722ccf0316f6e62790ca77c88d0444559378)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark
266b83c8e1 documentation/poky-ref-manual/development.xml: Updated software dev intro
Added more general description of what this section's purpose it.
I felt it was missing some basic information and making too many
assumptions.

(From yocto-docs rev: 4a5faeecc616313147283e50fe947c68555f55a2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:37 -07:00
Scott Rifenbark
45aa3ff3b8 documentation/poky-ref-manual/figures/poky-title.png: Changed Title
It seems that this manual should be named the yocto project reference
manual as we slowly try to rid ourselves of the "Poky" term.

(From yocto-docs rev: c9d30285adf83bbcfc06233be54aec4203cbfd13)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-23 18:46:36 -07:00
Scott Rifenbark
0a2e82c007 documentation/poky-ref-manual/usingpoky.xml: Fixed double dash display.
In the PDF version of the manual the "&dash;&dash;" 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>
2011-08-23 18:46:36 -07:00
Scott Rifenbark
958c355665 documentation: updated the note in the front matter to use a link specific to manual.
(From yocto-docs rev: 8008a00e188dc0569d0fb6e5cf497637a0b57747)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-20 17:51:58 -07:00
Scott Rifenbark
52435ce880 documentation/poky-ref-manual/ref-images.xml: Updated the list of images.
The list of images has grown.  I added all images reported in the
1.1_M2 build using the 'ls meta*/recipes*/images/*.bb' command.

(From yocto-docs rev: 62e12a71c73a5e3a20c6887d754a96eb9e754b48)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-15 15:26:57 +01:00
Scott Rifenbark
df815c1543 documentation/poky-ref-manual/poky-ref-manual.xml: Added note to title page.
Note mentions possible differences between docs in the released
tarball and docs on the website.  Suggests website for latest
docs.

(From yocto-docs rev: 5061f9e8b3cfb66b2ed17befc9c4c4d8b875f4eb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-08-04 15:06:51 +01: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
Scott Rifenbark
fad2e9834c documentation/poky-ref-manual/faq.xml: Updated Python FAQ entry
The entry previously stated that only Python 2.6 is required.  I
added Python 2.7 to that requirement.  I also changed the URLs that
point to our pre-built tarballs from which the user can get Python
2.6 to be in the yocto-1.0 download area.  They were pointing to
an area in the index of downloads that was up one level.  According
to Beth the official location is
http://autobuilder.yoctoproject.org/downloads/miscsupport/yocto-1.0- \
python-nativesdk.

(From yocto-docs rev: f5ba36dee8094209fa6d3c6f97656588ded0567f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:14:00 +01:00
Scott Rifenbark
64bac7f446 documentation/poky-ref-manual/ref-structure.xml: Fixed a type (From yocto-docs rev: b2f45f73832a2289158bfb89313957a48dded1cd)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:14:00 +01:00
Scott Rifenbark
72ed33f179 documentation/poky-ref-manual/extendpoky.xml: YOCTO #1104 EXTRA_IMAGE_FEATURES
YOCTO #1104: The section that describes how to customize images
with new features failed to mention the variable EXTRA_IMAGE_FEATURES.
I added text to include that option and referenced the variable.
(From yocto-docs rev: 128b53594be02e486ca3f4658b9f93b9913a3972)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:14:00 +01:00
Scott Rifenbark
3b67d8afd4 documentation/poky-ref-manual/ref-varlocality.xml: YOCTO #1104 EXTRA_IMAGE_FEATURES
YOCTO #1104: The section describing the local configiuration file
local.conf lists out variables used.  One variable it had in there
was IMAGE_FEATURES.  This variable is not in local.conf.  But,
EXTRA_IMAGE_FEATURES is the variable that is there.  I corrected this.

(From yocto-docs rev: 2698d0fc61adc8971a84436529a54190c998d4d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:14:00 +01:00
Scott Rifenbark
b46af8aa11 documentation/poky-ref-manual/ref-features.xml: YOCTO #1104 EXTRA_IMAGE_FEATURES
The Images reference section states you can control what features are
in an image by using the IMAGE_FEATURES variable.  It failed to mention
the EXTRA_IMAGE_FEATURES variable.  I included this variable in the
discussion.

(From yocto-docs rev: 6c7789bd409f43a3978c09c43db31010bc461573)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:13:59 +01:00
Scott Rifenbark
4f7dd81c6f documentation/poky-ref-manual/ref-variables.xml: YOCTO #1104 EXTRA_IMAGE_FEATURES
Added a cross-reference to the EXTRA_IMAGE_VARIABLES glossary
term and provided more explanation describing the relationship
between the variable and the IMAGE_FEATURES variable.

(From yocto-docs rev: 227c11b8d81e9ae266b7e60172d0a5e9e1237ed0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:13:59 +01:00
Scott Rifenbark
497d774201 documentation/poky-ref-manual/ref-variables.xml - YOCTO #1104 EXTRA_IMAGE_FEATURES
YOCTO #1104 - Added a glossary entry for the EXTRA_IMAGE_FEATURES
variable.

(From yocto-docs rev: f81a85322d944d33484da73020593891811a045a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-24 11:13:59 +01:00
Scott Rifenbark
306e1a5320 documentation: updated manual history
I added an entry to represent the Yocto Project 1.0.1 Release into
the manual history table for all of the manuals except the Yocto
Project Quick Start, which does not have a table.

(From yocto-docs rev: d2c570b18854b3f15dfb20436a2212f569e96d5f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-13 22:38:04 +01:00
Beth Flanagan
37eedd0ae3 documentation: [YOCTO #1025] build system for docs
These changes fix the following issues:

1. Multiple Makefiles. There really is no need for this.
2. Unable to maintain more than one version of the docs on the webserver.

This is a quick fix to enable the above.
In order to build the documentation, at the top level, issue a:
make all DOC=<doc directory name>
make all DOC=kernel-manual

Also, some changes need to occur on the webserver to fully
incorporate these fixes.
http://www.yoctoproject.org/documentation/
The docs are now published to:
http://www.yoctoproject.org/docs/<Release MM.mm>/<doc name>

The main page should be changed to point not only to the current doc release,
but also to the prior releases. This will enable us to maintain prior release
documentation without stomping over it when we publish new docs. Also, we'll
need to repoint the yocto-quick-start link to yocto-project-qs. Or rename
documentation/yocto-project-qs/* to support the website naming.

(From yocto-docs rev: 2651790d80fd32cd4619eeb5375f6ee28e7e7fda)

Signed-off-by: Beth Flanagan <elizabeth.flanagan@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-13 22:38:03 +01:00
Scott Rifenbark
baf6bf4a5d documentation/poky-ref-manual/faq.xml: Added new FAQ entry x-toolchain
Added a new FAQ entry per Richard Purdie answering the question
'How do I use an external toolchain?'

(From yocto-docs rev: 58b78df0d78637234cbcb0e70e225b72ba0f9a2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-06-13 22:38:03 +01:00
Scott Rifenbark
0eb49324c8 BUGID#_1083 - documentation/poky-ref-manual/usingpoky.xml: -k option added
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>
2011-05-23 15:53:29 +01:00
Scott Rifenbark
aff8c579f6 documentation/poky-ref-manual/faq.xml: Added FAQ entry for filename spaces
Added a new entry for we do not support spaces in filenames.
This entry was suggested by Richard.

(From yocto-docs rev: 27d7f951056fb55bddcd7a71374359583c635073)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 20:07:48 +01:00
Scott Rifenbark
375935df77 BUGID#_ 1068 - documentation/poky-ref-manual/extendpoky.xml: updated hello ex.
Changed the hello_2.2.bb example to hello_2.3.bb

(From yocto-docs rev: b1d07533b82a37aa5e52ebdbb3e9629e2b8ba549)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-17 18:14:05 +01:00
Scott Rifenbark
bc729d29e3 documentation: Removed hardcoded user name from publish option
I removed the hardcoded name from the publish option.  This involved
updating the Makefiles.  The publish option is still temporary as a
more permanent solution is being created.

(From yocto-docs rev: 6878b2ccdb98b18c438ca419e1caad0041a2bc00)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:17 +01:00
Scott Rifenbark
c7c40a3571 BUGID#_807: documentation/poky-ref-manual/ref-variables.xml: BBFILE_PRIORITY updated
BUGID#_807 - I updated the description of the BBFILE_PRIORITY variable
to provide more detail.  Input from Tom Zanussi on this fix.

(From yocto-docs rev: 90f9fd0c3bcf5c772423fa53f1f00579eba1bdeb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:16 +01:00
Scott Rifenbark
aa0575ce4d documentation/poky-ref-manual: Removed the PNG files in screenshots
The directory screenshots is no longer used in this manual.  Previously,
only one file (ss-sato.png) was used and I have moved it to the
figures folder.

(From yocto-docs rev: 1c75a62b33910ff951601dedd32b79bebb41090c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:16 +01:00
Scott Rifenbark
4ff1f64f1b documentation/poky-ref-manual: Added new title graphic
I have removed the multi-colored POKY image that was used for
the title of the Poky Handbook.  The image I put in here is in
line with the other graphics used as titles for our Yocto Project
documentation.  To accomplish this I had to create and add a new
PNG file named poky-title.png.  I placed this image in the figures
folder.  I removed the poky-ref-manual.png file (old figure).
I also had to alter the Makefile to use the new figure as part of the
tarball.  Finally, I had to alter the HTML style sheet (style.css)
to include the new file.

(From yocto-docs rev: 6c44fca054c1c105daea6fa42f89a7f78a6d12cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:16 +01:00
Scott Rifenbark
4100ebabfc documentation/poky-ref-manual/figures/ss-sato.png: Added this file.
I moved this file from the screenshots directory to the figures
directory so that all figures would be in the figures directory.

(From yocto-docs rev: b61915e6cdf7dfedc4588cd59f252088a1069b65)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:16 +01:00
Scott Rifenbark
fccb51c230 documentation/poky-ref-manual: Figures cleanup
I removed two figures from the figures directory:
cropped-yocto-project-bw.png and yocto-project-transp.png.
Both figures are relics and not used in the manual.  I also
altered the Makefile to pull the ss-sato.png file from the
figures directory instead of the screenshots directory.  I moved
this PNG file from the screenshots directory to the figures
directory so that all figures would be in the figures directory.
Finally, I updated the introduction.xml file so that the html
code to include the ss-sato.png file pulls it from the figures
directory and not the screenshots directory.

(From yocto-docs rev: daa15c232d8c46d94cafd080e03318c733ec089f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:15 +01:00
Scott Rifenbark
92690ef3cc BUGID#_956: documenation/poky-ref-manual/Makefile: Updated publish
BUGID#_956: I updated the publish option so that the HTML and PDF
versions of the manual are automatically pushed to the Yocto Project
website. This fix takes care of BUGID#_956 for the Poky Reference Manual.

(From yocto-docs rev: aed87d15ce9df0835b704fda1e9d8f464d070e32)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-10 10:02:15 +01:00
Scott Rifenbark
1eb81c8ab0 documentation/poky-ref-manual/Makefile: BUGID#_956 - fixed publish URL
Fixed the remote publish URL used to push the HTML and PDF files to
the website.

(From yocto-docs rev: c5c170c582ca0a483aca13b7ddaa7f4d99a3aaf9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-09 14:17:37 +01:00
Saul Wold
9aa2ef7467 documentation: Update publishing location
(From yocto-docs rev: 2f55104fe696f55d1f4ebb7f2cfcb3a2fd89385e)

Signed-off-by: Saul Wold <sgw@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-09 14:17:34 +01:00
Scott Rifenbark
7accf4ba99 documentation/poky-ref-manual/resources.xml: removed referenct to poky linux site
There was a reference to the pokylinux.org home site.  I commented this
item out so it does not show in the user documentation.  I was unclear
on whether the reference should have been entirely removed from the manual
or not.

(From yocto-docs rev: 1cda8aab1336cc81648536e1f7d2777047673a64)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-09 14:17:32 +01:00
Scott Rifenbark
720e6e1bf7 documentation/poky-ref-manual/extendpoky.xml: removed pokylinux.org link
There was a link whose URL was http://autobuilder.pokylinux.org:8010.
I changed the link to use yoctoproject.org.  Note that this URL
was not visible to the reader in the manual.  However, it was there
in the DocBook code.

(From yocto-docs rev: ca1cf9fb404f148fe4f0868630dc4f109231c5c3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-09 14:17:32 +01:00
Scott Rifenbark
a838bca936 documentation/poky-ref-manual/ref-images.xml: [BUGID#_1004] - EXTRA_IMAGE_FEATURE
[BUGID#_1004] - The statement indicating to comment out EXTRA_IMAGE_FEATURE was
incorrectly shown as IMAGE_EXTRA_FEATURE.  I corrected this.

(From yocto-docs rev: e18da2d4e4520a60045f869ca0c63a34c16e3e89)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-05-09 14:17:30 +01:00
Richard Purdie
8d40582b19 Rename poky-image.bbclass to core-image.bbclass
(From yocto-docs rev: c4d0d454e5b484246a9a1b0d29da41a85a8f442c)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:47 +01:00
Richard Purdie
fa8b2c8477 Rename poky-extract-sdk to runqemu-extract-sdk
(From yocto-docs rev: b4189cf91d4bc79fa1d6ab09fd99d1204dad5b01)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-21 13:08:46 +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