summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Updated reference sections for environment setup scripts.Scott Rifenbark2014-05-301-0/+70
| | | | | | | | | | | | | | | Fixes [YOCTO #5895] Both section for the environment setup scripts (oe-init-build-env and oe-init-build-env-memres) were updated to provide some usage information on the conf-notes.txt file. This file is where the default list of images appears that the scripts display upon completion. (From yocto-docs rev: 77bd0cd6eeb77036fb7e1584c469f98c2524b750) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the task chapter.Scott Rifenbark2014-05-131-24/+59
| | | | | | | | | Minor edits based on feedback from Paul Eggleton. (From yocto-docs rev: 71bd6b3e0c8f7abcd753240fd8a503b62443ad74) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Bumped the YP revision in the note.Scott Rifenbark2014-05-131-1/+1
| | | | | | | (From yocto-docs rev: 593fdf2ba7c17723a1f0e398706c445ec11eea65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added more detail to the tasks chapter.Scott Rifenbark2014-05-131-33/+98
| | | | | | | | | | I made sure all formatting was correct and also applied some cross-referencing for the reader where appropriate. (From yocto-docs rev: aea5cab493107b2458ecd3bde719115c3f4e02b4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added links to new do_* sections.Scott Rifenbark2014-05-138-90/+177
| | | | | | | | | | | | | | With the creation of the new chapter that documents the 51 tasks defined by the OpenEmbedded build system, the remainder of the ref-manual had many first-instance occurrences of do_* task names that could be cross-referenced to the new sections. I have added these links. (From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new chapter on task documentationScott Rifenbark2014-05-133-0/+503
| | | | | | | | | | | | | | Changes to support a new chapter on the 51 tasks that the OpenEmbedded build system defines. The changes include a new file called ref-tasks.xml, changes to the ref-manual.xml building file to include the new chapter, and a new bullet item to the list that describes what is in the reference manual. (From yocto-docs rev: a816746051ec025014e515fb848b3e0e58d4c7be) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables for 1.7Scott Rifenbark2014-05-131-0/+5
| | | | | | | (From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Globally replace 'base_contains' calls with 'bb.utils.contains'Otavio Salvador2014-04-251-1/+1
| | | | | | | | | | | The base_contains is kept as a compatibility method and we ought to not use it in OE-Core so we can remove it from base metadata in future. (From yocto-docs rev: b8e7dee82929213e7581d6c598f42da74ee03988) Signed-off-by: Otavio Salvador <otavio@ossystems.com.br> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new section to the 1.6 migration section plus some 1.5 edits.Scott Rifenbark2014-04-231-3/+28
| | | | | | | | | | | Added a new section on "Matching Branch Requirement for Git Fetching" into the BitBake section. Plus, made some minor corrections to some of the 1.5 sections. (From yocto-docs rev: 326a8009ca0bef0a4686510bb521010d8f58ac81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Pulled the item for forked packages out.Scott Rifenbark2014-04-221-5/+0
| | | | | | | | | | | | | Fixes [YOCTO #4958] I pulled the change I put in to warn users about forked packages based on further review from Paul Eggleton. This pretty much means the bug is back to square one. (From yocto-docs rev: fec630e4d1c464865d85e824ec684ef3cee55b42) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added package change info to the migration section.Scott Rifenbark2014-04-211-0/+9
| | | | | | | | | | | The package architecture for armv7a packages with the thumb optimization enabled will now get a "t2" suffix as it should; this was not the case in the 1.5 release. Architecture names will change within package feeds as a result. (From yocto-docs rev: 1ce59f6911dd67835266aa3b0e29f404a487fd6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the list of supported distributions.Scott Rifenbark2014-04-211-4/+8
| | | | | | | | | I get this list from meta-yocto/conf/distro/poky.conf. (From yocto-docs rev: 796d4eced50d14203f1a791ff557a4016f4dd031) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated all the manual revision history tables.Scott Rifenbark2014-04-211-1/+1
| | | | | | | | | Set the release date to April 2014. (From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added review comments to core-image-testmaster image.Scott Rifenbark2014-04-191-3/+7
| | | | | | | (From yocto-docs rev: 064a49648b2333dede612642a9a6621470b603ed) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added core-image-testmaster to the list of images.Scott Rifenbark2014-04-191-0/+5
| | | | | | | | | Fixes [YOCTO #5614] (From yocto-docs rev: 5df086664b858423d6e7054b451942feb73047e9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typoScott Rifenbark2014-04-191-1/+1
| | | | | | | (From yocto-docs rev: 28577b94d14be63df7ac00a89b774992055c94fe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Re-ordered the insane.bbclass tests list.Scott Rifenbark2014-04-191-152/+150
| | | | | | | | | I ordered these 39 tests by alphebetical ordering. (From yocto-docs rev: 3a7ef1c149ee1f8f0ac4709e906f5c84ed7ab642) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added symlink-to-sysroot insane.bbclass tests.Scott Rifenbark2014-04-191-0/+7
| | | | | | | (From yocto-docs rev: 6152a64ffaab638cffc952be70707d5e9aedbf88) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Removed VIRTUAL-RUNTIME note from most places.Scott Rifenbark2014-04-192-32/+0
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #5159] Edits to fix the occurrences of VIRTUAL-RUNTIME_initscripts = "". I removed it from all places in the manuals except under "Selecting an Initialization Manager". Note that it still needed removed from "Using Systemd for the Main Image and Using SysVinit for the Rescue Image". Also, in the "Using Systemd Exclusively" section I made some edits as suggested by Paul Eggleton's review. (From yocto-docs rev: 28b2e3eba3acff17f165899a7f4a65c98263e201) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Edits to running tests on hardwareScott Rifenbark2014-04-131-14/+13
| | | | | | | | | | | | | | Fixes [YOCTO #5554] Applied edits to the section in the dev-manual on running tests on hardware. Edited the TEST_TARGET and TEST_IMAGE variables. (From yocto-docs rev: a26ba11c739aabab4009a944d9b622e2814c7fca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to DISK_SIGNATURE variable.Scott Rifenbark2014-04-111-6/+3
| | | | | | | | | | | | | Fixes [YOCTO 5766] I removed the note about the "live" IMAGE_TYPES. Turns out I was wrong on this information. It does not create a "directdisk" image. That is accomplished through a .bbclass. (From yocto-docs rev: a3b762be9933178e9cecdac3fa9e110c031a64d0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added warning about forking packages when upgrading YPScott Rifenbark2014-04-111-0/+5
| | | | | | | | | | | | | Fixes [YOCTO #4958] Added a bullet item to the packages section in the migration chapter for upgrading to YP v1.6. Item notes the issue and warns the user to beware. (From yocto-docs rev: f66ca39a65c2529ebc552d3a816e6565dae183f7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the DISK_SIGNATURE description.Scott Rifenbark2014-04-111-8/+27
| | | | | | | | | | | Fixes [YOCTO #6125] Did some re-writing based on Jonathin Liu's feedback. (From yocto-docs rev: bee4a584bcb1e70e9848324781c32d1d9e3d1fc2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed note limiting tests to QEMU.Scott Rifenbark2014-04-111-5/+1
| | | | | | | | | | | Fixes [YOCTO #5554] Removed the note limiting this to QEMU tests. (From yocto-docs rev: c91d058514832aacfb74fd4480e0a2dba95b4921) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the module_autoload and module_conf variables.Scott Rifenbark2014-04-111-6/+6
| | | | | | | | | Minor re-wording edits as suggested by Paul Eggleton. (From yocto-docs rev: 699eec0b691a19b4ae2f05c7774f559898e952da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to deal with installing packages in initramfsScott Rifenbark2014-04-112-28/+58
| | | | | | | | | | | | | | | | Fixes [YOCTO #4961] Documented the user requirement to use PACKAGE_INSTALL to specify packages for installation into an initramfs image. Normally, you use IMAGE_INSTALL. To account for this user model, I updated the PACKAGE_INSTALL and IMAGE_INSTALL variables. I also added a bit more information to the "Images" chapter item that talks about the core-image-minimal-initramfs image. (From yocto-docs rev: a1ad649cf310f281a7de584d5b9a1820ca99d4eb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to module_autoload and module_conf variables.Scott Rifenbark2014-04-111-8/+10
| | | | | | | | | | | | Fixes [YOCTO #5888] Applied some feedback to the variables based on Paul's comments. Needed a caveat on how you can use these variables. (From yocto-docs rev: ef8fac4b36089d3162ee16c93866a39bcd31701c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: added module_autoload and module_conf variables.Scott Rifenbark2014-04-111-0/+93
| | | | | | | | | | | | | Fixes [YOCTO #5888] Two new variables added to the glossary. These help with specifying kernel modules that need to auto-load on boot and with specifying module.d syntax in the modname.conf file. (From yocto-docs rev: 1ac544c4f6129faafea10691b426cd510ff56a69) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated KBRANCH to fix a reference to the linux kernel.Scott Rifenbark2014-04-111-1/+1
| | | | | | | (From yocto-docs rev: 59aab89f2c1ff5e0ab43fe9ba25f929500b94d5f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated KBRANCH variable description.Scott Rifenbark2014-04-111-25/+35
| | | | | | | | | | I replaced the v3.4 version example with the v3.10 version. It is more up-to-date. (From yocto-docs rev: 2e7f5d4fbe24a8248686c9ca7cf870204966beec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Extended the D variable description.Dennis Meier2014-04-111-5/+4
| | | | | | | | | | | Applied this patch from Dennis and then removed some whitespace, used the 5-space indentation convention for the literal, formatted the task name and did some other minor fixes. (From yocto-docs rev: 477a9ecb2f91681ee401478189a424793381bfcb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Extended description of the ${D} variable to better explain its purpose.Dennis Meier2014-04-111-1/+10
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_EXPORT_DIR to glossary.Scott Rifenbark2014-04-111-0/+16
| | | | | | | | | | | Fixes [YOCTO #5554] New variable description. (From yocto-docs rev: 9c245950faba53abc79f01d174e0f88e87d85430) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_EXPORT_ONLY to glossary.Scott Rifenbark2014-04-111-0/+11
| | | | | | | | | | | Fixes [YOCTO #5554] New variable description. (From yocto-docs rev: 6be2edb9ff994c7e952c6b1c9fca7357549afd90) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_LOG_DIR to glossary.Scott Rifenbark2014-04-111-0/+15
| | | | | | | | | | | Fixes [YOCTO #5554] New variable description. (From yocto-docs rev: f6ae7dc4fd29af0befd35ba15390eeec8d905487) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_SERVER_IP to the variable glossary.Scott Rifenbark2014-04-111-0/+18
| | | | | | | | | | | Fixes [YOCTO #5554] New variable description. (From yocto-docs rev: e12134c93661a827787ec878a94d3d2c8a280f83) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_TARGET_IP to the variable glossary.Scott Rifenbark2014-04-111-0/+26
| | | | | | | | | | | Fixes [YOCTO #5554] New variable description. (From yocto-docs rev: 8c673542769a1a1aaef58100be15fc735a19adbe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added TEST_TARGET variable description.Scott Rifenbark2014-04-111-0/+65
| | | | | | | | | | | Fixes [YOCTO #5554] New description. (From yocto-docs rev: b81e056f8ef1a7ba0868857be71d46250382ffa3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added DISK_SIGNATURE variable description to glossary.Scott Rifenbark2014-04-111-0/+34
| | | | | | | | | Fixes [YOCTO #6125] (From yocto-docs rev: 5ee5433cc7799a240dd18aa20ce44b3ae978b592) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to fix up how GID and UIDs are handled.Scott Rifenbark2014-04-082-39/+42
| | | | | | | | | | Some review edits to change the useradd-staticids class and the related USERADD* variables. Input from Paul Eggleton. (From yocto-docs rev: 9b94046721a971de41d2062a48d624e06dcf17f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added useradd-staticids class and edits to some variables.Scott Rifenbark2014-04-082-5/+71
| | | | | | | | | | | | | | | | | | | Added the new useradd-staticids class to the reference section for classes. Updated the USERADD_UID_TABLES and USERADD_GID_TABLES variables to tell how the system uses BBPATH in the default mode to get UID and GID information from the files/passwd and files/group files. Added a note indicating that you can delete the TMPDIR directory to fix things up if you configure useradd-staticids in a configured system. (From yocto-docs rev: a3f5ee3f5060369405d59a238fb02bddfeae5d6f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Beagleboard replaced with BeagleboneScott Rifenbark2014-04-081-2/+2
| | | | | | | | | | | | Fixes [YOCTO #2444] Several areas affected by the reference BSP "beagleboard" being replaced by "beaglebone". (From yocto-docs rev: 2f02b570e1ebcf0469871b67a029b65fa8b285f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variables to support static uid and gid values.Scott Rifenbark2014-04-081-0/+135
| | | | | | | | | | | | | | Added variable descriptions for the following variables: * USERADDEXTENTIONS * USERADD_UID_TABLES * USERADD_GID_TABLES * USERADD_ERROR_DYNAMIC. (From yocto-docs rev: 988c21db5ca2bc5a6884acc2320e0143e3a7cf14) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the image-live class description.Scott Rifenbark2014-04-081-0/+8
| | | | | | | | | | | | | Fixes [YOCTO #605] I added an example showing what the user would need to do in order to build an ISO file. This seemed to be the best existing place in the YP docs to get this information in. (From yocto-docs rev: a715c28e533f723e0c2d4ab4d33b86b93fa2d66b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the bootimg class description.Scott Rifenbark2014-04-081-2/+2
| | | | | | | | | Found some poor writing in this description. (From yocto-docs rev: f54810d68a5efb25c102cd99a7e2b9cfcf7ad7de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new migration section on BB console output.Scott Rifenbark2014-04-081-0/+15
| | | | | | | (From yocto-docs rev: cb4802ac533fe5344bd67494355b43b9b1f6f51d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Typo fix to CFLAGS 1.6 migration section.Scott Rifenbark2014-04-081-1/+1
| | | | | | | (From yocto-docs rev: 185f68d23202a19cf4e7bec8bb369b8c88043020) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the 1.6 migration section.Scott Rifenbark2014-04-081-38/+74
| | | | | | | | | | Applied review comments from Paul Eggleton to the section on migrating to the 1.6 version of YP. (From yocto-docs rev: ffd224a16cef4d643cc2c527ad8dc5e15d715faa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed archive* class and replaced with archiver class.Scott Rifenbark2014-04-081-9/+2
| | | | | | | | | | The set of archive* classes has been removed leaving only the archiver.bbclass. (From yocto-docs rev: 1660896b47ff5d21ae73d383505063f1c7c1a3b1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the copyleft_compliance class.Scott Rifenbark2014-04-081-9/+10
| | | | | | | | | | I updated the referencing to adjust to the emergence of the archiver.bbclass and disappearance of the archive* classes. (From yocto-docs rev: 903e9b7c534e65e1be3eb0dc57378e120c7a0e3e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>