summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Review comments applied for patch sessionScott Rifenbark2013-04-133-55/+57
| | | | | | | | | | | | | Paul Eggleton provided quite a series of patches that I previously applied. These changes represent the edits from an interactive review he conducted with me. The series of changes represents his review for the entire set of changes in the original patch series. (From yocto-docs rev: e26f615a01de2b101e97eb6fd7175b813f74295e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide, ref-manual: Spell checks on some chapters.Scott Rifenbark2013-04-133-3/+3
| | | | | | | | | | Performed some spelling checks against the files associated with a large number of patches sent by Paul Eggleton. (From yocto-docs rev: 8b16924aa1da161271cbfce5410344d94c840fa6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "Target Package Management with RMP" section.Scott Rifenbark2013-04-131-0/+15
| | | | | | | | | | New section for the Migration chapter. Reported-by: Paul Eggleton <paul.eggleton@linux.com> (From yocto-docs rev: 34745eec0f30d1ee5e02c1e681d7506a85d78aa9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a link to the SANITY_TESTED_DISTROS variable.Scott Rifenbark2013-04-131-1/+2
| | | | | | | | | Link put in the "Migration" section. (From yocto-docs rev: 43c8fd145737bb504cae6cf24a1553af7ad121b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Added links to the RPROVIDES variable.Scott Rifenbark2013-04-132-2/+2
| | | | | | | (From yocto-docs rev: 96f9e09d977b4b81b956f4742c47a9393f30eae4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a cross-reference link to the RSUGGESTS variable.Scott Rifenbark2013-04-131-1/+1
| | | | | | | (From yocto-docs rev: 6a9a894bdc98acf6d32466927ebc3f1db69aacb6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added two cross-references.Scott Rifenbark2013-04-131-3/+4
| | | | | | | | | | New variables DISTROOVERRIDES and MACHINEOVERRIDES resulted in needing a couple links from the "Mirgration" chapter. (From yocto-docs rev: cd1b7f7c430eddd5953dc1dac1defe968cfde0aa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed section title capitalization.Scott Rifenbark2013-04-131-1/+1
| | | | | | | (From yocto-docs rev: cbbb76a62be7acce5b62e449e09c08b4a18c11d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a cross-link to the INSANE_SKIP variable.Scott Rifenbark2013-04-131-1/+1
| | | | | | | (From yocto-docs rev: 73561644c4fa0aae4217862e8d15a0cb2d874dd1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add STAMPS_DIR and update STAMP entryPaul Eggleton2013-04-131-2/+13
| | | | | | | | | | | | STAMPS_DIR was split out of STAMP recently. Added some specifics about who is doing what. (From yocto-docs rev: dafb13f4b3c4cf40292d43ea53fe9150d4dfc0ee) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add LOG_DIRPaul Eggleton2013-04-131-0/+15
| | | | | | | | | | Added some specifics and a bit of a rewrite. (From yocto-docs rev: 03435b52f9f27729d81d46ec6d87cf73b4bd92cb) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: clarify T definitionPaul Eggleton2013-04-131-4/+6
| | | | | | | | | | | | | | Took out the clause in the parantheses set and replaced with better structure. * Ensure we mention what kind of files go into T * We're talking about recipes here, not packages (From yocto-docs rev: 8783bb7beb10e0fdfca22648f1dff4a85b760cd7) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add SIGGEN_EXCLUDE_SAFE_RECIPE_DEPSPaul Eggleton2013-04-131-0/+28
| | | | | | | | | | Removed some ambiguous text. (From yocto-docs rev: cdf5cf7505af9c2c61e7b7d8a7db61ec0baad254) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add SIGGEN_EXCLUDERECIPES_ABISAFEPaul Eggleton2013-04-131-0/+20
| | | | | | | | | | Broke the long first sentence up. (From yocto-docs rev: bfccfc6401c3e1dd88e7a965f1df1a68801844fa) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add SANITY_TESTED_DISTROS and NATIVELSBSTRINGPaul Eggleton2013-04-131-2/+49
| | | | | | | | | | Tightened up the writing for both entries. (From yocto-docs rev: b6a0679fb74aef4a718e42d20343f5b7ae8e9679) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add SYSROOT_PREPROCESS_FUNCSPaul Eggleton2013-04-131-0/+12
| | | | | | | | | | Added some more specifics for who is doing what. (From yocto-docs rev: 3156a8f3af24cfd21478f2cf29ca9fdac699c0dd) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: correct and extend DEFAULT_PREFERENCE entryPaul Eggleton2013-04-131-1/+21
| | | | | | | | | | Rewrote the description to break it up a bit and flow better. (From yocto-docs rev: 7f0e8cf693b3b0a77537a15f7962f9e0e05fddfa) Signed-off-by: Paul Eggleton <paul.eggleton@linux.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add KERNEL_EXTRA_ARGSPaul Eggleton2013-04-131-0/+10
| | | | | | | | | | Recast the sentence to read better. (From yocto-docs rev: 522f7b2bb8a8f25e5ce1f4397a581c289beae51f) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add MODULE_TARBALL_DEPLOYPaul Eggleton2013-04-131-0/+12
| | | | | | | | | | | Added a consisten introductory sentence before jumping into how to use the variable. (From yocto-docs rev: 3e68a345d233ca2fd60e02290547578001b2fa0c) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-classes: minor typo fixes and clarificationsPaul Eggleton2013-04-131-7/+8
| | | | | | | | | | | Removed a redundant use of "and" and broke the long sentence into two. (From yocto-docs rev: d6087ffaf36a3e3f16a7910c2b065bebaaf20a23) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/technical-details: remove outdated statement on BB_SIGNATURE_HANDLERPaul Eggleton2013-04-131-3/+1
| | | | | | | | | | | | | | Now that BB_SIGNATURE_HANDLER is OEBasicHash in OE-Core (which has already reflected in this section) this statement makes no sense, so drop it. Changed "metadata" to "Metadata" for consistency across the manual. (From yocto-docs rev: 7bdf37f4930a96402344a9b988aee1012b602a77) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: specify the value for INHIBIT_PACKAGE_STRIPPaul Eggleton2013-04-131-1/+1
| | | | | | | | | | This variable must be set to 1 in order to inhibit stripping, so specify this. (From yocto-docs rev: 35c4a025b68857495f252b35bb50288e308dc5c3) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add PROVIDESPaul Eggleton2013-04-131-0/+17
| | | | | | | | | | Tightened up the text. (From yocto-docs rev: 9b697681e0c2c3658c6552ec0c9951fc987c9b10) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add RPROVIDESPaul Eggleton2013-04-132-1/+25
| | | | | | | | | | Added some key words to tighten things up. (From yocto-docs rev: 8da0f8bd5c54c16e62c0f226d7473e32f3fb5928) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add RSUGGESTSPaul Eggleton2013-04-132-1/+20
| | | | | | | | | | A bit of rewriting to tighten things up. (From yocto-docs rev: a2b30eb3fc6b6ef276f5b95aff0ddb7e2e26c8c3) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: correct and extend RREPLACES entryPaul Eggleton2013-04-131-2/+19
| | | | | | | | | | | | The existing definition was sparse and not quite correct. I did some rewriting for active voice and present tense. (From yocto-docs rev: da1eb14573e2050dc03046311d9f2621f5dcc825) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add COMPATIBLE_HOST and touch up COMPATIBLE_MACHINEPaul Eggleton2013-04-131-8/+116
| | | | | | | | | | | | | | | | | | This also necessitated adding HOST_SYS so we can point to it being matched against by COMPATIBLE_HOST; similarly MACHINEOVERRIDES and SOC_FAMILY needed to be added for COMPATIBLE_MACHINE (and while we're at it, let's add DISTROOVERRIDES; however I've drawn the line at OVERRIDES since that ought to be covered by the BitBake manual). Quite a bit of rewriting here to clear up some ambiguity created through article use not specifically associated with subject matter. Also, some recasting to active voice and present tense. (From yocto-docs rev: 4090073899e3dfd0e0e6a17aea8210546f08a942) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add RM_WORK_EXCLUDEPaul Eggleton2013-04-131-0/+12
| | | | | | | | | | | Added quotes around the cross-referenced section title. Cleaned up some passive voice and future tense. (From yocto-docs rev: 4ee5834f8262ced5417a63fa76baa6594138e087) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add IMAGE_LINGUASPaul Eggleton2013-04-131-0/+29
| | | | | | | | | | Re-wrote to be active and in present tense. (From yocto-docs rev: 7fabb25ab15da501ac3aae64a56d41c9cad6bbe7) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: add INSANE_SKIPPaul Eggleton2013-04-131-0/+22
| | | | | | | | | | | | Added quotes around the section head for the cross reference. Made some sentences present tense rather than future tense. Shortened a sentence. (From yocto-docs rev: 77f8a2778e5880928cc79e56636a12a39f25492a) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-classes: add note to insane.bbclass section on INSANE_SKIPPaul Eggleton2013-04-131-0/+19
| | | | | | | | | | | Performed a few edits to clean up some sentences. Broke one long sentence up into two. (From yocto-docs rev: 7641113906e062b751abb5366827fe302ec4a2b9) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-classes: add missing QA checksPaul Eggleton2013-04-131-0/+48
| | | | | | | | | | | | | | | | | | | | | Added proper text formatting and cross-reference links to the variables that exist in the reference glossary. Did a bit of writing to shorten some long sentences and perform general clean up. Add the following missing QA checks to the section on insane.bbclass: * textrel * pkgvarcheck * xorg-driver-abi * libexec * staticdev (From yocto-docs rev: 2857cc20b3b136b17d1d2892e046b2ae7f4b699d) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: fix reference to old netbase versionPaul Eggleton2013-04-131-1/+1
| | | | | | | | | | This was pointing to the old 4.47 file even though the rest of the references in this section used 5.0. (From yocto-docs rev: 42c2a0262b316ac25ad3a413f925e94cabae4553) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/ref-variables: ensure values are quotedPaul Eggleton2013-04-131-2/+2
| | | | | | | | | | Just a couple of examples that didn't use quotes around the value, which is mandatory, so correct these. (From yocto-docs rev: 2903ce2b232536c566bd8c29a8772823b44c19df) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: virtualisation not visualisationPaul Eggleton2013-04-131-1/+1
| | | | | | | (From yocto-docs rev: b142d884656c39d0862dd9fd1cb7e60875dee603) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/faq: clarify that package management is optionalPaul Eggleton2013-04-131-1/+2
| | | | | | | | | | | Fixed the line breaks so new sentences start on a new line. (From yocto-docs rev: 6bb50f51edc44222970db42d7441303d042a2262) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add more undocumented classesPaul Eggleton2013-04-131-0/+8
| | | | | | | (From yocto-docs rev: ac3cfb6ad67fc6963ebe50fa4451297772a1c2e7) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add documentation for rm_work.bbclassPaul Eggleton2013-04-131-1/+36
| | | | | | | | | | | | I rewrote the class description to conform to the existing manual style. Mainly making voice active and breaking up long sentenced. (From yocto-docs rev: e715167e280eb647be52c142f733942dab3f4dfb) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed typo for "&gt;".Scott Rifenbark2013-04-121-1/+1
| | | | | | | (From yocto-docs rev: c7e62bbf4a1d35ed00f6cc0641e2c19606c7e53d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Completed first draft of the new Ptest section.Scott Rifenbark2013-04-121-26/+47
| | | | | | | (From yocto-docs rev: 90fbbc2eb6bc6292432060fbd3e806b809f70148) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: First draft of new Ptest section.Scott Rifenbark2013-04-121-0/+126
| | | | | | | (From yocto-docs rev: 0580709bedec80446e6de5b9c135c3df89e2805f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the FILESEXTRAPATHS variable description.Scott Rifenbark2013-04-121-28/+20
| | | | | | | | | | | | | Fixes YOCTO #3662. Per comments from Paul Eggleton, I updated the description to include best practices of prepending and from using within append files. (From yocto-docs rev: 368055bc046277fe601ff3a64913044be0a15e6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Spell check.Scott Rifenbark2013-04-111-2/+2
| | | | | | | | | Found a couple words that were fat-fingered and fixed them. (From yocto-docs rev: 593fd043f350bbce302c3de7dce0ab4bdbd2f247) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Using a Development Shell" section.Scott Rifenbark2013-04-111-2/+2
| | | | | | | (From yocto-docs rev: b90142103e053636e1fe5e00e43cff8195146f12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Image Development Using Hob" section.Scott Rifenbark2013-04-111-7/+11
| | | | | | | (From yocto-docs rev: 62d5833951780cb5e8c39cc37e43bc30cf151d92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Using a Git Workflow" section.Scott Rifenbark2013-04-111-1/+1
| | | | | | | (From yocto-docs rev: 94358ad29cf92f4094fa5ba336ef9b4ccf3cc81d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Using a Quilt Workflow" section.Scott Rifenbark2013-04-111-2/+2
| | | | | | | (From yocto-docs rev: 392cfbab010858ce0354a41e1e6c2304a3be9287) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed section heading capitalization.Scott Rifenbark2013-04-111-1/+1
| | | | | | | (From yocto-docs rev: 7f948729342eeb55072816ccade3bc9a32646c92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Workflow Using Stand-Alone Cross-Development ↵Scott Rifenbark2013-04-111-1/+2
| | | | | | | | | Toolchains" section. (From yocto-docs rev: ea008dbbb0a6ab14ae3fe44238f60f92d85cecde) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to "Building and Customizing the Image Using Hob" section.Scott Rifenbark2013-04-111-7/+11
| | | | | | | (From yocto-docs rev: bd5fd85a90f4262eda09623fe2398798a4fecfe3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>