summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
AgeCommit message (Collapse)Author
2013-04-04dev-manual: Edits to adding features through variables section.Scott Rifenbark
I cleaned up the wording to indicate best places from which to use the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES variables. (From yocto-docs rev: 68e9c8b3f8d9fe3a086ad77bc0c3b465380476b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: merged "updating images" into the "working with packages"Scott Rifenbark
The section that talked about IPK-specific information for installing updated packages onto an existing running target system is parse and really needs to be in the section that talks about setting up a package repository. I moved it to the end of that repo section. (From yocto-docs rev: 3b1c5858527cba908a5acff1ddc924630cc954b0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual, dev-manual: Applied review edits (read-only rootfs and package repo)Scott Rifenbark
A couple sets of review comments from Paul applied here. 1. Added the "read-only-rootfs" item to the EXTRA_IMAGE_FEATURES variable description and a link to the appropriate section in the dev-manual. 2. Pulled the how-to-create a package repository section out of the section on how to customize an image with the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES section and made it a stand-alone section in the "Tasks" chapter of the dev-manual. 3. Integrated the SSH server example into the main topic because we don't want an isolated sub-section within a main topic. 4. In the image features section of the ref-manual, I fixed the link with the "read-only-rootfs" feature to go to the now-isolated section on how to do that instead of going to the customizing an image using the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES variables section. (From yocto-docs rev: 9c79b5f40d8dc6b37fbe636a2459f89b70bd8ea8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual, dev-manual: Review comments applied to package repositoryScott Rifenbark
Changes are the review comments from Paul Eggleton regarding setting up the optional package repository on the host that can be used by Smart. These changes reflect the fact that the task is not package-type dependent or host web server dependent. (From yocto-docs rev: 779989878bcc9501ddc4570519d93325442a8493) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: First draft of new customizing images with features section.Scott Rifenbark
I created two sub-sections in the original section. One covers how to customize the image by choosing the particular SSH server and the other has the new information on creating a read-only root filesystem. (From yocto-docs rev: a0ce1a2784f991b7c0871cbc0783e32dde37e314) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: General clean-up edits to the customizing images sectionScott Rifenbark
Edits to add a link and create a more active voice throughout this section. (From yocto-docs rev: 2cb62dab03d5ca4de9c9310c4d075fc643b7e68a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual, ref-manual: Changes to support runtime managementScott Rifenbark
Created the first draft of the new "Setting Up Runtime Package Management" section in the dev-manual's common tasks chapter. Updated the "Packaging - package*.bbclass" section in the ref-manual to mention this capability and point off to the dev-manual's new section. (From yocto-docs rev: d91c8530dba20839f36c5e247cc447adbedac7fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Updated the OE layer index link to existing layers.Scott Rifenbark
(From yocto-docs rev: 4e1be01ee9388f850c6582a78f0860ade311a0b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual, ref-manual: Rewrote the adding a package titleScott Rifenbark
Second thoughts caused me to adjust this title again. Also fixed the cross-ref in the FAQ. (From yocto-docs rev: 0553790236c60d30306b796587cd5b5213456aff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Updated the title for the adding a package section.Scott Rifenbark
I think this is better wording. (From yocto-docs rev: 4f673b0c3df4a7af4ec54325722e407d12a0e7fc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Fixed punctuation.Scott Rifenbark
(From yocto-docs rev: f7e9acfe6bc8d406e7fc19d6f7dadfc6ca03b2f7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Added another summary bullet due to new section.Scott Rifenbark
(From yocto-docs rev: f9512bbbfd41cf644d583bc3cfd610513b38527d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: fixed three grammar issues.Scott Rifenbark
(From yocto-docs rev: 56c7b78d17951917611c8b849d6ae4e98297f899) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Applied review comments to building tiny section.Scott Rifenbark
Fixes YOCTO #2568 These changes are based on Darren Hart's second review of this new section. (From yocto-docs rev: b61ef2b6cf96b45666e0f75753b76e0f875663b5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Added some development notes on the systemd feature.Scott Rifenbark
These notes will be deleted eventually. (From yocto-docs rev: 3c4894eaab5e87efbc06132f8c46e69623a72842) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: First draft of new init manager section.Scott Rifenbark
I created a first draft of a section titled "Selecting an Initialization Manager." The text was based on information from Ross burton. This is for the "systemd" support that is new for 1.4. There is a lot of work left on the section. This is the first draft. Reported-by: Ross Burton <ross.burton@intel.com> (From yocto-docs rev: ad358b96834879abe8a10d89e77453e30799ac0a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Cleaned up some "file system" "filesystem" terminology.Scott Rifenbark
(From yocto-docs rev: 21e265746d59ed952e3c80aae565e8c1b792b2ba) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Edits to the Using GDB sectionScott Rifenbark
Fixes YOCTO #3540 First pass at altering this section based on changed methods and Jessica Zhang's instructions. Rather than fully removing a couple of sections that have quite a bit of information, I decided to comment them out for now. Once the material is reviewed I can remove the sections for good. (From yocto-docs rev: bde7771166a178dd283fc9baacbee5239c679251) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Applied review comments to poky-tiny sectionScott Rifenbark
Fixes YOCTO #2568 Applied Darren's review comments where I could for his review. Not all questions are answered but this represents the third draft of the section. (From yocto-docs rev: da0bc9542259238caf7b474bb15157d80a2b3651) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: New section for installing different versions of a libScott Rifenbark
Fixes YOCTO #1548 Added a new section to describe how to install multiple versions of the same library in parallel on the same system. Also, I added some introductory text into the parent section that houses the three sub-sections that deal with library use-cases. (From yocto-docs rev: c77538bc8adae90e4b900f129b63988fa3ab6c9e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual: Reorganization for section using librariesScott Rifenbark
Fixes YOCTO #1548 Created a new section called "Working With Libraries". This section is a parent section for all the stuff about libraries. Previously, there were two other sections dealing with libraries: one was mulitlib section and one was about loading static libraries. It makes sense to have a parent section now that gathers the three sub-sections together. I have reorganized the chapter structure to accomplish this. Also, I placed some IRC chat notes temporarily into the new section that will discuss how to load multiple versions of the same library in parallel on the system. (From yocto-docs rev: 5d150421bcd660a191aff63ebabd577cc19bd421) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Updated the "Core System Development" sectionScott Rifenbark
Added a new bullet as a tip for best practices that addresses how we address bug 3071 and 3274. We are suggesting they enable a PR Service if they are using continually incrementing PR values when package feeds are published or used. Reported-by: Richard Purdie <richard.purdie@linux.com> (From yocto-docs rev: b90497f139b1b6f7ab5510313eb297d5d7fb4e68) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Wording change to GDB example.Scott Rifenbark
Fixes YOCTO #2827. Slight wording modification. Reported-by: Paul Eggleton <paul.eggleton@linux.com> (From yocto-docs rev: 8a9cd86d95bfcfca9c000dbd6f4213d15547cdfe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Updated path in cross-GDB package example.Scott Rifenbark
Fixes YOCTO #2827 Replaced the path where one findes the binary for the meta- toolchain to a more recent example that was built from the beagleboard and using arm. (From yocto-docs rev: 020a7fcd7f99c50d32e831b8d51150e8db8ab4e9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Reword for when to use BBMASK.Scott Rifenbark
Changed the wording on when a user would consider using the BBMASK variable. It is more suited for excluding things that cause problems rather than for speeding up build time. Reporte-by: Paul Eggleton <paul.eggleton@linux.com> (From yocto-docs rev: 993d7c953a37747297238cd9af53a1f00e737df9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: second pass of poky-tiny section.Scott Rifenbark
(From yocto-docs rev: 44be6fdc992809846fcaade8986c1a1323c14f0c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: First pass at poky-tiny section.Scott Rifenbark
(From yocto-docs rev: fbf31831e9cf3fc088c12a2867fa56e2004d624b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Added more examples of non-poky distros to note.Scott Rifenbark
(From yocto-docs rev: 7ff0db9e6f6ba5f50b71280f8a99d2c3ed5f0c4a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Applied review comments to creating distro sectionScott Rifenbark
Applied two comments sent by Paul Eggleton. (From yocto-docs rev: d3b61e07b5b9db6a582c76f66a984b9f27812a6f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: applied review comments to create own distroScott Rifenbark
These changes are basically Paul Eggleton's review comments. (From yocto-docs rev: bb92dbb968013952c4308b9aeed48223f49c866d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Created list for other layer mods for other distrosScott Rifenbark
The final paragraph of the "Creating Your Own Distribution" really should have been in list form and should have some cross-refs for other parts of the manual. The paragraph is now in list form and there are some references. (From yocto-docs rev: 02c4b2e99a3237d1506887659be0e67d6b000648) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Added notes about creating your own distroScott Rifenbark
Added a couple of notes to point out the ease of creating your own distro and not just relying on a Poky distribution. One note is at the very beginning of the manual and mentions Angstrom as an example of a distro based on the YP. The other note is at the beginning of the second chapter. (From yocto-docs rev: 1525a5e34c615cbfd25aeb12cc7a27ef95b51eab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: fixed broken linksScott Rifenbark
Added the "var-" part of links for the creating your own distribution section. (From yocto-docs rev: d419cd67084ce25d0d4b4437d8ce4cec180da59a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: Fixed two typos.Scott Rifenbark
(From yocto-docs rev: b2e0b0dbb8079be30420f306c3f844a3a0a466e0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22dev-manual: First draft of "Creating your own distro" section.Scott Rifenbark
(From yocto-docs rev: fa8ddbf0ca6e7619fa79a5637e49f95f06719da9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-02dev-manual: Added note about BitBake processing brace characters.Scott Rifenbark
Fixes YOCTO #3403 Provided a note at the front of the "Adding a Package" section explaining the exception when using a closed curly brace character inside a shell function with the character at the front of a line with no leading spaces. (From yocto-docs rev: a1c0972083751444a8cc89aa8a026f273d98e23e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-02dev-manual: Added multilib example referencesScott Rifenbark
Fixes YOCTO #1622 In the introduction paragraph I added references to the three multilib examples that are located in the meta-skeleton layer within the Poky repository. (From yocto-docs rev: f284525c6f9b655a61a0ac052a637b0aedb5b694) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-02dev-manual: Review comments applied for "Working in team" sectionScott Rifenbark
Fixes YOCTO #3274 Re-wordings per Dave Stewarts review comments. (From yocto-docs rev: 1d8fbc557388e9b86274e58d04cc6e70193e500c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-02dev-manual: Review comments added to "Working in Team" sectionScott Rifenbark
Fixes YOCTO #3274 Applied several recommended changes for the section describing best practices when using YP in a team enviornment. these changes were from Dave Stewart. (From yocto-docs rev: 7efc9864dc6757e3cf5c026f3c1785e5947cbfec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-02dev-manual: Edits to the "Working in a Team Environment" section.Scott Rifenbark
Fixes YOCTO #3274 Applied various review edits from Richard Purdie. Additionally, I ran a spell-check on the chapter and caught some typos. I fixed these as necessary. (From yocto-docs rev: 794a13d26bb7a9e268b16f809158a6af58cc3ce8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Revision of "Team Environment" section.Scott Rifenbark
Fixes YOCTO #3274 First draft of a re-written section that describes best practices for scaling the YP over a large development effort. this draft is based on Richard Purdie's text he sent to me. (From yocto-docs rev: e5135f76946997a0a060dd16c0b62308be4f6048) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual, ref-manual: Cross-references between PR Service and cacheScott Rifenbark
Fixes YOCTO #3684 These changes help tie in the relationship between how the OE build system uses checksums and such and the PR Service that can track revision. (From yocto-docs rev: 39a3010a3bb4b2c1d37aef60984ac16e85b56aac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual, bsp-guide: Added some linksScott Rifenbark
Fixes YOCTO #3552 Added some links to the FILESEXTRAPATHS and SRC_URI variables. These links connect appropriate sections to a newly improved section on FILESEXTRAPATHS glossary description. (From yocto-docs rev: a58e7c6f013393c87381411f918e16a8f04d55d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Updated PR Service section with commentsScott Rifenbark
Fixes YOCTO #2684 Applied some review comments to the section from Richard Purdie. (From yocto-docs rev: 772617a45df10e5e42364854fe03d8aad7cb46b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: First draft of the PR Service section.Scott Rifenbark
Fixes YOCTO #2684 Completed first draft. (From yocto-docs rev: c8b81e372578b1964bca4aa26d1085162115a2b0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Fixed <ulink> to be on a single line.Scott Rifenbark
These types of links must not span multiple lines in order for mega-manual to process them. (From yocto-docs rev: bcea042cd796a51d866f82399b2fd0cc89ec9e2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14documentation: Part 1 of 2 updates to integrating docs to Eclipse help.Timo Mueller
Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Updates to expose cross-toolchain recipes.Scott Rifenbark
Added a bulleted list to the "Terms" section to help define some toolchain recipes such as gcc-cross-initial, gcc-cross-intermediate, and so forth. Added a cross-reference link to the term "Cross-Development Toolchain" in the the "Working Using Stand-alone Cross-development Toolchains" section. This gives the reader a way to see more on the toolchain recipes. (From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Various typos fixedScott Rifenbark
Received a patch from Robert P. J. Day but deleted it from my Thunderbird account so could not apply it directly. I applied most of his corrections. A couple I left alone. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 2cadd5265fcb5cc281c22ccae81260a6633229e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14dev-manual: Updates to "Using .bbappend Files" sectionScott Rifenbark
Fixes YOCTO #3664 Added some information in the note to point out that not all append files add files into the mix. Some just exist to add build options. And, in this case the _prepend part of the FILESEXTRAPATHS statement is not necessary. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 388c441341006227be2f9e7d42bb1c509c32790d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>