summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2012-07-26documentation/dev-manual/dev-manual-intro.xml: typo fixed.Scott Rifenbark
(From yocto-docs rev: fc6fb25fd69b3af41692f482f768a63ee746d52f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/poky-ref-manual: Removed included BSP GuideScott Rifenbark
With the decision to create a single HTML file that has all individual YP manuals, the need for including the BSP guide as part of the YP Reference Manual goes away. I have removed this guide as a chapter, removed the mention of it in the introduction, and fixed the two links in the FAQ chapter to reference the external manual. (From yocto-docs rev: b0dbda9e09b73c2b26111bda118731dbb3090cae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-26documentation/bsp-guide/bsp.xml: Fixed error in sample layer.conf file.Robert P. J. Day
(From yocto-docs rev: 9ea6fc5d2b9ede51668121421e448f9fffc7e7de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Updated the h6 style to use a larger fontScott Rifenbark
(From yocto-docs rev: 5fa8d627fe671f0eb7bbc67ce852e2010cbd723f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Moved the Eclipse chapter to the YP Dev Manual.Scott Rifenbark
The detailed chapter that describes how to install and configure the Eclipse Yocto Plug-in has been moved to become a subsection of the "Workflow" chapter in the YP Development Manual. This commit accomplished the bulk move, edits to integrate the information, and fixes to all cross-references. Moving the chapter creates a sectioning issue in the YP Development manual that results in subsections that are six levels deep. Not ideal. Will look at fixing these with a subsequent commit. (From yocto-docs rev: e6abff8f578f2cf6997895260f607395281ae8e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation: Changes to ADT Manual titleScott Rifenbark
The name of the ADT manual has changed to the "Yocto Project Application Developer's Guide." This change had some ripple effect regarding cross-references into the manual. These are now fixed. (From yocto-docs rev: 7ba25c470b03a85098388e6cca7c78a6ebb245d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation/dev-manual/dev-manual-model.xml: Edits for Eclipse insertionScott Rifenbark
In preparation for taking the Eclipse installation and configuration steps, I have made an edit pass through the section "Workflow Using the ADT and Eclipse". Minor edits performed to integrate the new information. (From yocto-docs rev: 7b4e0ae371b23f329451ac768b7d9eab5931df2d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-24documentation/kernel-manual/kernel-doc-intro.xml: Fixed typoScott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ef6888dffa95e1fbf74dd80e48034f3591a32959) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-22documentation: Created cross-references to new KMACHINE glossary itemScott Rifenbark
With the creation of a new KMACHINE glossary item, there were two areas in the YP doc set that reference the variable. I added cross-reference tags. Also noted that some other references were missing to the variable COMPATIBLE_MACHINE. (From yocto-docs rev: f740b62be175a50f17ce8a244258dcf391fcf672) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-22documentation/poky-ref-manual/ref-variables.xml: New KMACHINE gloss entryScott Rifenbark
Created a new glossary entry for the KMACHINE variable. I used Bruce Ashfield as my resource for understanding this variable. (From yocto-docs rev: 1069ddb3fe0b3bd00ba651b51419354258ae57d3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-20documentation: Config fragment sections updatedScott Rifenbark
I have updated both the section for configuration fragments found in the BSP and dev manuals. Reported-by: James Abernathy <jabernathy@gmail.com> (From yocto-docs rev: 62f4df751c80e7b749356bb80ade3a7847411f7c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-19documentation/poky.ent: updated YOCTO_DOCS_RELEASE variable to 1.3Scott Rifenbark
We should not use "latest" any longer for this variable. The string is fine in URLs that might appear on a website but the actual variable should be set to the release number. This way when we go to release the version of the docs they do not have to be reset with a post-release commit to change the variable from "lastest" to "1.3". (From yocto-docs rev: f97122847e65c223173fabb793ef1ddb04605e62) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-package.xml: Edits to packaging chapterScott Rifenbark
Some minor edits to create some links to some terms used. (From yocto-docs rev: 1559b8caca07cce8630de9ddf8c84f0b24fa35e7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-prepare.xml: Edits affecting rename and clarityScott Rifenbark
I made a pass through this chapter and focused on better descriptions for getting the system ready for application development. I made adjustments to better represent what is really being done. It is not all ADT here as was being described before. Miscellaneous edits and improvements throughout. (From yocto-docs rev: 3544beda4794005fe139d7620fd13618fab05534) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-intro.xml: Edits to introduction chapterScott Rifenbark
I edited the text so that the purpose of the manual is clearer. I have segmented out the ADT into distinct components and made sure the overviews of each is good. Edits to clarify the role of the ADT as well. (From yocto-docs rev: c4abd8305dcdba986f1e761887c740e8322bb331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/adt-manual.xml: Title change for link.Scott Rifenbark
(From yocto-docs rev: 4b34f9e53230b792a7f57f2880177299286d057d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-18documentation/adt-manual/figures/adt-title.png: Changed ADT Manual titleScott Rifenbark
figure updated to reflect new manual title. (From yocto-docs rev: 420bad21ffe1d1fd60a1bbbe66f3e1463b80cff9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/bsp-guide/bsp.xml: Updates to Kernel configuration sectionScott Rifenbark
final changes to the section that talks about configuring the kernel. Changes here based off Bruce Ashfield's review comments. (From yocto-docs rev: 7715643f2a24336585dd44d1d75e7be0aade7f6b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: Changed link anchor for 'resourses' in QSScott Rifenbark
The string used for the link anchor for the "What You Need and How You Get It" section in the YP QS used "resources". This string is actually used as the chapter id for the resources chapter in the YP ref manual. I changed the string in the QS from "resources" to "yp-resourses" to make it unique. There was one instance in the YP ref manual where a cross-reference to the section occurred. I fixed that as well. (From yocto-docs rev: 58c1e4e327cb489e037bbde170c4c495f4567392) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/dev-manual/dev-manual-common-tasks.xml: Fixed referenceScott Rifenbark
Caught and fixed a stray reference to "appendix" that should be "chapter." (From yocto-docs rev: 97d26495dd9b561bb5724a86e9cd777eeef9f71a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Converted resources appendix to chapterScott Rifenbark
Converted the "Resources" appendix to a chapter. I also made sure all the references to the chapter use proper term now, which is "chapter". (From yocto-docs rev: bf7212b72d54a2696c16dcc1c0a19681f23fbc1c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: Converted FAQ appendix to a chapterScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "faq" appendix to a chapter and made sure any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 6e090132823e3b121d00d9116b0693c922156b32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Converted ref-varlocality to chapter.Scott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-varlocality" appendix to a chapter and made sure any references in the doc set use the proper term now (chapter). (From yocto-docs rev: d666a3f6581bb114c6c15d63ef850678c398b247) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: converted ref-variables-gloss to chapter.Scott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-varibales-gloss" appendix to a chapter and made sure any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 3f541c20c7aff1012eb4c06cb856bf9795124822) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: converted ref-images and ref-features to chaptersScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-imagese" and "ref-features" appendices to chapters and made any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 08117634034a5cd5567c971957583d986c9ee9a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Converted ref-classes to chapterScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-classes" appendix to a chapter and made sure any references in the doc set use the proper term now (chapter). (From yocto-docs rev: 54991c7fb0a2d3a894249f8a253b1a974cf2e571) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual/ref-structure.xml: wording change to chapter.Scott Rifenbark
(From yocto-docs rev: abd9bed2df669462913d70b15c2033d05cc216e6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Converted ref-bitbake to chapterScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-bitbake" appendix to a chapter and made sure the single in the doc set use the proper term now (chapter). (From yocto-docs rev: 1086155dd6e67a9c75e99332a9ad122dc04ec7a1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Re-cast structure appendix as chapterScott Rifenbark
As part of moving the reference manual to a real reference manual I am removing the "appendix" classification and having everthing be a chapter. I changed the "ref-structure" appendix to a chapter and made sure the two references in the doc set use the proper term now (chapter). (From yocto-docs rev: 840a3e4dab355e53fdb400674bd6765957b24066) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation: Fixed the links to the BitBake Documentation page.Scott Rifenbark
Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: ddee80872afc567b9381387980f257b337f29ea1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky.ent: Changed BITBAKE_DOCS_URL.Scott Rifenbark
(From yocto-docs rev: 15c9daa399b5bea5045c23759d324d397c5eb545) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Removed artifacts for dev chapterScott Rifenbark
Removing the Development chapter resulted in some links being re-defined to go to the YP Development manual. Also, the poky-ref-manual.xml file had to be altered to not include the chapter. Any sort of residual cleanup needed as a result of getting rid of this chapter is handled in this commit. (From yocto-docs rev: f8d113654b33ed5f6f1ba8e2d2e755b78033ddbf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual/development.xml: Deleted development chapterScott Rifenbark
The Development chapter has been emptied out so it is now deleted from the reference manual. All relevant topics now reside in the YP Development Manual. (From yocto-docs rev: aa30971ea0b23c19e3fefcb48db8aa4c0db8e95e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/dev-manual/dev-manual-common-tasks.xml: Added external SCMScott Rifenbark
Added the section "Using an External SCM" to the "Common Tasks" chapter. This information was formerly in the YP Reference Manual in the old development chapter. (From yocto-docs rev: d34cd9e86cb7a6b27cf6a5b4daf58c445dd86331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual/development.xml: Removed devshell sectionScott Rifenbark
Removed the "Development Using a Development Shell" section. This section was moved to the YP Development manual into the "Common Development Models" chapter. (From yocto-docs rev: 4222ce12d620bf3cd98ae80b19402cf59cca3d3f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/dev-manual/dev-manual-model.xml: Added devshell sectionScott Rifenbark
I inserted the section "Using a Development Shell" into the "Common Development Models" chapter. This information was formerly in the YP Reference Manual and is being moved out to help the ref manual become a truer reference manual. (From yocto-docs rev: f4ca1c567afcebbae119f21c147e3c38c7ffd54e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual: Fixed various references to YPScott Rifenbark
I did a scrub for "Yocto Project" and found some that could be changed. (From yocto-docs rev: 985062b6a9320e8a3ca3d3dafb6516db4fbc5bd5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual/faq.xml: Updates to external toolchainScott Rifenbark
Updated the FAQ entry on "How do I use an external toolchain." Comments were from Richard Purdie. (From yocto-docs rev: db3986d2eff17087eb141ac0f4dfed55ff753368) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/yocto-project-qs/yocto-project-qs.xml: install toolchain detailsScott Rifenbark
I added a bit of detail to the install toolchain example to explain that the user needs to be in the root directory. (From yocto-docs rev: afb294f6e0997b72f11d9e9d31b3b22d083c2dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/poky-ref-manual/ref-variables.xml: Added KBRANCH entryScott Rifenbark
New finalized entry for KBRANCH. Reviewed by Bruce Ashfield. (From yocto-docs rev: 566e112d20ebe91a1302263b96254f6f66462aaf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-17documentation/bsp-guide/bsp.xml: Changes to kernel config section.Scott Rifenbark
Some work in progress. (From yocto-docs rev: d344b2db75c21bc7050e4a5f70c07ffd8f7545de) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-09documentation/bsp-guide/bsp.xml: Fixed referece to source directoryScott Rifenbark
I missed a "Yocto Project Files" term because the damn thing split across two lines in the source file and my grep method did not find it. Changed it to "source directory." (From yocto-docs rev: 31a261c141d3e26f4a87b9725097005c96345e2e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-09documentation/yocto-project-qs/yocto-project-qs.xml: edits to super userScott Rifenbark
Mentioned at the very end of the beagleboard build that the image can now be run on the target hardware. Also, specically noted the local.conf file as "conf/local.conf" in the build directory. Reported-by: Kevin Strasser <keven.strasser@intel.com> (From yocto-docs rev: a4b41c7f5e8e8017401961097e0df4b13458ac24) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/yocto-project-qs/yocto-project-qs.xml: Some link fixesScott Rifenbark
Minor fixes to some links and some typos. (From yocto-docs rev: 8d1f53bca404461f8edc526d5e144ef7d76f0594) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/yocto-project-qs/yocto-project-qs.xml: Scrub and editScott Rifenbark
I did a scrub for the term "Yocto" and substituted appropriately. This resulted in the term "Yocto Project build system" going away and being replaced by "OpenEmbedded build system." The "Yocto Project build directory" was replaced by "build directory." I also found a few little things that were wrong like including the Debian distro in the list of supported distros so I removed that. Finally, a spell check produced a couple of fixes. (From yocto-docs rev: 6957658982516aa4b0e4726c9344c46854aa11d3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/poky-ref-manual/technical-details.xml: Fixed various termsScott Rifenbark
I fixed several "Yocto Project build system" terms and some "Yocto Project Build Directory" terms. (From yocto-docs rev: 10c1d50380336ac684243525646ac9aa3c1812d4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/poky-ref-manual/faq.xml: Removed old YP Build DirectoryScott Rifenbark
Found a stray reference to "Yocto Project Build Directory." I changed to "build directory." (From yocto-docs rev: e0c593ac162c61f7d42625482b95c253d0f8622a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/poky-ref-manual/ref-structure.xml: log directory and typoScott Rifenbark
Updated the build/tmp/log directory description to mention that running a build does not necessarily mean a log directory is created. Also, ran a spell check and found a typo. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c602919a1f188a4dff23f965bcc52b635f9a92ae) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/poky-ref-manual/ref-structure.xml: removed "/" from recipes.txtScott Rifenbark
the section describing meta/recipes.txt had the "/" character at the end of the filename, which is incorrect. I removed this. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: 28295d8c46d3a2cc6b53f0a7ccea35f1db77d1df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-07-06documentation/poky-ref-manual/ref-structure.xml: Edits to BitBake directoryScott Rifenbark
Made a few edits to better describe how the scripts and bin/bitbake directories are placed into the PATH variable. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: 1e45731898935d40db6e6705f60bdea9633255ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>