summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual, mega-manual, Makefile: Updates to expanded dev sectionScott Rifenbark2013-08-1310-163/+170
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] Applied review comments to the "Images" and SDK sections that are part of the "A Closer Look at the Yocto Project Development Environment" section. Comments from Paul. They resulted in a single figure being removed and split into two new figures - one for the image part and one for the sdk part. Some terminology issues were cleaned up in the main sections as well as the documented variables sections. Makefile changes involved adding the two new figures and removing the old combined one. (From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: New section for images/SDKScott Rifenbark2013-08-135-3/+174
| | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new section for the closer look at how BitBake creates images and the SDK installer files. This included the section itself, a new .PNG figure that had to be added to the figures directory of both the ref-manual and the mega-manual. Finally, the Makefile needed to be edited so that the tarballs for the ref-manual and mega-manual also included the new figure. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variables added to the glossary.Scott Rifenbark2013-08-131-0/+49
| | | | | | | | | | Added entries for DEPLOY_DIR, TOOLCHAIN_HOSTS_TASKS, and TOOLCHAIN_TARGET_TASKS. (From yocto-docs rev: b239c41871f8c833cd33f4c5c875d51fa1bdf9eb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New glossary entry for DEPLOY_DIR.Scott Rifenbark2013-08-131-0/+24
| | | | | | | (From yocto-docs rev: f1594bfbc795dd9c22545b4d01601fbc88c91610) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update to note regarding distros supported.Scott Rifenbark2013-08-131-13/+26
| | | | | | | | | | | | | | Fixes [YOCTO #4927] Updated the wording to specifically point out that YP does not support rolling releases or developmental releases due to their constantly changing nature. I did not include wording to indicate planned or unplanned type of futuristic support. (From yocto-docs rev: fe9d269fd6c867a9a8e8cc33d90eedccbcbad0e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Updated note about the distros supported.Scott Rifenbark2013-08-131-13/+19
| | | | | | | | | | | | Fixes [YOCTO #4927] Updated the wording to be less severe. The wording matches that used in the ref-manual. (From yocto-docs rev: d44cd9d6d01bad9aa5269730efae100c163e34f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated warning note in supported distro section.Scott Rifenbark2013-08-131-10/+6
| | | | | | | | | | | | Fixes [YOCTO #4927] Did some rewording to tone down the fear in the note that tells users which distros YP works with. (From yocto-docs rev: 773c5003d222252f0456f9cfb622e1255a8886cb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typoScott Rifenbark2013-08-131-1/+1
| | | | | | | (From yocto-docs rev: 69698c8e133cb49701d15543a4917c7f539354e3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New entry for OE_IMPORTS variable added to glossary.Scott Rifenbark2013-08-131-1/+16
| | | | | | | (From yocto-docs rev: 3b73c2e1418190b1d998f3f7cf425088df887c21) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Corrected figure file name.Scott Rifenbark2013-08-131-1/+1
| | | | | | | | | I left off the ".png" part of a figure in the TARBALL statement. (From yocto-docs rev: e1024da36a94dd3cb8c0679782bedaba4bf2e5dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: fixed a grammar issue.Scott Rifenbark2013-08-131-1/+1
| | | | | | | (From yocto-docs rev: d3f5099e353c1f787d155d1178744f5a8f19e1db) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added note about not supporting rolling distrosScott Rifenbark2013-08-131-0/+19
| | | | | | | | | | | | Fixes [YOCTO #4927] Provided a note and some explanation about YP support on the official distributions. (From yocto-docs rev: c2957ad400127d05f940dc326cb5da4994a66785) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed link to wiki page for tested distros.Scott Rifenbark2013-08-131-4/+1
| | | | | | | | | | | | | | | | Fixes [YOCTO #4911] This bug's comments determined that the link from the "Supported Distributions" section to the wiki page that shows a list of tested distros be removed. The wiki page has been updated to link into the section of manual and the wiki page states that it is out of date. So, the manual should not point back to that wiki page. (From yocto-docs rev: 8d22568b348c1ba34068f73711e70b5eb507f29e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added five new figures to the figures folderScott Rifenbark2013-08-135-0/+0
| | | | | | | | | New figures for the expanded build section. (From yocto-docs rev: d22d4978a4c0a95744651f97afa0b5c148f0d873) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Added new figures to the TARBALL variables.Scott Rifenbark2013-08-131-2/+6
| | | | | | | | | | Needed to add six new figures to the mega-manual TARBALL and five figures to the ref-manual TARBALL. (From yocto-docs rev: 296e356cbd6a65d187a3e3d7905566685580f575) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Wording change for Images section.Scott Rifenbark2013-08-131-1/+2
| | | | | | | | | | Changed the wording to better reflect what these sample images in the chapter really accomplish. (From yocto-docs rev: 8ae60cd52e5b8fba02b00bdd8b7b242a077e8196) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section on Package Feeds.Scott Rifenbark2013-08-132-0/+52
| | | | | | | | | | | | Fixes [YOCTO #2808] New section for package feeds created. Includes a new figure also. (From yocto-docs rev: 6d8b41114ebadcfb06f6064a13c4da5b47a9f73c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Typos fixed.Scott Rifenbark2013-08-131-2/+2
| | | | | | | | | | | | Fixes [YOCTO #4935] Two typos located and fixed. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 805ff913b85bff390609beabdbbf48e45589ee13) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: added opengl to distro feature list.Scott Rifenbark2013-08-131-28/+38
| | | | | | | | | | | | | Fixes [YOCTO #4907] Open Graphics Library was not included in the list of supported distro features that could be included using the DISTRO_FEATURES variable. It is now. (From yocto-docs rev: 2e06fe0f8135c13d3a86857f9b0e450239cedbf4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a section reference to external toolchain question.Scott Rifenbark2013-08-131-69/+73
| | | | | | | (From yocto-docs rev: 6b125e0e0f09e817422f899923d51ee73923b15b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changes "Webhob" to "Toaster"Scott Rifenbark2013-08-131-32/+32
| | | | | | | | | | | I made some assumptions that the supporting filenames would be changed to reflect the new name. If they do not, I will fix them. (From yocto-docs rev: 4e71ea30951cef60e5a7daf5f11a197511731b8f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: First draft of webhob sectionScott Rifenbark2013-08-131-0/+169
| | | | | | | | | | | Fixes [YOCTO #4730] First draft of the section documenting the webhob service. (From yocto-docs rev: 4d995519cd4e481445a5399f936fce682d330dfe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Fixed CentOS packages section.Scott Rifenbark2013-08-131-7/+3
| | | | | | | | | | | | | | | Removed the "-y" argument from the command to install required CentOS packages. Added a qualifier to the version of Python that you need for the build system. Removed the note about RHEL. (From yocto-docs rev: 25cff75cd361ff5070b21a5ee4a241148c580d49) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to requirements section.Scott Rifenbark2013-08-131-8/+11
| | | | | | | | | | | | | Fixes [YOCTO #4753] Minor review edits to this buildtools section. Additionally, I removed the "-y" argument from the CentOS package install commands. (From yocto-docs rev: 8f5991f7d3a5ceee63a022af19afd713dcf740c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the "source" section of yp dev environmentScott Rifenbark2013-08-132-7/+9
| | | | | | | | | | | | Fixes [YOCTO #2808] I updated the "Sources" section with review comments from Paul. The figure needed changed as well as some text changes. (From yocto-docs rev: 0a44dbdebce50fb599b8dcb2f17adc76f9fb862c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: First draft of the "Sources" section added.Scott Rifenbark2013-08-132-0/+153
| | | | | | | | | | | | | | Fixes [YOCTO #2808] The "Sources" section provides a more detailed look at where BitBake gets source files from. This change included the first draft of the text and the first draft of the expanded figure. (From yocto-docs rev: 4e432a05666e67c6494486f392a05f629c6c148a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Another round of edits from Paul implemented.Scott Rifenbark2013-08-132-3/+1
| | | | | | | | | | | | Fixes [YOCTO #2808] Some small changes to the layer figure and the software layer wording. (From yocto-docs rev: 687652a4970910de8a4636999f63ad5c7e861069) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review comments added.Scott Rifenbark2013-08-132-20/+28
| | | | | | | | | | | | | Fixes [YOCTO #2808] Applied review comments from Paul Eggleton on the user configuration and the layers section. Changes applied to the figure for the user configuration section as well. (From yocto-docs rev: b05af4b740f0daf3d6c59acf71c362decba2a176) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review comments for config and layer sections.Scott Rifenbark2013-08-133-201/+258
| | | | | | | | | | | | | Fixes [YOCTO #2808] I applied extensive review comments to the user configuration and to the layer sections. These revisions also included updates to the two figures. (From yocto-docs rev: 029692b07cb7dff605b81aa45de7c891a3a77db1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new overview figure.Scott Rifenbark2013-08-131-0/+0
| | | | | | | | | | | | | | Fixes [YOCTO #2808] This figure is slightly different than our reference environment figure used in the QS. I did not want to simply duplicate it. Here the only difference is boxing in the metadata layer input to the left. (From yocto-docs rev: d1c8c69dfb5ec4261b8e5d15de6d5088fde86024) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed some rogue characters.Scott Rifenbark2013-08-131-2/+2
| | | | | | | | | | | Discovered a random ":S" and ":" character in front of a couple of list items. Must have been a wandering cursor situation during an edit session. (From yocto-docs rev: b81412e255ca90e850bce61ef7f9927692f0fcb5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new section for layer input detail.Scott Rifenbark2013-08-132-121/+283
| | | | | | | (From yocto-docs rev: ff952a9681df798cde34b50d1046233a47ca0ce5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New figure added for Layer section.Scott Rifenbark2013-08-131-0/+0
| | | | | | | (From yocto-docs rev: 3a1101fb66e9fc4e708a601a0153d18b3c10e1f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Some additional editsScott Rifenbark2013-08-131-16/+19
| | | | | | | | | Made a pass through this before sending it out for review. (From yocto-docs rev: 702f65bb497b157dfd2635f9b13ffd679dda9d0a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New user configuration figure added.Scott Rifenbark2013-08-131-0/+0
| | | | | | | (From yocto-docs rev: ec8e9de1fb42b8d6aaecf35ad23b11788f02e442) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Start of new section on deeper look into dev env.Scott Rifenbark2013-08-131-0/+210
| | | | | | | | | | Start of the new section on the closer look into the development environment. (From yocto-docs rev: e1f1cee951433144d1adedcb4f0bbc8d8296c444) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added URL for the pre-built buildtools tarballScott Rifenbark2013-08-131-1/+2
| | | | | | | | | | | | Fixes [YOCTO #4753] I added the URL for where this tarball will be located once we release YP 1.5. Until we release, the URL will not resolve. (From yocto-docs rev: 694571690e91ecc49e9afa85b9084543b71a85c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed deprecated kernel-manual.Scott Rifenbark2013-08-139-2511/+0
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #4810] I removed this manual from the tip of the repo. We carried a symlink to it for the 1.4 and 1.4.1 release. Now it is time to get rid of it. Removing this manual should get rid of the folder in the poky/documentation folder for future clones of that repo. This bug was entered because someone tried to make the manual for YP 1.5. It is debatable as to whether this is a fix or not. You might argue that the bug is not even a bug. (From yocto-docs rev: 6e2a14f9be5f37f16b91c0c8931df558aa9ef155) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual.sed: Deleted kernel-manual line.Scott Rifenbark2013-08-131-1/+0
| | | | | | | | | | I had commented this out with the previous commit but decided to completely eliminate it with this one. (From yocto-docs rev: 088f783bb12d29499d1b5da36a3c7a682a7d79d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual.sed: Removed the processing for kernel-manualScott Rifenbark2013-08-131-2/+2
| | | | | | | | | | The kernel-manual folder is depricated post 1.4 release. I commented out the line that processes links for that folder. (From yocto-docs rev: 1b84448020f75fa2d3c9c12d8ae72ba2a7e7db99) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* README: Updated the file to reflect current state of documentationScott Rifenbark2013-08-131-34/+31
| | | | | | | | | | | This file was out of date. I replaced the kernel-manual descriptions with dev-kernel. Also, added the profiling manual. Finally, changed the poky-ref-manual string to ref-manual. (From yocto-docs rev: a1e60078dcfcfd5a912d78f981fe70dc1aa33e37) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Fixed link in title page to point to new manual.Scott Rifenbark2013-08-131-1/+1
| | | | | | | | | | | The stock Note indicating that the user should consult the website for the latest version of the released manual had a link to the old kernel-manual. I have replaced it with a link to kernel-dev. (From yocto-docs rev: 804e672e42a66aecdbe83ce239433216af10ef8c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed reference to bug format.Trevor Woerner2013-08-131-1/+1
| | | | | | | | | | Based on observations from the various mailing lists, it is obvious that bugzilla issues are almost always referenced using square brackets. (From yocto-docs rev: 10b51afe7db62b8eb6e29bd1dd1ba4edb4320f83) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Update to Linux Distribution RequirementsScott Rifenbark2013-08-131-7/+24
| | | | | | | | | | | | | | | | | Fixes [YOCTO #4753] The section that tells the user the basic Linux requirement has been updated to mention the Git, tar, and Python minimum requirements. There is a new section in the reference manual's introduction area that describes how to create the buildtools tarball if these requirements are not met. The changes I made in the Quick Start now summarize the requirements and provide a link to that new section in the YP Reference Manual. (From yocto-docs rev: fcc61acab7e4a7ddde194aa2db21181778d5dcdf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed file.Scott Rifenbark2013-08-131-553/+0
| | | | | | | | | | | I removed the original version of this file. It has been hanging around long enough and there is no need for it to be tracked now. (From yocto-docs rev: 180465d8f3ab80e1b8bf51d82cbccc3b0e51f976) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed repo name.Scott Rifenbark2013-08-131-19/+19
| | | | | | | | | | | | Changed the poky-extras repo name to meta-yocto-kernel-extras repo. This repository had become stale and Bruce did some work to freshen it up a bit. The name was poor too. That drove the name change. (From yocto-docs rev: 4fa2b0f86cfe7191b8de7577d8d8ad6adb984a4e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section on building buildtools tarballScott Rifenbark2013-08-131-0/+72
| | | | | | | | | | | | | Fixes YOCTO #4753 This is the main change to address this bug. It is a new section that describes how the user can get a buildtools tarball if their system does not meet the proper Git, tar, and Python versioning. (From yocto-docs rev: 0493a55c85f050ba29f605ab727e557849242bae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, adt-manual: Added links to SDKMACHINE variable.Scott Rifenbark2013-08-132-7/+12
| | | | | | | | | | | Now that a glossary entry for SDKMACHINE exists, I needed to create some links to it where referenced in the ref-manual and the adt-manual. (From yocto-docs rev: 6efe13bcda22276e5ef71ebafff6f91961b34679) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added SDKMACHINE variable description.Scott Rifenbark2013-08-131-0/+27
| | | | | | | (From yocto-docs rev: f1e3e52257c296cfeb70fea63bf5ea7b142774dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added note about issues on supported distrosScott Rifenbark2013-06-211-9/+20
| | | | | | | | | | | | | | Fixes YOCTO #4519 I have added a note after the list of supported Linux distros that states there might be problems on a given distro when using YP. I cited the CentOS 6.4 example for this 4519 bug. (From yocto-docs rev: 30c413739aae99462ec2b4771041d4c115917aa9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>