summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2013-03-22ref-manual: Edits to make section heads consistent capitalizationScott Rifenbark
Various section heading titles were not using capital letters for primary words. Fixed this up. (From yocto-docs rev: da15d2ac3d043a0296a51d1a9fac69e7b4229f75) 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-22profile-manual: Updated sysprof basic usage sectionScott Rifenbark
There was a danny-specific note here that did not apply to the section any longer. I have removed it per Tom Zanussi's suggestion. (From yocto-docs rev: 2a3ccab263cfaa779a5182e6a4a7e534db253700) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22profile-manual: updated the Oprofile sectionScott Rifenbark
Removed the danny-specific note at the end of the "OProfileUI - A GUI for OProfile" section per Tom Zanussi. (From yocto-docs rev: b665be9ad906cdc3ac644e67151da3a2cc1acfd3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22profile-manual: Updates to LTTng section setupScott Rifenbark
With dylan, the two patches are no longer required. However, the information to view traces still holds true regarding using Eclipse's Juno. Updated appropriately. (From yocto-docs rev: 90845677a37562b465bbd2bc849f773a2f54d92e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-03-22poky-ent: Updates for the 1.4 release.Scott Rifenbark
I changed the distro name variable to "dylan" and the release to 9.0. (From yocto-docs rev: 4afec4519f3104f5a2e906f9ec4dfcca35d8000a) 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-22adt-manual: Added note to indicate ADT is distribution neutral.Scott Rifenbark
Cleared up some old wording that was confusing the build system with "Poky". Also, added a note at the front of the manual to be clear that the ADT is distribution-neutral. (From yocto-docs rev: 52d090ab931e5cbeffc612b91c11dbb55db15297) 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-02adt-manual: Updates to de-emphasize opt/poky and include sysrootScott Rifenbark
Fixes YOCTO #2645 Several changes to make sure that the default toolchain directory (opt/poky) is understood as the default. I changed some wordings to call it out as the default. Some examples I left alone as they used /opt/poky but I clearly indicated that the example was using the default installation directory. I also updated the note in the manual that talks about alternatively building the toolchain installer. Previously, it mentioned two methods. I have added the third and most significant method that uses bitbake image -c populate_sdk. This method creates a toolchain installer that contains the matching sysroot. (From yocto-docs rev: 2e5eeb7e0c9aa448149cc369572b31dbc1603e28) 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-14yocto-docs: Fixup a couple of merge issuesRichard Purdie
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-14template: Changed the font color for footers and headersScott Rifenbark
Fixes YOCTO #3728 The poky-db-pdf.xsl file has code that controls the font color for the headers, footers, and separating lines for each when the PDF version of a manual is made. I changed the values from #cccccc to #999999 to darken these up so they can be seen a little better. (From yocto-docs rev: c9c83028a5f13dc672414b6ca395290f05019f8e) 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-14ref-manual: Created "Development Host System Issues" sectionScott Rifenbark
Fixes YOCTO #2790 Created a new section in the "Debugging Build Failures" section to deal with host issues that cause a build to fail. (From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683) 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: Removed three figures from poky-ref-manualTimo Mueller
three PNG files go away from the eclipse folder due to the renaming of the poky-ref-manual to ref-manual. (From yocto-docs rev: 29907784ecb509b3d4fba633b2c4970e4105bea2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14documentation: Part 2 of 2 for YP doc integration into Eclipse.Timo Mueller
This commit adds the three *.customization.xsl files. I (Scott Rifenbark). Split the commit because after applying the 18 patches, the list of stuff to stage was huge and I did not want to add them one-by-one. So I staged them using git add -u. Here is the general cover letter information from Timo included with the 18 patches: ----------------- 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 (From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771) 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-14adt-manual: Added cross-reference link for Cross-dev toolchain.Scott Rifenbark
I placed a link on the term "Cross-Development Toolchain" in the section of the same name. This is to help the user see the recipes related to the toolchain. The link resolves back into the "Terms" section of the dev-manual. (From yocto-docs rev: c77ec0212bcf3b1c5f8079ccf08129ecbefea0aa) 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-14kernel-dev: Added note for YP release requirements.Scott Rifenbark
The user needs to have YP 1.2.2 release or forward for the examples in the book to work. I have added a note indicating such. (From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14ref-manual: edits to update-alternatives.bbclass description.Scott Rifenbark
Fixes YOCTO #3838 First draft of edits for this class. Removed specific variable definitions as they are now deprecated. Added a general explanation of the variable functions. Pointed user to the commented code in the actual class for details. Removed statement saying that the build system supports only one binary per package. (From yocto-docs rev: bd574f2c8a95470c5a44500b70743a6e039522b7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14ref-manual: Edits to the question on how source code is fetched.Scott Rifenbark
Updated the question that asks "How doe the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?". Some of the variables did not have links or proper font type. (From yocto-docs rev: be1f665b480a47483595381c9a837892100007e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14ref-manual: Updated SSTATE_MIRRORS glossary entry.Scott Rifenbark
added links for the PREMIRRORS and MIRRORS variables used in the description. (From yocto-docs rev: 1ec0f9cbeebeaeaadee8cc8b3631e6194c013a2f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14yocto-project-qs: Updates to how to use local directories for sourceScott Rifenbark
The section that describes an efficient way to set up the build system to look in local areas for tarballs needed updated so that PREMIRRORS was not the focus. The example used does not even employ PREMIRRORS. So I changed wording to support the example. I also added a mention of the PREMIRRORS variable and a linked reference to it for more information. (From yocto-docs rev: 7966942e2dfad85c2eb9480d7f706355871c40ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14ref-manual: added MIRRORS glossary definition.Scott Rifenbark
(From yocto-docs rev: 3dfc95974cdaf345d36a51e8f581602242c38148) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14ref-manual: Added PREMIRRORS glossary entry.Scott Rifenbark
(From yocto-docs rev: a91e562db5c1581cb88f0254f8d5a170296f3e41) 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>
2013-02-14dev-manual: three typos fixed.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 3272f0d51e3d09f4ffd96b7322f66ffd878d3714) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>