summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* 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-193-45/+11
| | | | | | | | | | | 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-192-31/+7
| | | | | | | | | | | | | | | 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>
* overview-manual, mega-manual: Updated Package Feeds diagramScott Rifenbark2019-02-252-0/+0
| | | | | | | | | | The diagram had a typo in it ".ipd" rather than ".ipk". Fixed and dropped in the figures folder for each manual. (From yocto-docs rev: d39d196713a68df8d298f6ed0f40899bc148a323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated section on running menuconfigScott Rifenbark2019-02-251-9/+27
| | | | | | | | | | | | | Fixes [YOCTO #13146] I added some information to the "Using menuconfig" section to indicate two host packages that must be installed in order for menuconfig to run. (From yocto-docs rev: 4f5b12ebe8f8c0ab23001b8fc770295dc585429c) 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>
* dev-manual: Updated clone and checkout example.Scott Rifenbark2019-02-251-10/+15
| | | | | | | | | | Needed to have a predictive number of tags and branches in the example commands that assume a released 2.7 version. (From yocto-docs rev: b9f302cf819dbe759b560f4586edaedfae13e3d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated tag list in example.Scott Rifenbark2019-02-251-5/+7
| | | | | | | (From yocto-docs rev: 93fabeb457ba98dc3a328a5951b82f5419276c8f) 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>
* dev-manual: Grammar fix.Scott Rifenbark2019-02-121-1/+1
| | | | | | | (From yocto-docs rev: 49e54aee94bc0972142efd1ba72eb1d9431c86c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed typo.Brian Silverman2019-02-121-1/+1
| | | | | | | | | "eSDSK" -> "eSDK" (From yocto-docs rev: 5ececa4362e0400e01327dbe4ce25202f2c392ce) 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>
* dev-manual: Added some clarification for nographic qemu option.Scott Rifenbark2019-01-161-0/+3
| | | | | | | (From yocto-docs rev: ff3d2ed0878d511f48007f5df468ae04e95109eb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Remove True option to getVar callsAndré Draszik2019-01-161-6/+6
| | | | | | | | | | | | | | | | | | | | | getVar() has been defaulting to expanding by default for a long time (2016), thus remove the True option from getVar() examples with a regex search and replace. Search & replace made using the following command: sed -e 's|\(d\.getVar \?\)( \?\([^,()]*\), \?True)|\1(\2)|g' \ -i $(git grep -E 'getVar ?\( ?([^,()]*), ?True\)' \ | cut -d':' -f1 \ | sort -u) Note that there are are several other examples of getVar() usage which already don't explicitly add the True option, this patch just align some stray remainders. (From yocto-docs rev: 9824280085c4164c614c5ef2bc1e69ffac1732dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs, dev-manual: Update tag checkout examplesScott Rifenbark2019-01-162-14/+67
| | | | | | | | | | | | Turns out I had some hard-coded stuff in these examples. Furthermore, I did not have good enough detail in the brief-yoctoprojectqs manual. I added more detail on how to get that sato example going. (From yocto-docs rev: 3dd6217be5e6f73ba3927431105096aec1445e10) 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>
* mega-manual: Updates to support BitBake User ManualScott Rifenbark2018-12-275-15/+38
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12399] Fixes made to have the BitBake User Manual included in the build of the mega-manual. I placed this manual at the end of the mega-manual. Following changes made: * Makefile - Modified to include two PNG files. All PNG files in a given manual are listed in the area that makes the mega-manual so that the tarfile is complete. * mega-manual.xml - Updated the front wording to tell the user that the BitBake User Manual is included in the Mega-Manual. Also, added a last section to actually include the bitbake-title.png file and the *.xml files. Note that I could not add the title figure from the same figures folder of the local "bitbake" folder. Would not include in the build. So, I pulled the file from the figures folder of the mega-manual, which is what I do for all the other book titles used in the mega-manual. * mega-manual.sed - Modified to clean out the old stuff that had been carried along for older books not supported for the release. Modified to include link processing for the newly included BitBake User Manual. * New Figures - Moved copies of the "bb_multiconfig_files.png" and "bitbake-title.png" figures into the figures folder of the mega-manual. (From yocto-docs rev: 78a1ae0ca92bb7f8a9d3a32a320299371d0ed361) 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-272-3/+3
| | | | | | | | | | | | | | 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-1510-44/+84
| | | | | | | | | | | 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>
* poky.ent: Updated copyright variable to span into 2019.Scott Rifenbark2018-12-151-1/+1
| | | | | | | (From yocto-docs rev: f06b1838f7f4516272aca290995f00f6fd16e35a) 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>
* dev-manual: Added note stating no WSL supportScott Rifenbark2018-11-221-0/+6
| | | | | | | | | | The Windows Subsystem for Linux is not supported. Added a note in the section on setting up the build host. (From yocto-docs rev: e6c3b0acd77569e0422cf86e7dc56433e76bdf20) 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>
* brief-yoctoprojectqs: Added warnings about WSL, which can't be used.Scott Rifenbark2018-11-221-11/+28
| | | | | | | | | | | Windows Subsystem for Linux (WSL) is not compatible with the Yocto Project. Added information in the beginning to note this fact to the user. (From yocto-docs rev: d8fcc0e3dc609086ca82a3419a337350f4e5c529) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated phrasing for what a "defconfig" file is.Scott Rifenbark2018-11-221-2/+5
| | | | | | | | | It was over simplistic. (From yocto-docs rev: 1c17e3ef607d18c89c3e20d2d44eb5120779cd2c) 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>
* dev-manual: Updated the "Post-Installation Scripts" section.Scott Rifenbark2018-11-221-23/+15
| | | | | | | | | | Added a better, more up-to-date description of the way to defer a post-installation script past the boot. (From yocto-docs rev: 1bcec14eed720fd05e81fbe7ecaa2f95174c0fbf) 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>
* dev-manual: Removed occurrence of mkefidisk.sh script.Scott Rifenbark2018-11-221-7/+6
| | | | | | | | | Script has been removed. (From yocto-docs rev: c23de8eb2648f98864579e857a1de0b2ed74532a) 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 14:17:24 +0000