Commit Graph

42 Commits

Author SHA1 Message Date
Scott Rifenbark c81c4cb0c7 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: f3ff26568b371807986e4ba77fe41cba6875efcc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-01-30 16:05:59 +00:00
Scott Rifenbark cc004358f1 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 14:01:40 +01:00
Scott Rifenbark a59ca8316b 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 14:01:39 +01:00
Scott Rifenbark 4423b5b024 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 14:01:39 +01:00
Scott Rifenbark 66ddb69916 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 14:01:39 +01:00
Scott Rifenbark de1dcde413 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 14:01:39 +01:00
Scott Rifenbark 9f36b1fe16 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 14:01:38 +01:00
Scott Rifenbark 38c7a8a069 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 14:01:38 +01:00
Scott Rifenbark 23bac7cb0e 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 14:01:38 +01:00
Scott Rifenbark 0021456aad 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 14:01:38 +01:00
Scott Rifenbark a568995f40 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 14:01:38 +01:00
Scott Rifenbark f82ac840aa 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 14:01:38 +01:00
Scott Rifenbark ed93525e65 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 14:01:38 +01:00
Scott Rifenbark 4025831e90 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 14:01:38 +01:00
Scott Rifenbark 588e21b339 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 14:01:37 +01:00
Scott Rifenbark cae817e833 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 17:57:25 +01:00
Scott Rifenbark c32652716d 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:57:24 +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 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 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 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 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
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 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 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 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 e3618e1863 documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR variable
Due to some changes in the file structure for 1.0 there is a new directory
for the shared state.  The variable SSTATE_DIR can be used to point to
the directory.  I added this variable to the list of documented variables.

(From OE-Core rev: fe939d7181856145ea26c193be131883da182fcd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2011-04-06 08:01:22 -07:00
Paul Eggleton 6d5adf1048 documentation/poky-ref-manual: expand discussion of PR and INC_PR
Expands a little on PR and INC_PR.

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
2011-01-20 21:37:00 +00:00
Saul Wold 2c37d41ab1 Add glossary for PACKAGE_DESCRIPTION and PACKAGE_SUMMARY for binary packaging
Signed-off-by: Saul Wold <Saul.Wold@intel.com>
2010-12-16 15:52:50 +00:00
Scott Rifenbark 9f4c630dbd documentation/poky-ref-manual: changes applied from a patch submitted by Cyril Humbert.
Cyril submitted a patch via email form for several spelling corrections.  The master docs, however, are not up-to-date with what I have on my contrib area.  Many of Cyril's corrections were already addressed.  A few were not and I have updated them here with this commit.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:27 -08:00
Scott Rifenbark 8feae13423 Poky Reference Manual: Added INC_PR documentation.
Added an entry in the glossary for INC_PR.  Also updated section
"Package Revision Incrementing" to mention the use of INC_PR in conjuntion
with the PR and PV variables.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-12-10 22:01:05 -08:00
Scott Rifenbark 175be120f3 Poky Reference Manual: Added a glossary definition for BBPATH.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:26 +00:00
Scott Rifenbark b978c8e251 Poky Reference Manual: Added BBFILE_PRIORITY glossary term.
The Extending Poky chapter referenced this non-existent term.  I
added it.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark ab92ec1a87 Poky Reference Manual: Added BBFILE_COLLECTIONS glossary term.
The Extending Poky chapter was referencing a non-existent BBFILE_COLLECTIONS
glossary term.  I added the term.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00:00
Scott Rifenbark 4a671e54cc Poky Reference Manual: Added BBLAYERS to glossary.
Added an entry for BBLAYERS in the ref-variables (glossary) appendix.
The Extending Poky chapter was referencing this variable and it did not
exist.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2010-11-15 22:25:25 +00: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