summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
AgeCommit message (Collapse)Author
2019-10-23Documenation: Prepared for the 2.7.2 releaseScott Rifenbark
Entails all the cover pages for the release date. Used November 2019 for now. Updated poky.ent and the mega-manual.sed file. Good to go. (From yocto-docs rev: f7bf30b96ba7feaf33df544162a713204520b389) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual, dev-manual: Added CMake toolchain files.Scott Rifenbark
Fixes [YOCTO #12760] Updated the cmake.bbclass description to tell what directory to insall custom CMake toolchain files into. Also, updated the two areas in the "Writing a New Recipe" section that mention CMake. Placed a couple notes there concerning the same directory stuff. (From yocto-docs rev: cacdedf4e1186a96ce00f94e0f42817dfb724ac7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: Updated the BUSYBOX_SPLIT_SUID variable.Scott Rifenbark
Fixes [YOCTO #13596] (From yocto-docs rev: e6c9e9511221d47397e97e26d9f7002d4b918dce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: Removed deprecated link to ref-classes-bluetoothScott Rifenbark
This was in a moving to YP version 1.8 migration section. (From yocto-docs rev: 76e63455276aff8a03c00e2fd12c728c5aeb6e2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06ref-manual: Updates to "Building Your Recipe"Scott Rifenbark
(From yocto-docs rev: aa68a20154dca8541dfbff8c5694c35bdbf51037) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06ref-manual: Updated the "AS" variableScott Rifenbark
(From yocto-docs rev: f41496026f55de8d530b203024c52cffd27f2a2b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18ref-manual: Fixed typo for BBMULTICONFIG variable.Scott Rifenbark
There was a typo in the BBMULTICONFIG variable description. It appeared as "BBMULTIFONFIG". I fixed it. (From yocto-docs rev: 3e00ab7a7b16f3aba5bf78e015b9073d2a79698a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18Documentation: Prepared for 2.7.1 releaseScott Rifenbark
* Updated all variables in poky.ent * Updated all *.xml files for manual history * Updated the mega-manual.sed file for 2.7.1 (From yocto-docs rev: 7e20c42cbcdab63e02eab4ad316385d18b7beb68) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Updated "npm.bbclass" section.Scott Rifenbark
I provided a general link to the wiki on npm software. Also, updated the section to point to the new section on how to create NPM packages, which is in the dev-manual. (From yocto-docs rev: 23d1cef7323b1b7ada7a7c8378a42db18b82626e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Grammar correctionScott Rifenbark
I left out the word "not" in a key sentence in the new "Checking on the Upgrade Status of a Recipe" section. Little words can make big differences. (From yocto-docs rev: 2f3995a07eba7e3e3b66aa60bfffcdf9c50077b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Updates to check-recipe-upgrade devtool commandScott Rifenbark
I updated the section to include more detail on what the user sees in the returned table. (From yocto-docs rev: 34b801d6fa61290be51e589c4cc759b59620edf1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: do_checkpkg - added link to checking upgrade statusScott Rifenbark
I show the "devtool check-upgrade-status" command as part of the "do_checkpkg" task section. I added a cross-reference link to the "Checking on the Upgrade Status of a Recipe" section in the ref-manual. (From yocto-docs rev: d1bc8b9c3bb6d40fb8401e93b46088e965e2d956) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: New section "Checking Upgrade Status of a Recipe"Scott Rifenbark
I added a new section showcasing the "devtool check-upgrade-status" command. Also, added a note in the "Upgrading a Recipe" section" to tell the reader they might want to check on a recipe's upgrade status before upgrading a recipe. (From yocto-docs rev: ca091498a274b9a7a44b0d6d5ee826c1d2bd6a3c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Udated devtool help output examples.Scott Rifenbark
Specifically missing was the "devtool check-upgrade-status" command. (From yocto-docs rev: 1b6e87598e246806af7908e7d2e17ad579868aa9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Removed "distutils-tools" class.Scott Rifenbark
This class was removed for 2.7 and I took the reference section out of the class area. (From yocto-docs rev: b2afcc27571e36c9646755013e2e1e4be56b7268) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Removed bugzilla.bbclassScott Rifenbark
The migration section noted this class as becoming obsolete. I removed it from the class reference section. (From yocto-docs rev: 2f1040b1e079eb9f661cc643326bd03514747e07) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18dev-manual, ref-manual: removed "distrodata" classScott Rifenbark
Ousted these since it was noted in the migration section that the class had been removed. Modified all references to the removed class as needed. (From yocto-docs rev: ab63a38340fbbcffb8e02b0cb925c637615f884c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Updated the "Container Layer" term.Scott Rifenbark
I removed the incorrect "meta-intel" layer for the example and replaced it with the better "meta-openembedded" layer. Reported by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 7a819f3d49be651e345661a12b7d97dc25439851) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Review comments applied to 2.7 migration section.Scott Rifenbark
(From yocto-docs rev: ab4f9a0b882b04976a10dcf6d383188a5c240667) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Added Fedora 29 to the supported distros list.Scott Rifenbark
(From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Added "License Value Corrections to migration.Scott Rifenbark
(From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Added Eclipse removal for migration section.Scott Rifenbark
(From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Inserted Migration 2.7 section.Scott Rifenbark
(From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Removed all references to EclipseScott Rifenbark
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>
2019-06-18Documentation: Removed customization.xsl files for EclipseScott Rifenbark
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>
2019-04-09ref-manual: Updated BB_GENERATE_MIRROR_TARBALLSScott Rifenbark
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>
2019-03-26ref-manual: Removed DISK_DESCRIPTION variable from glossaryScott Rifenbark
(From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19ref-manual: Fixed SRC_URI cut-and-paste error.Filip Jareš
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>
2019-03-19YP Documentation: Updated host package listsScott Rifenbark
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>
2019-03-19ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.Scott Rifenbark
(From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19ref-manual, poky.ent: Updated essential host packagesScott Rifenbark
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>
2019-03-19ref-manual: Removed DISTRO_FEATURES_LIBC variableScott Rifenbark
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>
2019-02-25ref-manual: Typo found and fixed.Daniel Ammann
(From yocto-docs rev: 8a64478540dcaad5e79d5ef494f9086a3c8a50a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25ref-manual: Review edits to FILESOVERRIDES variable.Scott Rifenbark
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>
2019-02-16ref-manual: Updates to FILESPATH and FILESOVERRIDES.Scott Rifenbark
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>
2019-02-12ref-manual: Fixed literal formatting in INC_PR variable.Scott Rifenbark
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>
2019-02-12ref-manual: Update default value for PACKAGE_DEBUG_SPLIT_STYLEJoshua Watt
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>
2019-02-12ref-manual: Updated list of supported distros.Scott Rifenbark
(From yocto-docs rev: 95eadbcc69b83ef92f28098058d62c596d4936cc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-01-21ref-manual: Update to SDK_VERSION variable.Peter Kjellerstedt
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>
2019-01-16ref-manual: Updates to FILESPATH and IMAGE_FSTYPES variables.Scott Rifenbark
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>
2018-12-27ref-manual, overview-manual: Fixed BitBake User Manual linksScott Rifenbark
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>
2018-12-15ref-manual: Document the fifth argument to PACKAGECONFIGPeter Kjellerstedt
(From yocto-docs rev: adb17e3172c829de77d2664c91f7cf4b22c9e5f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15ref-manual: Add missing whitespace around "=" in a few code examples.Peter Kjellerstedt
(From yocto-docs rev: 0d22771c64d082bf86f5efd85ac9aaeb1c7f3093) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-15documentation: Preparing for 2.7 release.Scott Rifenbark
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>
2018-12-15ref-manual: Updates to CMake and cmake.bbclass.Scott Rifenbark
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>
2018-11-22ref-manual: Updated list of supported Linux Distros:Armin Kuster
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>
2018-11-22ref-manual: Added a note saying WSL is not supported.Scott Rifenbark
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>
2018-11-22ref-manual: Updated image_types.bbclass description.Ming Liu
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>
2018-11-22ref-manual: Added description for devupstream.bbclassScott Rifenbark
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>
2018-11-22ref-manual: Added cross-references to "Post-Installation Scripts"Scott Rifenbark
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>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-18 05:17:35 +0000