summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Removed redundant "and"Scott Rifenbark2016-08-011-1/+1
| | | | | | | (From yocto-docs rev: 60a1b98e22d4118e090c0dd214736b78884da227) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed stray parenthesis.Scott Rifenbark2016-08-011-1/+1
| | | | | | | | | Fixes [YOCTO #9988] (From yocto-docs rev: 314f3c10e420a9681b4a814ddc4f24bbddd3741a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the STAGING_DIR_HOST variable.Scott Rifenbark2016-08-011-1/+1
| | | | | | | | | | | | Fixes [YOCTO #9988] Added a link to the MULTIMACH_HOST_SYS variable from the STAGING_DIR_HOST variable where it is referenced. (From yocto-docs rev: 0f72b58a7bc1271245d139726f1145d5d99acee4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated STAGING_DIR_TARGET and MULTIMACH* variables.Scott Rifenbark2016-08-011-11/+58
| | | | | | | | | | | | | | | | | Fixes [YOCTO #9988] Updated the STAGING_DIR_TARGET variable with a better introductory sentence. Updated the MULTIMACH_TARGET_SYS variable with a more expanded explanation. Added a new glossary entry for the MULTIMACH_HOST_SYS variable. (From yocto-docs rev: d17873d695772b62325de35dd0e5b9ccc7f12f1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a link to D variable and moved a task:Scott Rifenbark2016-08-012-31/+31
| | | | | | | | | | | | | | | | Fixes [YOCTO #9989] Added a link to the WORKDIR term in the D glossary description example. Also, moved the do_checkpkg task from the section of showing normal recipe build tasks to the the section for manually called tasks. (From yocto-docs rev: 548e2fdfeae9d67bbad73ee3ab69a64a9a6ce9ff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Augmented some STAGING_DIR_* variable descriptions:Scott Rifenbark2016-08-011-14/+25
| | | | | | | | | | | | | * Updated the STAGING_DIR_HOST description * Updated the STAGING_DIR_NATIVE description * Updated the STAGING_DIR_TARGET description Fixes [YOCTO #9988] (From yocto-docs rev: cc2c3d849f0919199d1b7960e30ed152f3f0474e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Revert "ref-manual: Added new glossary entry for REMOVE_PKG_SUPPORT."Scott Rifenbark2016-08-011-24/+0
| | | | | | | | | This reverts commit 95b740d719a7a6ffe3a06a1f152af4d877ee08c7. I inadvertantly put this variable description in before they had settled on it. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added 3 new QA sanity checks.Scott Rifenbark2016-08-012-1/+32
| | | | | | | | | | | | Fixes [YOCTO #9983] Added the host-user-contaminated, invalid-chars, and invalid-packageconfig QA checks. (From yocto-docs rev: 5bd28f9386a8afff435254788fbce73a7fc48305) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits to "Checking for Missing Build-Time ↵Scott Rifenbark2016-08-011-9/+12
| | | | | | | | | | | | | Dependencies" Removed an errant comma and rewrote the final area of the section. Fixes [YOCTO #9976] (From yocto-docs rev: 19924dee2ebec3ff2a53152ecb8f79172eb43060) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review changes to the do_deploy task.Scott Rifenbark2016-08-011-12/+19
| | | | | | | | | | | | Cleared up the last third of the description with better structure and wording. Fixes [YOCTO #9970] (From yocto-docs rev: a2dbea4f3bbdddd72c86a5ade86ac822cd9bfecd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new "Checking for Missing Build-Time Dependencies" section.Scott Rifenbark2016-08-011-0/+71
| | | | | | | | | | | | | I added a new suggest section to the existing "Debugging Build Failures" section. This section describes how to check for build-time dependencies. Fixes [YOCTO #9976] (From yocto-docs rev: 54cd7161593ba35b63a26ade312cc4aee17e3515) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added link to the do_populate_sysroot taskScott Rifenbark2016-08-011-2/+2
| | | | | | | | | | | Fixes [YOCTO #9968] Made a link for the STAGING_DIR_HOST variable for consistency. (From yocto-docs rev: eeb163ead40752d69f2f6c19e859e82109ef967d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied formatting to QA check string in do_install taskScott Rifenbark2016-08-011-2/+3
| | | | | | | | | Fixes [YOCTO #9966] (From yocto-docs rev: ae87d07c8d429813d30569360eb4889eac398bee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed output example in the B variable.Scott Rifenbark2016-08-011-1/+1
| | | | | | | | | Updated the example statement line to match the actual assignment. (From yocto-docs rev: 45e9274fcca0a285bda38cad8a6fe5e7bb05bd80) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_deploy task reference section.Scott Rifenbark2016-08-011-9/+46
| | | | | | | | | | | Fixes [YOCTO #9970] Added more detail to the do_deploy task. (From yocto-docs rev: 1b2daf814011dbc3c5987313442e95e18e83e180) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added detail to the populate_sysroot task.Scott Rifenbark2016-08-011-1/+3
| | | | | | | | | | | Provided more detail in the first sentence. Fixes [YOCTO #9968] (From yocto-docs rev: 15080a565bafdfffe0c13a0a18fd1c011773cc25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_packages task.Scott Rifenbark2016-08-011-2/+9
| | | | | | | | | | | Fixes [YOCTO #9967] Added more detail to this task description. (From yocto-docs rev: 8cb154493a6b4ee541826f898b823a4dc2795f88) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_install reference section.Scott Rifenbark2016-08-011-5/+42
| | | | | | | | | | | Fixes [YOCTO #9966] Added quite a bit of detail to this task's description. (From yocto-docs rev: c29d86813b9cb9bc1c9c02aeffb5cfd99fc5a542) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_configure task.Scott Rifenbark2016-08-011-0/+14
| | | | | | | | | | | Added more detail for this task. Fixes [YOCTO #9965] (From yocto-docs rev: e50207488b8262bb46e58c4b9f40e487c15abc67) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fleshed out the do_compile task.Scott Rifenbark2016-08-013-6/+25
| | | | | | | | | | | | | | Fixes [YOCTO #9964] Added more detailed information to the do_compile task. Also, provided some information about oe_runmake in the base.bbclass refrence. Finally, put some detail in the "Shared State" section concerning do_deploy[dirs]. (From yocto-docs rev: 5d0612a57cc8e035a2194ada21e65055ef2b8a2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated RDEPENDS variable description with note.Scott Rifenbark2016-08-011-0/+12
| | | | | | | | | | | | Fixes [YOCTO #9963] I created a new cautionary note to warn the user to use the correct operator "+=" rather than "=" so that they do not destroy $PN. (From yocto-docs rev: e6861ffe9400b1ee48cc46ccfc6e8d65efbbec8c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review comments to logging mechanism sectionScott Rifenbark2016-08-011-8/+8
| | | | | | | | | | | | Fixes [YOCTO #9950] I Provided a suggested introductory sentence and a better link to the logging.class file, which is near the end. (From yocto-docs rev: 6f296266b35f17792510d6a01f5640ba30818a22) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the "Recipe Logging Mechanisms" sectionScott Rifenbark2016-07-191-13/+53
| | | | | | | | | | | Fixes [YOCTO #9950] Added more detail on the functions for logging. (From yocto-docs rev: b7ed4d84ae5221765201fe661af3741fb01da738) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review changes to the DEPENDS variable.Scott Rifenbark2016-07-191-11/+17
| | | | | | | | | | | Updated the note with some formatting and grammar changes. Fixes [YOCTO #9933] (From yocto-docs rev: afef28ae894c313f85ddbaeef8b0abbc2700ba2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added review changes to BBCLASSEXTEND descriptionScott Rifenbark2016-07-191-7/+9
| | | | | | | | | | | | | Fixes [YOCTO #9909] Added some technical clarifications to the existing note to be clear about what is causing the limitations in this case. Applied some formatting fixed to for the use of the include word. (From yocto-docs rev: cbbd960d8665d9fb6b92698c14728d1c0bcc659f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added notes to the DEPENDS variable description.Scott Rifenbark2016-07-191-0/+33
| | | | | | | | | | | | Fixes [YOCTO #9933] Added two notes to help clarify how DEPENDS works with pre-compiled objects. There are some details that trip people up. (From yocto-docs rev: 06917e97adf24816b0aee6fdfdd14aa79d4c6ab2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added clarifying note to the BBCLASSEXTEND variable.Scott Rifenbark2016-07-191-0/+21
| | | | | | | | | | | | Fixes [YOCTO #9909] Added a note that talks about how the BBCLASSEXTEND mechanism adds recipe variants. (From yocto-docs rev: a05990ecb760519a685a1c5ddcf2ce3e048bfbf2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-referencing to tasks and dependenciesScott Rifenbark2016-07-192-0/+14
| | | | | | | | | | | | | | | | Fixes [YOCTO #9861] Placed some section links into the "Tasks" and the "Dependencies" sections of the BB manual from several areas: * The "Normal Recipe Build Tasks" section * The variable description for DEPENDS * The variable description for RDEPENDS (From yocto-docs rev: d96347fdb4c3d5a34695f20e995f165c5ba91c32) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new glossary entry for REMOVE_PKG_SUPPORT.Scott Rifenbark2016-07-191-0/+24
| | | | | | | | | | | Fixes [YOCTO #9899] New variable description added. (From yocto-docs rev: 95b740d719a7a6ffe3a06a1f152af4d877ee08c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a new section on setscene task variantsScott Rifenbark2016-07-191-0/+125
| | | | | | | | | | | | | Fixes [YOCTO #9251] I added a new section on the task variants for setscene, which uses the shared state cache. The section describes the BitBake processing that helps the build system to not have to build everything from scratch. (From yocto-docs rev: 6aa0e6b837de14dd7d6c5ef34328bbf268dd6d71) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typo in the "Shared State" section.Scott Rifenbark2016-07-191-1/+1
| | | | | | | | | | | | Fixes [YOCTO #9823] The do_deploy[sstate-inputdirs] string was wrongly do_deploy[sstate-inputsdirs]. (From yocto-docs rev: 49e7cb239f4f4f70dc5738686f1bca135772bcbe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review edits to the PR variable in glossary.Scott Rifenbark2016-07-191-4/+6
| | | | | | | | | | | Fixes [YOCTO #9843] Some minor rewordings and removal of a stray comma. (From yocto-docs rev: 0b0c8b0b1c4edb86eb2b20c73ffb83d640f6b916) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the RDEPENDS variable description in the glossaryScott Rifenbark2016-07-191-8/+14
| | | | | | | | | | | | Fixes [YOCTO #9380] Updated the shlibdeps description for this variable to try and satisfy automatically added version restrictions. (From yocto-docs rev: d94de0b24591206620c83a9022a9d813141a7637) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the PR variable description.Scott Rifenbark2016-07-191-2/+40
| | | | | | | | | | | | | Fixes [YOCTO #9843] The variable description was very brief. These changes added some substance to the description and how the OpenEmbedded build system uses the variable. (From yocto-docs rev: cc9117d4e16c56dd54f81804fda94561e61d91a7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the flag descriptions for shared state detailsScott Rifenbark2016-07-191-0/+118
| | | | | | | | | | | | | Fixes [YOCTO 9823] I added more details to the explanations of how shared state is implemented. Included a bulleted list of the various statements of code to help explain flags and settings. (From yocto-docs rev: 518352f88c8dda16f2915a7bb9901ffd7686d739) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the DISTRO_FEATURES description of Bluez5Scott Rifenbark2016-07-191-1/+19
| | | | | | | | | | | Edits to explain that by default, DISTRO_FEATURES backfills bluetooth support with Bluez5. If the user wants to use the Bluez4 feature, they need to backfill consider Bluez5. (From yocto-docs rev: 4e8b34c8c5841cdc1cae564decae4689ae4f2b11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SSTATE_MIRRORS examples to match realityScott Rifenbark2016-06-212-2/+2
| | | | | | | | | | | | Fixes [YOCTO #9773] Updated two examples that set SSTATE_MIRRORS so that they match the changes made by YOCTO #3220. (From yocto-docs rev: e07674cd0665c485173eaa05c4072c287411b81f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a typo for installing "python3-git"Scott Rifenbark2016-06-211-1/+1
| | | | | | | | | Fixes [YOCTO #9712] (From yocto-docs rev: 0ece224ec34b3b441af7a3a7a8c076d5cdce7c4d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the UPSTREAM_CHECK_* variables.Scott Rifenbark2016-06-211-19/+25
| | | | | | | | | Fixes [YOCTO #9671] (From yocto-docs rev: 0f7e086e126d210cde0bd0cbe3e56d0808138e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added note about installing Git-Python packageScott Rifenbark2016-06-211-0/+13
| | | | | | | | | | | | buildhistory-diff tool requires the Git-python package. I added a note indicating this. Fixes [YOCTO #9712] (From yocto-docs rev: 2187df01f784b40608b30f62d19888cf183e67e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the UPSTREAM_CHECK_* variablesScott Rifenbark2016-06-211-19/+28
| | | | | | | | | | | | I applied some grammar edits and re-wordings as directed by technical reviews. Fixes [YOCTO #9671] (From yocto-docs rev: b5a5d3d3b311cb83ed61bfd247fbf802027fe5c4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to UPSTREAM_CHECK_* variables.Scott Rifenbark2016-06-211-17/+26
| | | | | | | | | | | | | Fixes [YOCTO #9671] Applied some review comments to these three variables. Edits to be sure to qualify that the variables only to recipes who inherit the distrodata class. (From yocto-docs rev: 1b094b0567fa75d1c77da7ec04641d034f29272d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added descriptions for three UPSTREAM* variables.Scott Rifenbark2016-06-211-0/+54
| | | | | | | | | | | | | | | Fixes [YOCTO #9671] Put in descriptions for the following variables: * UPSTREAM_CHECK_GITTAGREGEX_pn * UPSTREAM_CHECK_URI_pn * UPSTREAM_CHECK_URI_pn (From yocto-docs rev: e00470cbf98714236f3197dd538371488d8f03fb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the INHIBIT_PACKAGE_STRIP variableScott Rifenbark2016-06-211-1/+13
| | | | | | | | | | | Fixes [YOCTO #9553] Added detail to this variable description. (From yocto-docs rev: 35407b9db582ebc23be89a6f9bc7b0ad9ab90979) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed *[doc] string for INHIBIT_PACKAGE_DEBUG_SPLITScott Rifenbark2016-06-061-1/+1
| | | | | | | | | | The string was a copy paste error. It was using the string for INHIBIT_PACKAGE_STRIP. (From yocto-docs rev: d2efc36a7bc39b3fb596286dcde5efa1b8fead7c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared manuals for a 2.2 release.Scott Rifenbark2016-06-061-0/+5
| | | | | | | | | | | | | * Updated poky.ent to have the appropriate 2.2 variables * Updated all manual revision tables to have a new entry for 2.2 - used "Sometime in 2016" for the date. * Updated the mega-manual.sed file to process internal links for 2.2. (From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added BlueZ version 5 feature to distro feature section.Scott Rifenbark2016-06-061-0/+3
| | | | | | | (From yocto-docs rev: c7055f313a127bc8ed65a93ed7bea21775518567) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added GObject Introspection to 2.1 migration section.Scott Rifenbark2016-04-291-0/+15
| | | | | | | (From yocto-docs rev: 0b9ee8da66ff81e0724465f18b0323f1216cb9fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new 2.1 migration misc. ChangeScott Rifenbark2016-04-291-0/+19
| | | | | | | | | | Lists packages removed if package-management was not in IMAGE_FEATURES. (From yocto-docs rev: 45768d661b800782e32b76b4fa7efa0f70cb7e47) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied 2.1 Migration section review edits.Scott Rifenbark2016-04-291-0/+16
| | | | | | | (From yocto-docs rev: d641e8404d13aa96f23c537045d1ce165a0fe119) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>