summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Review comments applied to 2.7 migration section.Scott Rifenbark2019-05-071-33/+43
| | | | | | | (From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added Fedora 29 to the supported distros list.Scott Rifenbark2019-05-071-0/+1
| | | | | | | (From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "License Value Corrections to migration.Scott Rifenbark2019-05-071-12/+41
| | | | | | | (From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added Eclipse removal for migration section.Scott Rifenbark2019-05-071-0/+11
| | | | | | | (From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Inserted Migration 2.7 section.Scott Rifenbark2019-05-071-0/+224
| | | | | | | (From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed all references to EclipseScott Rifenbark2019-05-073-12/+1
| | | | | | | | | Links updated as needed. (From yocto-docs rev: acd5a75314b023f613be24b7512f991f8455e325) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Removed customization.xsl files for EclipseScott Rifenbark2019-05-071-35/+0
| | | | | | | | | | | The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated BB_GENERATE_MIRROR_TARBALLSScott Rifenbark2019-04-091-4/+12
| | | | | | | | | | | Updated the description to tell the user they can safely clean up the DL_DIR after creating tarballs of the source files from downloaded repos. (From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed DISK_DESCRIPTION variable from glossaryScott Rifenbark2019-03-261-54/+0
| | | | | | | (From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed SRC_URI cut-and-paste error.Filip Jareš2019-03-191-1/+1
| | | | | | | | | | | | The update fixes a copy-paste-and-forget-to-update-everything error in the documentation of the `SRC_URI` entry in the Reference Manual. The `maxdate` paragraph just repeated what is there for the neighboring `mindate` paragraph which was incorrect. (From yocto-docs rev: bbeb096222d42a31adcb358a85f8fe6c4120416a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP Documentation: Updated host package listsScott Rifenbark2019-03-191-39/+4
| | | | | | | | | | | Changes to the lists resulted in the testing and graphics & Eclipse Plug-in lists going away. Also, I added several packages based on some testing requirements to the "Essentials" list. (From yocto-docs rev: cbc9a595bef3dd80f5eef1376e466627248f9fda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.Scott Rifenbark2019-03-191-0/+38
| | | | | | | (From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, poky.ent: Updated essential host packagesScott Rifenbark2019-03-191-27/+0
| | | | | | | | | | | | | | | Fixes [YOCTO #13196] The set of host packages for the testing has been merged into the essential set of packages for all supported distros. I updated the variables defined in "poky.ent" so that these packages are now part of the essentials. I also removed the section on the required packages for testing. (From yocto-docs rev: 9b19661d21a14966eac162ee063fca46d6403323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed DISTRO_FEATURES_LIBC variableScott Rifenbark2019-03-191-2/+4
| | | | | | | | | | | | Took this out of the glossary. After eglibc was merged into glibc, Kconfig support was also dropped so these libc features therefore are not effective anymore and can be removed. (From yocto-docs rev: cfdd02864f004fc48b0353ec0f007ca24b06d29e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Typo found and fixed.Daniel Ammann2019-02-251-1/+1
| | | | | | | (From yocto-docs rev: 8a64478540dcaad5e79d5ef494f9086a3c8a50a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review edits to FILESOVERRIDES variable.Scott Rifenbark2019-02-251-2/+5
| | | | | | | | | | | | | Fixes [YOCTO #13112] Added a reference in the FILESOVERRIDES variable description to the FILESPATH description to see an example of how automatic overrides work. (From yocto-docs rev: e78fc3468de3d9b9935f0e4f4aa4117b6805e631) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to FILESPATH and FILESOVERRIDES.Scott Rifenbark2019-02-161-26/+31
| | | | | | | | | | | | | | | Fixes [YOCTO #13112] Did some paragraph re-ordering based on reviewer feedback. Also, added a bit in the FILESOVERRIDES variable description about out it uses overrides to help with automatic overriding of the FILESPATH variable. Added some better links into the BitBake User Manual as well. (From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed literal formatting in INC_PR variable.Scott Rifenbark2019-02-121-4/+4
| | | | | | | | | No indentation was being used for the example. (From yocto-docs rev: e5d13181546d19772fede972b20518103d897eaa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update default value for PACKAGE_DEBUG_SPLIT_STYLEJoshua Watt2019-02-121-1/+1
| | | | | | | | | The new default is "debug-with-srcpkg" (From yocto-docs rev: b427e7c2d9f6efca7e0867cc8e508d4e941c5a09) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated list of supported distros.Scott Rifenbark2019-02-121-10/+22
| | | | | | | (From yocto-docs rev: 95eadbcc69b83ef92f28098058d62c596d4936cc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update to SDK_VERSION variable.Peter Kjellerstedt2019-01-211-1/+1
| | | | | | | | | Updated the definition to match that of poky.conf. (From yocto-docs rev: 09c73c227c6949ed3f1287ce063aa96967ed2fda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to FILESPATH and IMAGE_FSTYPES variables.Scott Rifenbark2019-01-161-26/+69
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #13112] Fixes [YOCTO #13115] * FILESPATH: Added a detailed example of how to use the variable to set machine-specific configurations. Also, noted the default behavior of using FILESOVERRIDES to automatically extend FILESPATH. Did some rewriting as well. * IMAGE_FSTYPES: Updated the note to not be exclusive to "live" images. The behavior applies to many images. (From yocto-docs rev: 46e3f2545c45ba5391603f9ffa1c87896d472df6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, overview-manual: Fixed BitBake User Manual linksScott Rifenbark2018-12-271-1/+1
| | | | | | | | | | | | | | Some occurrences of links to the BitBake User Manual were using a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual). Using this form causes the mega-manual.sed file to not process the link correctly for the mega-manual. These are subtle errors and have probably existed for some time. I removed the target ID to fix the problem. (From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Document the fifth argument to PACKAGECONFIGPeter Kjellerstedt2018-12-151-4/+8
| | | | | | | (From yocto-docs rev: adb17e3172c829de77d2664c91f7cf4b22c9e5f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add missing whitespace around "=" in a few code examples.Peter Kjellerstedt2018-12-151-6/+5
| | | | | | | (From yocto-docs rev: 0d22771c64d082bf86f5efd85ac9aaeb1c7f3093) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparing for 2.7 release.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to CMake and cmake.bbclass.Scott Rifenbark2018-12-153-7/+14
| | | | | | | | | | | I cleaned up the terminology used for the CMake build system. I provided some meaningful links to a good overview page for CMake. I also built in some cross-referencing as needed. (From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated list of supported Linux Distros:Armin Kuster2018-11-221-15/+18
| | | | | | | | | Updates for the "thud" release. (From yocto-docs rev: ccd2d2c7b062627a3fd1961ab23ee6fff714428a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a note saying WSL is not supported.Scott Rifenbark2018-11-221-0/+8
| | | | | | | | | | Windows Subsystem for Linux (WSL) is not supported with the Yocto Project. (From yocto-docs rev: 0898d7fb7166da91598854f385cd574004098ac3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated image_types.bbclass description.Ming Liu2018-11-221-14/+21
| | | | | | | | | | | | The "image_types" class is now inherited mandatorily in image.bbclass through the variable IMGCLASSES. Users do not have to inherit it in their customized image type bbclass. They also do not have to put it in IMAGE_CLASSES. (From yocto-docs rev: bd391092b216e39dad317dc1aae5c715371766ef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added description for devupstream.bbclassScott Rifenbark2018-11-221-0/+48
| | | | | | | | | | | New section added. Fixes [YOCTO #12732] (From yocto-docs rev: 3d4a1fef8e1809cd7f1dece55790b6ee12dc60b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-references to "Post-Installation Scripts"Scott Rifenbark2018-11-221-1/+11
| | | | | | | | | | | | Two areas in the migration chapter discuss the post-installation behavior when you defer the scripts to after boot. I added a couple references to each of those migration note sections that go into the dev-manual's section. (From yocto-docs rev: eeb09b5fa208499f37be4e5aafcf55db82715fd1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated "Packaging Changes" section for 2.6 migration.Scott Rifenbark2018-11-221-1/+2
| | | | | | | | | | Changed reference to "python-modules" to "python-modules / python3-modules". (From yocto-docs rev: 49d66f928366dda19b6afd1e9ac6431f0f66ab21) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits to the 2.6 migration section.Scott Rifenbark2018-11-221-11/+8
| | | | | | | | | Minor fixes here and there. (From yocto-docs rev: 740b4392bd98a12f188b79ae3ecdc7c3031f9f7d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New 2.6 Migration section complete.Scott Rifenbark2018-11-221-20/+14
| | | | | | | (From yocto-docs rev: 6597ea2d706e3975ff0ffae15cf748ffd7aaed8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new python3 profile-optimization migration topicScott Rifenbark2018-11-221-0/+33
| | | | | | | (From yocto-docs rev: 2d0960d9282ffcb843ed9956a0e49183b22f11f2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated postinstall migration note.Scott Rifenbark2018-11-221-2/+8
| | | | | | | (From yocto-docs rev: fa6582df36d770e7207e4c5201dafe0e64f46a76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the 2.6 migration section.Scott Rifenbark2018-11-221-9/+235
| | | | | | | | | This is the completed first draft. (From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.Scott Rifenbark2018-11-221-59/+53
| | | | | | | | | | | | | | The KERNEL_ARTIFACT_NAME variable is used throughout to set the names of build artifacts. Rather than repeat informaiton about KERNEL_ARTIFACT_NAME in the many variables that use it, I added a new entry for the variable. This also impacted the descriptions of the variables that were repeating information. I updated those variable descriptions as well. (From yocto-docs rev: 5750d30be21e17fe21d89254925dc0e773c08e66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the NOISO and NOHDD references.Scott Rifenbark2018-11-221-8/+0
| | | | | | | (From yocto-docs rev: fdce52a34db29c98140daa05bd9c660a2494dc12) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the NOISO and NOHDD variables.Scott Rifenbark2018-11-221-38/+0
| | | | | | | (From yocto-docs rev: bdb67279cd6707e5b0141ecfbfbc09101d508ef4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added several new sections to the 2.6 migration section.Scott Rifenbark2018-11-221-2/+284
| | | | | | | (From yocto-docs rev: 54703fbde3f7808b9257da883fe8e4769a65fc44) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new artifact naming variables to glossary.Scott Rifenbark2018-11-221-37/+257
| | | | | | | (From yocto-docs rev: ed122fae8ec6e9eb38c196decfc6f5016945f4ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed "post 2.6" to correct wording.Scott Rifenbark2018-11-221-2/+3
| | | | | | | | | | | I changed the wording "post 2.6" to state "2.6 and forward". It was incorrect as the changes are inclusive of YP release 2.6. (From yocto-docs rev: fb3f3db17ea416cd829a291df3933cc3597392b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added KERNEL_IMAGE_NAME descriptionScott Rifenbark2018-11-221-3/+44
| | | | | | | | | | | | | | The KERNEL_IMAGE_NAME variable is new and is effectively a renamed KERNEL_IMAGE_BASE_NAME variable now. I provided a new glossary description for the new variable. I updated the existing KERNEL_IMAGE_BASE_NAME description to note it has changed. We can't just delete the old variable as there are migration notes for previous releases of YP. (From yocto-docs rev: e5a38711342f88ded4368521a70e9d117b6d991c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added GCCVERSION variable description to glossary.Scott Rifenbark2018-11-221-0/+22
| | | | | | | (From yocto-docs rev: 8095f61c0bf0bbfc7fcf83e3f1c080913ed5f17d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated migration section for 2.6Scott Rifenbark2018-11-221-3/+3
| | | | | | | | | Made two minor corrections from reviewer feedback. (From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated 2.6 migration topic "_remove"Scott Rifenbark2018-11-221-0/+9
| | | | | | | | | | Provided more explanation and also a link into the BB manual for a detailed example. (From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added the 2.6 Migration Section.Scott Rifenbark2018-11-221-0/+88
| | | | | | | | | | Provided some new sections on the information for migrating from the 2.5 release to the 2.6 release. (From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated testimage and testsdk class descriptions.Scott Rifenbark2018-11-221-0/+16
| | | | | | | | | | | I added notes indicating that the best practice for automated testing is to inherit these classes by using the IMAGE_CLASSES variable instead of the INHERIT variable. (From yocto-docs rev: 8f4765db897c20f0011ea65f62d6b45495d313d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>