summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Updated all XSL style sheet imports to use 1.76.1 versionScott Rifenbark2015-01-061-1/+1
| | | | | | | | | | | | | This fixes the issue where the lines for the manual revision table are not appearing. For some reason they do not appear when building the docs using Ubuntu 14.10 and the "current" XSL transformation files. So, I backed up to the 1.76.1 version, which is the nearest version where the issue does not surface. (From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update to the BOOT_IMAGE_FILES variable in the glossaryMaciej Borzecki2014-12-191-4/+27
| | | | | | | | | | | | | Update entry for IMAGE_BOOT_FILES with information on glob patterns. (From yocto-docs rev: ad3fc0061e3f4dc3ecc6b0a101685c301c5690e9) Signed-off-by: Maciej Borzecki <maciej.borzecki@open-rnd.pl> Signed-off-by: Maciek Borzecki <maciek.borzecki@gmail.com> Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to some tuning variables in the glossary:Scott Rifenbark2014-12-191-22/+23
| | | | | | | | | | | | | | | | | Fixes [YOCTO #5463] Updated the notes in the TUNE_ASARGS, TUNE_CCARGS, and TUNE_LDARGS to indicate that the BSPs select the tune and then selected tun affects the tun variables themselves. Also combined the TUNE_PKGARCH and the TUNE_PKGARCH_tune variable. We really don't need the TUNE_PKGARCH_tune variable as it is simply the TUNE_PKGARCH variable with the override. (From yocto-docs rev: dabc624272a9bb4cf5e62dee664ba729a9887208) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Created form for context images for variablesScott Rifenbark2014-12-092-427/+436
| | | | | | | | | | | | | | | | Fixes [YOCTO #6158] Updated the style scheet file to format glossary variables in such a way to allow for a PNG file of standard size to be displayed below each variable. Right now, the PNG file is a generic placeholder. Each variable displays a PNG file. Updated each variable to include that PNG file. (From yocto-docs rev: 24b7b847b7093022a49a014395df0c3a8c019331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added XSERVER variable description to the glossary.Scott Rifenbark2014-12-091-3/+27
| | | | | | | (From yocto-docs rev: 9e1551afd4d82197b2c46e76b6f6ea68c1dca886) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added info strings for variables in glossary.Scott Rifenbark2014-12-091-116/+1379
| | | | | | | | | | | | | | | | Fixes [YOCTO #5600] Added a <info></info> tag pair with a short description of the variable to each variable in the glossary. The short description is what will be used in the documentation.conf file. Scripting from engineering will pick up the variable description automatically. The information between the tags does not appear in the HTML or PDF output. (From yocto-docs rev: 57fb9100e377a96c330be20613c5895b25910022) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: WIP - Edits for the speed section.Scott Rifenbark2014-12-091-139/+142
| | | | | | | (From yocto-docs rev: 3a158dbefe32fb1e87718558462c0562077052c8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: WIP - New section on speeding up builds.Scott Rifenbark2014-12-091-0/+139
| | | | | | | | | Fixes [YOCTO #5594] (From yocto-docs rev: e841f3c59f0c272f8a7314b2de20bab6581149cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typo in the PACKAGE_EXTRA_ARCHS variable.Scott Rifenbark2014-11-081-1/+1
| | | | | | | (From yocto-docs rev: 85bd37d28b4394d422a70adec9a01a88ba4b4f21) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables.Scott Rifenbark2014-11-041-0/+5
| | | | | | | | | | Added an entry for the 1.8 release stating that the release is slated for sometime in 2015. (From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the migrating to YP 1.7 section.Scott Rifenbark2014-10-281-56/+88
| | | | | | | | | | Some minor wording changes and a new section added for local.conf QEMU changes. Also, reordered some sections. (From yocto-docs rev: 65207b6afa6df7d82cd3482d61f10b308da6fac7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added some new test variables:Scott Rifenbark2014-10-281-0/+68
| | | | | | | | | | | | * TEST_SERIALCONTROL_CMD * TEST_SERIALCONTROL_EXTRA_ARGS * TEST_POWERCONTROL_CMD * TEST_POWERCONTROL_EXTRA_ARGS (From yocto-docs rev: 25f196cc03178f07201ef183fb309721d412e971) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated list of supported distros.Scott Rifenbark2014-10-281-0/+2
| | | | | | | | | Added Debian 7.5 and 7.6 to the list. (From yocto-docs rev: 35fd5d5399fe1759158aef19d7b6eb68f2a1af12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to variables.Scott Rifenbark2014-10-231-1/+1
| | | | | | | | | | Applied the third set of review comments from Paul Eggleton to some variables. (From yocto-docs rev: 2be5bc26a6fda1922ee73a874522180633d33b98) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Cleaned up wording in glossary for "inheriting"Scott Rifenbark2014-10-231-44/+58
| | | | | | | | | | For consistency, I changed the introductory sentence to the variables that function when inherited. (From yocto-docs rev: 6ba4fe635c45abf7692f4be0a09ede89a89ec9fa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits for new classes and variables.Scott Rifenbark2014-10-232-38/+80
| | | | | | | | | | 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-212-3/+115
| | | | | | | | | | | | | | 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-212-0/+37
| | | | | | | | | | | 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-212-0/+27
| | | | | | | (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-212-0/+29
| | | | | | | (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-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-182-5/+6
| | | | | | | | | | 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-184-119/+73
| | | | | | | | | | 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-181-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>
* 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-102-40/+44
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-031-1/+1
| | | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-21 03:54:19 +0000