aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
AgeCommit message (Collapse)Author
2017-01-11dev-manual: Updated "Building an Initial RAM Filesystem (initramfs) Image" ↵Scott Rifenbark
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: 1ef9bb89057be46878a70c558268b5ace43967f8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11dev-manual: Fixed "recipetool create" exampleMartin Vuille
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: 749970f4394af3855751c776689b7002232f2d13) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11dev-manual, ref-manual: Created new section on initramfsScott Rifenbark
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: a14e550494641c46ac2518632cbf251e07d459fd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11ref-manual, dev-manual: Removed term "wic-partitioned"Scott Rifenbark
This term was incorrect and I have replaced it with the term "partitioned." (From yocto-docs rev: af1bf889bf862b1bc861de72888a82e25997ab71) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-11dev-manual: Updated to the "Creating Partitioned Images" sectionScott Rifenbark
new information on how wic works (From yocto-docs rev: c5bfbba2bc810eb1ff8825b66aa1397cfeed8ce1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08dev-manual: Added note about RPM not dealing with post-installScott Rifenbark
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: a2b36b4a352522e3c576a45ee239af51eda518c1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08ref-manual, dev-manual: Added references to SYSROOT_DIRSScott Rifenbark
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: 23114b4bc708398bae8c4559793dd36bc53c96a2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16dev-manual: Fixed typo for "${INC_PR}.0"Scott Rifenbark
The string appeared in the text as "$(INC_PR).0". So, fixed it to be proper with the curly braces. (From yocto-docs rev: 113296272e60da09c88660d09a5e8ba06f0fda7a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16dev-manual: Updated "Exporting Tests" sectionScott Rifenbark
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: 006a25fad282b03aacd59eb8dc1a44cad2c19fc4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25dev-manual: Added section for multi-configuration supportScott Rifenbark
I added a new section in the "Common Tasks" chapter to support the fact that BB can now build for multi-configurations. (From yocto-docs rev: 0bf464908200d6c40c35fbf753712a8b0201dd88) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13dev-manual: Re-wrote the remote GDB debugging section.Scott Rifenbark
Fixed [YOCTO #9481] Complete re-write based on Mark Hatle's steps. I converted from sub-sections to an ordered list. (From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13dev-manual: Applied review comments to "Packaging Externally Produced Binaries"Scott Rifenbark
Fixes [YOCTO #10392] Moved the last bullet item from the list that was about DEPENDS to a note form above the list. This was done because the stuff for DEPENDS is more general. (From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Updated "Packaging Externally Produced Binaries"Scott Rifenbark
Fixes [YOCTO #10392] People often needlessly put [noexec] on tasks, making the recipes more complicated than they need to be. I updated the first bullet item in this section to more clearly explain how to do this. Also, added a new bullet item to the end to point into the DEPENDS variable for more clarification. (From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Added new section on recipe style guidelinesScott Rifenbark
Fixes [YOCTO #10360] Added a new section to reference into the OpenEmbedded Styleguide. This will help people writing new recipes to conform to known styles. (From yocto-docs rev: 40c12742c78f5aba5bb4e43f759e8c478470fd83) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Fixed missing quote in SRC_URI example.Scott Rifenbark
Fixes [YOCTO #10360] (From yocto-docs rev: 4a8fce4962ca77f6840294f7942fffd0c3479874) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Fixed IMAGE_FEATURES examples in debug section.Scott Rifenbark
Fixes [YOCTO #9554] In the examples, I changes "IMAGE_FEATURE" to "IMAGE_FEATURES_append" (From yocto-docs rev: 3fc2cc217a0a67b3e0739c6a235ab8e350c4b7c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Update to GPL file finder script.Scott Rifenbark
Fixes [YOCTO 10323] Made a code change to the example script that helps a user locate GPL files. (From yocto-docs rev: bd02012de75f0c30887d3a5bb4aa219703a3ee1c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Applied review changes to GNU debugging section.Scott Rifenbark
Fixes [YOCTO #9554] Fixed a grammar problem. Also, provided correct syntax to two examples. (From yocto-docs rev: 10eeaf036542696a7037f667feda114dc63527f3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Updated the example to identify GPL files.Scott Rifenbark
Fixes [YOCTO #10323] In the Providing the Source Code section, I replaced the 3-line code example that returns GPL files. The bits I put in are a script that does the trick. The 3-line example was not working. (From yocto-docs rev: a07873d46b5135555961499c6ce8f0b6b8bf2c8f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Updates to the on-target debugging section.Scott Rifenbark
Fixes [YOCTO #9554] I applied some review comments for the section on using GDB on the target for debugging. Included a new note on optimizations considerations. (From yocto-docs rev: 23f0dd82f682ea39849de0f589ee1ebfb16be749) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Added new GDB debug requirements section for targetScott Rifenbark
Fixes [YOCTO #9554] I added a new section titled "Debugging with the GNU Project Debugger (GDB) on the Target" that provides requirements for this type of debugging. (From yocto-docs rev: 5d15c6c5f2030395f9faea8a5ef3ead1b98042d8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Updated the Known issue for QEMU not working in usermodeScott Rifenbark
Fixes [YOCTO #9285] Altered the wording to more accurately reflect the issue. (From yocto-docs rev: 66cda9997a6c17752903a0b5600fb8cae98566e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual, dev-manual: Updates for "staging" discussion and variables.Scott Rifenbark
Fixes [YOCTO #8631] These fixes cover the following: * New glossary entry for SYSROOT_DIRS * New glossary entry for SYSROOT_DIRS_NATIVE * New glossary entry for SYSROOT_DIRS_BLACKLIST * New section titled "Sharing Files Between Recipes" in the dev-manual's "Writing a New Recipe" section. (From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Added new "Dependencies" section to writing new rec.Scott Rifenbark
Fixes [YOCTO #9679] I added a new section titled "Dependencies" inside the section that talks about writing a new recipe. This section details both build-time and runtime dependency behavior and conditions. (From yocto-docs rev: 37305ea09473dcaee2db4f9cc37c7ce0fc33c52a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Applied review edits to the "writing new recipe"Scott Rifenbark
Applied various edits to the "Writing a New Recipe" section. Several nits. (From yocto-docs rev: 17818ff89805e0df3a0445f64a4f9133550fa7d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28dev-manual: Updates to the "Writing a New Recipe" section.Scott Rifenbark
Made several improvements to this section. * fixed a typo where a YP release was referred to as 7.1 instead of 1.7 * Added a note box to the "Using Variables" list item elaborating on the expansion behavior. * Removed the detail around the WORKDIR discussion. * In the "Loccate or Automatically Create a Base Recipe", I added the devtool add method to the list of ways to create a base recipe. (From yocto-docs rev: 79c86fc3653c747ae42f08528063a8984cdd3b4d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.Scott Rifenbark
Fixes [YOCTO #10183] Added a new variable entry for the PACKAGECONFIG_CONFARGS variable. With the introduction of the new PACKAGECONFIG_CONFARGS variable, many places in the mainstream YP documentation that referenced how to pass configure arguments using EXTRA_OECONF needed to also make mention of this new variable. I added many cross-references to the new variable. (From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23dev-manual: Updated QEMU known issues for user-modeScott Rifenbark
Fixes [YOCTO #9285] Applied some rewording to the last bullet of the "Known Issues" section in the "Enabling GObject Introspection Support" section. (From yocto-docs rev: 6cc0c7925984a29a115819195b800e2ecd8b4757) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-25dev-manual, ref-manual: Systemd-boot: Update documents for new EFI bootloaderScott Rifenbark
Fixes [YOCTO #9707] * Replaced gummiboot with systemd-boot in the dev-manual * Replaced the gummiboot class with a new systemd-boot class * Replaced the appropriate gummiboot variables in the glossary with new variables SYSTEMD_BOOT_CFG, SYSTEMD_BOOT_ENTRIES, and SYSTEMD_BOOT_TIMEOUT. (From yocto-docs rev: 778b620e65cc68531b3c41aeb8f27f2a07eb0d00) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18ref-manual: Various small corrections to package-related stuffScott Rifenbark
Fixes [YOCTO #10135] Some small problems were fixed: * Added a cross-reference in the FILES glossary entry to the PACKAGES variable. The two are tied and there was not a reference to it. * Removed a redundant "/" character in a pathname example in the dev-manual. * Removed a redundant "/" character in an example pathname in the FILES glossary description. (From yocto-docs rev: 11a397c232696deece7ac5c6dafcadb87d7a5775) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18dev-manual: Added a new "known issue" for running qemu.Scott Rifenbark
Fixes [YOCTO #9285] Added a new bullet item to note that Using QEMU in usermode might not work properly when running 64-bit binaries under 32-bit host machines. In particular, "qemumips64" is known to not work under i686. (From yocto-docs rev: 896beb3fddd427f8327d4ddd35be253866c90377) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19dev-manual: Review edits to the package installation sectionScott Rifenbark
Fixes [YOCTO #9672] A couple typos here needed fixed. Also, a missing statement in the JSON example. (From yocto-docs rev: 8756cb363a70a8b77077a666c62c0f678ffb3d3e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-19dev-manual: Edits to the package feed creation section.Scott Rifenbark
Updated the introduction of the trio of variables used for package feed naming in the "Build Considerations" section. Fixes [YOCTO #1882] (From yocto-docs rev: 4c7efd08f9f543dd3c4f2e6d68c72d16fd7b0b8c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Updated Runtime Testing for Package InstallationScott Rifenbark
Fixes [YOCTO #9672] Updated the "Exporting Tests" section to reflect the proper local.conf settings. Added a new section "Installing Packages in the DUT Without the Package Manager" that describes how to use a JSON file to accomplish package installation on a Device Under Test without a package manager. (From yocto-docs rev: 0275d2a8234a6418f32e802bcf46b7e68053e05a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Updated the method to set SimpleHTTPServer for testingScott Rifenbark
Fixes [YOCTO #1882] Re-did the steps to set this server up. (From yocto-docs rev: 45e073a60ef7b1d540439b621266a9019a3d2947) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Applied edits to the package feed section.Scott Rifenbark
Fixes [YOCTO #1882] (From yocto-docs rev: 12e6b9f21fc6067389ea7632b5991d45173ae2ff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Updated Host Server Machine Setup for package feedsScott Rifenbark
Removed the extra server instructions and just left the ones for SimpleHTTPServer. Fixes [YOCTO #1882] (From yocto-docs rev: fb502c608b015c37f361f4b54874ad199a67feb4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Review edits applied to the package feed build considerations.Scott Rifenbark
(From yocto-docs rev: 0810f8272be51219d03b06d6771a35bbe6d6e552) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-06-21dev-manual: Updated Package Feed Creation sectionsScott Rifenbark
Fixes [YOCTO #1882] Edited the sections in the "Working with Packages" section beginning with the "Build Considerations" section with text received from Daniela Placencia. (From yocto-docs rev: 07a55662d6ac98875555f80f766de263b131185f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29dev-manual: Added Gobject Introspection section.Scott Rifenbark
(From yocto-docs rev: be442bcb971c8685f8a2c6dde92b64479a211e2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-29dev-manual: Updated the "varname" use to "VARNAME"Scott Rifenbark
This makes the use of this replaceable consistent with the migration chapter in the ref-manual. (From yocto-docs rev: 5c2f13f505986d2efc7bfa72c79b933f5a5c5ec1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18dev-manual, profile-manual, ref-manual: Purging Oprofile stuffScott Rifenbark
Fixes [YOCTO #9264] Several occurrences of tools-profile and the like had to be dealt with. (From yocto-docs rev: 62f45579970f47d22dabe921a51c663059a04576) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18ref-manual, dev-manual: Scrubbed boot-directdisk and bootimg classesScott Rifenbark
These classes have been removed. The bootimg class was sucked into the image-live class. I removed the reference sections to both classes and fixed the references throughout the manual set as needed. (From yocto-docs rev: 649d56b54987580039cbd52f54642112f810ffad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark
Occurrences in many manuals and one figure. (From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18dev-manual: Updated "Additional Implementation Details" sectionScott Rifenbark
Fixes [YOCTO #5517] I added two package management system generic implementation details to the section. This brings the section up to speed as the definitive work on combining multiple versions of library files into one image. We no longer have to refer the reader to a separate wiki page. (From yocto-docs rev: 450e718ca1b853f332c4e607a5a76efd689f7769) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-09dev-manual: Updated poky-floating-revisions file snippit example.Scott Rifenbark
Discovered typo in the file... "naivte" instead of "native". Fixed. (From yocto-docs rev: baa9fb2b553db425c8a5cfca04d913963e24d0a0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-09dev-manual: set correct task name for do_kernel_configmeYi Zhao
(From yocto-docs rev: bb48ab8518ee89c23a251e98a011d652d6e49af8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06documentation: Fixed references using the DISTRO_NAME variableScott Rifenbark
With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences of the DISTRO_NAME variable had to be checked to see if they really should be using the "NO_CAP" variable instead. Output and actual branch names are case-sensitive. (From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06dev-manual, ref-manual, sdk-manual: Removing oprofile references.Scott Rifenbark
Fixes [YOCTO #9264] I handled the occurrences of "oprofile" and "tools-profile" throughout as I could. They are not all done yet. These in this commit have been removed. (From yocto-docs rev: d76e264ea210846ad8080134bacd56462ba69d24) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06dev-manual: Added new section describing hardware and non-hardware configScott Rifenbark
Fixes [YOCTO #5092] Added a new subsection to the "Configuring the Kernel" section to describe the part of the configuration audit phase that deals with non-hardware and hardware options. (From yocto-docs rev: 2545c3f2cf45ffcc9bf9f388d929c8242b74b011) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>