summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual, ref-manual: Cross-references between PR Service and cacheScott Rifenbark2013-02-141-0/+12
| | | | | | | | | | | | | Fixes YOCTO #3684 These changes help tie in the relationship between how the OE build system uses checksums and such and the PR Service that can track revision. (From yocto-docs rev: 39a3010a3bb4b2c1d37aef60984ac16e85b56aac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Created "Development Host System Issues" sectionScott Rifenbark2013-02-141-0/+31
| | | | | | | | | | | | | Fixes YOCTO #2790 Created a new section in the "Debugging Build Failures" section to deal with host issues that cause a build to fail. (From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed three figures from poky-ref-manualTimo Mueller2013-02-143-0/+0
| | | | | | | | | | three PNG files go away from the eclipse folder due to the renaming of the poky-ref-manual to ref-manual. (From yocto-docs rev: 29907784ecb509b3d4fba633b2c4970e4105bea2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 2 of 2 for YP doc integration into Eclipse.Timo Mueller2013-02-141-0/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds the three *.customization.xsl files. I (Scott Rifenbark). Split the commit because after applying the 18 patches, the list of stuff to stage was huge and I did not want to add them one-by-one. So I staged them using git add -u. Here is the general cover letter information from Timo included with the 18 patches: ----------------- Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo (From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 1 of 2 updates to integrating docs to Eclipse help.Timo Mueller2013-02-14184-11127/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: edits to update-alternatives.bbclass description.Scott Rifenbark2013-02-141-22/+23
| | | | | | | | | | | | | | | | Fixes YOCTO #3838 First draft of edits for this class. Removed specific variable definitions as they are now deprecated. Added a general explanation of the variable functions. Pointed user to the commented code in the actual class for details. Removed statement saying that the build system supports only one binary per package. (From yocto-docs rev: bd574f2c8a95470c5a44500b70743a6e039522b7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the question on how source code is fetched.Scott Rifenbark2013-02-141-32/+49
| | | | | | | | | | | | Updated the question that asks "How doe the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?". Some of the variables did not have links or proper font type. (From yocto-docs rev: be1f665b480a47483595381c9a837892100007e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SSTATE_MIRRORS glossary entry.Scott Rifenbark2013-02-141-1/+1
| | | | | | | | | | added links for the PREMIRRORS and MIRRORS variables used in the description. (From yocto-docs rev: 1ec0f9cbeebeaeaadee8cc8b3631e6194c013a2f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: added MIRRORS glossary definition.Scott Rifenbark2013-02-141-0/+25
| | | | | | | (From yocto-docs rev: 3dfc95974cdaf345d36a51e8f581602242c38148) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added PREMIRRORS glossary entry.Scott Rifenbark2013-02-141-0/+45
| | | | | | | (From yocto-docs rev: a91e562db5c1581cb88f0254f8d5a170296f3e41) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Updates for BBPATH.Scott Rifenbark2013-02-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | Two things fixed: 1. A couple examples for setting up a layer.conf file were using the meta-yocto configuration file as an example. Turns out this is a bad example because the BBPATH variable is appended to the LAYERDIR when setting BBPATH rather than the other way around. That is because meta-yocto is a distro layer. BSP layers, however, are not distro layers and are the norm here. So I switched up the way BBPATH was set and actually called out meta-yocto-bsp config file as a template. 2. Added a link for the BBPATH variable in the FILESYSTEM_PERMS_TABLES variable description in the glossary. Just happened to notice this so I fixed it Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 1a594b6dde1a494a5f7322b510e1e67d23635298) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Updates to BBMASK variable.Scott Rifenbark2013-02-141-17/+52
| | | | | | | | | | | | | | | | | | Fixes YOCTO #3662 I added more information to the variable desription in the glossary for BBMASK. The information included a bit more syntax information as well as some more complex examples. I added more reference information to the "Excluding Recipes From the Build" section to help better describe how the BBMASK variable works. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: f10f43a543e7b0892863e165d2902741a8823009) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the FILESEXTRAPATHS variable.Scott Rifenbark2013-02-141-12/+20
| | | | | | | | | | | | | | | Fixed YOCTO #3662 Updates to the description so _prepend is used to add paths to the front of the search order and use of the variable without _prepend just adds paths to the end of the FILESPATH order. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 44c98058c1a75a9e6c95e4f33dbe1696e23d97d0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: new BB_DANGLINGAPPENDS_WARNONLY variable added to glossary.Scott Rifenbark2013-02-141-0/+33
| | | | | | | | | | | | Fixes YOCTO #3662 New entry added. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 73f8b28f6b6cea16cf63b99db88c961f87088fe1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tagTimo Mueller2013-02-141-1/+3
| | | | | | | The title of the document used to create metadata for output formats such as eclipse help. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Move poky-ref-manual global parameters to customization fileTimo Mueller2013-02-141-0/+5
| | | | | | | | Standard stylesheet parameters were moved to the docbook customization file tying them to the docbook stylesheet used. Removing these parameters simplifies the Makefile. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated FILESPATH glossary entryScott Rifenbark2013-01-301-4/+2
| | | | | | | | | | | | | Fixes YOCTO #3661 The value for FILESPATH was incorrect. I have replaced it with the value found in base.bbclass. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: bc100cdd1bec48a65fcc4bed281f42953b1c9077) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed the default BB Signature HandlerScott Rifenbark2013-01-301-2/+2
| | | | | | | | | | | | Fixes YOCTO #3684 Updated the section that declares what the default BB Signature Handler is. (From yocto-docs rev: e4c64add4a54e5583bf88fc71f00c90f7a1f6440) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed broken link to "Build Directory" term.Scott Rifenbark2013-01-301-1/+2
| | | | | | | (From yocto-docs rev: 311edd13da00f6849094346aaa9509f27d60b2c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a general reference and link to kernel-devScott Rifenbark2013-01-271-1/+2
| | | | | | | | | | Put in a cross-link to the new YP Linux Kernel Development Manual up in the introduction. (From yocto-docs rev: ba00acb1a0db9494b0d0ff1335f2532b5e2a7994) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new KFEATURE_DESCRIPTION glossary entry.Scott Rifenbark2013-01-271-0/+16
| | | | | | | (From yocto-docs rev: 34060ca253a4434cd61c61fbefd0fe58ecd5fb36) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable KBRANCH_DEFAULT.Scott Rifenbark2013-01-271-0/+15
| | | | | | | (From yocto-docs rev: d97c04fd6e818e7b78971f8c459a9778fb4e69f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New KERNEL_PATH variable added to the glossary.Scott Rifenbark2013-01-271-1/+27
| | | | | | | | | | Also put in a cross-reference in the existing KERNEL_SRC variable. (From yocto-docs rev: 705074a16490155cd64469af3b2ea12a0780281c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New KERNEL_SRC variable added to glossary.Scott Rifenbark2013-01-271-0/+14
| | | | | | | (From yocto-docs rev: d8f7b32a9be1834f7835262f58c577b1f40a3edc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Set KARCH as the top "K" entry for the glossary.Scott Rifenbark2013-01-271-1/+1
| | | | | | | (From yocto-docs rev: 1fceec975f9e6b40c64d55050e257c2239340d65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variable descriptions for KTYPE and KARCH.Scott Rifenbark2013-01-271-0/+45
| | | | | | | (From yocto-docs rev: 35b7baa5653cffbb5e1dd1759643135c08b15bf7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to a couple variables in the glossaryScott Rifenbark2013-01-271-1/+29
| | | | | | | | | | | | | 1. LINUX_VERSION_EXTENSION: Added a link on the LINUX_KERNEL_TYPE variable. 2. Added a new variable description for the LINUX_KERNEL_TYPE variable. (From yocto-docs rev: f4ace3c64838044e2eb700af4b024a96ab1e2315) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the LINUX_VERSION_EXTENSION variable.Scott Rifenbark2013-01-271-7/+6
| | | | | | | | | | | Applied Darren Hart's review comments. Namely, use the example from the linux-yocto recipes and not the custom recipe. (From yocto-docs rev: 4a537a02bbf6fca4ff1a3beddd03d8115099cddd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the LINUX_VERSION variable.Scott Rifenbark2013-01-271-2/+8
| | | | | | | | | | | | | Added a bit about the variable being used to define PV for the recipe. Also, fixed a couple indentation problems with some nearby variables. (From yocto-docs rev: bec65049218c9c549fe8cd4d5c16e9d917e87866) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New glossary entry for SRCPV variable added.Scott Rifenbark2013-01-161-0/+34
| | | | | | | (From yocto-docs rev: 0eba5f7ff3e6801c1f8e41df02276e5524ff03f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New LINUX_VERSION_EXTENSION variable glossary entry.Scott Rifenbark2013-01-161-0/+26
| | | | | | | (From yocto-docs rev: 98a1d57e0bcf018509bb2a167381817b0b6b95d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New LINUX_VERSION glossary entry.Scott Rifenbark2013-01-161-0/+16
| | | | | | | (From yocto-docs rev: daf7bf83049b51ec918af1c49c53502b6488f675) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: ref-manual - Updated LIC_FILES_CHKSUM example.Scott Rifenbark2013-01-071-1/+1
| | | | | | | | | | One of the examples used "startline" instead of "beginline". Correction made. (From yocto-docs rev: 1ed3ae72b0492e03b37dc2c9519cf37209a7034b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Removing three unwanted files.Scott Rifenbark2013-01-073-5283/+0
| | | | | | | (From yocto-docs rev: b9b69da0c1f264388481817e988b5d131a0bb804) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Rename of poky-ref-manual folder to ref-manual.Scott Rifenbark2013-01-07214-0/+26016
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>