summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.xml
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Applied review edits for new classes and variables.Scott Rifenbark2014-10-231-8/+11
| | | | | | | | | | 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>
* ref-manual: Added new uninative class.Scott Rifenbark2014-10-211-0/+15
| | | | | | | (From yocto-docs rev: b227b6a636b0ca194e3f7a4521659304596303e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added gummiboot class and four supporting variables.Scott Rifenbark2014-10-211-1/+31
| | | | | | | | | | | | | | 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>
* ref-manual: Added copyleft_filter class description.Scott Rifenbark2014-10-211-0/+11
| | | | | | | (From yocto-docs rev: 2259f448cf1d102cbf06ad371e90c439812038cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added texinfo class and two new variables.Scott Rifenbark2014-10-211-0/+21
| | | | | | | | | | | 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>
* ref-manual: Added buildstats-summary.bbclass section.Scott Rifenbark2014-10-211-0/+12
| | | | | | | (From yocto-docs rev: 2eb52ec085e1add723548112390d2983b5a6b77e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added BINCONFIG variable and binconfig-disabled class.Scott Rifenbark2014-10-211-0/+15
| | | | | | | (From yocto-docs rev: 16e0176db9927296f721c25792d87b2495b5405b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added ptest-gnome.bbclass section.Scott Rifenbark2014-10-211-1/+17
| | | | | | | | | 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>
* ref-manual: Added compress_doc class and DOC_COMPRESS variable.Scott Rifenbark2014-10-211-0/+13
| | | | | | | (From yocto-docs rev: 875b6eb2e01b1bb9b4c8ed3c80553c1d0870cf78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the populate_sdk_* classScott Rifenbark2014-10-181-7/+8
| | | | | | | | | | 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>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-12/+12
| | | | | | | | | | | | | | | 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: Minor edits for review on new QA checks.Scott Rifenbark2014-10-181-4/+5
| | | | | | | | | 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>
* ref-manual: Added new build-deps QA check to insane.bbclass.Scott Rifenbark2014-10-181-0/+28
| | | | | | | (From yocto-docs rev: fe8862304f1f78bda924dc5c46cb22f876373875) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added file-redeps QA check to the insane.bbclass.Scott Rifenbark2014-10-181-0/+19
| | | | | | | (From yocto-docs rev: 85a0cec2a36889485f1bd010a85e0115303409a0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Another change to the autotools class.Scott Rifenbark2014-10-181-1/+2
| | | | | | | | | 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>
* ref-manual: Updated the autotools class.Scott Rifenbark2014-10-181-2/+1
| | | | | | | | | | 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>
* dev-manual, ref-manual: Updated 1.7 migration section with review commentsScott Rifenbark2014-10-181-4/+5
| | | | | | | | | | 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>
* ref-manual, dev-manual: Applied migration review edits.Scott Rifenbark2014-10-181-11/+11
| | | | | | | | | | 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>
* ref-manual: Updated the bin_package class.Scott Rifenbark2014-09-301-0/+2
| | | | | | | | | | 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>
* ref-manual: Updated native.bbclass with grammar fix.Scott Rifenbark2014-08-121-1/+1
| | | | | | | | | | | | 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>
* ref-manual: INITRD var: make it a list of filesystem images.Nitin A Kamble2014-08-121-3/+4
| | | | | | | | | | | | | | | | | | | 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>
* dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark2014-06-181-3/+3
| | | | | | | | | | | | 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>
* ref-manual: Updated example in extrausers.bbclass.Scott Rifenbark2014-05-301-0/+17
| | | | | | | | | | 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>
* ref-manual: Removed some extra space beyond the literal example.Scott Rifenbark2014-05-301-3/+0
| | | | | | | (From yocto-docs rev: 66bb31c9b59e5eaf4e35ade932a3d0f9083c4c47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the QA checks message section and insane.bbclass.Scott Rifenbark2014-05-301-6/+6
| | | | | | | | | | | | | 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>
* ref-manual: Applied review edits to QA messages and insane.bbclass.Scott Rifenbark2014-05-301-5/+11
| | | | | | | | | | | | | 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>
* ref-manual: Added LDFLAGS variable and supporting links.Scott Rifenbark2014-05-301-1/+2
| | | | | | | (From yocto-docs rev: 58d583c9167feee65d7d22b343ea250cb8807261) 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 links to new do_* sections.Scott Rifenbark2014-05-131-24/+48
| | | | | | | | | | | | | | 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>
* 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: 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-191-8/+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: 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 fix up how GID and UIDs are handled.Scott Rifenbark2014-04-081-12/+15
| | | | | | | | | | 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-081-0/+54
| | | | | | | | | | | | | | | | | | | 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>
* 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: 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>
* ref-manual: Edits to distutils3 and setuptools3 class descriptions.Scott Rifenbark2014-04-081-5/+6
| | | | | | | (From yocto-docs rev: 1be2bbfcfc9b4f3c2d32fb210fe815b1fe99eda1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added setuptools3 class description.Scott Rifenbark2014-04-081-0/+11
| | | | | | | (From yocto-docs rev: 3953f96224bb6a0e5e528d5230bc6706149dc52c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added distutils3 class.Scott Rifenbark2014-04-081-0/+28
| | | | | | | (From yocto-docs rev: 0962f3545ea7c97f821355e36bf6aa85fea8b392) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added notes for Systemd-based images.Scott Rifenbark2014-04-041-0/+8
| | | | | | | | | | | | | | | | | Fixes [YOCTO #5159] In the dev-manual, I located instances where a note about using VIRTURAL-RUNTIME_initscripts = "" in the local.conf file would be appropriate. Three areas updated. In the ref-manual, I located the note in the systemd.bbclass section and the variable descriptions for SYSTEM_AUTO_ENABLE, SYSTEM_PACKAGES, and SYSTEMD_SERVICE. (From yocto-docs rev: 57b0acf2f3f8159b635b42dcffa129f7d945eb81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added error reporting tool informationScott Rifenbark2014-03-301-0/+20
| | | | | | | | | | | | | | | | Fixes [YOCTO #1562] In the dev-manual, I created a new section called "Using the Error Reporting Tool" that describes how to use this feature. The text was based on information I received from Andreea Proca. In the ref-manual, I added a new variable entry for ERR_REPORT_DIR in the glossary and a new report-error class in the class chapter. (From yocto-docs rev: 70a5538fefcc1b77958fe4b2f29be00354f4137a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixing whitespace.Scott Rifenbark2014-03-251-1/+1
| | | | | | | (From yocto-docs rev: 5ab12447d14ca7054ae44283ec858464c9b04244) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual, ref-manual: Cross-toolchain details added. New class also.Scott Rifenbark2014-03-251-0/+46
| | | | | | | | | | | | | | | | | | | In the adt-manual in the "Optionally Building a Toolchain Installer" setion, I added some basic advantage information for building a toolchain installer using bitbake image -c populate_sdk. In the ref-manual, I added cross-referencing to this basic information in several strategic areas: "SDK Generation", the populate_sdk class reference section, the populate_sdk_* class reference section, and the "Cross-Development Toolchain Generation" sections. Finally, I also put in documentation for a new class called autotools-brokensep. (From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the nativesdk class to have correct class.Scott Rifenbark2014-01-211-1/+1
| | | | | | | (From yocto-docs rev: 8e0a3c236f746caa6263038380144957039feabe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated native and nativesdk classes.Scott Rifenbark2014-01-211-0/+6
| | | | | | | | | Added a bit about needing to place the inherit statement last. (From yocto-docs rev: 204e15035a9a116002b7f645e4edb378979c89f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed cross-reference anchor name.Scott Rifenbark2014-01-211-1/+1
| | | | | | | (From yocto-docs rev: 06f429d986c02a1b4d7b324e34c2434da0e9e9af) 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-06-15 13:44:20 +0000