summaryrefslogtreecommitdiffstats
path: root/documentation/brief-yoctoprojectqs
Commit message (Collapse)AuthorAgeFilesLines
* brief-yoctoprojectqs: buildtools changesTim Orling2020-04-061-4/+7
| | | | | | | | | | | | Bump tar, Python versions and add new gcc requirement. Update reference from 'required-git-tar-and-python-versions' to 'required-git-tar-python-and-gcc-versions' (From yocto-docs rev: ca6334c1653d5e2abfe77865391509a8cd516d88) Signed-off-by: Tim Orling <timothy.t.orling@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Document the basics of WSL and create a link to the ↵Alejandro Hernandez Samaniego2020-04-061-4/+12
| | | | | | | | | | build host setup process (From yocto-docs rev: 225e2aff28a4a68faf1bf1c702e7deacc9effbde) Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org> Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Updates to reflect that MACHINE defaults to qemux86-64Mark Asselstine2020-03-111-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | meta-yocto commit 69ddecdb1516 [local.conf.sample: change default MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to 'qemux86-64' but some documents which either explicitly mentioned the default, or where this was implicit didn't receive an equivalent update. Where it made sense we continue this change in default to the docs. In other places, such as the kernel-dev manual, we note the new default and instruct the user how to switch back to 'qemux86'. Eventually we should probably update the kernel-dev manual to use the default, but for now the intention was to limit the impact of these changes. Note that ext3 has also been replaced with ext4 for image generation, so while we are modifying runqemu lines to qemux86-64 we also make the change to reference ext4 such that the runqemu commands will function properly. (From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b) Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual; brief-yoctoprojectqs: Updated checkout branch exampleScott Rifenbark2019-05-071-0/+1
| | | | | | | | | | Added the "yocto-2.6.2" tag to the example output since that will be part of the overal list when 2.7 releases. (From yocto-docs rev: 4863284811ad459cb0193528d5686a1ec008bb3e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Removed customization.xsl files for EclipseScott Rifenbark2019-05-071-35/+0
| | | | | | | | | | | The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP Documentation: Updated host package listsScott Rifenbark2019-03-191-1/+1
| | | | | | | | | | | Changes to the lists resulted in the testing and graphics & Eclipse Plug-in lists going away. Also, I added several packages based on some testing requirements to the "Essentials" list. (From yocto-docs rev: cbc9a595bef3dd80f5eef1376e466627248f9fda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated tag list in example.Scott Rifenbark2019-02-251-5/+7
| | | | | | | (From yocto-docs rev: 93fabeb457ba98dc3a328a5951b82f5419276c8f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs, dev-manual: Update tag checkout examplesScott Rifenbark2019-01-161-9/+63
| | | | | | | | | | | | Turns out I had some hard-coded stuff in these examples. Furthermore, I did not have good enough detail in the brief-yoctoprojectqs manual. I added more detail on how to get that sato example going. (From yocto-docs rev: 3dd6217be5e6f73ba3927431105096aec1445e10) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added warnings about WSL, which can't be used.Scott Rifenbark2018-11-221-11/+28
| | | | | | | | | | | Windows Subsystem for Linux (WSL) is not compatible with the Yocto Project. Added information in the beginning to note this fact to the user. (From yocto-docs rev: d8fcc0e3dc609086ca82a3419a337350f4e5c529) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed section title for required packages.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | | | The title needs to use the terminology "Build Host" to be consistent with the manual set. I updated the title and the many links into that section. (From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Changed to "Locating Yocto Project Source Files". I am moving the sections on cloning repositories out from under this section. (From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Removed all references to "OpenEmbedded"Scott Rifenbark2018-05-241-10/+6
| | | | | | | (From yocto-docs rev: fd405db2962d20055ba213e35ed0d13c7672d2e8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added clarifying statement for the build systemScott Rifenbark2018-05-241-1/+2
| | | | | | | | | | | The term "OpenEmbedded build system" was being introduced with just a link. Apparently, that is not enough for marketing. I added a clause with some more information about it. (From yocto-docs rev: e7a3a581d44e21976c3f6fe19330e19af1ae0773) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added reviewer feedbackScott Rifenbark2018-05-241-26/+29
| | | | | | | | | | | | Softened the opening paragraph so it was not introducing any special terms right off the bat. Renamed the section on the hardware layer to configuring the build for specific hardware. Put in a link to "build host" and used that term throughout. (From yocto-docs rev: a324cb2f9c499dc8d68d1d87265930c308cbebb7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added link to "OpenEmbedded build system" term.Scott Rifenbark2018-05-241-2/+4
| | | | | | | (From yocto-docs rev: a7a5dc58b1f66cf270d737fa6ddd447364cf77c1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added more detail about layer greatness.Scott Rifenbark2018-05-241-2/+9
| | | | | | | (From yocto-docs rev: 935497e3d3a39cdc5eadcdd790466e3d18a65f25) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added sections on layersScott Rifenbark2018-05-241-1/+137
| | | | | | | | | | Added a section on adding a machine layer. Used Altera as an example. Also, added a section on creating a general layer. (From yocto-docs rev: fc36f006bd483a5c26d2b79a18431d16ec27dc00) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added customization file for eclipseScott Rifenbark2018-05-241-0/+35
| | | | | | | | | | this file was accidentally dropped during all the manual reording operations. I have restored it. (From yocto-docs rev: 5c1244f18ede1af0a540687cfb5d9071fbb3c1c0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-241-3/+3
| | | | | | | | | | | | | | | | | 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>
* brief-yoctoprojectqs: Fixed broken linkScott Rifenbark2018-05-241-3/+3
| | | | | | | | | | | | Found a link to a deprecated "overview" manual. Replaced it with the proper ENTITY to the getting-started manual. Removed the ENTITY to the old "overview" manual. (From yocto-docs rev: 891e4902052743833c422e6a557c93de42ed892d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-241-5/+6
| | | | | | | | | | | 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>
* documentation: Fixed "Getting Started" manual linksScott Rifenbark2018-05-241-1/+2
| | | | | | | | | | | | | | 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>
* documentation: Added brief-yoctoprojectqs to mega-manualScott Rifenbark2018-05-243-1/+1
| | | | | | | | | | | | | | | | | | | | | | | The original QS (yocto-project-qs) has been retired for the YP sumo (2.5) release. The manual has been replaced with the brief, two-page quick build document (brief-yoctoprojectqs). I needed to create a new title figure for the manual to include as part of the mega-manual (bypqs-title.png). The figure was added to the figures folder of both the bried-yoctoprojectqs and mega-manual book folders. I also removed the old ypqs-title.png file that was used for the original QS. Updated the stylesheet doc for the brief build to include a style using the new title .PNG file. Updated the mega-manual.xml file to include the brief doc and exclude the original QS. (From yocto-docs rev: aadec4a70fa89e4dcd233c337d8971c8353ee26d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Changed titleScott Rifenbark2018-05-241-41/+1
| | | | | | | | | | | Changed the title to "Yocto Project Quick Build" from "My First Yocto Project Build", which sound a bit too much like "My first little Pony." (From yocto-docs rev: c797590d3cd341a9c492c7af49a927e1d241184e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated wording to use ENTITY variablesScott Rifenbark2018-05-241-4/+4
| | | | | | | | | | | The tip box shows how to ure the mirrors for the most recent release and the most recent release minus one. I set these up to use variables rather than hardcoded releases. (From yocto-docs rev: ad47deb8ac1fc074ed3fdf3627609ac3ab38e92b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added link to getting started manual.Scott Rifenbark2018-05-241-0/+9
| | | | | | | | | | Provided a bullet item to the Getting Started manual in the "Where to Go Next" section. (From yocto-docs rev: ce4edc521d19b3c8025e950061cc962ca88fa29e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-20/+38
| | | | | | | | | | | | | I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated tip to mention the index of all sstateScott Rifenbark2018-03-031-0/+5
| | | | | | | (From yocto-docs rev: c8fac47e6bf0a610cb5ec190b1c8ae67c78d1044) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Removed Manual notes from title pageScott Rifenbark2018-03-031-2/+3
| | | | | | | | | | | This document is not a manual. We are not going to list it as a full-blown manual. It does not need the "Manual Notes" part in the title page. (From yocto-docs rev: 23267dea9a90dda33d646fcfc3e8b7a1c919adea) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added "tip" to use mirrors to speed build.Scott Rifenbark2018-03-031-1/+15
| | | | | | | (From yocto-docs rev: 4088481f081e4746da4a774648a59d6ec31439b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated reference to wiki for Proxy issues.Scott Rifenbark2018-03-031-1/+1
| | | | | | | (From yocto-docs rev: 0618e0bebc69f13ce0cd2a120d2a141b5e77e115) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Slight wording change regarding Poky meaning.Scott Rifenbark2018-03-031-2/+2
| | | | | | | (From yocto-docs rev: 2363aa3bb45b6683208b71399996031e7d47a6c1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* .gitignore: Added html, pdf, tgz, and eclipse types to ignoreScott Rifenbark2018-03-032-240/+0
| | | | | | | | | This is for the brief-yoctoprojectqs article. (From yocto-docs rev: 7237c9a36e855eee9056650455a4b6f3d2412961) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs, Makefile: New "First Build" article.Scott Rifenbark2018-03-038-0/+5410
I have created an brief article in the form of current YP docs that is a pared down version of the Quick Start (pre 2.5 release). The article fills a gap for a short (2-page), process-oriented article that steps the user through an initial build using YP. I had to make changes to the Makefile to support building the new article. (From yocto-docs rev: 47aace60cea4a892ae1efabb050b240c6abdaec9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>