summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2014-12-09mega-manual.sed: Updated strings to support a 1.7.1 release.Scott Rifenbark
This processes the links in the mega-manual.html file such that they remain inside the manual and do not go outside to individual manuals. (From yocto-docs rev: 29a30b9ace435ad0c6260e026033ac1a86314d73) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09poky.ent: Updated various variables to support the 1.7.1 release.Scott Rifenbark
I hit all the variables needed to reflect all combinations of 1.7.1. Additionally, incremented the copyright top-end year from 2014 to 2015 since this is a January 2015 release. (From yocto-docs rev: 25c9a6c0a7113f67ec40307d567ac5a16f3db85b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09documentation: Updated manual tables for a 1.7.1 date.Scott Rifenbark
Using January of 2015 (From yocto-docs rev: 0ff05cf9735a8e93a320b97800a4958a3fff9866) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09dev-manual: Added link to ptest wiki page into Ptest section.Scott Rifenbark
(From yocto-docs rev: 8ee7d8073056dfacc3afcce1eec8c79abd07881f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bsp-guide: Fixed ambiguous sentence.Scott Rifenbark
In the example that creates a new BSP layer by using the yocto-bsp script, the final step 6 could be interpreted as the script creating the new layer in "poky". Even though the sentence is technically correct, sloppy reading could mis-interpret it. I updated the sentence so that nobody will be confused. (From yocto-docs rev: b0d8703ed938152e7bbc61cc1308f75ed5af4a20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09profile-manual: Updates to the LTTng Documentation section.Scott Rifenbark
The LTTng Documentation website has been updated to actually have extensive documentation now. Previously, in the profile-manual, we were stating that documentation did not exist, which was true at the time of writing. I updated the section to link to the main LTTng documentation website and altered some other text in the section appropriately. Additionally, I found and corrected a couple spelling errors in this chapter. (From yocto-docs rev: aa6712376cdf958683d70acfba632a686617ed63) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09dev-manual: Fixed broken link to the allarch class.Scott Rifenbark
(From yocto-docs rev: ec4ec548840ef863403115ebb3271362a91f5b04) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09poky.ent: Updated the YOCTO_RELEASE_NOTES variable to new form.Scott Rifenbark
This variable now needs to have the form "&YOCTO_HOME_URL;/downloads/core/&DISTRO_NAME;&DISTRO_COMPRESSED;" The old form was causing the release team to have to hand-redirect the three links in the YP manuals that resolve to the release notes. (From yocto-docs rev: 55d500cbc8cf98c51416efdcdd8a2384f4ec1ea3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09poky.ent: post release fix of the POKYVERSION_COMPRESSED variable.Scott Rifenbark
Missed this one and it is used to resolve the YOCTO_RELEASE_NOTES URL in the dev-manual and the ref-manual. The value was left at "1100" when it should have been "1200". I changed it post-release. This means that the tarball is bad but the HTML versions published on the server are correct for dizzy. (From yocto-docs rev: dc7918d39271691fb2ce5441fba162a783814983) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-28ref-manual: Updates to the migrating to YP 1.7 section.yocto-1.7dizzy-12.0.0Scott Rifenbark
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>
2014-10-28dev-manual: Updates to "Performing Automated Runtime Testing"Scott Rifenbark
Updated the section to account for some new variables and several more ways to run tests against expanded targets. Also added power control section. (From yocto-docs rev: a0f08466c00ae51a99d790fa6c9dccef2e0f1518) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-28ref-manual: Added some new test variables:Scott Rifenbark
* 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>
2014-10-28ref-manual: Updated list of supported distros.Scott Rifenbark
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>
2014-10-23ref-manual: Minor edits to variables.Scott Rifenbark
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>
2014-10-23ref-manual: Cleaned up wording in glossary for "inheriting"Scott Rifenbark
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>
2014-10-23ref-manual: Applied review edits for new classes and variables.Scott Rifenbark
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>
2014-10-21ref-manual: Added new uninative class.Scott Rifenbark
(From yocto-docs rev: b227b6a636b0ca194e3f7a4521659304596303e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added gummiboot class and four supporting variables.Scott Rifenbark
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>
2014-10-21ref-manual: Added copyleft_filter class description.Scott Rifenbark
(From yocto-docs rev: 2259f448cf1d102cbf06ad371e90c439812038cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added texinfo class and two new variables.Scott Rifenbark
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>
2014-10-21ref-manual: Added buildstats-summary.bbclass section.Scott Rifenbark
(From yocto-docs rev: 2eb52ec085e1add723548112390d2983b5a6b77e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added BINCONFIG variable and binconfig-disabled class.Scott Rifenbark
(From yocto-docs rev: 16e0176db9927296f721c25792d87b2495b5405b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-21ref-manual: Added ptest-gnome.bbclass section.Scott Rifenbark
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>
2014-10-21ref-manual: Added compress_doc class and DOC_COMPRESS variable.Scott Rifenbark
(From yocto-docs rev: 875b6eb2e01b1bb9b4c8ed3c80553c1d0870cf78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Updated the populate_sdk_* classScott Rifenbark
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>
2014-10-18profile-manual: Scrubbed and fixed user-input formatting.Scott Rifenbark
There was a single occurrance of this that used angled brackets to denote the target (e.g. <target>). I replaced the formatting with the <replaceable></replaceable> tags for consistency. (From yocto-docs rev: 4e013136c27d68f89854e78cbf354583d51aa2a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18kernel-dev: Scrubbed and fixed all user-supplied input formatting.Scott Rifenbark
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>
2014-10-18adt-manual: Scrubbed and fixed user-supplied input formatting.Scott Rifenbark
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>
2014-10-18ref-manual: Scrubbed for variable (user) input.Scott Rifenbark
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>
2014-10-18ref-manual: Updated the introductory section list manual overview.Scott Rifenbark
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>
2014-10-18ref-manual: Minor edits for review on new QA checks.Scott Rifenbark
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>
2014-10-18ref-manual: Added [build-deps] QA error message.Scott Rifenbark
(From yocto-docs rev: 1883450fe2ca823dc258283a76012bf75b38615b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added [file->rdeps] QA error message.Scott Rifenbark
(From yocto-docs rev: d0546876a775c3d632a4a270aaaa8790a1e0535b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added new build-deps QA check to insane.bbclass.Scott Rifenbark
(From yocto-docs rev: fe8862304f1f78bda924dc5c46cb22f876373875) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added file-redeps QA check to the insane.bbclass.Scott Rifenbark
(From yocto-docs rev: 85a0cec2a36889485f1bd010a85e0115303409a0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Added new do_package_qa task entry to tasks chapter.Scott Rifenbark
(From yocto-docs rev: 7b95f578061777bc54c9b3d622db53b4745fd003) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Another change to the autotools class.Scott Rifenbark
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>
2014-10-18ref-manual: Updated the autotools class.Scott Rifenbark
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>
2014-10-18dev-manual, ref-manual: Updated 1.7 migration section with review commentsScott Rifenbark
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>
2014-10-18ref-manual, dev-manual: Applied migration review edits.Scott Rifenbark
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>
2014-10-18ref-manual, mega-manual: Updated build history figureScott Rifenbark
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>
2014-10-18ref-manual: Added new migration section for the 1.7 release.Scott Rifenbark
(From yocto-docs rev: 5b06b29f7f9e53db7b885795c2e11e1eccfc98df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Updated the build history section for build-id.txtScott Rifenbark
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>
2014-10-18dev-manual: Updated the list of linux-yocto kernelsScott Rifenbark
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>
2014-10-18ref-manual: Added cross-reference.Scott Rifenbark
(From yocto-docs rev: f64cc93d364a04c51f2c685fffad7a124349474a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Updated the module_autoload variable.Scott Rifenbark
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>
2014-10-18ref-manual: Added new KERNEL_MODULE_AUTOLOAD variable.Scott Rifenbark
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>
2014-10-18ref-manual: Added new KERNEL_MODULE_PROBECONF variableScott Rifenbark
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>
2014-10-18ref-manual: Updated module_conf variableScott Rifenbark
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>
2014-10-10ref-manual, template: Permalinks for QA errors and warningsScott Rifenbark
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>