summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Prepare for 2.6.1 release.Scott Rifenbark2018-12-271-1/+6
| | | | | | | | | | | | | | | | Updated the following: * poky.ent to use new variables values for 2.6.1 * mega-manual.sed to use "2.6.1" string for links * *.xml manual files to have a new entry in the manual history tables. Using the variable for the most recent entry. Hard-coded "November 2018" for the previous release, which was "2.6". (From yocto-docs rev: bada424e14169d1ae378c0481970e55ce8f5df51) 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>
* documentation: Fixed bad target ID for the dev-manual.Scott Rifenbark2018-08-152-2/+2
| | | | | | | | | This fix involved a few other manuals. (From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Minor intro wording changeScott Rifenbark2018-08-151-1/+1
| | | | | | | (From yocto-docs rev: 953db3d0b5fe14411e944b021a2f6f50a5bdeabd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed bad anchor string.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | Broken link fixed. (From yocto-docs rev: 420bc55ceac1d8c89f9153a70c8b4e3ca38d747d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated section on minimizing eSDK installer sizeScott Rifenbark2018-08-151-12/+12
| | | | | | | | | I made some re-writes for clearity. (From yocto-docs rev: a68619a2ba8b7877cde6c9ef7dbb726adc75b0cd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Converted bullet list to ordered listScott Rifenbark2018-08-151-2/+2
| | | | | | | | | | | On second thought, the list I turned into a bullet list from the previous commit was a bit hasty. That list is order dependent. Reverted the list. (From yocto-docs rev: 9ea640ffea2a2c9827f18070a5b287453c8653e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated "Providing Additional Installable Extensible SDK Content"Scott Rifenbark2018-08-151-18/+29
| | | | | | | | | | The list appears to be not a numbered list. Fixed that. Also, provided better wording around "exposing" the sstate-cache. (From yocto-docs rev: 15c65db41c9e6eddf7d12e138f6c63755e845beb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Provided better wording for sharing HTTP or HTTPS serverScott Rifenbark2018-08-151-1/+6
| | | | | | | | | | | | Step 1 of the "Providing Updates to the Extensible SDK After Installation" section really did not do much for the reader regarding setting up a HTTP or HTTPS directory. I added more detail on how to generally do that. (From yocto-docs rev: ff250cea239668db5fe26aa912942c0d142833fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to the section that changes the sdk titleScott Rifenbark2018-08-151-3/+20
| | | | | | | | | | Made some suggestions on how and where to edit the SDK_TITLE variable. (From yocto-docs rev: 4a4393e00c7108eefaaeaa3951a75524589bf360) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated section on changing SDK installer title.Scott Rifenbark2018-08-151-3/+9
| | | | | | | | | I added more detail to this section. (From yocto-docs rev: 15beb33eadd03391a1af0c9bad0620cefad2a0e2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added section on changing the default ext. SDK install directoryScott Rifenbark2018-08-151-0/+45
| | | | | | | (From yocto-docs rev: d3f0c7b9e2ddea3fec6f42fc9a3c8806b02119f3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to sections for updating installed Ext SDKsScott Rifenbark2018-08-152-20/+29
| | | | | | | | | | | | | | | | There are two sections that deal with this topic. One is from the standpoint of a user using a 3rd party published and installed extensible SDK ("Applying Updates to an Installed Extensible SDK"). The other is from the standpoint of a person providing Extensible SDKs for consumption ("Providing Updates to the Extensible SDK After Installation"). These sections needed some closer examination regarding fully describing what was going on. I provided some re-writes to both. (From yocto-docs rev: 1c60b13b5f1813d6e3688e1efce32b7f31422e86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Changed title to updating the SDK after installScott Rifenbark2018-08-151-3/+3
| | | | | | | | | | | The title for the section on how to effect changes to an installed extensible SDK is better suited as "Providing Updates to the Extensible SDK AFter Installation." (From yocto-docs rev: 2120ba194abada1769be28ae2737ac12a16adebc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed grammar errorScott Rifenbark2018-08-151-2/+1
| | | | | | | | | | | In "Providing Updates After Installing the Extensible SDK" section, Step 1 had a bit of a grammar error. Not technically, but it could have been written better. I fixed that. (From yocto-docs rev: 20f1cad5a813697afd99837699bf52a6586893bb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated section on changing title of extensible SDK installerScott Rifenbark2018-08-151-3/+14
| | | | | | | | | | I added more information on how this is done. Still could use a bit of detail on how you actually do it. (From yocto-docs rev: 007bbe40fd11a5f880adf7ad8137d1535f08c815) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Grammar fixScott Rifenbark2018-08-151-1/+1
| | | | | | | (From yocto-docs rev: b850e0d520401a52fbba083975f05f529b2b554d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Adjusting the Extensible SDK to Suit Build Host"Scott Rifenbark2018-08-151-19/+31
| | | | | | | | | I updated this section with clearer text. (From yocto-docs rev: 433388ff37297d905c465a5f05d93953dfe062c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Configuring the Extensible SDK" sectionScott Rifenbark2018-08-151-12/+17
| | | | | | | | | | Made improvements to this section and tied the variables together for the explanation. (From yocto-docs rev: de882b81ed8525dee5e10f247cc6f5c8f15e0f72) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated the fig for installed ext. SDKScott Rifenbark2018-08-152-7/+5
| | | | | | | | | | | This figure had changed. I updated the file and folder hierarchy. Also fixed some wording. (From yocto-docs rev: 359292397781f9f5eac2fb693d89ec286ddf9940) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated standard SDK install directory figureScott Rifenbark2018-08-152-1/+1
| | | | | | | | | | | The figure was incorrect for the installed file and folder hierarchy for a standard SDK. I updated it. This figure goes in both the sdk-manual and the mega-manual. (From yocto-docs rev: a0dc11ce74bba0a18f385d9800f93524340ed033) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Final edits to the extracting root filesystem sectionScott Rifenbark2018-08-151-22/+26
| | | | | | | | | Verified a good example and updated the text to match that example. (From yocto-docs rev: 053467557ef22ce37762222a2997ff9c10be87e8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added note in step to set SDKMACHINEScott Rifenbark2018-08-151-0/+14
| | | | | | | | | | | The value of SDKMACHINE must match the architecture of the machine on which the SDK installer is being built if you are building an installer for an extensible SDK. I added a note to this effect. (From yocto-docs rev: ffdd9a9d00cccf270b5aa236279e6eeea0ff47ed) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to section on obtaining the SDKScott Rifenbark2018-07-071-6/+12
| | | | | | | | | Updated the example to more current information. (From yocto-docs rev: 6952824473f820cbe6d02cba9523c023652f68e3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Building an SDK Installer" section.Scott Rifenbark2018-06-281-11/+12
| | | | | | | | | | Updated some links. Also, rewrote the note about the libraries. It was inaccurate. (From yocto-docs rev: a0fce0ed36f3d0668e2d211433e7d93fb8833319) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to the section for locating SDK installersScott Rifenbark2018-06-281-13/+14
| | | | | | | | | | | I corrected some wrong information. Provided the correct terminology for the build host, and provided quotations for supplied values to be in line with manual writing conventions. (From yocto-docs rev: 420a7e96e7145dbef31d706cd257059619f71e12) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to Depolying and DebuggingScott Rifenbark2018-06-282-23/+36
| | | | | | | | | | Made several formatting changes for selections. These should be using quotes and not being formatted in Courier. (From yocto-docs rev: ec0a2d7e3cfd78fa4e508d5672f1c8265a3600a4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to neon section building the projectScott Rifenbark2018-06-281-2/+1
| | | | | | | | | Rendered a menu correctly instead of in formatting mode. (From yocto-docs rev: 7c7da68171dfee037d02fa683c5cba047237fd52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to configuring the cross-toolchains section.Scott Rifenbark2018-06-281-15/+13
| | | | | | | | | | | The step that describes how Eclipse runs the Autotools is too detailed and can run into problems as Autotools workflow changes. I made it more general. (From yocto-docs rev: 5d378a48f7237c620b7fc781b43ee86ea7522432) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Neon creating the project sectionScott Rifenbark2018-06-282-14/+20
| | | | | | | | | | Needed to render fields and items from the dialog in normal text, not in formatted text. (From yocto-docs rev: 204750e3e2a2e777207d5f2044e38d5482254c46) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to configuring targe options sectionsScott Rifenbark2018-06-282-27/+28
| | | | | | | | | | Both Neon and Oxygen needed some changes for correct use of the way we refer to menus and fields. (From yocto-docs rev: 1cb20243194e61b925df6b0a3b136233f1da8a57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to configuring the cross compiler optionsScott Rifenbark2018-06-282-48/+43
| | | | | | | | | | Used correct formatting for menu items and items fromt the dialog screens. (From yocto-docs rev: 9f9d4d65036dc23d193961efb4ae3f236fc8935c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed section capitalization problem.Scott Rifenbark2018-06-282-2/+2
| | | | | | | (From yocto-docs rev: caf927123da995378116a3653232859992e8f8ec) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Used ordered list for sequence-dependent items.Scott Rifenbark2018-06-281-4/+6
| | | | | | | | | | The list in the "Configuring the Neon Eclipse Yocto Plug-In section should be an ordered list and not a bulleted list. (From yocto-docs rev: 87926b1fb62f3678bd328af3f018f1b17a982092) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to Neon intalling YP plug-in from latest sourceScott Rifenbark2018-06-281-21/+30
| | | | | | | | | | I provided similar wordings in places in this section as were provided in the parallel "oxygen" section. (From yocto-docs rev: f4fd33d10363ab84f1f76d3e4bf115df45aef77c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the step to install the pre-build YP plug-inScott Rifenbark2018-06-281-5/+5
| | | | | | | | | | | Needed to consolidate a couple steps here. When you add in the location for the YP Plug-in, it auto-populates the options. Updated the prose to reflect that. (From yocto-docs rev: b16963844cd573e5f52289f8948b38a5d4a0f7f1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated steps to configure Neon Eclipse IDEScott Rifenbark2018-06-281-5/+16
| | | | | | | | | | | The "Configuring the Neon Eclipse IDE" section needed a bit more information in the note. Telling the users that if some options are already installed they will not appear in the list. (From yocto-docs rev: fbee757f102ee51e4db9fb6bdfd516775de8b5e0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the Neon step to unpack the tarballScott Rifenbark2018-06-281-2/+3
| | | | | | | | | | | | Steps indicated you had to be in a clean directory to unpack the tarball. This is false. You can be in any directory and unpack the file. Unpacking it puts all the files into a directory named "eclipse". (From yocto-docs rev: 3e2fc8d013b51c1a90a44cf32a6cd69e2ef80a22) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to step to download Neon Eclipse.Scott Rifenbark2018-06-281-3/+7
| | | | | | | | | Fixed this step to be more accurate. (From yocto-docs rev: 1a5c25c57a8f5829a8c3302520661def856adb58) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed link in the intro section for NeonScott Rifenbark2018-06-281-2/+2
| | | | | | | | | | | The link was pointing to the Chapter 5 as if it were in a different manual. The link worked but should have been pointing to the actual section of the Eclipse flow overview. Fixed it. (From yocto-docs rev: 4cc906bf383af837855f4c40fc107c77ff6d3ff9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the note in Eclipse configuration sectionScott Rifenbark2018-06-151-2/+2
| | | | | | | | | Using consistent wording. (From yocto-docs rev: fad0230d99259aa94ef3d8db30bc81394b8da4ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated step to install OxygenScott Rifenbark2018-06-151-0/+11
| | | | | | | | | | | | | The step describes the installation process and the intial launch process. No information exists for describing how you launch Oxygen from outside the install process. I added a note that tells where the "eclipse" binary is installed and an example line to invoke it. (From yocto-docs rev: dc59410caf18e36497d70ea3c877b4f82f620e2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed superfluous text from Step 5 of the flow.Scott Rifenbark2018-06-151-2/+1
| | | | | | | (From yocto-docs rev: 3df35b5f313da7d2394c75ac6924f1add7f2af71) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated workflow step on getting the imageScott Rifenbark2018-06-151-6/+8
| | | | | | | | | | | Provided better instructions and accounted for the fact that it is just this workflow here that is assuming the need for a YP-built image. (From yocto-docs rev: a05091768c914817ed262b15d39e7c9b54a5b863) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to Eclipse Workflow sectionScott Rifenbark2018-06-151-14/+43
| | | | | | | | | | | | | | | Updated the "Workflow Using Eclipse" section head to not match so closely the "Working With Eclipse" section heading. TOC appeared funny. Also, updated the step 1 to be more accurate regarding the real need of having a YP build host and where to go to get information on setting it up. (From yocto-docs rev: 1cbca098a2f793bd86b6f73d3d35ce79bdf639f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Small edits correcting bits and pieces in Eclipse chapter.Scott Rifenbark2018-06-151-4/+3
| | | | | | | (From yocto-docs rev: 3ef3a4c7f424d0f16ab3e8093372210fa2c58be0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to the Oxygen sectionScott Rifenbark2018-06-151-56/+64
| | | | | | | | | | Found several items that were slightly off after working through the procedure. Updates to bring it into line with reality. (From yocto-docs rev: 0f34afe3c37dedda28a1a5714703787a5dfe649d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the "Makefile-Based Projects" section.Scott Rifenbark2018-06-151-55/+230
| | | | | | | | | | | Expanded this section to contain a figure of the flow and an example that showcases the ways to override and use SDK environment and Makefile variables. (From yocto-docs rev: 834c059c1df4e8328248ea86fa23ca9a397351fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Created a new Makefile flow diagramScott Rifenbark2018-06-151-0/+0
| | | | | | | | | | | | | | The Makefile-Based Projects section was expanded to add a useful example and figure. Added this figure to the sdk-manual and mega-manual figures folders. Updated the Makefile to include the new figure as part of the tar files for each manual. (From yocto-docs rev: 6261cb55b6393e0d5dce91cdb7c8e6e83849ec0c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Review edits to the "Autotools-Based Projects" section.Scott Rifenbark2018-06-152-61/+40
| | | | | | | | | | | | Autotools is simpler now as it uses "autoreconf" to one-step a bunch of the existing tools such as aclocal and autoconf. I updated the figure to reflect the simpler flow and also the steps that accompany the figure. (From yocto-docs rev: 380cb1bb89003229befb4715e875586c798d6735) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>