summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
Commit message (Collapse)AuthorAgeFilesLines
* sdk-manual: Updated devtool add workflow section.Scott Rifenbark2018-05-242-132/+121
| | | | | | | | | | | | | Had to update the figure to use "Upstream Source" labels and fix a wrong "devtool edit-recipe" command. That new figure went into both figures folders for the sdk-manual and mega-manual areas. Provideds some cleaner wording. (From yocto-docs rev: 6225d04dd0551a840d929b752225064a222962bc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to section on running the sdk installation scriptScott Rifenbark2018-05-241-6/+15
| | | | | | | | | | | | | I changed the way we handle the list of exported variables resulting from running the *.sh installation script. Rather than list them all out (they were getting to be quite numerous), I am referencing a few as examples and recommending the user look at the actual *.sh file if they would like to examine the entire list. (From yocto-docs rev: ce2c1491f4f0991cad5f8d4a220a102adb024624) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-241-0/+5
| | | | | | | | | | | poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Running the Extensible SDK Environment Setup Script"Scott Rifenbark2018-05-241-19/+29
| | | | | | | | | | | | Some Minor edits to this section. Also, a scrub of the list of variables exported when running the install script. The list is out of date and is missing many variables. I noted these in comments for now and will add them in later. (From yocto-docs rev: 739a2ca42ee798625492ddb51a32ad09f80aa960) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the "Installing the Extensible SDK" section.Scott Rifenbark2018-05-241-27/+36
| | | | | | | | | | | | | | | The text had not been updated to include the many architectures now supported in the Index of Releases toolchain directories. I added the list of architectures. Renamed the section to a more appropriate section heading. Verified the example and put in the latest output. (From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Minor edits to the intro chapter.Scott Rifenbark2018-05-241-27/+40
| | | | | | | (From yocto-docs rev: 706b4adfd925d247da2ce7405f12ce1e05666a9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved the "Simple Build" sectionScott Rifenbark2018-05-242-2/+2
| | | | | | | | | | | | | I had a section on building an image up in chapter that talks about getting set up to use YP. I moved the build section to a new parent section that will hold topics on building various things. I renamed the section to "Building a Simple Image". I had to fix several links in the sdk-manual, overview-manual, and dev-manual. (From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed title to remove redundancyScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | The "Setting Up the Development Host to Use the Yocto Project" title changed to "Preparing the Build Host". Fixed links in a lot of other manual. (From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated devtool modify workflow diagramScott Rifenbark2018-05-241-0/+0
| | | | | | | | | Added detail for the step one. Clearer. (From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated devtool modify workflow section.Scott Rifenbark2018-05-241-96/+125
| | | | | | | | | | | I found this section a bit loosely worded and could result in confusion to a user ramping up with YP. I have done an extensive rewrite focusing on exact wordings. (From yocto-docs rev: af64c07d259e06fb13572fc224636ed240037b57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Eclipse Oxygen plugin instructionsKristi Rifenbark2018-05-241-3/+8
| | | | | | | (From yocto-docs rev: 860f852b0aa99c9c65175fe5fe5035ea0bd26d63) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed redundant link to "Build Directory"Scott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 9ce5617e008ce18656cc04608c50186f3d3b05bf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Scrubbed "Neon" occurrences from the Oxygen chapter.Scott Rifenbark2018-05-241-15/+15
| | | | | | | (From yocto-docs rev: 5c53a75af70a6c6ddaaf5b1d298ea129006f2952) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed minor wording problem.Scott Rifenbark2018-05-241-3/+2
| | | | | | | (From yocto-docs rev: 030fa276d1fc462b321e43547a6da03ca05d590e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed bad title in link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Link was going to the right place but had an old chapter title name. (From yocto-docs rev: 57a5d25180429a97d47678c0782198623bc06eef) 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-242-2/+2
| | | | | | | | | | | | | | | | | 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>
* sdk-manual: Updated "Installing the Neon Eclipse IDE"Kristi Rifenbark2018-05-241-20/+8
| | | | | | | (From yocto-docs rev: e6e6cd146bb821d544b1b9a43307ecd3034f3e52) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed reference to the Neon Appendix.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | The link to the appendix was referencing Appendix C instead of Appendix D. (From yocto-docs rev: b8b4ffe14f74ef0a76289258ae17a3843363397d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed non-eclipse option for Eclipse flowScott Rifenbark2018-05-241-3/+1
| | | | | | | | | | | | | The step in the general Eclipse IDE workflow has a step that tells the user to "Create and Build Your Application." I had a sentence in that step that suggested if you were not using Eclipse to follow some sort of procedure. The whole idea of this flow is to be working within Eclipse. I removed that sentence. (From yocto-docs rev: 83c35e9bb7190464af840822f5dd66d84e15ec64) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added cross-reference to QEMU Emulator.Scott Rifenbark2018-05-241-1/+2
| | | | | | | (From yocto-docs rev: 97b070efdadaec645df24416d61c184065d4b96b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Formatting change to list.Scott Rifenbark2018-05-241-4/+4
| | | | | | | (From yocto-docs rev: 3f0ead6ce135ae8f92fa9cded676bb558424628c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed capitalization issue in a list.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 861ce526456e2ee2f924b57a469e8c8fdb6bb768) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated heads for list on Eclipse developmentScott Rifenbark2018-05-241-8/+7
| | | | | | | | | | | The list headings were not conforming to the capitalization rules for lists used in the YP manual set, which is significant words are capitalized in a bolded item of a bulletted or numbered list. (From yocto-docs rev: af60763b7daccb6af22b4761f6b8370ea1956714) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to the "Using SDK Toolchain Directly" chapterScott Rifenbark2018-05-241-14/+14
| | | | | | | | | | Some minor updates here. Mainly, bring a list into conformance for use of capitalization in the bolded item heads. (From yocto-docs rev: a9c9bb36caa146b0ff8338cb1fad850d75a64997) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated SDK installation script naming explanation.Scott Rifenbark2018-05-241-4/+5
| | | | | | | | | | Updated the various fields for what goes into the name of one of these *.sh files pulled from the download sites. (From yocto-docs rev: 4b326ae834d50607062c2f29c27fccd496489eb6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated note about some tools being deprecatedScott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | | | The note was written such that it appears some performance tools were just recently deprecated with this release of the Eclipse Yocto Project plug-in. This is not the case. I updated the note wording to simply state that those tools are deprecated with the plug-in. (From yocto-docs rev: 4e8aa076ec009c71d7ceeda5c64a617e1c2696fb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Eclipse trademarking usageScott Rifenbark2018-05-246-7/+8
| | | | | | | | | | Made sure that each first occurrence in a chapter used the "tm" mark. (From yocto-docs rev: b7b21441b5fc009b8161902a10cfe1863d87b8a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Cleaned up section IDs between Neon and OxygenKristi Rifenbark2018-05-242-23/+20
| | | | | | | | | | | Updated section IDs for the new Using Eclipse Neon Appendix and Chapter 5 Working Within Eclipse (Oxygen). Changed one link found in reference manual. (From yocto-docs rev: d767007cf4151127063d1992a4e11e90437ae2da) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged the YP Quick Start references from YP setScott Rifenbark2018-05-242-6/+6
| | | | | | | | | | | | | | | The original Yocto Project Quick Start is being retired for the YP 2.5 release (sumo). I have purged all the various references from the YP manual set and replaced them with references to the appropriate doc. The references were mainly into the YP dev-manual for setting up the host or for building an image. There were a few references into the new "Yocto Project Quick Build" document for overviewing manual-type references. (From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed duplicate linkKristi Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 53da7ae95f499bcfb80d4f04b834bf6ade71d2ff) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-14/+25
| | | | | | | | | | | | | 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>
* sdk-manual: Added new appendix for NeonKristi Rifenbark2018-05-242-10/+930
| | | | | | | | | Fixed [YOCTO #12417] (From yocto-docs rev: 9f6b874740b98c5b3eed1c06dcf5fbe687279ca8) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed Mars AppendixKristi Rifenbark2018-05-242-917/+1
| | | | | | | | | | | | | | | Fixed [YOCTO #12417] Deleted the appendix.xml file. Updated the mega manual .xml file to not include the Mars appendix file. Updated the sdk-manual.xml file to not include the Mars appendix file. (From yocto-docs rev: e7752c3db1aec8d5143e78aab44ec5afaaaf9c76) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to the devtool upgrade flow section.Scott Rifenbark2018-03-251-67/+107
| | | | | | | | | | Did some rewriting to add some references to other sections in the manual set. Did some other minor clean up. (From yocto-docs rev: 7e7be31e96a0e73e230b8596b2431716f254e027) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Replaced eclipse-poky repo name to eclipse-yoctoKristi Rifenbark2018-03-032-6/+6
| | | | | | | | | Fixed [YOCTO #12546] (From yocto-docs rev: 6fa7fb663d8a9067ddec783424cf0da81e875669) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Created new "Getting Started" manual.Scott Rifenbark2018-02-142-2/+2
| | | | | | | | | | | | | | | | | | | | 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>
* documentation: Created new YP Overview ManualScott Rifenbark2018-02-142-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* documentation: Set up for "sumo" (YP 2.5) Release.Scott Rifenbark2017-11-121-0/+5
| | | | | | | | | | | poky.ent - updated variables <manual>.xml - updated manual revision tables mega-manual.sed - replaced "2.4" with "2.5" for links. (From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title page notes and author groupScott Rifenbark2017-10-301-0/+7
| | | | | | | | | | | | | Made the title page notes consistent across the manual set. Made the author group information consistent as well. It is better that authorship is seen as a third party and not tied to Intel Corporation. (From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated title page note for manual information.Scott Rifenbark2017-10-301-13/+9
| | | | | | | (From yocto-docs rev: 7f54c31b91c7ec719f507a1b67a99c1b329619f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Minor wording update in title page note.Scott Rifenbark2017-10-301-1/+1
| | | | | | | (From yocto-docs rev: fdfa837b5d453d2721e92b01dda25e3b0a517913) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Changed name of the manual.Scott Rifenbark2017-10-303-10/+8
| | | | | | | | | | | | Change the name of the manual to "Yocto Project Application Development and the Extensible Software Development Kit (eSDK)". The "sdk-title.png" file was updated and all title information was updated. (From yocto-docs rev: 502a49a9e4f5e80efe16507391bc9d9618efefbd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Split the Eclipse section into a separate chapterScott Rifenbark2017-10-305-1212/+1221
| | | | | | | | | | | | | | | This also affected a link in the dev-manual and some setup stuff in the mega-manual and sdk-manual.xml file due to a new chapter being introduced. This section on the Eclipse stuff is big enough to warrant its own chapter. I decided to pull it into a separate chapter of its own. (From yocto-docs rev: a4b2b605902f09bb200facfabb0a7c355fbf4c87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed two links to changed dev-manual title.Scott Rifenbark2017-10-301-2/+2
| | | | | | | (From yocto-docs rev: 2cc71fb47c5281a981509fcd0f31f9100471f841) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Converted external links to internal and fixed dev-title linkScott Rifenbark2017-10-301-7/+6
| | | | | | | | | | | | The dev-manual title changed to the Yocto Project Development Tasks Manual. I fixed a link to this title. Also, fixed several external links that were going to the dev-manual and should have been going to the ref-manual. (From yocto-docs rev: 69c0832ea9378d097e85e23e45cec750b8c42042) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Converted external links to internal links.Scott Rifenbark2017-10-301-2/+2
| | | | | | | | | | Two links that should have been to different places were overlooked. I fixed these. (From yocto-docs rev: a1681d065812546a573ed778141289a6b476cecd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed links to dev-manual for changed dev-manual title.Scott Rifenbark2017-10-301-4/+4
| | | | | | | (From yocto-docs rev: 20fdeaf0a9003e694fb240f75c14e98148459b67) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed link to dev-manual for new title of dev-manual.Scott Rifenbark2017-10-301-1/+1
| | | | | | | (From yocto-docs rev: 43a3b04efa8e579b5cc320a898d94cf886c80d3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>