summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* kernel-dev: Scrubbed and fixed all user-supplied input formatting.Scott Rifenbark2014-10-183-22/+23
| | | | | | | | | | | In the manual I was using angled brackets to denote user-supplied input values. This was confusing so I changed to using the <replaceable></replaceable> tag pair. (From yocto-docs rev: dc73a78f11038a1ff04b16867e7513f31f02374b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Scrubbed and fixed user-supplied input formatting.Scott Rifenbark2014-10-183-18/+18
| | | | | | | | | | | Throughout the manual I was using angled brackets to denote user-supplied input. This is confusing so I changed to using the <replaceable></replaceable> tag set. (From yocto-docs rev: 79ec3f1b1330539ab2b3bdfb1c94e58c2d0feead) 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-1813-160/+166
| | | | | | | | | | | | | | | 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: Updated the introductory section list manual overview.Scott Rifenbark2014-10-181-0/+4
| | | | | | | | | Added the new QA Warnings and Messages chapter to the list. (From yocto-docs rev: aab515c793107b7c0b3a8a26f522cf26461fd3d4) 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-182-8/+9
| | | | | | | | | 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 [build-deps] QA error message.Scott Rifenbark2014-10-181-0/+30
| | | | | | | (From yocto-docs rev: 1883450fe2ca823dc258283a76012bf75b38615b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added [file->rdeps] QA error message.Scott Rifenbark2014-10-181-0/+26
| | | | | | | (From yocto-docs rev: d0546876a775c3d632a4a270aaaa8790a1e0535b) 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: 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: 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-183-7/+7
| | | | | | | | | | 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-185-133/+103
| | | | | | | | | | 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, mega-manual: Updated build history figureScott Rifenbark2014-10-182-0/+0
| | | | | | | | | | | | | The figure needed to be updated to reflect that build-id.txt is now part of the tree and not build-id. The publication scheme dictates that figures are kept in individual manuals and in the mega-manual figures directory. (From yocto-docs rev: 0711a3e41c42eb058db25ff2ea7f1c0982e06963) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>