summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/introduction.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: poky-ref-manual - Final changes before the 1.3 lockdown.Scott Rifenbark2012-10-231-1/+1
| | | | | | | | | various changes as required. (From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: poky-ref-manual, yocto-project-qs - supported distrosScott Rifenbark2012-10-151-8/+28
| | | | | | | | | | | | | Created the new section in the reference manual that lists the distributions that support YP. Updated the section in the QS to reference the new section in the reference manual. (From yocto-docs rev: ff85945574466b2e6431fbaa0026cdea9d96ac9b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: poky-ref-manual, yocto-project-qs - Packages fixedScott Rifenbark2012-10-101-24/+12
| | | | | | | | | | | | Fixes [YOCTO_#3180] Final changes to the packages section. They were re-organized and the set is complete and thus fixes this bug. (From yocto-docs rev: 533b45c9d41330497bbd0da58b812a4738ba64a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: poky-ref-manual, yocto-project-qs - Updates to packagesScott Rifenbark2012-10-101-13/+26
| | | | | | | | | | | | | A few edits to the respective sections that talk about required packages. Some wording changes for headless and graphics supported systems. Also, re-inserted the note about older CentOS systems. Reported-by Paul Eggleton <paul.eggleton> (From yocto-docs rev: 112370758cf41104ff04c4996d4a432e6bd54be1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: yocto-project-qs, yocto-project-ref - package re-orgScott Rifenbark2012-10-101-1/+168
| | | | | | | | | | | | | | | | | | | | | | | | | Reorganization of the packages section in the YP Quick Start. These are now ordered still by distro but the listed packages have been culled down to just the needed ones to run an image on QEMU with graphical support. A corresponding section in the reference manual now provides the comprehensive list of packages for all supported distros. The section in the reference manual is broken down by distro and by function. Finally, four new variables were introduced to track the essential packages for each of the distros. The variables are defined in poky.ent and follow the form <distro>_HOST_PACKAGES_ESSENTIAL. This will make it so we don't have to maintain this list of essential packages in multiple places. Reported-by: Paul Eggleton <paul.eggleton@intel.com> (From yocto-docs rev: 839b441791980db82f4795454e976e606b486d25) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Toolchain corrections from tarball to .sh fileScott Rifenbark2012-09-141-1/+1
| | | | | | | | | | | | | For 1.3 there is not longer a toolchain tarball. Instead, there is a wrapper script that lets you install the tarball. This fundamental usage model change caused several ripples throughout the documentation set. I have changed wordings and examples to reflect the new paradigm. (From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Manual reference fixes for mega-manual processingScott Rifenbark2012-09-041-5/+3
| | | | | | | | | | | | | I fixed several occurences of cross-references to whole manuals where the formatting was split in the <ulink> statement. The <ulink> tag and the manual title must be on one DocBook line in order for the sed scripts to correctly process the links when the mega-manual is created. (From yocto-docs rev: 0dee12d518c892f59c0446e1c7b5d0f71b6ee22b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed references to the YP Dev ManualScott Rifenbark2012-09-041-2/+2
| | | | | | | | | | The references to the YP Development Manual were inconsistant. These references were fixed. (From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Removed included BSP GuideScott Rifenbark2012-07-261-4/+0
| | | | | | | | | | | | | | 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>
* documentation: Changed link anchor for 'resourses' in QSScott Rifenbark2012-07-171-1/+1
| | | | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Converted resources appendix to chapterScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | 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>
* documentation: Converted FAQ appendix to a chapterScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Converted ref-varlocality to chapter.Scott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation: converted ref-variables-gloss to chapter.Scott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation: converted ref-images and ref-features to chaptersScott Rifenbark2012-07-171-4/+4
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Converted ref-classes to chapterScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Converted ref-bitbake to chapterScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Re-cast structure appendix as chapterScott Rifenbark2012-07-171-2/+2
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Removed artifacts for dev chapterScott Rifenbark2012-07-171-4/+0
| | | | | | | | | | | | | 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>
* documentation/poky-ref-manual: Fixed various references to YPScott Rifenbark2012-07-171-11/+10
| | | | | | | | | | 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>
* documentation/poky-ref-manual: Yocto Project scrubScott Rifenbark2012-07-031-9/+15
| | | | | | | | | | I have changed as many "Yocto Project" terms as possible so that better reflect reality. (From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Converted to use poky.ent variables.Scott Rifenbark2012-03-231-11/+10
| | | | | | | | | | Fixed all the hard links to use appropriate variables from the file poky.ent. (From yocto-docs rev: 9a6267d0d843dc47c1171eba6200387901b77df4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Cross-referencing section fixed for consistency.Scott Rifenbark2012-03-081-5/+3
| | | | | | | (From yocto-docs rev: 8e861c6fc07aefa81ff65e3542de855116e14969) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Link updatesScott Rifenbark2012-03-081-4/+0
| | | | | | | | | | | | Pulling the "Common Tasks" chapter fromt YP Reference Manual broke many links. Each of these links had to be repaired so that the link is to the YP Develepment Manual now, where the chapter was moved to. (From yocto-docs rev: 08176135b8ac856b8cf7872300ce41ada87fa486) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: Added referenceScott Rifenbark2011-12-161-0/+3
| | | | | | | | | | Added a reference to the YP development manual in the introductory paragraph. (From yocto-docs rev: 84761f2a705cd0c3bf730b9f13fd21ca318c0494) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: added new chapterScott Rifenbark2011-12-161-0/+5
| | | | | | | | | | The list that describes the organization of the book needed the "Technical Details" chapter added. (From yocto-docs rev: f94d4b2626c1a2e2bf3f6d033222ab1b35c3efde) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed all manual links to point to "latest"Scott Rifenbark2011-11-251-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are many references to YP documentation throughout the YP manual set. They used to have hard-coded links to the current release (e.g. yoctoproject.org/docs/1.1 for Edison). This created a situation where if you went to a document on the website and clicked on a external reference to another manual, you would redirect to the current manual on the website. Really, you would want to go to the latest manual, which is one that is under development. Changing the links to "yoctoproject.org/docs/latest" makes the tip of master, which is used for devloping the next release, always have references to the manuals being developed and not back to the stable released set of manuals. This "latest" and "current" scheme for the links is not perfect. What has to happen when the latest set of the manuals freezes and becomes the next stable release, all the links in the docs will need to be changed from "latest" in the URL to the new release number. So for example, all the "latest" occurences would need to be changed to "1.2". Then for the next cycle as development begins again, the links need to be infused with "latest" again. (From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Minor wording fixesRobert P. J. Day2011-11-251-1/+1
| | | | | | | | | Robert identified several wording issues. Fixes applied. (From yocto-docs rev: 9c1ed58a1ecdd620246970419ed58b53f95cf2ec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: Fixed broken linkScott Rifenbark2011-11-251-1/+1
| | | | | | | | | | Robert identified this broken link to the stable Yocto Releases. As Reported by: Robert P. J. Day (From yocto-docs rev: e42a501df2ca44030f99f017b8c532b03db62f55) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for yocto-1.1Scott Rifenbark2011-10-061-1/+1
| | | | | | | | | | | After greping through the documentation directory, I addressed all the <ulink> statements that used to have yocto-1.0 in the URL. They are now yocto-1.1. (From yocto-docs rev: 97d160263c5905fdeaf4ec285bc5359918790581) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: Title changed.Scott Rifenbark2011-08-231-2/+1
| | | | | | | (From yocto-docs rev: 244c632812f10a3dc79eb814caf1449c50655e36) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: re-write for YPScott Rifenbark2011-08-231-139/+107
| | | | | | | | | | I re-wrote and reorganzied this chapter to reflect the book as a Yocto Project Reference Guide. (From yocto-docs rev: ef3c3955ab0cedb57d9ae48041ed94806fe34001) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Figures cleanupScott Rifenbark2011-05-101-1/+1
| | | | | | | | | | | | | | | | | | I removed two figures from the figures directory: cropped-yocto-project-bw.png and yocto-project-transp.png. Both figures are relics and not used in the manual. I also altered the Makefile to pull the ss-sato.png file from the figures directory instead of the screenshots directory. I moved this PNG file from the screenshots directory to the figures directory so that all figures would be in the figures directory. Finally, I updated the introduction.xml file so that the html code to include the ss-sato.png file pulls it from the figures directory and not the screenshots directory. (From yocto-docs rev: daa15c232d8c46d94cafd080e03318c733ec089f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: Wording and release updateScott Rifenbark2011-03-181-4/+5
| | | | | | | | | | | | I changed several occurances of "Yocto Project" to "the Yocto Project." Also changed the statement about what Poky release the book supported. It previously said "applies to Poky Release 4.0 (Laverne)." I changed this to "applies to Poky Release 5.0 (Bernard)." (From OE-Core rev: 021bc37ad0698c567f9b7089fde99fe985ae3551) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: Removed linkScott Rifenbark2011-03-181-1/+1
| | | | | | | | | | | | | | Removed a link to the Intel Website. Upon testing this link I discovered that it loads the Intel site into the current web page and then disables the back button. Rather annoying. I tried to change the link to pop a new window but couldn't get the ulink.target parameter to work. Ran out of time to try and figure it out so I removed the link. (From OE-Core rev: 8f75a06300714938e79800e0e140dd76ba42de86) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* - documentation/poky-ref-manual/introduction.xml: fixed pokylinux.org URLScott Rifenbark2011-03-031-1/+1
| | | | | | | | | | | | [BUGID# 553] - In the Development Checkouts section (1.5.3) there was a reference to our git repository located at git://git.pokylinux.org/poky.git. I changed this to git://git.yoctoproject.org/poky.git. This is a partial fix to Bug 553. (From OE-Core rev: fe4ed51c121b8f1445a0999e411c54270321e025) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* - documentation/poky-ref-manual/introduction.xml: Fixed pokylinux.org URLScott Rifenbark2011-03-031-1/+1
| | | | | | | | | | | | [BUGID# 553] - In the Releases section (1.5.1) there was an URL to http://pokylinux.org/releases. This URL was old and I replaced it with http://yoctoproject.org/downloads/poky. This partially fixes bug 553. (From OE-Core rev: e66d4b53c773d76f2f05c574132796e2fdcf6ebd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed ↵Scott Rifenbark2011-03-031-1/+1
| | | | | | | | | | | | | | | | | | pokylinux URL [BUGID# 553] - In the Development Checkouts section (1.5.3) there is a reference to http://git.pokylinux.org/. This URL resolves to an older looking source area. I determined that the URL http://git.yoctoproject.org/ resolves to the newer Yocto source web interface so I changed the URL to that. This is a partial fix to Bug 553. (From OE-Core rev: 18f0124db5c10ea23698ca0c469d4dfde89adf43) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual/introduction.xml: [BUGID# 553] - Fixed ↵Scott Rifenbark2011-03-031-1/+1
| | | | | | | | | | | | | | | | pokylinux.org link in Nightly Build section [BUGID# 553] - In the nightly build section (1.5.2) there is a reference to http://autobuilder.pokylinux.org/. This URL resolves to an autobuilder page that has a bunch of pokylinux links. I determined that the URL http://autobuilder.yoctoproject.org/ also resolves to the autobuilder page so I updated the URL to use the YP link. This is a partial fix to Bug 553. (From OE-Core rev: b1c7055dead4badd14872105c49466cbf86d3b54) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/poky-ref-manual: Fixed to mis-spellingsScott Rifenbark2010-12-101-3/+3
| | | | Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: A couple more minor fixes.Scott Rifenbark2010-11-151-3/+3
| | | | | | | I found another redundant </ulink> tag. I removed the word sections from within a section link in a couple of places. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Poky Reference Manual: Clean up of the XML tagsScott Rifenbark2010-11-151-4/+5
| | | | | | | Added a section id to the 'welcom to poky' section that was missing. Removed a redundant </ulink> tag that was not needed. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* Editing pass through the Introduction chapter.Scott Rifenbark2010-11-041-49/+63
| | | | | | | | | I did a complete edit pass through this chapter. The manual has not been fully edited from its original state. One critical technical correction was corrected where the green-3.3 release was referenced. I changed this to laverne 4.0. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* documentation/pokt-ref-manual: Update with Yocto brandingRichard Purdie2010-10-271-226/+32
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* documentation/poky-ref-manual: Various tweaks to the textRichard Purdie2010-10-151-3/+0
| | | | Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>
* handbook: Move into documentation directoryRichard Purdie2010-10-151-0/+352
Signed-off-by: Richard Purdie <rpurdie@linux.intel.com>