summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2013-05-31dev-manual, ref-manual, poky.ent: Fixed broken Release Note schemeScott Rifenbark
The URL naming convention for the YP Release Notes has changed. It now takes the following form: http://www.yoctoproject.org/download/yoctoproject-15-poky-1000 The above is an example for YP Release 1.5 and poky release 10.0.0. I have set up three new variables in the poky.ent file to somewhat automate the links in the docs to point to the location of a given set of release notes: 1. DISTRO_COMPRESSED - set to the DISTRO string with no period (e.g 15 for 1.5). 2. POKYVERSION_COMPRESSED - set to the poky version with no periods (e.g. 1000 for 10.0.0). 3. YOCTO_RELEASE_NOTES - set to the full-blown release note URL. I made two changes to existing links for the Release Notes. One was in the dev-manual and one was in the ref-manual. (From yocto-docs rev: e6088927980a1de8022b22f7f38b3046fea20235) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31ref-manual: Partial draft for the new Wayland support section.Scott Rifenbark
I created a partial draft of the new section that describes how to use the wayland feature. (From yocto-docs rev: a03d1897a39ee2eb0fbb551c66c63b10928aebc4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31ref-manual: Added new THISDIR variable and fixed some minor issues.Scott Rifenbark
1. Added a new glossary entry for the THISDIR variable. 2. Inserted a link in the note of the FILESEXTRAPATHS variable to the new THISDIR glossary entry. (From yocto-docs rev: a4e704ff165959fab9c1e6f7d28906e8f15c6d27) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31dev-manual, kernel-manual: Added links to THISDIR variableScott Rifenbark
There is now a glossary description for the THISDIR variable in ref-manual. I added some cross-reference links to the variable in key places of these two manuals. (From yocto-docs rev: 0d0f756c142c506a66ebc6a1a33e9f124dafd333) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31tools: Bumped version to 1.5Scott Rifenbark
This sed script needs to process the correct version of the release. I changed from 1.4 to 1.5. (From yocto-docs rev: 8a27243191408b0bc58803d21a6853283d0b3c6a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31ref-manual: Updated note for FILESEXTRAPATHS variable.Scott Rifenbark
Added a bit more clarification (different wording) on why to use the immediate expansion operator and on why to include the trailing separating colon character. (From yocto-docs rev: d5789c98fe570f48de8546d1fc218b4d5c577d0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-31dev-manual: Updated wording about GitScott Rifenbark
I removed the statement saying that checking out a Git repository is a backup of the repo. Technically, that is not true. It would be more of a clone operation. The statement was superfluous anyway so I decided to remove it altogether. Reported-by: Trevor Woerner <twoerner@gmail.com> (From yocto-docs rev: 081bd0119f8c17a3932485857b6846dcb6998ee1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22ref-manual: Added xmlto and dblatex packages for docsScott Rifenbark
These two packages are required for all the supported distros if you are going to build the BitBake manual. (From yocto-docs rev: 76b19462aa1dd850c00b7addccdafcc0f1a67e1c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22kernel-dev: Updates to "Creating the Append File" section.Scott Rifenbark
Pointed out by Robert P. J. Day that I was using the wrong FILESEXTRAPATHS example for an append file. I failed to include the "_prepend" part of the variable. Also, the wording based on the example made some assumptions and was not entirely accurate. The changes I put in made the section very specific. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 659c5a9c41a92f469ea0ea3630e11b4ba2df8f56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22ref-manual: Added more detail to note for FILESEXTRAPATHS use.Scott Rifenbark
Some discussion about this variable indicated that the importance of the immediate expansion operator was not being called out enough. I added further information to the existing note that states to be sure to use ":=" when using the variable. (From yocto-docs rev: b97d3fa714a7c71356cd00548d3d01280034afc2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22kernel-dev: Updated changing the configuration section.Scott Rifenbark
Robert P. J. Day pointed out some implied meanings in this section that indicate configurations from .config are exclusive somehow from configurations applied through config fragments. That is not the case. I have inserted a note to clear up that implied meaning. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 5ac27e8a2aea662a8e70dda0e852b5ea401b8b00) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22ref-manual: Added Ubuntu 12.04 (LTS) to list of supported distros.Scott Rifenbark
(From yocto-docs rev: 9452cc3eda50a901682c4c36b8abcc0f556711a7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation/poky-ent: Updated to essential packages OpenSUSEScott Rifenbark
Fixes YOCTO #4468 OpenSUSE 12.3 will not work without the "patch" package. I added this package to the OPENSUSE_HOST_PACKAGES_ESSENTIAL variable in the poky.ent file. This will list that package in both the ref-manual and the yocto-project-qs. Reported-by: Winfried <winfried_mb2@xmsnet.nl (From yocto-docs rev: c2e557fcbe393d6533a3ae7f548a5a25bc5d31f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22ref-manual: Updated supported distros listScott Rifenbark
In line with our policy of supporting the current and previous releases of host distributions (and additionally the latest LTS release of Ubuntu): * Add Ubuntu 13.04 (released on 25th April) * Remove Fedora 16 * Remove 5.x versions of CentOS * Remove OpenSUSE 11.4 and 12.1 * Remove pre-1.3 versions of Poky Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: 9ae656fb351a7df735f87f99d9823a53774ffb0d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual: Edits to removing package management requirementsScott Rifenbark
Fixes YOCTO #1706 Applied another set of minor review comments to the section received from Richard Purdie. (From yocto-docs rev: 48aa19b7eea9f4b253cbe86981431ec7dc6d78df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual: Applied review comments for eliminating packaging req.Scott Rifenbark
Fixes YOCTO #1706 Richard suggested some technical wording changes. I also added the new sub-section into the introductory material as part of the parent section. (From yocto-docs rev: 201ae16541676365bef69be578433222191eccd3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual: Created new section to remove packaging requirementsScott Rifenbark
Fixes YOCTO #1706 Added a new subsection to the section that talks about making a tiny system. The subject matter fits in with reducing a kernel image size. (From yocto-docs rev: 51eb79b88794beaefcb88a4408714a88c9126b2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation: Updated poky.ent to use 1.5 as YOCTO_DOC_VERSION.Scott Rifenbark
I had "tbd" in there but discovered that that breaks all my manual cross-referencing linking. (From yocto-docs rev: 0b7ca589b4a2b567fd220ba502da1b1f080db2ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation: Updates to properly build the 1.5 manualsScott Rifenbark
1. Changed the variables in poky.ent to contain the "1.5" string and the "tbd" string for the unknowns. 2. Updated the manual revision history tables so to replace the 1.4.1 release entry, which should not be there, to the 1.5 entry. (From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22documentation: Set up the 1.4.1 manual set.Scott Rifenbark
1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff. 2. Updated the manual revision tables to have a new entry for 1.4.1 release. (From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22bsp-guide: Fixed syntax error in BBLAYERS example.Scott Rifenbark
I fixed this as pointed out by Robert. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 52eb7d8698ef643150ac0ce987677da7a654b3ea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual, ref-manual: Minor edits suggested by Bill TraynorScott Rifenbark
Applied some re-wordings as suggested by Bill Traynor. Reported-by: William M.A. Traynor <wmat@alphatroop.com> (From yocto-docs rev: 2510d9795720afc0309a10b18605e5af4a83769b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22bsp-guide, ref-manual: Various fixes from Robert P. J. Day review.Scott Rifenbark
Robert read through the BSP Guide and noted several issues. There were several typos, inacurracies for crown bay code, out-dated kernel usage example, etc. One change I had to make that was related was to fix two cross-reference links to a re-named section. These links were the changes in the FAQ chapter of the ref-manual. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ae45df660ebf33105ebf5e60e606b0ec76eb9a6d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual, bsp-guide: Updates for init-ifupdown change.Scott Rifenbark
Release 1.4 requires the user to create an append file to the new recipe init-ifupdown if they want to create their own custom /etc/network/interfaces file. Previously, they needed to append the netbase recipe. Changes needed in the migration section of the ref-manual as well as the exmaple used in the bsp-guide. (From yocto-docs rev: 1903df0c21dbc018f0dbb4ce90eac192b428606b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-05-22dev-manual: Review edits applied to selecting init manager section.Scott Rifenbark
Applied comments based on Ross Burton's review of this new section. (From yocto-docs rev: d4f5f7b712ea2944efffec9b675341143675efb0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17dev-manual: Fixed directory name used in example.Scott Rifenbark
(From yocto-docs rev: 1efd52814eaeadd36bb12a53f31967eb959b32a1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17dev-manual: Edits to "Set Up Your Layer for the Build" section.Scott Rifenbark
Added a cross-reference to the section that describes how to use .bbappend files. (From yocto-docs rev: 884740c066f0f45cfc85282c6d20737a39d7af88) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17dev-manual: Edits to "Using .bbappend Files"Scott Rifenbark
I re-wrote this to more clearly describe use. (From yocto-docs rev: c3d6eecd38c6d4c8b4e0b4e134cbd53ae3fd2aee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Edits to the "Changing the Configuration" section.Scott Rifenbark
This section had some problems. It failed to mention the need to extend FILESPATH by using FILESEXTRAPATHS. (From yocto-docs rev: e627cf21242a62fb23e93fdae61e8cfce32082a9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17ref-manual: Edits to SRC_URI, FILESPATH, and FILESEXTRAPATHS.Scott Rifenbark
Applied some review comments from Paul. Took the warning formatting out because it sucks. (From yocto-docs rev: 6c4162777cb686c8b24b15ded2594f4f4a6acba6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17ref-manual: Updates to the FILESPATH variable.Scott Rifenbark
Added some more clarity about how this variable works and the implications for using the default setting from the base.bbclass file. Namely, if you are going to have the build system look for files in your layer and your layer uses an append file, then you need to also use the FILESEXTRAPATHS variable to extend FILESPATHS. (From yocto-docs rev: 2826fa6f9286efb1d5ca6cf85f65266a35bb8cfc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17ref-manual: Edits to clear up the SRC_URI variable description.Scott Rifenbark
I found it confusing due to not specifically accounting for .bb and .bbappend files. I added some wording to clearly specify use given the two types of "recipes". Specifically, if you are going to use a SRC_URI statment from an append file, the user really should be aware that they will need to extend the FILESPATH variable by also using FILESEXTRAPATHS from within that append file. (From yocto-docs rev: 8fd0047bd5c4598532afc6f0803f6ae23fa213b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Fixed another occurrence of ${FILES}Scott Rifenbark
Further down in the section, a second occurrence of ${FILES} needed changed. (From yocto-docs rev: 0212a1ebfef4c5a6a0ae76410f7753bbc41d3e82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17kernel-dev: Correction to where to place a .cfg file.Scott Rifenbark
This was inaccurately referencing the ${FILES} directory when it should be talking about a "files" directory created in the user's layer where the kernel .bbappend file resides. (From yocto-docs rev: 2af3a71db6e6d99b9aa4b710e21f3f3bacff0b82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17yocto-project-qs: Final edits for QS manual.Scott Rifenbark
1. Fixed broken links to the website downloads page. 2. Added a better link to the oe-init-build-env script. 3. Added a note about the image directory because I discovered that the QEMU ones have the string "lib32" in prepended to them. (From yocto-docs rev: 38074bc97b94a23b115c44aa9f353205914f7cce) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17adt-manual: Changed capitalization of list for consistency.Scott Rifenbark
Start with lower-case letters. (From yocto-docs rev: 638963fb2c4cbcc3065725abe4f09f9b528c648e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17adt-manual: Fixed formatting of filenames in a list.Scott Rifenbark
(From yocto-docs rev: 61d250b1409c2640e32b14f884f2e3b6fda4f9d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17adt-manual: Added quotes around cross-link section title.Scott Rifenbark
(From yocto-docs rev: e467b272498ad9400fe9c025a193d4d58851ffe5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17adt-manual: Minor edits and links.Scott Rifenbark
(From yocto-docs rev: f2ceeef22a357a4c8a5fa920fd03c57b8e017200) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17adt-manual: minor updates.Scott Rifenbark
1. Made "Metadata" the term instead of "metadata". 2. Created a link to "Metadata" term for first use. 3. Fixed a broken link to the LatencyTop site. (From yocto-docs rev: 7b53ddd0c9c846c558796d8ae6a46c476ab3b68d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17ref-manual: Minor edits to the supported distros listScott Rifenbark
Removed the "Yocto Project" distros and renamed the openSUSE-project to openSUSE. (From yocto-docs rev: 8e29abce57d5bfca04633b1b0c5a57809513056f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Updated the yocto-kernel script example.Scott Rifenbark
Discovered a bad typo for the CONFIG_YOCTO_TESTMOD configuration. I had a "K" in front of it making the command throw an error. Fixed that. (From yocto-docs rev: 9c25a69abb12fd2fd472a2b9435a30b2c9ac4f2f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Updated the help listing for the yocto-layer command.Scott Rifenbark
(From yocto-docs rev: 48b55bc49c4871d00c03dc3bacc5cfff9807d5bc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Some minor edits.Scott Rifenbark
(From yocto-docs rev: 01121297f5b3c6ac4bfca4603ad3536fd1379639) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Updated the yocto-bsp script output.Scott Rifenbark
(From yocto-docs rev: e8361a9a93c9b30d6d439979977ee58fcf9cec92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Fixed "ARM" term appropriately.Scott Rifenbark
(From yocto-docs rev: 9b3ac75e5c88ba491bf4c34cf8dcc29dea393095) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Fixed "QEMU" term appropriately.Scott Rifenbark
(From yocto-docs rev: cb1a404339b64f6f1f65f5f2027e7bdf2fc067e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Added a link to the oe-init-build-env script.Scott Rifenbark
(From yocto-docs rev: 60b8c950dd232151188ced0f73fa48f5f6171a1d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Minor editing change.Scott Rifenbark
(From yocto-docs rev: 702b3a72cd95c01770e4e7a8f0bd1e2302a1beba) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-17bsp-guide: Removed a redundant note.Scott Rifenbark
(From yocto-docs rev: 2df7840ed52c55aa01cea593f9468e1dd2d3c54a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>