summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* YOCTO #1088: documentation - Added text to partially address package bugScott Rifenbark2011-09-022-5/+59
| | | | | | | | | | | | | | | | | | | 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/poky-ref-manual/usingpoky.xml: Edits per Darren HartScott Rifenbark2011-09-021-10/+10
| | | | | | | | | | 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>
* documentation/poky-ref-manual: Removed "spitz" machine example.Scott Rifenbark2011-08-302-5/+6
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-features.xml: typos fixed.Scott Rifenbark2011-08-301-2/+2
| | | | | | | (From yocto-docs rev: b2c9750abec8429d665996231ddd16359e168c47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/usingpoky.xml: Updated logging mechanismScott Rifenbark2011-08-301-21/+23
| | | | | | | | | | 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>
* YOCTO #910 - documentation/poky-ref-manual/extendpoky.xml: point to dev manual.Scott Rifenbark2011-08-301-0/+9
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/resources.xml: re-write for today's world.Scott Rifenbark2011-08-301-116/+88
| | | | | | | | | | 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>
* documentation/poky-ref-manual/faq.xml: Scrubbed for term Poky.Scott Rifenbark2011-08-301-111/+143
| | | | | | | | | | | | | | 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>
* documentation/poky-ref-manual/extendpoky.xml: Changed targe link title.Scott Rifenbark2011-08-301-1/+1
| | | | | | | (From yocto-docs rev: c8d5570ba9f6180bba3c2b618d0b401c0fdb86ce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docuementation/poky-ref-manual/ref-structure.xml: Changed SRCDATE referenceScott Rifenbark2011-08-241-1/+1
| | | | | | | | | | 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>
* documentation/poky-ref-manual/faq.xml: Edits to scrub for PokyScott Rifenbark2011-08-241-2/+2
| | | | | | | (From yocto-docs rev: 089575ceb618199fbeccad1a4e7b7bd19eb5ad7f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/faq.xml: Edits to scrub for PokyScott Rifenbark2011-08-241-48/+33
| | | | | 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-246-38/+50
| | | | | | | | | | | | | | 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: clarify specifying a specific package with -ePaul Eggleton2011-08-241-1/+2
| | | | | | | | | | | 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>
* 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: set titles for all documentsPaul Eggleton2011-08-241-1/+1
| | | | | | | | | | 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>
* 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 for directdisk/live image changesPaul Eggleton2011-08-241-24/+8
| | | | | | | | | | -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>
* documentation: update TERMCMD/TERMCMDRUN documentationPaul Eggleton2011-08-242-3/+11
| | | | | | | | | | * 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: ensure all examples have LIC_FILES_CHKSUMPaul Eggleton2011-08-245-0/+9
| | | | | | | | | | 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>
* documentation: improve LIC_FILES_CHKSUM documentationPaul Eggleton2011-08-242-24/+28
| | | | | | | | | | 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-242-2/+2
| | | | | | | | | | 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-249-23/+23
| | | | | | | (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: manpage -> help outputPaul Eggleton2011-08-241-1/+1
| | | | | | | | | 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>
* documentation: correct QT to QtPaul Eggleton2011-08-241-1/+1
| | | | | | | (From yocto-docs rev: 37ac4cbd61bc8c891aa6dc05baf632a0a4bfd906) 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-varlocality.xml: ReformattedScott Rifenbark2011-08-231-191/+185
| | | | | | | | | | | 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>
* documentation/poky-ref-manual/introduction.xml: Title changed.Scott Rifenbark2011-08-231-2/+1
| | | | | | | (From yocto-docs rev: 244c632812f10a3dc79eb814caf1449c50655e36) 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-features.xml: Cleaned up list formatting.Scott Rifenbark2011-08-231-263/+122
| | | | | | | (From yocto-docs rev: 1813848d673dedae6b918676eec1f3926ee630f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-images.xml: Reformats of the Docbook code.Scott Rifenbark2011-08-231-162/+80
| | | | | | | (From yocto-docs rev: 8b334782415a428724023af0e6ee8a0ee5aa79f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/ref-classes.xml: Scrubbed for PokyScott Rifenbark2011-08-231-185/+191
| | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-bitbake.xml: scrubbed for PokyScott Rifenbark2011-08-231-73/+97
| | | | | | | | | | | 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>
* documentation/poky-ref-manual/ref-structure.xml: Scrubbed for Poky and editsScott Rifenbark2011-08-231-184/+168
| | | | | | | | | | 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>
* documentation/poky-ref-manual: Removed figures from file structure.Scott Rifenbark2011-08-233-117/+0
| | | | | | | | | | | 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>
* documentation/poky-ref-manual/figures/ss-sato.png: deleted figure.Scott Rifenbark2011-08-231-0/+0
| | | | | | | (From yocto-docs rev: 29a5c1da4695fc8a5979c3d095f87879c0b267ce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/extendpoky.xml: scrubbed for PokyScott Rifenbark2011-08-231-520/+642
| | | | | | | | | 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>
* documentation/poky-ref-manual/development.xml: Garman's partial review commentsScott Rifenbark2011-08-231-11/+12
| | | | | | | (From yocto-docs rev: 329401ac13e60381ca74a617ae398586cbd5dfed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/development.xml: updates for YP termsScott Rifenbark2011-08-231-216/+186
| | | | | | | | | | 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>
* documentation/poky-ref-manual/usingpoky.xml: small edits to list and titleScott Rifenbark2011-08-231-6/+8
| | | | | | | | | | 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>
* documentation/poky-ref-manual/introduction.xml: re-write for YPScott Rifenbark2011-08-231-139/+107
| | | | | | | | | | 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>
* documentation/poky-ref-manual/resources.xml: Changed titleScott Rifenbark2011-08-231-1/+1
| | | | | | | | | 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>
* documentation/poky-ref-manual: Changed top-level titlesScott Rifenbark2011-08-233-3/+3
| | | | | | | | | | 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>
* documentation/poky-ref-manual/usingpoky.xml: re-write for YoctoScott Rifenbark2011-08-231-104/+143
| | | | | | | | | | 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>
* documentation/poky-ref-manual/usingpoky.xml: YOCTO #1001 - new section addedScott Rifenbark2011-08-231-3/+95
| | | | | | | | | | 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>
* documentation/poky-ref-manual/development.xml: re-write of software dev sectionScott Rifenbark2011-08-231-473/+185
| | | | | | | | | | | | 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>
* documentation/poky-ref-manual/development.xml: Updated software dev introScott Rifenbark2011-08-231-3/+6
| | | | | | | | | | | 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>
* documentation/poky-ref-manual/figures/poky-title.png: Changed TitleScott Rifenbark2011-08-231-0/+0
| | | | | | | | | | 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>