Commit Graph

28 Commits

Author SHA1 Message Date
Scott Rifenbark a73fde8caf documentation: poky-ref-manual - Final changes before the 1.3 lockdown.
various changes as required.

(From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-23 00:03:14 +01:00
Paul Eggleton 971a94369f documentation/poky-ref-manual/ref-classes.xml: update undocumented classes
(From yocto-docs rev: 607fd73aa2e5bcc042839e2a0f840463f2fd1c2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:48 +01:00
Paul Eggleton fe2ad765d2 documentation/poky-ref-manual/ref-classes.xml: Add packagegroup.bbclass
Add a short section about packagegroup.bbclass.

In addition to Paul's patch, I changed the title of the cross-reference
to be the actual title used in the YP Development Manual.

(From yocto-docs rev: bfd4db7e0ef61a2dd7159cdc841dcffc2d9c53d4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-14 09:50:48 +01:00
Scott Rifenbark 695420417f documentation/poky-ref-manual: Converted ref-classes to chapter
As part of moving the reference manual to a real reference manual I
am removing the "appendix" classification and having everthing be
a chapter.  I changed the "ref-classes" appendix to a chapter and
made sure any references in the doc set use the proper term now
(chapter).

(From yocto-docs rev: 54991c7fb0a2d3a894249f8a253b1a974cf2e571)

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

(From yocto-docs rev: f8d113654b33ed5f6f1ba8e2d2e755b78033ddbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17 10:54:10 +01:00
Scott Rifenbark 5966b44893 documentation/poky-ref-manual: Yocto Project scrub
I have changed as many "Yocto Project" terms as possible so that
better reflect reality.

(From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-03 14:55:03 +01:00
Scott Rifenbark 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 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 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 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 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
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 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 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 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 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 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 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
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 72d7e27351 documentation/poky-ref-manual/ref-classes.xml: tag updates
Removed the various styles for commands and such and replaced with
simple <filename>/</filename> pairs.

(From OE-Core rev: c5a0cc3e6a2f1e7eb1a90c67d2a038d3dc18b1ba)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:21 -07:00
Scott Rifenbark bed5b96b0e documentation/poky-ref-manual/ref-classes.xml: re-write of autotooled packages
Section C.2 (Autotooled Packages) was re-written.  I removed a bunch
of <variable> tags and replaced them with <filename>.  Also removed
some Britishisms.

(From OE-Core rev: 7a932962fb8f0dbfe14eb2d3636ddbb1c974b947)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:20 -07:00
Scott Rifenbark efaf5d0973 documentation/poky-ref-manual/ref-classes.xml: Fix to <filename> tag
Had to fix the <variable> tag by replacing it with <filename>.
Previous commit didn't work so this is fixing it.

(From OE-Core rev: 263e572055b09ad2f432f1feda797813ef254e74)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:20 -07:00
Scott Rifenbark 5bbffff68b document/poky-ref-manual/ref-classes.xml: removed <function> tag
I got rid of the <function> tag and replaced with <filename>.  We
have too many styles.

(From OE-Core rev: 5ac97ba191c8707ff20105626427998df997d221)

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

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