summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/faq.xml
AgeCommit message (Collapse)Author
2018-05-24documentation: Updated everything for new overview-manualScott Rifenbark
This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Changed getting-started manual titlesScott Rifenbark
Throughout the documentation, the manual "Getting Started With Yocto Project" was used. The manual now is called "Yocto Project Overview and Concepts Manual". (From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24documentation: Fixed "Getting Started" manual linksScott Rifenbark
There was inconsistent use when referencing the getting-started manual. The manual's name does not include the word "Manual". So, I cleaned this up across the manual set and also in the mega-manual.sed file, which was incorrectly processing the links to that manual that do not target a specific section. (From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-05-24mega-manual: Fixed various links to the dev-manualScott Rifenbark
Found a few links that were not using the correct wording when referencing a section to the dev-manual. Also, fixed one link that was assuming a section outside the dev-manual when the link was to a section inside the dev-manual. (From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Purged overview manual referencesScott Rifenbark
When I converted the Yocto Project Overview Manual to the Getting Started With Yocto Project Manual, I updated the strings for references from "&YOCTO_DOCS_OVERVIEW_URL" TO "&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command that did not take into account the text the might follow the link by saying "see such-and-such section in the Yocto Project Overview Manual." So, I had to hand fix these. Additionally, since I have moved a deeper concepts chapter that was in the getting-started manual to a new Yocto Project Concepts chapter, many of those links changed had to really go to the new manual instead. Those were fixed. (From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new "Getting Started" manual.Scott Rifenbark
Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new YP Overview ManualScott Rifenbark
Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-30ref-manual: Fixed "Oe-Core" links and links to dev-manual.Scott Rifenbark
The dev-manual name has changed to the "Yocto Project Development Tasks Manual." I had to update some references to the manual. (From yocto-docs rev: 64b5f18b953c89811a08f76a302e29e25ad2fb70) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-10-16documentation: Updates to cull out buried YP Website references.Scott Rifenbark
With the redoing of the YP website, it was decided that the manuals could only reference into the top-level and the top-level/documentation URLs of the website. I removed all references to areas such as projects (e.g. Toaster, VM, etc.) and any other URL that was not the top-level landing page or the documentation page. (From yocto-docs rev: 2bd838f1a9fb2698bab098b13b76c8852853e0e7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-22documentation: Purged "oe-init-build-env-memres" from docsScott Rifenbark
Fixes [YOCTO #11968] Purged all occurrences of the "oe-init-build-env-memres" script from the YP documentation set. Occurrences in a lot of places. The BBSERVER variable was also impacted and had to have the definition updated. (From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual, ref-manual: Moved "Licenses" section to ref-manualScott Rifenbark
Fixes [YOCTO #11630] Moved the "Licenses" section from the dev-manual to the ref-manual. The information in the section is purely reference material and does not belong in the dev-manual, which is being reconstructed as a "how-to" manual. (From yocto-docs rev: a89cb18f6cab6702a2bf2a0f77d46e64f82b1729) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Fixed links for "build-directory" term.Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Fixed links to "bitbake-term"Scott Rifenbark
Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual. Doing so caused all the links to the id "bitbake-term" to break. These had to be individually fixed. Discovered two unresolved references that were a consequence of moving that section to the ref-manual. These were fixed as well. (From yocto-docs rev: 829ca6b64562f00a69f3956e9636c7edaa90ce16) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23yocto-project-qs, ref-manual: Updated Python requirement to 3.4.0Scott Rifenbark
This is the minimum requirement for YP 2.2 release. (From yocto-docs rev: 0aebdd8556a6e5a52c0caf28dc97c1872b40e950) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23yocto-project-qs, ref-manual: Removed Python 3.0 exclusionScott Rifenbark
Fixes [YOCTO #10178] Previously, YP did not support Python 3.0. We mentioned that in the manual in several places as a requirement for running YP. I removed this exclusion in the following areas: * yocto-project-qs - the section that tells what version of Python you need. * ref-manual - the section that tells what version of Python you need. * ref-manual - the FAQ entry about not having the right version of Python. (From yocto-docs rev: 5a0d3ac1c2a4154b93dc925b8074bc9243a86faf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06ref-manual: Updated verbiage on proxy handlingScott Rifenbark
Fixes [YOCTO #9313] Update the DL_DIR variable description to add a cross-reference to the wiki page that talks about working behind a firewall. Updated the 14.12 FAQ entry with new information about working behind the firewall. (From yocto-docs rev: 056e6881951023e62a7363ba60fe73cd6d2932b6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03ref-manual, dev-manual: Clarification of "native" and "sdknative"Scott Rifenbark
Fixes [YOCTO #8620] I went through and made some judgement calls on the use of "native" and "sdknative". I tried to make sure that the reader understood the real meaning of these terms. (From yocto-docs rev: d711e8c6dfb32a4ad79e9d11dbf44fbc759d0245) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-02-04ref-manual: Fixed typo in FAQ 14.15 section.Scott Rifenbark
Found the word "Ebedded". Fixed to "Embedded". (From yocto-docs rev: 65815012cd70b52b7558e6402f0eec946eb3d445) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-02-04ref-manual: Updated FAQ entry regarding Proxy for SOCKSScott Rifenbark
Fixes [YOCTO #8637] Added an example to the section for https_proxy. Also added a small example section for SOCKS proxy. Reported-by: Liam R. Howlett <liam.howlett@windriver.com> (From yocto-docs rev: e17510f1209660b934e27f52a3e5c01a1f213453) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-24ref-manual: Removed FAQ question for GNOME Mobile.Scott Rifenbark
(From yocto-docs rev: d214db03da1802ca9a42eaed64b51daa8f7f5682) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual: Added "leakage" FAQ entry.Scott Rifenbark
Fixes [YOCTO #6852] I added a new FAQ entry to address situations where during a native build, the build fails due to previously installed stuff on the system from /usr/local/include and /opt. The entry tries to cover "leakage" issues in general but calls out the specific case involving libiconv and iconv.h. (From yocto-docs rev: 2c09c7ee0970189953bfbbdcaac49a1ebe8482fe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-10-18ref-manual: Scrubbed for variable (user) input.Scott Rifenbark
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>
2014-08-12ref-manual: Edits to some FAQ entries.Scott Rifenbark
Minor review edits from Max. (From yocto-docs rev: c70de50aeceda60db92c5e488bde8fe910eaeba1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12ref-manual: Review edits to new FAQ entries.Scott Rifenbark
(From yocto-docs rev: f484b8d752fe1957f36745bfa6bb2aebd8ac1e5a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-12ref-manual: Updated a couple FAQ entries.Scott Rifenbark
(From yocto-docs rev: aa445a20ae68d7648a3ccfb76ec42aa5fb95fe01) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02ref-manual: Added two new FAQ entries.Scott Rifenbark
One has to do with the weird names the build system creates based on DESTDIR and other variables. The other has to do with -native recipes not buiding correctly. (From yocto-docs rev: 32a444a258e3c7c87fdc015475f54e5b34628246) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18ref-manual: Edits to the FAQ entry on getting source and firewalls.Scott Rifenbark
I added a note at the end of the section to point to a wiki page with more information. (From yocto-docs rev: ba310c34844e9e496d7ff1164691930d4f330f93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25ref-manual, yocto-project-qs: Notes and infor for buildtools issuesScott Rifenbark
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>
2014-01-21ref-manual: Fixed cross-reference anchor name.Scott Rifenbark
(From yocto-docs rev: 15c124c85e95e070c959ab110511ddd70acbb71f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-02ref-manual: Updated FAQ entry cross-reference.Scott Rifenbark
The FAQ entry for the information on adding a package to your image changed regarding the cross-reference. I updated it to the new anchor tag. (From yocto-docs rev: 6c6b4cced41354412dc8c8d3c99d69f3a7cc8a95) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-01-02ref-manual: Updated the FAQ entry for how to use an external toolchain.Scott Rifenbark
We no longer have the external-sourcery.bb recipe. Had to rewrite this around it. (From yocto-docs rev: 4b0e3860216092461862d29b3a53a834f8dd43b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03ref-manual: Removed FAQ entry about running on RHEL/CentOS 5.1.Scott Rifenbark
We don't even support these Linux distributions. We should not have a FAQ entry telling people how to deal with it. If the distro is that "hot", we should take steps to support it. (From yocto-docs rev: b2f77f048da82becb590f948c41e94598817b4ee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03ref-manual: Updated the FAQ entry about old Python versionScott Rifenbark
I re-wrote this FAQ entry to indicate more recent versions of Python and to leverage off the way we can now download or build out the buildtools. Reported-by: Paul Eggleton <paul.eggleton@linux.intel.com> (From yocto-docs rev: a4743936fa6dcd9449f0def771d116c53db7aa7e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12documentation: Added the memory-resident BitBake featureScott Rifenbark
The main changes are captured in a new section devoted to the oe-init-build-env-memres script within the ref-structure.xml file and in the variables.xml file in a BBSERVER variable entry in the glossary. All other changes were necessary to integrate the new functionality into areas where running the setup script are discussed. Before this feature, there was a single setup script (oe-init-build-env). Consequently, wordings and such were designed exclusively for this single method. With the introduction of a second possible method to initialize the build environment, tweaks to many sections were needed. Beside the wording tweaks, appropriate cross-referencing was also needed. All these changes cover the integration of the new feature. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13ref-manual: Typos fixed.Scott Rifenbark
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>
2013-08-13ref-manual: Added a section reference to external toolchain question.Scott Rifenbark
(From yocto-docs rev: 6b125e0e0f09e817422f899923d51ee73923b15b) 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-04-13ref-manual/faq: virtualisation not visualisationPaul Eggleton
(From yocto-docs rev: b142d884656c39d0862dd9fd1cb7e60875dee603) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-13ref-manual/faq: clarify that package management is optionalPaul Eggleton
Fixed the line breaks so new sentences start on a new line. (From yocto-docs rev: 6bb50f51edc44222970db42d7441303d042a2262) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04dev-manual, ref-manual: Rewrote the adding a package titleScott Rifenbark
Second thoughts caused me to adjust this title again. Also fixed the cross-ref in the FAQ. (From yocto-docs rev: 0553790236c60d30306b796587cd5b5213456aff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Updated a link because the section title changed.Scott Rifenbark
(From yocto-docs rev: 97fa6e89dab3d9bdea4971bdd92ddc468fb0442c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Spell check - fixed one typo.Scott Rifenbark
(From yocto-docs rev: 9d0726aa3584e2d8381de45774bb9c4c27ff1f5b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the git rid of all output question.Scott Rifenbark
(From yocto-docs rev: fb0fb77f581eef9eb6fcb4226d618d0927d3ad10) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the getting source from behind firewall question.Scott Rifenbark
(From yocto-docs rev: 11f95cb2cafef69cd2160afb62ec7444bf8cc0a9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the using an external toolchain question.Scott Rifenbark
(From yocto-docs rev: 8fc82c1dfc527cf8356bed580077cb9e6f665876) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the spaces in pathnames question.Scott Rifenbark
(From yocto-docs rev: c34de7720930583058625fc21c83895c659966af) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the create more free space question.Scott Rifenbark
(From yocto-docs rev: e1bfd2f51a6e63c2db6569ff6f9b017dd14e0b0c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the connected network interfaces question.Scott Rifenbark
(From yocto-docs rev: 7daeab80d41c44b87c0f188b935eeec6fd37bc6a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the disabling cursor question.Scott Rifenbark
(From yocto-docs rev: f1b869827e8f12b420aec800f4d256dddabce285) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Edits to the License Compliance question.Scott Rifenbark
(From yocto-docs rev: bdf123ae728ff5725831dab5d5e0505bbb56bac2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>