summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: Added new migration section for the 1.7 release.Scott Rifenbark2014-10-181-0/+298
| | | | | | | (From yocto-docs rev: 5b06b29f7f9e53db7b885795c2e11e1eccfc98df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the build history section for build-id.txtScott Rifenbark2014-10-181-2/+4
| | | | | | | | | | | This file is what is written now rather than build-id. I changed the file name and noted that it also contains the full build header information as written out by BitBake during the build. (From yocto-docs rev: 7e55b4b5f9e27f6ac5d8f1eab4923bf1b8a712c6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the list of linux-yocto kernelsScott Rifenbark2014-10-181-3/+3
| | | | | | | | | | | I removed the linux-yocto 3.4 kernel from the list in the section describing which kernels we support. Also, added the 3.17 linux-yocto kernel to the list. (From yocto-docs rev: 41f57a9abe1201ed2fb657f8441c97f86f75200a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-reference.Scott Rifenbark2014-10-181-1/+1
| | | | | | | (From yocto-docs rev: f64cc93d364a04c51f2c685fffad7a124349474a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the module_autoload variable.Scott Rifenbark2014-10-181-38/+8
| | | | | | | | | | | This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. I updated the description to note that and to provide a cross-reference to the new variable. (From yocto-docs rev: 8b2f464f7d100db1c585ccc62d7cab89f7f7b164) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new KERNEL_MODULE_AUTOLOAD variable.Scott Rifenbark2014-10-181-0/+50
| | | | | | | | | Added this description to the variables glossary. (From yocto-docs rev: 3da322f92d5028e96422e0c1f5df78b285f2355e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new KERNEL_MODULE_PROBECONF variableScott Rifenbark2014-10-181-0/+59
| | | | | | | | | Added this new variable to the variable glossary. (From yocto-docs rev: d2d75631777f6cef3472bde428ed65419c99457e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated module_conf variableScott Rifenbark2014-10-181-6/+13
| | | | | | | | | | | | | This description was a bit confusing with the way the general syntax was described so I re-wrote it a bit. Also, added the requirement that if you use module_conf for a given <modname>, then you must also include the <modname> as part of the new KERNEL_MODULE_PROBECONF variable. (From yocto-docs rev: 15b7819a0d9946ad6565576a6f28897e2dd724f9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, template: Permalinks for QA errors and warningsScott Rifenbark2014-10-103-40/+67
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Updated the ref-qa-checks.xml chapter so that each QA warning or error message would generate a permalink that is suitable for searching from the poky codebase. To implement this, I had to embed an id marker in the <para> tag that precedes each <code></code> tag pair. The 'xxx' string of the id is the leaf portion of the permalink. This creates the following tag construct: <para id='xxx'> <code> some-warning-or-error-message </code> </para> The permalink is generated with the help of the new qa-code-permalinks.xsl file, which triggers on the <para><code></code></para> construct. This new file resides in documentation/template. Right now, this construct is unique to the ref-manual's chapter on the QA error and warnings chapter only. However, if for some reason that construct is used in any other part of the ref-manual, a generically numbered permalink would also be generated. The ref-manual-customization.xsl file was also altered to include the new documentation/template/qa-code-permalinks.xsl file. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: aec27a9f8337575d31bfe0066563da99259046e0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed grammar use in "Image Features" list.Scott Rifenbark2014-10-101-1/+1
| | | | | | | (From yocto-docs rev: eb4ff8e1345987391e735f088d685ec70e641ed1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date for manual rev tables.Scott Rifenbark2014-10-036-6/+6
| | | | | | | | | | Added "October 2014" to table for all manuals that have the table. (From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "Image Features" section.Scott Rifenbark2014-10-031-54/+52
| | | | | | | | | | Reversed order of the list presentation and re-worded the static library sentence. (From yocto-docs rev: 5c32730550629527f6ceb2140df31a097f7a6081) 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 Features" section layoutScott Rifenbark2014-09-301-62/+56
| | | | | | | | | | | | I updated the section to have two lists of features. One list is for features that work only when you inherit the core-image class. The other list is for features that are available for all images regargless of inheriting this class. (From yocto-docs rev: 9d1bcab2a9264e64db2dec66247aaf55493ae362) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed "debug-tweaks" typo.Scott Rifenbark2014-09-301-2/+2
| | | | | | | (From yocto-docs rev: d8b8005cc8e24b08db74961aa28e33b746d3acd1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the "Image Features" section.Scott Rifenbark2014-09-301-48/+115
| | | | | | | | | | | | | The list of features in the section was out of sync with the list of features shown in the comments of the core-image class. Additionally, four of the features are available to all images regardless of whether or not the core-image class is inherited. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: e4821fd0a63e906da8b1ff015fb4970e5e62d667) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated list of Machine Features shipped with YP.Scott Rifenbark2014-09-301-0/+12
| | | | | | | | | | | | | | | | | Added the following: efi pcbios phone qvga rtc vfat Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: b3fe96df8552921cb6494a72d721fa6b41a70a3b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_BOOT_FILES variable.Scott Rifenbark2014-09-301-1/+1
| | | | | | | | | This is a space-separated list and not a comma-separated list. (From yocto-docs rev: 23cf09ac128289e878bbc056e28060008ab5217c) 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 the IMAGE_BOOT_FILES variable description.Scott Rifenbark2014-09-301-8/+10
| | | | | | | | | Corrected some wording and also the first example. (From yocto-docs rev: d641cdbf697b14d8122b3a018b06eed3437011ad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the supported BSP bullet item.Scott Rifenbark2014-09-301-18/+16
| | | | | | | | | | The bulleted item on supported BSPs was very centric on meta-intel. I rewrote the section to not be so exclusive. (From yocto-docs rev: d8118bb6124fbbb2340ae8720cd6187fd5546967) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document IMAGE_BOOT_FILESMaciej Borzecki2014-09-231-0/+18
| | | | | | | | | | Document IMAGE_BOOT_FILES variable. (From yocto-docs rev: f0b5cbcde4b83911780ab525f279dcb527fb1839) Signed-off-by: Maciej Borzecki <maciej.borzecki@open-rnd.pl> Signed-off-by: Maciek Borzecki <maciek.borzecki@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added reference to the meta-selinux layer.Scott Rifenbark2014-09-231-0/+3
| | | | | | | | | | | | Fixes [YOCTO #5482] Added a cross-reference to the meta-selinux layer in the section that describes how to make images more secure. (From yocto-docs rev: 0c96273ee857808046c5a76517c1eda4aa703c81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added a note to the EXTERNALSRC example about the classScott Rifenbark2014-09-221-0/+6
| | | | | | | | | | | Added a short note after the example that shows how to set up the EXTERNALSRC variables stating that the externalsrc class needs to be either globally or locally inherited. (From yocto-docs rev: db935135c0b060e06f6a63530df995d286002598) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed typo in the make races section header.Scott Rifenbark2014-09-221-1/+1
| | | | | | | (From yocto-docs rev: 26ffb2e47f3caa8a0ab0f2a9cd83af8cdf893cfd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added a second EXTERNALSRC example.Scott Rifenbark2014-09-221-0/+10
| | | | | | | | | | Added a new example on how to set this from the recipe or the recipe's bbappend file. (From yocto-docs rev: bc0d9de3378f3462729301e74419b7dede17558b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated another EXTERNALSRC example.Scott Rifenbark2014-09-221-1/+1
| | | | | | | | | | Found another occurrance of where I needed to add a <replaceable> tag set in an example. (From yocto-docs rev: 586e5a590bb5382a28fde4670fdcd6cbb75f6c32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated EXTERNALSRC example for user-input formatting.Scott Rifenbark2014-09-221-1/+1
| | | | | | | | | | I missed a <replaceable> tag set on the example. Adding it clears up confusion for how to use the variable. (From yocto-docs rev: 8bbf2a012e580d82aaf9c9a98ad5dab1aea64f7b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated RRECOMMENDS variable description.Scott Rifenbark2014-09-221-15/+24
| | | | | | | | | | | | There was confusion about how this actually worked when you do not create a package for a package listed with the variable. Cases for when the build would throw an error or not had to be clarified. (From yocto-docs rev: 02f95339322afe53db816b3b73234490d835b1ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Updated the "tbd" name to "dizzy" for 1.7.Scott Rifenbark2014-09-221-1/+1
| | | | | | | (From yocto-docs rev: 2847ef41d708bff81838a945b3b1057d7ac6e929) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new INHIBIT_PACKAGE_DEBUG_SPLIT variable to glossary.Scott Rifenbark2014-09-221-0/+28
| | | | | | | (From yocto-docs rev: 72a24adb61038536d665f139d4c0f381814b198b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Minor edits from a read-thruScott Rifenbark2014-09-221-28/+31
| | | | | | | | | | | | | | | | * Added some text associated with the screencast we link to that calls out the fact that the screencast is somewhat dated but still useful. * Replaced all user input in examples so that they are formatted using the <replaceable></replaceable> tags. * Fixed a few places so that they use better and clearer wording. (From yocto-docs rev: f99536a7581ef9b8b57a446b65e4ebb902b4e4b1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added some formatting for user-supplied input.Scott Rifenbark2014-09-221-4/+4
| | | | | | | (From yocto-docs rev: 0b586d27a647d7afcaff0623919dff33a9206632) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: General edits to "Common Tasks" chapter.Scott Rifenbark2014-09-221-152/+182
| | | | | | | | | | | | * Found and fixed several areas with issues. * Scrubbed for user-supplied input to make it use the <replaceable></replaceable> tags. (From yocto-docs rev: 0e1c7ad31921ee7d4ee0d7d4ece01303a25a5d60) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits for GDB without sourceScott Rifenbark2014-09-221-2/+12
| | | | | | | | | | | Fixes [YOCTO #6621] Applied a few review edits for this fix. (From yocto-docs rev: 99511bbcfa1de2f7bf691da1a002913f3a7f6034) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added GLIBC_GENERATE_LOCALES variable.Scott Rifenbark2014-09-221-1/+29
| | | | | | | | | | | | | | Fixes [YOCTO #6629] Added a new variable description to the glossary and also updated the IMAGE_LINGUAS entry to have a back-reference to the new variable. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 219097735c57a3dc10195511dd5b199e73b8a094) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added PACKAGE_DEBUG_SPLIT_STYLE variable.Scott Rifenbark2014-09-221-0/+56
| | | | | | | | | | | | | Fixes [YOCTO #6621] This is a new variable that helps control how debug symbols and source files are split off when creating -dbg files for use with GDB. (From yocto-docs rev: 506b79707f6aec7c14f1f9d7e5099d20fca45c0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, ref-manual: Added 'socat' package to essentials.Scott Rifenbark2014-08-121-4/+4
| | | | | | | | | For firewall performance. (From yocto-docs rev: a866449b4caf1c0cee4ce00ec7d8fa2119a0b481) 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>
* dev-manual: Misc edits to the model chapter (Chapter 4).Scott Rifenbark2014-08-121-15/+33
| | | | | | | | | | | | | | I replaced user-supplied variables with <replaceable></replaceable> tags to get proper formatting. I inserted several references to the new QEMU chapter for help using QEMU. I updated a note on the BSP available so that it is a bit more generic and not so dependent on an exact list within meta-intel and the source repositories. (From yocto-docs rev: daef4406e7c3e45dd5d98d565e519d91939f6965) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Various small edits to Chapter 3.Scott Rifenbark2014-08-121-7/+7
| | | | | | | | | | Replaced angled bracket items for user-supplied variables with the <replaceable></replaceable> tags. (From yocto-docs rev: 393af6c0cfbfc0f3921bc1eb1fdbd3dd734f51ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, mega-manual: Updated the downloads picture.Scott Rifenbark2014-08-122-0/+0
| | | | | | | (From yocto-docs rev: 67c71f5a51749e4f15987ce7cb3ae8f22436bb93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Misc edits to Chapter 2.Scott Rifenbark2014-08-121-3/+8
| | | | | | | | | Added some links and fixed up some replaceable items. (From yocto-docs rev: 5c9ce934f13c68c2efbd952f399a8b88e87eb761) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added Toaster to the list of other resources.Scott Rifenbark2014-08-121-0/+6
| | | | | | | (From yocto-docs rev: 14652c5aeb7ae54d079f6360c1fa650638f280ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated section on launching remote GDB.Scott Rifenbark2014-08-121-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #6620] I altered the path name of the .gdbinit file in the text to prepend ~/ to it to reinforce what file the user must modify. I also removed the /home/jzhang string in favor of ~ to make it more general. (From yocto-docs rev: ff09d3a5666c97598adf385f63dee4b30b0f1792) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Applied the <replaceable> tag as needed.Scott Rifenbark2014-08-121-40/+40
| | | | | | | (From yocto-docs rev: 6f8f374f3f7f70082c7bc45c1715324214dc2099) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a couple links and made some minor corrections.Robert P. J. Day2014-08-121-3/+5
| | | | | | | | | | | | I'm guessing that the OE wiki page for bitbake is the closest thing there is to an "official" bitbake web page, so i'll just use that as a replacement for all berlios.de links i run across, unless someone has a better suggestion. (From yocto-docs rev: 36bafb65e96752631d71afca86dcebda6ba1a876) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits for clarity.Robert P. J. Day2014-08-121-3/+6
| | | | | | | (From yocto-docs rev: 79025b3cb5e3af25d960f0fc9f2266a8dcb3fd12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated "Images" chapter to remove listed dirs for recipes.Scott Rifenbark2014-08-121-134/+130
| | | | | | | | | | | | | This list has grown substantially and it is impractical to list the directories that contain image recipes out. I left the "ls" command that the use could run in order to see those directories. This makes the section of the manual much more maintainable. (From yocto-docs rev: ee129f578dfa986937b45b111e0e26b61b42c565) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Ordered images alphabetically.Scott Rifenbark2014-08-121-50/+50
| | | | | | | | | | The image list has grown to where it probably could use some structure. I ordered the list by alphabet. (From yocto-docs rev: 4ee03974d9a58d2b49af3ae4cafe9ac181627c86) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "core-image-testmaster-initramfs" imageScott Rifenbark2014-08-121-0/+4
| | | | | | | | | | Added this image to the list of images in the "Image" chapter. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 29161a98f2bacc6fac77fcb11c2bfe1c905167f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>