aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.xml
AgeCommit message (Collapse)Author
2016-03-03ref-manual: Updated the staging.bbclass descriptionScott Rifenbark
Fixes [YOCTO #8800] Provided better wording. (From yocto-docs rev: 68be69d758b7638ddb824bbec89e76cf7dc026ff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-27ref-manual: Updated the rootfs*.bbclass description.Scott Rifenbark
Fixes [YOCTO #8298] Added "rootfsdebugfile" class to the list of classes in this general class description. (From yocto-docs rev: ad2f6e1d22c9453b0d28cdc0b53558efa1dcc212) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the allarch class description.Andre Draszik
Added a patch to include a note from Andre. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added correct class name as part of pkgconfig descriptionScott Rifenbark
I was refering to the class as "pkg-config". This was incorrect. I fixed it in the opening sentence to use "pkgconfig". (From yocto-docs rev: c8400b362704093d4c2c891f521c11818eb506a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual, dev-manual: Applied feedback to edit several classesScott Rifenbark
Fixes [YOCTO #8298] Updated several classes with feedback from Jose Lamego of Intel. The feedback fixed some class groupings so that previously isolated classes could be bundled under common classes (e.g. autotools*.bbclass). I scrubbed the cross-references for cases where a particular class became "undocumented." The cross-references now point to the bundled class entry in the ref-manual. (From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the image-swab.bbclass descriptionJohn Maxin
Fixes [YOCTO #8439] The "image-swab" class depends on "strace" package being on the build host. I added that fact to the note where we say the class is not maintained. (From yocto-docs rev: 503f4199b3c0bcfcd333dbab025b40f9508a6820) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added many new class descriptions.Scott Rifenbark
Fixes [YOCTO #8298] (From yocto-docs rev: bff0119d2e13922cdd7b0772f6ed4ff74afe3c26) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updates to clarify Fetcher URL directory parametersScott Rifenbark
Updated the SRC_URI variable description to cross-reference the "Fetchers" section in the BitBake User Manual and added some more Fetcher URL parameters specific to certain fetchers. This was done to help clarify how to put fetched code into specific directories. Also updated the bin_packages.bbclass description to have a better example. Used a git:// fetcher example and provided some specific URL parameters. (From yocto-docs rev: 7133b49092096c253ffce99f39d4fa6db7810061) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added linuxloader.bbclass reference description.Scott Rifenbark
(From yocto-docs rev: f33dbbd740ddd9dc88154373dc824e63d832ca0c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated distrodata.bbclass exampleScott Rifenbark
Fixes [YOCTO #8237] The use of this class no longer requires including the laundry list of files that was provided in the section. It just needs the INHERIT statement now. Removed the include statements. (From yocto-docs rev: c31a5a3a78d265dea68c1c72c4eea6c2f80c839a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: Fix to QA error message.Scott Rifenbark
Fixed wording in section 7.78 to use "nativesdk-myrecipe.bb". Fixed message to say "non-dev/-dbg/nativesdk- package contains symlink..." Reported-by: Rene Fichter <rene@fichter.se> (From yocto-docs rev: 80a5b51a0416dc610edf1526079102fee661375b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: Fixed grammar issue in the oelint.bbclass section.Scott Rifenbark
(From yocto-docs rev: ec29b817cd426a1214100b583557c6a4a1aae03c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: Updated ARCHIVER_MODE and archiver.bbclassScott Rifenbark
Added information in about the various varflags the user can use to define the type of archive. (From yocto-docs rev: 9035c415d4453750f016fe4ea2fa8179549330ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: Added new variable description for ARCHIVER_MODEScott Rifenbark
Also, added a cross-reference link from the archiver.bbclass section to the new description. (From yocto-docs rev: f825ba932970e9d62d335f249365a34b2992b6cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: clarify allarch wrt RDPENDS and TUNE_PKGARCHAndré Draszik
See e.g. http://permalink.gmane.org/gmane.comp.handhelds.openembedded/64067 (From yocto-docs rev: 5ad5f90edc5aefc95049f36afa2792dd7a9fba3d) Signed-off-by: André Draszik <git@andred.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: fix example of setting root password using extrausersPaul Eggleton
We need to use usermod here not useradd. (From yocto-docs rev: 7f4a5523c14304985ab8b277fd5010fd22903dea) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-03ref-manual; mega-manual: Edits to further define packaging processScott Rifenbark
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>
2015-04-28dev-manual; ref-manual: Fixed &dash; issueScott Rifenbark
Fixes [YOCTO #7386] Apparently the "&dash;" ENTITY used throughout the YP manual set to get literal "-" characters in example commands renders into a unicode that is not a dash. This results in users getting errors if they attempt to cut-and-paste a sample command that uses a "-" character from the manual into a shell. I have universally replaced all the "&dash;" strings in the YP manual set to "-" strings. (From yocto-docs rev: ef6dbf591eee70866f163e3c98454b6145f4fa3a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24ref-manual: Updates to ELF binary QA warningScott Rifenbark
Fixes [YOCTO #7630] Apparently the text relocation being done here can cause runtime performance issues. I documented a potential work-around for the issue and provided a cross-reference link to an external site for more general information about text relocation at runtime. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: f7ba2fd03ee40c5dbe6a07a24a63d9147857ed78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-10ref-manual: Corrected the "package_rpm.bbclass" section.Scott Rifenbark
A cut-and-paste error had left a "package_deb" string in the first sentence of the section. Replaced with "package_rpm." Reported-by: Geoffroy VanCutsem <geoffroy.vancutsem@intel.com> (From yocto-docs rev: 38b20d775ba41cb14d86177dddd85ada32fb3f86) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-02ref-manual: Added new bluetooth class.Scott Rifenbark
(From yocto-docs rev: 536117974fb08c1c6739af9c8200b228a59b7f6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual: Fixed icecc example codeScott Rifenbark
Fixes [YOCTO #6912] The example used to make sure builders use the same sstate signatures regardless if they use icecc or not was incorrect. I updated the INHERIT_DISTRO line of the example to use the append part in the name so it appends the icecc as suggested by the bug submitter. Reported-by: Peter Bergin <petan679@gmail.com> (From yocto-docs rev: 1f6b2f152202ab6e0be3026af3275f67bdb40d16) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual, dev-manual, adt-manual, yocto-project-qs: scrub eglibcScott Rifenbark
Scrubbed out the occurrences of eglibc and replaced them with glibc. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual: Added warnings about using package_tarScott Rifenbark
This option to the PACKAGE_CLASSES variable is broken and not supported. I added several warnings saying such. We opted to keep the documentation rather than eliminating it completely to prevent questions should someone find the code and wonder why it is not documented. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 1acf3da2034c4c3f74acee1ccb375f0450ed90a0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-23ref-manual: Applied review edits for new classes and variables.Scott Rifenbark
These edits were minor with the addition of some descriptions that had to be fleshed out. All comments from Paul Eggleton. (From yocto-docs rev: 4ae7c5a5e5aa23307e28de0832d379145c4ef8f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added new uninative class.Scott Rifenbark
(From yocto-docs rev: b227b6a636b0ca194e3f7a4521659304596303e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added gummiboot class and four supporting variables.Scott Rifenbark
The variables added were: * EFI_PROVIDER * GUMMIBOOT_CFG * GUMMIBOOT_ENTRIES * GUMMIBOOT_TIMEOUT (From yocto-docs rev: 42d548a9c4e6eb8eb67ada258fefb32ba8ba175c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added copyleft_filter class description.Scott Rifenbark
(From yocto-docs rev: 2259f448cf1d102cbf06ad371e90c439812038cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added texinfo class and two new variables.Scott Rifenbark
Added ASSUME_PROVIDED and SANITY_REQUIRED_UTILITIES variable place-holders. There is no text there yet but they are there for placeholders. (From yocto-docs rev: adfa77dc597303dcff0e95fd4b3ffd5ae2fb08d5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added buildstats-summary.bbclass section.Scott Rifenbark
(From yocto-docs rev: 2eb52ec085e1add723548112390d2983b5a6b77e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added BINCONFIG variable and binconfig-disabled class.Scott Rifenbark
(From yocto-docs rev: 16e0176db9927296f721c25792d87b2495b5405b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added ptest-gnome.bbclass section.Scott Rifenbark
Also fixed an error in the compress_doc class. (From yocto-docs rev: 3c3532ec4f3ab5985ea3c2f3689ab5cdb7e16bad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added compress_doc class and DOC_COMPRESS variable.Scott Rifenbark
(From yocto-docs rev: 875b6eb2e01b1bb9b4c8ed3c80553c1d0870cf78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Updated the populate_sdk_* classScott Rifenbark
Improved the formatting of the two examples that show where sysroots are written. (From yocto-docs rev: 7807e8a727e1e70c2537ac9ead2ad15305c656ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Scrubbed for variable (user) input.Scott Rifenbark
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>
2014-10-18ref-manual: Minor edits for review on new QA checks.Scott Rifenbark
Fixed some minor issues with build-deps and file-rdeps. (From yocto-docs rev: b4250c9ba7d6a3d30c3dfb94d9e2e2eea6b47764) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added new build-deps QA check to insane.bbclass.Scott Rifenbark
(From yocto-docs rev: fe8862304f1f78bda924dc5c46cb22f876373875) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added file-redeps QA check to the insane.bbclass.Scott Rifenbark
(From yocto-docs rev: 85a0cec2a36889485f1bd010a85e0115303409a0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Another change to the autotools class.Scott Rifenbark
Forgot the word "class". (From yocto-docs rev: e54102d2a5df3f703e4ab23ed9062ef2abf7315b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Updated the autotools class.Scott Rifenbark
Needed to change wording to state that the class uses out-of-tree builds. (From yocto-docs rev: 2fbaeba33988e14a97d5946f7e714a1bbc5a3ccb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18dev-manual, ref-manual: Updated 1.7 migration section with review commentsScott Rifenbark
Applied the second round of review edits from Paul Eggleton. Minor fixes. (From yocto-docs rev: 2c7c45c8f09b724e92e8b59fe47834226b44b4fb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual, dev-manual: Applied migration review edits.Scott Rifenbark
Applied the full set of first draft revision edits for the new migration section for 1.7. Comments from Paul Eggleton. (From yocto-docs rev: 90586addbc719ecaf7c768b267adf0e988e27b74) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-09-30ref-manual: Updated the bin_package class.Scott Rifenbark
I added a small sentence to note that this class is a good class to use for extracting and installing propretary binaries. (From yocto-docs rev: adde5e66f46df0b4e21bfe0fc0b47a9a8bed5e0c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12ref-manual: Updated native.bbclass with grammar fix.Scott Rifenbark
Fixes [YOCTO #6622] Fixed a bungled sentence. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 4a782c61c21623d82e14b2c3cbe7ca99e418a2c0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12ref-manual: INITRD var: make it a list of filesystem images.Nitin A Kamble
The initrd image used by the Linux kernel is list of file system images concatenated together and presented as a single initrd file at boot time. So far the initrd is a single filesystem image. But in cases like to support early microcode loading, the initrd image need to have multiple filesystem images concatenated together. This commit is extending the INITRD variable from a single filesystem image to a list of filesystem images to satisfy the need mentioned above. (From yocto-docs rev: 051ef2e4d6480b28d21a59a79b6f0dca1a5944bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark
There was inconsistency on how we refer to a task name throughout the YP manual set. The proper way is "do_<taskname>". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30ref-manual: Updated example in extrausers.bbclass.Scott Rifenbark
I added a couple of examples to show how to set passwords. This is the -P option for adduser. (From yocto-docs rev: 2726fcd3b3c2a5144b23af6ab342832c242f85c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30ref-manual: Removed some extra space beyond the literal example.Scott Rifenbark
(From yocto-docs rev: 66bb31c9b59e5eaf4e35ade932a3d0f9083c4c47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30ref-manual: Edits to the QA checks message section and insane.bbclass.Scott Rifenbark
Fixes [YOCTO #6159] I applied some review edits to various parts of the QA chapter as derived by Paul Eggleton. Also, updated two areas of the insane.bbclass list. (From yocto-docs rev: 6529a261961339b747bb3b89b3080ef794244809) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30ref-manual: Applied review edits to QA messages and insane.bbclass.Scott Rifenbark
Fixes [YOCTO #6159] Edits from Paul Eggleton included some reformatting, some minor wording tweaks, and edits to a couple tests as described in the insane.bbclass. (From yocto-docs rev: b42ef1bd51cb20f6bbb6bf812999e3a35b332339) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>