summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/introduction.xml
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Updated list of supported distros.Scott Rifenbark2014-10-281-0/+2
| | | | | | | | | Added Debian 7.5 and 7.6 to the list. (From yocto-docs rev: 35fd5d5399fe1759158aef19d7b6eb68f2a1af12) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-4/+4
| | | | | | | | | | | | | | | Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the introductory section list manual overview.Scott Rifenbark2014-10-181-0/+4
| | | | | | | | | Added the new QA Warnings and Messages chapter to the list. (From yocto-docs rev: aab515c793107b7c0b3a8a26f522cf26461fd3d4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated note in the "CentOS Packages" section.Scott Rifenbark2014-07-251-5/+11
| | | | | | | | | | We want to encourage installation of the buildtools tarball for getting the most up-to-date packages on this build host. (From yocto-docs rev: 5298737a5ad579ea5097221d2ef5a0f388ebff6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, yocto-project-qs: Fixed required Git to 1.7.8+Maxin B. John2014-07-031-1/+1
| | | | | | | (From yocto-docs rev: ca86bbd8c4d9be44cbc11f579d0720aaf30cbc6c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new chapter on task documentationScott Rifenbark2014-05-131-0/+4
| | | | | | | | | | | | | | Changes to support a new chapter on the 51 tasks that the OpenEmbedded build system defines. The changes include a new file called ref-tasks.xml, changes to the ref-manual.xml building file to include the new chapter, and a new bullet item to the list that describes what is in the reference manual. (From yocto-docs rev: a816746051ec025014e515fb848b3e0e58d4c7be) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the list of supported distributions.Scott Rifenbark2014-04-211-4/+8
| | | | | | | | | I get this list from meta-yocto/conf/distro/poky.conf. (From yocto-docs rev: 796d4eced50d14203f1a791ff557a4016f4dd031) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the "Introduction" section.Scott Rifenbark2014-03-301-1/+6
| | | | | | | | | | | During the read-through, I noticed that I did not have a complete list of YP manuals in the "Introduction" section. I also added the new BitBake manual to the list of external manuals. (From yocto-docs rev: 46ae0400d807c733bc0c32b07b4b59cc8d6d2618) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the laundry list of what sections are in the manual.Scott Rifenbark2014-03-301-0/+10
| | | | | | | | | | This had been negleted and many new sections were not on the list. It is all up to date now. (From yocto-docs rev: 3291491ec41146a1dfa0cb2f1387fba85b1c7d24) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the BitBake chapter.Scott Rifenbark2014-03-301-4/+0
| | | | | | | | | | | | | | | This information now exists in the separate BitBake User Manual. To remove this information, the ref-bitbake.xml file was taken out of the ref-manual.xml build, an overview bullet describing BitBake chapter was removed from the "Introduction" chapter, and one cross-reference link to a sub-section of the old BitBake chapter had to be re-routed into the similar section of the BitBake Manaul. (From yocto-docs rev: 3828291699b5997c28a782600c9d472b8449ecd3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Point out "xterm" needed for eclipse use.Scott Rifenbark2014-03-301-8/+16
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #5766] In the ref-manual, I added "Eclipse" use in the title for the "Graphics Support" packages because the "xterm" package is required for graphics support across all distributions. In the dev-manual, I specifically called out the need for "xterm" as a host package at the top of the section describing workflow with Eclipse. I also updated the cross-reference links to the host package and Linux distro requirements to point into the ref-manual, which is more comprehensive, than into the QS. (From yocto-docs rev: d3405be506fcb113f01d4fcba4631db80a1ed5dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, yocto-project-qs: Notes and infor for buildtools issuesScott Rifenbark2014-03-251-52/+131
| | | | | | | | | | | | | | | | Fixes [YOCTO #4866] Updated the main area where it talks about needing the right versions of Git, tar, and Python. You can get this set up using a couple methods. I documented both. The changes in the FAQ and in the QS are basically notes that point to that section for more information. (From yocto-docs rev: 1b64c7c271303ecf10ec85c8a2cd5a0d909f1151) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent, ref-manual: Updated list of Fedora packagesScott Rifenbark2014-01-081-1/+1
| | | | | | | | | | | I added perl-Thread-Queue to the essential and graphical package sets for the Fedora distribution. Reported-by: Richard Purdie <richard.purdie@intel.com> (From yocto-docs rev: 26b1ce3cd1fb20b67107d0d1bc0a66cc3a06706e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fixed typoRobert P. J. Day2013-12-031-1/+1
| | | | | | | | | Removed extra "the" (From yocto-docs rev: 58582739dcb3f969ee44b074040bb64773d9d4bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Small number of fixes to Ch1 of ref-manualRobert P. J. Day2013-12-031-4/+4
| | | | | | | | | | | | Three chunks attempted in a patch from Robert. Two out of three worked. One did not because the text had changed due to re-writing a note that had some links to out-of-date wiki pages. (From yocto-docs rev: 7f807d6df4842d47534c4011ccf67fd01bf0b830) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed out-of-date links in supported distros section.Scott Rifenbark2013-12-031-5/+0
| | | | | | | | | | | | The links to the supplemental information wiki pages on setting up your system to run YP were terribly out of date. I re-wrote the section to remove them. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 0a2a2b95781e6b70d584612c33f81839cf7a10c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the "Development Checkouts" sectionScott Rifenbark2013-11-011-4/+3
| | | | | | | | | | | Partial fix for [YOCTO #5368] Removed the tarball method completely. (From yocto-docs rev: ca898b6ada09cdf88d6eab373119aac941299363) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: updated the list of where to get YP releaseScott Rifenbark2013-11-011-7/+23
| | | | | | | | | | | | | | | Partial fix for [YOCTO #5368] The list that summarized where to get YP release did not include the source repositories. It basically just listed tarball areas. Now that cloning the Git repo of poky is the preferred method for obtaining YP, I made sure that this area was the first spot listed and called out as the preferred method. (From yocto-docs rev: d5aabd2cb70ea7b7caf5f39d0630ba6961280e1a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated link to build tools.Scott Rifenbark2013-11-011-1/+1
| | | | | | | | | | The link had a hard-coded 1.5 in it. I replaced it with a &DISTRO variable that resolves to the release. (From yocto-docs rev: ce7ae7131a7e1d79bbc67e82cb5232a6ffbaa324) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated supported distros list.Scott Rifenbark2013-10-011-12/+14
| | | | | | | | | | We bottomed out on this list and this change represents the latest. (From yocto-docs rev: 65718c40ccfb3cdbea756dbc7319b06d8f13a7b5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to restore the supported Linux distro list.Scott Rifenbark2013-10-011-3/+11
| | | | | | | | | | | This list evidently is not quite ready so I put it back to its orginal form with a couple of commented out lines in there for some distros that might be part of the list. (From yocto-docs rev: 3ace1c2e54675de72538742bc9920c5acbe36e8b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: udated list of supported distrosScott Rifenbark2013-10-011-2/+1
| | | | | | | (From yocto-docs rev: f0ad9b74a9d5af9f776b55d177a45df306284d82) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: updated the note about what distros we supportScott Rifenbark2013-08-261-1/+2
| | | | | | | | | | | | Fixes [YOCTO #4927] Added some minor wording to the note to indicate that we currently have no plans to support rolling releases. (From yocto-docs rev: d3b7b4791c01ce01ac9e50c78e9223955eb9b3f2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual, yocto-project-qs: Debian support addedScott Rifenbark2013-08-131-4/+4
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #4912] Throughout the manual set, various areas talk about the Linux distributions we support and the required packages among other items that are tied to a distro. Debian had been missing except from the list in the ref-manual that shows the releases we test against. I have attended to all areas where Debian needs to be mentioned now. Reported-by: Laszlo Papp <lpapp@kde.org> (From yocto-docs rev: 2004567821add745d320106b0dc6cccb4f73b605) 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>
* 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: 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>
* 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: 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>
* 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: 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>
* ref-manual: Added xmlto and dblatex packages for docsScott Rifenbark2013-05-221-4/+4
| | | | | | | | | | 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>
* ref-manual: Added Ubuntu 12.04 (LTS) to list of supported distros.Scott Rifenbark2013-05-221-1/+2
| | | | | | | (From yocto-docs rev: 9452cc3eda50a901682c4c36b8abcc0f556711a7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated supported distros listScott Rifenbark2013-05-221-9/+4
| | | | | | | | | | | | | | | | | | 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>
* ref-manual: Minor edits to the supported distros listScott Rifenbark2013-04-171-4/+1
| | | | | | | | | | 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>
* ref-manual: Generated and included new list of supported distros.Scott Rifenbark2013-04-171-4/+8
| | | | | | | (From yocto-docs rev: b8b2b8950863ef2684f76336671598431be716d2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a cross-reference Heading to match.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: ed97ec84b7a4ab05bfcde911674455fdb257969b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied better wording.Scott Rifenbark2013-04-041-2/+2
| | | | | | | (From yocto-docs rev: d6c93a7d975e148c69b0b9c8fa0a478ad6d7abc5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed typo.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 54d76c5e7ea98dd9e1fdc98f55ecd93206fe25fb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: List wording changes for brevity.Scott Rifenbark2013-04-041-12/+12
| | | | | | | (From yocto-docs rev: 2ad8b4fab383266f93f8edc57400060f9a76fa22) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Capitalization fix.Scott Rifenbark2013-04-041-2/+2
| | | | | | | (From yocto-docs rev: 3675f08ff8860dad80af3558e49c1502d726d64d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Small edits to introduction paragraph.Scott Rifenbark2013-04-041-1/+3
| | | | | | | | | Added a reference to the BSP Manual. (From yocto-docs rev: f65c6d41bfe92c6bbc795982a1d1113e60cbf7dd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a general reference and link to kernel-devScott Rifenbark2013-01-271-1/+2
| | | | | | | | | | Put in a cross-link to the new YP Linux Kernel Development Manual up in the introduction. (From yocto-docs rev: ba00acb1a0db9494b0d0ff1335f2532b5e2a7994) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Rename of poky-ref-manual folder to ref-manual.Scott Rifenbark2013-01-071-0/+322
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-04-28 00:43:02 +0000