summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
Commit message (Collapse)AuthorAgeFilesLines
* sdk-manual: Add SPDX license headersakuster2020-06-1710-0/+13
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: 5b88e5e0f7a71ffefdd5e9c21520bf20692521c6) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentaiton: Change author infoakuster2020-04-061-3/+2
| | | | | | | | | | Update the author indo and use variables for author and email to make it easier to change in future. (From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"rpjday@crashcourse.ca2020-04-061-2/+2
| | | | | | | | | | | | | | | Given the defined DocBook entity: <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs"> replace numerous instances of the more verbose "&YOCTO_HOME_URL;/documentation", which is a redirect, anyway. rday (From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-docs: remove refrence to mpc8315e-rdbakuster2020-03-241-2/+1
| | | | | | | (From yocto-docs rev: 8768196b4a313df794bf21937da4bf92de858463) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Update YP manual notes with pointer to docs MLRobert P. J. Day2020-03-111-6/+8
| | | | | | | | | | Update the "Manual Notes" section of numerous YP manuals with a reference to the recently-introduced YP documentation mailing list. (From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP 3.1 Docs: Updated Manual revision tables.Scott Rifenbark2019-12-161-2/+2
| | | | | | | | | | Scrubbed so subsequent releases are relevant to the initial release only. (From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP Documentation: Set up for YP 3.1 releaseScott Rifenbark2019-12-091-1/+6
| | | | | | | | | | | * Updates to poky.ent * Updates to mega-manual.sed * Updates to all <manual>.xml files for date (From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: Changed "2.8" to "3.0".Scott Rifenbark2019-10-231-2/+2
| | | | | | | | | | I was using "2.8" throughout the manual set instead of "3.0". Updated all aspects to "3.0". (From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated devtool to talk about oe-local-files.Scott Rifenbark2019-07-181-12/+73
| | | | | | | | | | | | | | | | | | | Fixes YOCTO #13079 Bug is about making sure the section on the devtool command talks about oe-local-files. Two devtool commands (modify and upgrade) needed to mention the role of the oe-local-files area and how it is used during these commands. I updated the appropriate sections: * Use devtool modify to Modify the Source of an Existing Component * Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software. (From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added link to BB manual fetcher section.Scott Rifenbark2019-06-071-1/+3
| | | | | | | | | | | | In the "Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software" section, we reference "fetchers" but do not link to the section on them in the BB manual. I added a link. (From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared for 2.8 releaseScott Rifenbark2019-05-071-1/+6
| | | | | | | | | | | poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" <folder>.xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed all references to EclipseScott Rifenbark2019-05-077-99/+6
| | | | | | | | | Took care of links as well. (From yocto-docs rev: a338dc13ebbcdc77fb16e36f12eb5f0e1e05187f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed all references to EclipseScott Rifenbark2019-05-073-2204/+0
| | | | | | | | | | | One Neon appendix completely removed. One other chapter removed that held the latest version of Eclipse use removed. A figure was also removed. (From yocto-docs rev: 03524fc363f9232a2ed45d10688ddeb0439b0917) 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>
* kernel-dev, sdk-manual: Unified question spacingGianfranco Costamagna2019-04-092-2/+2
| | | | | | | | | | | | unify the spacing for questions in various places e.g. before the [Y/n] there should be a space, and before "?" there should be none. Unify the questions where the system expect an answer from the end user (From yocto-docs rev: 0643b2e22273a798b96f126931885efd733e5f89) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparing for 2.7 release.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) 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>