summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-tasks.xml
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Converted external links to internal and fixed dev-manual linksScott Rifenbark2017-10-301-5/+5
| | | | | | | | | | | The dev-manual title changed to the Yocto Project Development Tasks Manual. Fixed links for that. Also, fixed some external links that should have been internal to ref-manual. (From yocto-docs rev: 2369e8d1c1c4f376de0faf6ab02afdea79082d87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Eliminated "Generating Configuration Files" section.Scott Rifenbark2017-10-061-6/+3
| | | | | | | | | | | | | | | This section was largely redundant now. The small things that did add value I placed in other areas of the chapter 2. One was a new section on expanding variables using bitbake -e. Another was a bit about the defconfig file. And a small procedure on how to create config fragments using the "diffconfig" command was retained. Links from the dev-manual and the ref-manual were adjusted as well. (From yocto-docs rev: 7059d3eac1fec20089cabf197503f1bec747686d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Compatibility program and moving kernel configurationScott Rifenbark2017-09-261-4/+4
| | | | | | | | | | | | | | Should have been two commits but I forgot to do them separately. 1. I updated the YP Compatible Program section. 2. I moved the "Configuring the Kernel" section from the dev-manual to the kernel-dev manual. (From yocto-docs rev: cdb5bbc917db55a2ca987ce9b9ed371f9fca6524) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Image format implementation changesScott Rifenbark2017-09-221-10/+0
| | | | | | | | | | | | | | | Recently a number of changes have happened on the implementation side of some image formats, and a few have been renamed. The u-boot image signing code is now always available and no longer in a stand-alone file. The vmdk/mdi/qcow2 images have been removed and are now just a conversion type that is applied to wic images. Reported-by: Tom Rini <trini@konsulko.com> (From yocto-docs rev: ce86da3d48507cee12208e0138c285b4be83d8cd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added review commentsKristi Rifenbark2017-09-021-2/+3
| | | | | | | | | | | Added review comments to variables COMPONENTS_DIR, and SYSROOT_DESTDIR. Added review comments to task do_prepare_recipe_sysroot. (From yocto-docs rev: 362998c71b44ddf89d32ed5c45e4251e932a9217) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed links in do_prepare_recipe_sysroot taskKristi Rifenbark2017-09-021-2/+5
| | | | | | | (From yocto-docs rev: 80c60be5f560d20ee60270df0de2c86b23e004df) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Updates to support recipe-specific sysrootsScott Rifenbark2017-04-181-0/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changes covered several areas. Version 2.3 of the YP now supports recipe-specific sysroots and is not limited to machine-specific as was prior releases. Manual changes were as follows: dev-manual: "Sharing Files Between Recipes" - Wordings were changed to support the new functionality. ref-manual: do_prepare_recipe_sysroot task added to the list of tasks described in "Configuration and Compilation". ref-manual: Extensive re-write of the "staging.bbclass" section. ref-manual: Added a section to the build structure for build/tmp/work/tunearch/recipename/version/. This section breaks down the recipe-specific subdirectories used to create (stage) the sysroot. ref-manual: New section (entry) for the do_prepare_recipe_sysroot task in the task chapter. ref-manual: Added a variable glossary description for the SSTATE_SCAN_FILES variable. In addition to these changes, I sprinkled in a liberal amount of cross-referencing for the readers pleasure. (From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Expanded kernel task descriptions.Scott Rifenbark2017-02-191-32/+120
| | | | | | | | | | | | Fixes [YOCTO #9376] Expanded many of the brief descriptions for the kernel-related tasks. (From yocto-docs rev: ee9e54aa9f148e5438cd9bdf7e55d7fa43cc3ec5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review edits to do_populate_sysroot and SYSROOT_DIRS_NATIVEScott Rifenbark2016-10-111-4/+4
| | | | | | | | | | | | Fixes [YOCTO #10377] Some minor wordsmithing. Also added a new note to the SYSROOT_DIRS_NATIVE variable. (From yocto-docs rev: 459666b01b8d6d8212a59c877ea6c324511a5883) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_sysroot_populate task description.Scott Rifenbark2016-10-111-11/+18
| | | | | | | | | | | Fixes [YOCTO #10377] Added more detail and linked it to key variables. (From yocto-docs rev: d82c1d4e8cc95bee718388cfeced1566ce8569a0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Add information on devpyshellScott Rifenbark2016-09-281-0/+16
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #9166] In the dev-manual, I added a new section titled "Using a Development Python Shell." This section is similar to the section that talks about using devshell. The section is tied to a reference section on the do_devpyshell task. In the ref-manual, I entered a new task reference for the do_devpyshell task. It is brief and references into the new section in the dev-manual. (From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to PKGDESTWORK and do_packagedataScott Rifenbark2016-09-231-4/+5
| | | | | | | | | | | Fixes [YOCTO #10248] Provided more accurate descriptions for this variable and task. (From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section and updates for runtime dep workScott Rifenbark2016-09-231-0/+13
| | | | | | | | | | | | | | | | fixes [YOCTO #10248] The bulk of this change is a new section called "Automatically Added Runtime Dependencies". Additionally, changes were made to the RDEPENDS and DEPENDS variables. Some cross-referencing to the new material was also added in the do_package task entry, the do_packagedata task entry, the PKGDATA_DIR glossary entry, and the PRIVATE_LIBS glossary entry. (From yocto-docs rev: 16504cd0eb23e102322c6c6096c5b52500a04640) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New "Fakeroot and Pseudo" section.Scott Rifenbark2016-08-181-0/+9
| | | | | | | | | | | | | Fixes [YOCTO #10060] I provided a new section in the Technical Details chapter. Also some extra explanation was added to both the do_install task and to the D variable. (From yocto-docs rev: 565fb11d72bf8c585469bcf65f92b6738e344813) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_compile task section.Scott Rifenbark2016-08-181-1/+1
| | | | | | | | | | | | Fixes [YOCTO #9964] There was a small fix to change oe_runmake task to oe_runmake function. (From yocto-docs rev: aa049c9165c67e041c84fab9fabfbe98828c79bb) 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-011-30/+30
| | | | | | | | | | | | | | | | 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: Added 3 new QA sanity checks.Scott Rifenbark2016-08-011-1/+2
| | | | | | | | | | | | 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 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 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: 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-011-3/+13
| | | | | | | | | | | | | | 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: Added cross-referencing to tasks and dependenciesScott Rifenbark2016-07-191-0/+4
| | | | | | | | | | | | | | | | 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: Created distrodata and checkpkg tasks, updated distrodata classScott Rifenbark2016-03-231-0/+56
| | | | | | | | | | | | | Fixes [YOCTO #7894] I created two new task reference sections: distrodata and checkpkg. Also, updated the distrodata class description to reflect the presence of these new tasks. (From yocto-docs rev: 3896cbf640d296dafb5eda37f89bba31a47ca8a5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the do_populate_sysroot task.Scott Rifenbark2016-03-031-3/+9
| | | | | | | | | Fixes [YOCTO #8800] (From yocto-docs rev: 582fc36e9c7157ca9457cad5c8bc6824163feede) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added do_image and do_image_complete tasksScott Rifenbark2016-01-291-0/+54
| | | | | | | (From yocto-docs rev: 7b6eb076adc24a6f290e73db93aa831f982817b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to cull out qt4 stuff.Scott Rifenbark2016-01-151-9/+0
| | | | | | | | | | Several areas changed throughout the ref-manual to remove qt4 referencing. (From yocto-docs rev: 9ee721034ceb2bb7b7a9e64f6a6a7a2b3bfd1c82) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added descriptions for 5 new variables and 2 tasks.Scott Rifenbark2015-10-211-0/+17
| | | | | | | | | | | Fixes [YOCTO #8019] Added new descriptions for five kernel variables and two tasks. (From yocto-docs rev: 834aebb75dce1c905b1e0f142d0d7de6bb44e7d4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual; mega-manual: Edits to further define packaging processScott Rifenbark2015-05-031-12/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In response to community input where developers were attempting to locate information on how to write packages out to a directory other than ${DEPLOY_DIR}/<package_type>, I updated the "Package Feeds" section, added several new DEPLOY_DIR_* variables, updated four classes, and updated four tasks. Here are some details: * Made changes to the "Package Feeds" section to provide more accurate information in the package feeds directory structure used by the build system in build/tmp. These changes included updating the figure itself and some explanatory text. * Updated the DEPLOY_DIR variable description. * Added new variable descriptions for DEPLOY_DIR_DEB, DEPLOY_DIR_IPK, DEPLOY_DIR_RPM, and DEPLOY_DIR_TAR. * Updated the related classes: package_deb, package_ipk, package_rpm, and package_tar. * Updated the related tasks: do_package_write_deb, do_package_write_ipk, do_package_write_rpm, and do_package_write_tar. Reported-by: Trieu Nguyen <trieu.t.nguyen@intel.com> (From yocto-docs rev: e8742267506bf9359346cfcd3965f762ed2c7d6f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: 13 new variables added to the glossary.Scott Rifenbark2015-02-171-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Added descriptions for the following variables: EXTRA_AUTORECONF KERNEL_IMAGE_MAXSIZE UPDATERCPN AUTO_LIBNAME_PKGS DEBIANNAME DEBIAN_NOAUTONAME TCLIBCAPPEND PACKAGEGROUP_DISABLE_COMPLEMENTARY CLEANBROKEN DISTRO_CODENAME BASE_WORKDIR DISTRO_FEATURES_DEFAULT DISTRO_FEATURES_LIBC Part of adding new variables is checking to see if a previously undocumented variable is used elsewhere in the manual. One occurrence was spotted and turned into a link for this list. (From yocto-docs rev: bb75387b7aa4fcb0b594d300772952d81a651644) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-5/+5
| | | | | | | | | | | | | | | Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new do_package_qa task entry to tasks chapter.Scott Rifenbark2014-10-181-0/+11
| | | | | | | (From yocto-docs rev: 7b95f578061777bc54c9b3d622db53b4745fd003) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to several tasks that do a bit of "cleaning"Scott Rifenbark2014-06-181-2/+28
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #1949] Updated the following tasks to note that they "clean" out some areas when run: do_populate_sysroot do_deploy Also made some notes to the do_cleansstate task about attempting to clean remote mirrors. And, made a change to do_cleanall to specifically mention that DL_DIR is cleaned. (From yocto-docs rev: 7e532b17ccd89e43d3661c733ce1f06a52066c29) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Expanded on the "clean" tasks.Scott Rifenbark2014-06-181-4/+60
| | | | | | | | | | | | | | | Fixes [YOCTO #1949] Added more explanation and examples how to run for: bitbake -c clean <recipe> bitbake -c cleanall <recipe> bitbake -c cleansstate <recipe> (From yocto-docs rev: 170d1a31c9c064884599c5485c16fcfffbefce5b) 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: 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-131-7/+12
| | | | | | | | | | | | | | 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-131-0/+497
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-16 23:27:20 +0000