summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* kernel-dev: Reorganized Kernel Metadata Location and Syntax sectionsScott Rifenbark2017-03-241-169/+169
| | | | | | | | | | | | | It seems that the two sections "Kernel Metadata Location" and "Kernel Metadata Syntax" were flipped regarding their order of apperance in the kernel-dev manual. I belive that syntax should be first and then followed by a discussion on the location. I have swapped these section's ordering in the manual. (From yocto-docs rev: 167b088f459c7128bdc1abddd0b948be8f3bf5fe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Corrected linking format for two variables.Scott Rifenbark2017-03-241-4/+7
| | | | | | | | | | | | | Convention is to avoid using hyperlinks for variables that appear in <literallayout>/</literallalyout> coded blocks. I removed the links for the KERNEL_FEATURES and LINUX_KERNEL_TYPE variables, which appeared in a literal block and put the links into the context of the description. (From yocto-docs rev: 3384f67e4b9f15e8f96297ceb2aafc63a5994d22) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added cross-reference note into the BSP Guide.Scott Rifenbark2017-03-241-0/+4
| | | | | | | | | | | | The section in the dev-manual that introduces BSP Layers for the first time was missing a general link to reference into the BSP Guide to help the user understand BSP Layer structure. I added a note. (From yocto-docs rev: c515e30a551e96e11091c3850f7eed1b034abdad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added support for "pyro" name and May release date.Scott Rifenbark2017-03-249-10/+10
| | | | | | | | | | | | | poky.ent - changed the "tbd" and "TBD" strings to "pyro" and "Pyro", respectively. Manual Head Files - Updated the manual history table with the May release month. (From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated note about included failed license checkScott Rifenbark2017-03-241-6/+16
| | | | | | | | | | | | | | | Fixes [YOCTO #10898] It is hard to get the exact start and end for included license text during a LIC_FILES_CHKSUM operation. I updated the notes indicating that the QA message returned upon failure includes the attempted license text. The user can better adjust his LIC_FILES_CHKSUM statement to then dig out the proper text. (From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Added support for WKS_FILE_DEPENDS variable.Scott Rifenbark2017-03-242-0/+52
| | | | | | | | | | | | | | | | | Fixes [YOCTO #11017] There is no current way to specify or list plug-in dependencies when building a Wic image. The variable WKS_FILE_DEPENDS was introduced to allow the user to use this in the recipe building the image. I added a description and example of the variable to the ref-manual variable glossary. I also cross-referenced the variable in the "Plug-ins" section of the dev-manual to point to the variable for more information. (From yocto-docs rev: 5a1072499ab80f74ffec6af2cc0b2f1987843a25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed formatting error for arguments.Scott Rifenbark2017-03-241-3/+1
| | | | | | | (From yocto-docs rev: 53153191b83007763d41d9aa8356d88bce88a3d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar error - article agreement.Scott Rifenbark2017-03-241-1/+1
| | | | | | | (From yocto-docs rev: 39a7810c668936586455bf8a0331371a27d2dd7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added information about pre-installed dependenciesScott Rifenbark2017-03-241-0/+45
| | | | | | | | | | | | | | | | | Fixes [YOCTO #10350] A situation exists where a user deploys a new application using devtool target-deploy and the new application has runtime dependencies that are not already on the target. When this situation exists, the application misbehaves if it calls a missing function. I added the explanation of this situation to the section that describes the devtool deploy-target command. Also, put a pointer in the section on devtool add for cross-reference purposes. (From yocto-docs rev: 694151e397ff40871b3ec8700c39d32a15814535) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Add explanation for signing RPM packages and using signed packagesScott Rifenbark2017-03-241-0/+121
| | | | | | | | | | | | | Fixes [YOCTO #11048] No documentation existed for telling the user how to create signed RPM packages or for how to use signed package feeds. I have created a new section on the topic to describe both scenarios. (From yocto-docs rev: cbdde75f06b1fc190b8e4f7f93f302dc238e3e7f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new "Release Process" chapterScott Rifenbark2017-03-243-0/+128
| | | | | | | | | | | | | | Fixes [YOCTO #10888] The YP documentation was missing information on how the major and minor (point) release process works. I added a new chapter in front of the "Maintenance" chapter that details the naming schemes, cadence, and maintenance for YP releases. (From yocto-docs rev: b486f871e1fb8a6f763510ed385f459fe215fa27) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added python3-pip and python3-pexpect to all distrosScott Rifenbark2017-03-241-4/+4
| | | | | | | | | | | Fixes [YOCTO #10854] The distros for Fedora, OpenSUSE and CentOS needed these. (From yocto-docs rev: a83dcca50681d589fbcc924de4845e62de053810) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent, yocto-project-qs: Added "xz" and "which" to Essential packagesScott Rifenbark2017-03-242-6/+8
| | | | | | | | | | | | | | Fixes [YOCTO #10855] In order for BitBake to run, we needed to add two more packages to the essential host packages: "xz" and "which". I have added these to the poky.ent file variables for each host and did the formatting so that the manuals render properly. (From yocto-docs rev: 1bfbdcb58e31ca6e978d6dcccd6d58fbd68dbf2b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added five "COPYLEFT*" variables to the glossary.Scott Rifenbark2017-03-241-0/+155
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #11021] The "Maintaining Open Source License Compliance During Your Product's Lifecycle" section in the dev manual covers use of archiver.bbclass, but is missing mention of the filtering options (e.g COPYLEFT_LICENSE_INCLUDE, COPYLEFT_LICENSE_EXCLUDE and COPYLEFT_RECIPE_TYPES). I added descriptions for these three. During the write-up, Paul noticed a couple other variables missing: COPYLEFT_PN_INCLUDE and COPYLEFT_PN_EXCLUDE. I also added descriptions for these two variables. (From yocto-docs rev: 450311037ea3048d30057c0b9d294efd33db2d3c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Expanded kernel task descriptions.Scott Rifenbark2017-02-191-32/+120
| | | | | | | | | | | | Fixes [YOCTO #9376] Expanded many of the brief descriptions for the kernel-related tasks. (From yocto-docs rev: ee9e54aa9f148e5438cd9bdf7e55d7fa43cc3ec5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor corrections to maintaining Open Source lic. comp.Scott Rifenbark2017-02-191-10/+12
| | | | | | | | | | | The section "Maintaining Open Source License Compliance During Your Product's Lifecycle" had a vew minor typo things (e.g. duplicated word and some formatting issues). I fixed these. (From yocto-docs rev: 67beb658445e79129d8aae1739bb33c000367107) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated NO_RECOMMENDATIONS glossary entryScott Rifenbark2017-02-191-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #11010] The second example was incorrect in the glossary entry. Instead of "1" an image name place holder was in the example. I put "1" in there. (From yocto-docs rev: 00ab787d0d90da5c6d384c3669e804c9b2baca53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated "latest manual" note on title pageScott Rifenbark2017-02-199-54/+224
| | | | | | | | | | | | | | | Fixes [YOCTO #10076] The note on the title page for each manual was brief regarding where to find the latest version of the manual. I updated the note to have more detailed information on finding current, alternate, and latest versions of the manual based on YP releases. (From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove core-image-directfb referenceScott Rifenbark2017-01-251-3/+0
| | | | | | | | | | | | | | | | core-image-directfb was removed from oe-core with this commit: remove core-image-directfb.bb as part of moving directfb from oe-core (From OE-Core rev: 8871fe1189776d78e5848b08edb9c990b9aebf2d) I made the similar change to the ref-manual by removing it from the "Images" chapter. (From yocto-docs rev: bee62aea8469cfca77e6f5e97a9ef2f52f16c9cb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed package-depends.dot and pn-depends.dotScott Rifenbark2017-01-251-8/+0
| | | | | | | | | | | | | | The generated package-depends.dot and pn-depends.dot stuff contains partial data about the taskgraph and tends to confuse users. Richard Purdie suggested removing these from bitbake/lib/bb/cooker.py. I have removed the references to them in the "Viewing Dependencies Between Recipes and Tasks" section of the ref-manual. (From yocto-docs rev: 3dc9b124532b52369cec2de8209f33aebce2b648) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, poky.ent: Added "pexpect" to essential packagesScott Rifenbark2017-01-232-5/+6
| | | | | | | | | | | | | Fixes [YOCTO #10889] Missing this package. Speculation is that this package was part of the Python 2.7 stuff but not Python 3. So, adding it clears the issue up. (From yocto-docs rev: c61672267f872ed0f57ecf83d86b0d96080aac51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added "pip3" as an essential host installation packageScott Rifenbark2017-01-201-4/+4
| | | | | | | | | | | | | Apparently, this package dropped out when migrating to Python3. So, I have added it to all the supported distributions as an essential package. Fixes [YOCTO #10909] (From yocto-docs rev: e5f915fb80fc36db515ad5a56bc31228a7f875d3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Updated the Ubuntu/Debian Essential package listScott Rifenbark2017-01-201-1/+1
| | | | | | | | | | | | | | Fixed [YOCTO #10854] BitBake fails on a new Ubuntu/Debian installation unless the "cpio", "Python", and "python3" packages are installed. I added these to the essentials list variable for the distro. Affects both the YP Quick Start and YP ref-manual. (From yocto-docs rev: 7a0ef9a85404ef4478bae103d1ea47c3e1c675f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added Essential packages to Fedora and openSUSEScott Rifenbark2017-01-201-2/+2
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #10855] On Fedora version 24, missing packages were preventing BitBake from running. These essential packages included "python", "cpio", and "file". Also, missing for openSUSE were "python3", "python3-curses", and "tar". I added these sets of packages to the essentials variable for each of the hosts involved. They resolve to both the YP Quick Start and YP Reference Manual, appropriately. (From yocto-docs rev: 5150bb932536dc17d99f94a96245655144ae5137) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "How to Submit a Change" section.Scott Rifenbark2017-01-201-128/+234
| | | | | | | | | | | | | | Fixes [YOCTO #10905] I updated the section with suggested improvements for completeness. The section has been broken into more subsections and provides the reader with more direction on mailing lists based on components changed. (From yocto-docs rev: f7c9010c14d96c64d00ca32e2e217d2dd1343919) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated LIC_FILES_CHKSUM exampleScott Rifenbark2017-01-201-3/+13
| | | | | | | | | | | | | | Fixes [YOCTO #10898] No information indicated the use of "endline" and "beginline" in the examples setting LIC_FILES_CHKSUM. I added a note indicating that line numbering starts with one and the "endline" value is inclusive. (From yocto-docs rev: 21114f09efa423033da67af1f27c99eb3cb9695d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Updated Manual Note information on title pageScott Rifenbark2017-01-201-5/+20
| | | | | | | | | | | | Fixes [YOCTO #10076] Added a new note for where the reader can find the most recent version of the manual dictated by release or in-progress work. (From yocto-docs rev: 8c2bd2a72ba89354027fa87872395d5b727c8b90) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, ref-manual: Added note for "resources temporarily ↵Scott Rifenbark2017-01-112-2/+101
| | | | | | | | | | | | | | | | | | | | | | | | | | | | unavailable" error Fixes [YOCTO #10818] There is a weird and intermittant error that can occur on any given distribution that has a 4.3+ Linux kernel and a version 228+ systemd. The error happens during an initial build of an image and indicates that resources are unavailable. Investigation determines that resources are available. The combination of the kernel and the systemd in a distro is causing issues when a distro is upgraded. yocto-project-qs: I added a note in the two areas where the user is stepped through the bitbake process to build an image. The note mentions the possibility of the error, the host configuration situation, and a couple work-arounds, which are to reboot the machine or to set the "DefaultTaskMax" systemd parameter to "infinity". ref-manual: Added the same note in the "Building an Image" section. (From yocto-docs rev: 3516803f9e6b5a29e4f95d31742c6e03ff63ef41) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added section on bmap-tool to flash imagesScott Rifenbark2017-01-112-56/+40
| | | | | | | | | | | | | | | | Fixes [YOCTO #10621] bmaptool is integrated into the OpenEmbedded build system but is not documented. I added a new section describing how to flash an image to media using the tool. Also, updated a small section in the Wic part of the manual that used "dd" to flash an example. I added a bmaptool counterpart here and referenced the reader back to the main new section. (From yocto-docs rev: 98ebe9acccceea2b833c1372a3e664befd1b6aef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added section on bmap-tool to flash imagesScott Rifenbark2017-01-112-4/+118
| | | | | | | | | | | | | | | | Fixes [YOCTO #10621] bmaptool is integrated into the OpenEmbedded build system but is not documented. I added a new section describing how to flash an image to media using the tool. Also, updated a small section in the Wic part of the manual that used "dd" to flash an example. I added a bmaptool counterpart here and referenced the reader back to the main new section. (From yocto-docs rev: 83a9a3aa5f20c7f389306eea9213eabea997aba1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added cross-reference for tool-chain installation.Scott Rifenbark2017-01-111-0/+5
| | | | | | | (From yocto-docs rev: f57728c63cc83c44682fb5a109808a17e1f18485) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Building an Initial RAM Filesystem (initramfs) Image" ↵Scott Rifenbark2017-01-111-8/+9
| | | | | | | | | | | | | | | section Fixes [YOCTO #7096] Applied a couple review comments to the section to clarify where to set key variables. Also fixed an incorrect variable name used to specify the *.cpio file. (From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New VOLATILE_LOG_DIR variable descriptionScott Rifenbark2017-01-112-3/+31
| | | | | | | | | | | | | | Fixes [YOCTO #6132] No mention of how to make the target directory /var/log persistent. I added a note to the "post-install-logging" image feature that points to the new VOLATILE_LOG_DIR variable description, which I added to the glossary. (From yocto-docs rev: 5d2bdf49e569e44d02602501d72418f04dbe6e4a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed "recipetool create" exampleMartin Vuille2017-01-111-2/+2
| | | | | | | | | | | | | | Fixes [YOCTO #10763] The final example in the section describing how to create the base recipe using receipetool create was wrong. I updated it to use the -d option in addition to the -o opetion. I also changed the description to match appropriately. (From yocto-docs rev: 8cc6d5e21532eeaac0e6d9ace3e0b58803a9804e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Created new section on initramfsScott Rifenbark2017-01-113-20/+124
| | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #7096] We did not document how to create an initramfs image to be included with a kernel build. Various variables sort of inferred the knowledge. I created a new section in the "Common Tasks" section of the dev-manual that describes how to create an initramfs image. Also, I updated the kernel.bbclass reference section to point back to the new "how-to" section. Finally, I also created a bunch of cross-reference links from various related variables back to the new "how-to" section. (From yocto-docs rev: 289dfbd5d24241e42446a043104eecd6dca76f13) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Removed term "wic-partitioned"Scott Rifenbark2017-01-112-9/+9
| | | | | | | | | | This term was incorrect and I have replaced it with the term "partitioned." (From yocto-docs rev: 50dd5c6994a2f799fdaf1ccbf7138b0074e981ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated to the "Creating Partitioned Images" sectionScott Rifenbark2017-01-111-797/+895
| | | | | | | | | new information on how wic works (From yocto-docs rev: 7b6a54a593a678442541b1fa6847498a792183c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added WKS_FILE description for new variableScott Rifenbark2017-01-111-0/+20
| | | | | | | | | | This new variable points to the location of the wics kickstart file. (From yocto-docs rev: 80d18224140f95fdca0b4efad8f6a6e545ee4d56) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added note about nullpointer error for launch eclipseScott Rifenbark2016-12-081-0/+18
| | | | | | | | | | | | | Fixes [YOCTO #10714] Apparently there is some issues with GTK3 libraries for the Mars Eclipse version. The note provides a workaround that requires editing the eclipse.ini file. (From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added KERNEL_IMAGE_BASE_NAME change to 2.2 migrationScott Rifenbark2016-12-081-0/+21
| | | | | | | | | | | | | | The fact that the OpenEmbedded build system can now build multiple image types caused the KERNEL_IMAGE_BASE_NAME variable to have the KERNEL_IMAGETYPE portion removed. This could cause existing recipes that use the KERNEL_IMAGE_BASE_NAME variable directly issues. I added a section indicating that the user should address those recipes to avoid problems. (From yocto-docs rev: c433fca3840440c14bb364a51afc5c3c2bfc7c88) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated KERNEL_IMAGE_BASE_NAME glossary descriptionScott Rifenbark2016-12-081-2/+1
| | | | | | | | | | | | | | Fixes [YOCTO #10717] Now that multiple images can be built, the KERNEL_IMAGE_BASE_NAME no longer requires "${KERNEL_IMAGETYPE}" as part of its default value. I have removed this portion of the default definition described in the glossary. (From yocto-docs rev: 713b3c141dfb66fc3852b5a997a7fc19d494e97b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added note about RPM not dealing with post-installScott Rifenbark2016-11-231-0/+7
| | | | | | | | | | | | | | | Fixes [YOCTO #10351] I added a note to the "Post Installation Scripts" section of the "Writing a New Recipe" section to call out the fact that the RPM package manager will not install packages on the target when any RPM post-install script returns a non-zero exit code when the script is run on the target. (From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Added references to SYSROOT_DIRSScott Rifenbark2016-11-232-5/+34
| | | | | | | | | | | | | | | | | Fixes [YOCTO #10692] I updated the STAGING_DIR variable description to have a reference to the SYSROOT_DIRS variable as well as the "Sharing Files Between Recipes" section of the dev-manual. I also updated the "Sharing Files Between Recipes" section so that the role of SYSROOT_DIRS is explained and actually used in an example to add another directory. (From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the section on adding docs to standard SDKScott Rifenbark2016-11-231-14/+9
| | | | | | | | | | | Fixes [YOCTO #8584] Made some edits to tighten this down and make it more efficient. (From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to support developing 2.3 YP docsScott Rifenbark2016-11-1610-28/+68
| | | | | | | | | | | | | | | | | | Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added new appendix for customizing standard SDKScott Rifenbark2016-11-165-0/+81
| | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #8584] This fix essentially had to document how to add the API documentation to the standard SDK. The fix required adding a new appendix to the SDK manual on how to customize that standard SDK. I could not put just one topic in a new appendix so I also added a sub-section on how to add indidual packages to the standard SDK. Other changes here were the introduction of a new file for the new appendix, updated the mega-manual.xml file so that it would include the new chapter when the MM was built. Finally, I added some cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the distro features section on the api-documentation bullet. (From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added api-documentation to distro featuresScott Rifenbark2016-11-162-4/+10
| | | | | | | | | | | | Fixes [YOCTO #8584] Updated the "Distro Features" section to include the "api-documentation" feature. (From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed typo for "${INC_PR}.0"Scott Rifenbark2016-11-161-18/+22
| | | | | | | | | | The string appeared in the text as "$(INC_PR).0". So, fixed it to be proper with the curly braces. (From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed presentation of "openSUSE" in supported distrosScott Rifenbark2016-11-161-1/+1
| | | | | | | | | The way I had this string was incorrect. I changed it to "openSUSE". (From yocto-docs rev: 221f5032ad3589b96a004d38e2b250e38f971007) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Exporting Tests" sectionScott Rifenbark2016-11-161-8/+28
| | | | | | | | | | | | | Fixed [YOCTO #10588] This section was confusing due to the fact that it used an actual set of IP addresses and image name where they should be clearly called out as examples. Fixed it. (From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>