summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* kernel-dev: Removed bad reference for creating patches.Scott Rifenbark2017-09-021-3/+0
| | | | | | | | | | | We do not want to mix traditional kernel development with kernel development using devtool. This reference implied that was okay to do. (From yocto-docs rev: 38c3a5d3b47e15880ca10ed30ae4a450ecc851cd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added output to kernel clone example.Scott Rifenbark2017-09-021-2/+10
| | | | | | | (From yocto-docs rev: d5880262ab74499fbeef620af7907ee6e5d328fd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Removed bare clone stuff for trad. kernel dev.Scott Rifenbark2017-09-021-84/+8
| | | | | | | | | | | Bare clone setup is no longer recommended or necessary for traditional kernel development. All that is required is to clone the kernel Git repo locally. (From yocto-docs rev: cbe6d79da4fc2d5bba530b0fe6abead7783bdfbe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Some cleanup of the output for the kernel flow ex.Scott Rifenbark2017-09-022-86/+5
| | | | | | | (From yocto-docs rev: 30bbe308339ad0665d59d8238e9420d1d594332e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide, mega-manual: Updated BSP dev flow figureScott Rifenbark2017-09-022-0/+0
| | | | | | | | | Removed spelling warning that was underlining "BSP" in the figure (From yocto-docs rev: 354fe8c39057ab3aec24474ead65d2d13a5bb3b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Working kernel flow process using devtoolScott Rifenbark2017-09-023-369/+408
| | | | | | | | | | | A work-in-progress of an example that modifies the kernel using the devtool. The procedure is not complete yet as it does not run properly. (From yocto-docs rev: 462ba2e46f237c294f05805ad5044291a085975d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added "next steps" for setting up a native linux hostScott Rifenbark2017-09-021-33/+173
| | | | | | | | | | | | The end of this section did not direct the user to the next logical step for preparing a development host. I added a paragraph to guide the user to the next area they would need to read based on their development methods. (From yocto-docs rev: 4a1aa7800e7bca82dddef0ed83e14e075b3aa9f2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Eclipse informationScott Rifenbark2017-09-022-15/+69
| | | | | | | | | | | | | | | | | Fixed [YOCTO #11970] Updated the field description for "Specify Sysroot Location" to note that the user can have this either downloaded or built and the ramifications of using a downloaded root filesystem. Updated the "Deploying and Debugging the Application" steps for both supported Eclipse versions to tell the user what to do if a browse operation fails or times out. (From yocto-docs rev: 623000af186cb5632af551f95384d4c96d4d6c54) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added support for signed RPM package feedsKristi Rifenbark2017-09-021-3/+1
| | | | | | | | | | | Fixed [YOCTO #11209] Rewrote so text indicates signed RPM package feeds work. (From yocto-docs rev: 41c1e3d786f4436de59697431b2494cbabdebb8d) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added review commentsKristi Rifenbark2017-09-022-7/+5
| | | | | | | | | | | Added review comments to variables COMPONENTS_DIR, and SYSROOT_DESTDIR. Added review comments to task do_prepare_recipe_sysroot. (From yocto-docs rev: 362998c71b44ddf89d32ed5c45e4251e932a9217) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable COMPONENTS_DIR to glossaryKristi Rifenbark2017-09-022-1/+23
| | | | | | | | | | Added new description and created a link for an existing occurance of the variable. (From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed broken link.Scott Rifenbark2017-09-021-1/+1
| | | | | | | (From yocto-docs rev: 79d1615389f51a0856ea4130684a618abb1c6a93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed duplicate section id.Scott Rifenbark2017-09-021-1/+1
| | | | | | | (From yocto-docs rev: b5ef950136b2d2bb00fdd86f971f77cb744a8c82) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: removed note indicating signed RPM packages unsupported.Scott Rifenbark2017-09-021-4/+3
| | | | | | | (From yocto-docs rev: 00c312e7515d82661fb16cd51f8fe9d03b4ea394) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a cross-reference link to "tmp/sysroots-components"Kristi Rifenbark2017-09-021-1/+1
| | | | | | | (From yocto-docs rev: 29458d81901336ae7c904a23e02786e024f20963) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SSTATE_SCAN_FILES variable descriptionKristi Rifenbark2017-09-021-4/+10
| | | | | | | (From yocto-docs rev: 190b257e788d7f6f2f87e4e8c031bcda4a9f6d46) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added tmp/sysroots-components taskKristi Rifenbark2017-09-021-0/+19
| | | | | | | (From yocto-docs rev: ae635dfc2f53e026b597c1d2ca93ecaa9416417c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Corrected spelling errorsKristi Rifenbark2017-09-021-2/+2
| | | | | | | | | | Updated two instances of "sysroot-components" to "sysroots-components". (From yocto-docs rev: 035be964e6f345c058c1dacbb58b09745e8f827d) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates on how to prepare for kernel modification.Scott Rifenbark2017-09-022-1/+71
| | | | | | | | | WIP at this point. (From yocto-docs rev: 12e44f6ee7f9437d85c33d0789dbafe937af5664) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated step 1 of flow and intro verbiageScott Rifenbark2017-09-021-5/+24
| | | | | | | | | | Updated the step to include proper links and verbiage for setting up the system for YP development. (From yocto-docs rev: d5d908847d66178a995d2be985c605e6a5c48d76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev, dev-manual: Moved Kernel prep stepsScott Rifenbark2017-09-026-141/+206
| | | | | | | | | | | | | | | | | The dev-manual had a place-holder section for getting the build host ready for using YP and then doing kernel development. This stuff is better suited for the actual kernel development manual. I moved the section. Moving created several broken links in the manual set that had to be fixed. In the dev-manual, I updated the introductory list to include the newly moved kernel stuff. (From yocto-docs rev: 2e21260bb5f84e9e30eb353ec841d5962e8a7642) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Fixed broken tar by adding ".png" to figureScott Rifenbark2017-09-021-1/+1
| | | | | | | | | | | | | The figure "figures/kernel-overview-2-generic.png" was missing the ".png" suffix in the TARFILES statment. This was throwing an error during the make process for the manual. Probably an error for quite some time and not noticed. I added the suffix to remove the make early exit error. (From yocto-docs rev: 00ad7874f8da149f193caeab8fd89bbf6d8132d7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Removed bogus link to Linux Yocto Kernel.Scott Rifenbark2017-09-021-2/+1
| | | | | | | (From yocto-docs rev: 7c267ede783dc25fa623673d51c49bf9535a4fcd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Pulled Eclipse preparation sectionScott Rifenbark2017-09-021-45/+29
| | | | | | | | | | | | | | | | I moved the section on preparing a build host to use the Eclipse IDE and placed it as introductory text for the section that talks about getting the system ready for either native Linux or CROPS use to use YP. I also created as part of that list, links to the BSP manual where I now talk about getting the system ready for BSP development. (From yocto-docs rev: f5b5d27ea5036792a96c0a42a3d7513a2a57a4b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide, dev-manual: Moved BSP Layer prep steps to bsp-guideScott Rifenbark2017-09-022-111/+151
| | | | | | | | | | | | The YP Development Manual had some build host preparation steps as part of the chapter that talks about getting a host ready for using YP. These steps are better suited in the BSP Guide. I moved them there and filled out the steps to be more complete. (From yocto-docs rev: 2277812d0dd411a103a4a4252d4cb90c471901c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev, sdk-manual: Moved patching kernel sectionScott Rifenbark2017-09-025-358/+366
| | | | | | | | | | | | | | Moved the "Patching the Kernel" section, which was in the dev-manual to the kernel-dev manual. During the move, renamed the section to "Using devtool to Patch the Kernel". This move bothered a lot of links so I had to fix them in various manuals. (From yocto-docs rev: a000be1eddf33e4d7de8f350e076d48e27ca4b98) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated steps to build an SDK installerScott Rifenbark2017-09-021-3/+44
| | | | | | | | | | The steps needed updated to reflect the introduction of CROPS as a way to prepare a build host. (From yocto-docs rev: 8f52372afad4c32d0b895a88c2298625e7f53da3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Fixed broken links to "Source Directory"Scott Rifenbark2017-09-021-3/+3
| | | | | | | | | | These references now go to the ref-manual and not the dev-manual. (From yocto-docs rev: e58681488c307ba1daf2e10423e56b7d3ec486b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variableKristi Rifenbark2017-09-021-0/+22
| | | | | | | | | Added SYSROOT_DESTDIR to the variable glossary. (From yocto-docs rev: 37388eccf162811ba7b9fd3ee3c110a8fa0f2556) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated kernel dev flow figure and supporting text.Scott Rifenbark2017-09-022-17/+5
| | | | | | | (From yocto-docs rev: 68dafc1a68d48a8fe5292185d5ca62d1bdcd80ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated BSP workflow list and figureScott Rifenbark2017-09-022-21/+6
| | | | | | | | | | | With the introduction of CROPS as a way to set up the build system, I had to alter the first bullet of the BSP workflow list and the figure. (From yocto-docs rev: f1db3db4053142619c62629d4b05023f0b148e6c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated simple build flow, text and diagramScott Rifenbark2017-09-022-14/+6
| | | | | | | | | | | Now that we have CROPS as an option, the step for preparing your build host is condenced to include cloning poky. This resulted in removal of step 2 and updating of the figure. (From yocto-docs rev: 903d1f98b736a744de1d9c973f7a96b6a92049b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated "Creating and Preparing a Layer" sectionScott Rifenbark2017-09-021-9/+13
| | | | | | | | | | | This section failed to mention the "yocto-layer create" script, which is a simple way to create a layer. I have added this info into the section by way of a "Tip" box. (From yocto-docs rev: cf204f2b72b1da0104315f54cfe55c3f1eaf0f96) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed links in do_prepare_recipe_sysroot taskKristi Rifenbark2017-09-021-2/+5
| | | | | | | (From yocto-docs rev: 80c60be5f560d20ee60270df0de2c86b23e004df) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edited Migration sectionKristi Rifenbark2017-09-021-3/+3
| | | | | | | | | | | Edited OpenEmbedded reference in "Recipe-specific Sysroots" secion. Edited bullet title in "Recipe-specific Sysroots" section. (From yocto-docs rev: b2ee4bb8b31d5c7df22287ae390e68c845ec0732) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to staging.bbclassKristi Rifenbark2017-09-021-4/+4
| | | | | | | | | | Added a missing closing parenthesis. Edited Note for for file clarification. (From yocto-docs rev: fd7bb7aa57cfcf8b77f82edea65773e50e751902) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated build/tmp/work/tunearch/recipename/versionKristi Rifenbark2017-09-021-10/+10
| | | | | | | | | | Replaced "recipe_work_directory" with "${WORKDIR}" throughout the section. (From yocto-docs rev: a961cf07cd18d06e0c6399a10dc40c0d4143c23f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Sharing Files Between Recipes"Kristi Rifenbark2017-09-021-4/+4
| | | | | | | | | | Updated text for sysroot terminology, and clarity. Fixed a capitalization error. (From yocto-docs rev: 4eea6497663efc937cddf4700298f5824ade7b47) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated Documentation required packagesKristi Rifenbark2017-09-021-3/+3
| | | | | | | | | | | Removed xsltproc package in Fedora, CentOS, and openSUSE Documentation required packages. Removed fop package in openSUSE Documentation required packages. (From yocto-docs rev: 58c4384974ac29f6f591a51d66a5041a29695e76) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved recipe syntax section to ref-manualScott Rifenbark2017-09-022-301/+308
| | | | | | | | | | | The section on recipe syntax that was buried in the creating a new recipe section was really a reference on syntax. I have moved it to the ref-manual. (From yocto-docs rev: cb55d1b5832cca6faa6e2a5b26f3add3032cade2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Converted sections for following best layer practicesScott Rifenbark2017-08-091-182/+167
| | | | | | | | | | | | | | The section about following best practices was more of a reference section the way it was written. I recast the section and the sub-sections such that it is a list of items to consider. Also renamed the section to be more of an action section rather than passive. (From yocto-docs rev: 8b050a46c67a3d3e89d905cf028eec6ae370388a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Using .bbappend Files in Your Layer"Scott Rifenbark2017-08-094-38/+39
| | | | | | | | | | | | | | | I did some rewriting for clarity in the "Using .bbappend Files in Your Layer" section. The section needed to be retitled so focus on the layer aspect of .bbappend files. Also, while I was in there, I did more work on the prose in general. Also had to fix some links in the bsp, kernel, and ref manuals that linked into the section whose name I changes. (From yocto-docs rev: a82bcc9fe0f909135434ee1bd36b4414f6c046c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed wording that intros layer creation stepsScott Rifenbark2017-08-091-1/+1
| | | | | | | | | | I updated the wording to note that the steps are how to create a layer without the aid of steps (i.e. by hand). (From yocto-docs rev: 81800fa9ba0dd9ff439a43b286981eea51d4c87f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Updated bullet heading for CROPS procedureScott Rifenbark2017-08-091-1/+1
| | | | | | | (From yocto-docs rev: b51e29013ab86072989a878b118a3bdf7c11355b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Added section for CROPS.Scott Rifenbark2017-07-301-165/+253
| | | | | | | (From yocto-docs rev: 0d6fba532e0247db2cce4e94466f4476114d3e13) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Added writernotes style to the *.css file.Scott Rifenbark2017-07-301-0/+5
| | | | | | | | | | This style allows a writer to use the <para role='writernotes'> tag to have text in the paragraph render in red. (From yocto-docs rev: 65bb4edcd0a58ea8e17f28f9f5c13e2898c22745) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Updated overview to account for re-orged materialScott Rifenbark2017-07-301-8/+23
| | | | | | | | | | | Because the YP development introductory information was moved to the ref-manual, and the QS will get a CROPS section inserted, the introductory section of the QS needed to be updated a bit. (From yocto-docs rev: e173b762a74678cd660850e4f5bc28712c3d83ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, ref-manual: Moved YP intro from QS to ref-manualScott Rifenbark2017-07-306-84/+72
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The introductory stuff in the QS is really conceptual information and needs to be in the ref-manual where YP is introduced. Regarding the QS, all we really need to do is point to places where the reader can go to find that stuff out. Part of this move involved getting the diagram of the YP flow for the environment from the QS to the ref-manual. That figure was named "YP-flow-diagram.png". It was named "yocto-environment.png" in the QS but I renamed it when moving it to the ref-manual. This caused some edits to the "Makefile" to clean up the figure lists for tarballs. (From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Updated CentOS required packageKristi Rifenbark2017-07-301-1/+1
| | | | | | | | | | Replaced "python34-pip" package with "python3-pip" in the list of required packages for CentOS' variable. (From yocto-docs rev: 5d48ea7953169b4392d6caf0fb8f2f952479f033) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Corrected package duplicationKristi Rifenbark2017-07-301-1/+1
| | | | | | | | | | Removed duplicated package, "which" in list of required packages for Fedora's variable. (From yocto-docs rev: e016735fe7ef0d866d44df1100597ab3f3af7d5f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>