summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-variables.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation/poky-ref-manual/ref-variables.xml: image size glossaryScott Rifenbark2012-01-061-0/+81
| | | | | | | | | | | | | | | | 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>
* documenation/poky-ref-manual/ref-variables.xml: added LICENSE_DIRScott Rifenbark2011-12-161-6/+19
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: EXTRA_IMAGEDEPENDS added.Scott Rifenbark2011-11-251-0/+19
| | | | | | | | | | 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>
* documentation: BB_NUMBER_THREADS and PARALLEL_MAKE suggestionsScott Rifenbark2011-11-251-1/+1
| | | | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: updated KERNEL_FEATURESScott Rifenbark2011-10-041-2/+4
| | | | | | | (From yocto-docs rev: 37a9cea71139ceda1d2a7da639f5555414ef497b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-variables.xml: updates to KERNEL_FEATURES.Scott Rifenbark2011-10-041-1/+7
| | | | | | | (From yocto-docs rev: ec1e2d71c576fe1c12031371de89a71770cebb1d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-variables.xml: Added KERNEL_FEATURESScott Rifenbark2011-10-041-1/+21
| | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: Variables updatedScott Rifenbark2011-10-041-84/+91
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Updates to several variables.Scott Rifenbark2011-10-041-8/+121
| | | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: update RDEPENDS and RRECOMMENDSScott Rifenbark2011-10-041-12/+56
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: update PREFERRED_VERSIONScott Rifenbark2011-10-041-2/+12
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: update PREFERRED_PROVIDERScott Rifenbark2011-10-041-3/+11
| | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: update TCLIBC and POKYLIBCScott Rifenbark2011-10-041-5/+23
| | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: updates TCMODE and POKYMODEScott Rifenbark2011-10-041-11/+19
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: edits to ↵Scott Rifenbark2011-10-041-10/+14
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: updated RDEPENDSScott Rifenbark2011-10-041-2/+20
| | | | | | | | | | | 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>
* documentation: scrubbed out 'glibc' and replaced with 'eglibc'Scott Rifenbark2011-10-041-5/+7
| | | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: added FILESYSTEM_PERMS_TABLESScott Rifenbark2011-10-041-0/+27
| | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: added BAD_RECOMMENDATIONSScott Rifenbark2011-09-251-1/+9
| | | | | | | | | | | 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>
* documenation/poky-ref-manual/ref-variables.xml: debug-tweaks qualifiedScott Rifenbark2011-09-251-28/+30
| | | | | | | | | | 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>
* YOCTO #1088: documentation - Added text to partially address package bugScott Rifenbark2011-09-021-1/+13
| | | | | | | | | | | | | | | | | | | 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>
* documentation: Changes to Paul Eggleton's edits for various manuals.Scott Rifenbark2011-08-241-23/+30
| | | | | | | | | | | | | | 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>
* documentation: update documentation for SRCREV variablePaul Eggleton2011-08-241-1/+5
| | | | | | | | | | | * 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>
* documentation: update BBFILE_* variable documentationPaul Eggleton2011-08-241-9/+43
| | | | | | | | | | | * 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>
* documentation: update TERMCMD/TERMCMDRUN documentationPaul Eggleton2011-08-241-2/+10
| | | | | | | | | | * 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>
* documentation: improve LIC_FILES_CHKSUM documentationPaul Eggleton2011-08-241-5/+5
| | | | | | | | | | 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>
* documentation: SITEINFO_ENDIANESS -> SITEINFO_ENDIANNESSPaul Eggleton2011-08-241-1/+1
| | | | | | | | | | 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>
* documentation: typo, spelling & minor grammar fixesPaul Eggleton2011-08-241-5/+5
| | | | | | | (From yocto-docs rev: a5b069b04979a566b08415cf27af2ad6abf90f2f) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-variables.xml: Fixed linksScott Rifenbark2011-08-231-15/+15
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: Fixed default formatScott Rifenbark2011-08-231-8/+8
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: Scrubbed for PokyScott Rifenbark2011-08-231-271/+337
| | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: partial edits.Scott Rifenbark2011-08-231-8/+8
| | | | | | | (From yocto-docs rev: e8300735591f0b47aff64200a2dff477b5bfd9b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-variables.xml: YOCTO #1104 ↵Scott Rifenbark2011-06-241-1/+5
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml - YOCTO #1104 ↵Scott Rifenbark2011-06-241-0/+43
| | | | | | | | | | | | 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>
* BUGID#_807: documentation/poky-ref-manual/ref-variables.xml: BBFILE_PRIORITY ↵Scott Rifenbark2011-05-101-3/+16
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-variables.xml: added SSTATE_DIR variableScott Rifenbark2011-04-061-0/+6
| | | | | | | | | | | 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>
* documentation/poky-ref-manual: expand discussion of PR and INC_PRPaul Eggleton2011-01-201-2/+6
| | | | | | Expands a little on PR and INC_PR. Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
* Add glossary for PACKAGE_DESCRIPTION and PACKAGE_SUMMARY for binary packagingSaul Wold2010-12-161-0/+13
| | | | Signed-off-by: Saul Wold <Saul.Wold@intel.com>
* documentation/poky-ref-manual: changes applied from a patch submitted by ↵Scott Rifenbark2010-12-101-4/+4
| | | | | | | | 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>
* Poky Reference Manual: Added INC_PR documentation.Scott Rifenbark2010-12-101-0/+20
| | | | | | | | 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>
* Poky Reference Manual: Added a glossary definition for BBPATH.Scott Rifenbark2010-11-151-1/+6
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added BBFILE_PRIORITY glossary term.Scott Rifenbark2010-11-151-0/+16
| | | | | | | The Extending Poky chapter referenced this non-existent term. I added it. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Added BBFILE_COLLECTIONS glossary term.Scott Rifenbark2010-11-151-0/+7
| | | | | | | 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>
* Poky Reference Manual: Added BBLAYERS to glossary.Scott Rifenbark2010-11-151-0/+6
| | | | | | | | 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>
* handbook: Move into documentation directoryRichard Purdie2010-10-151-0/+879
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-06-09 22:48:07 +0000