summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Prepared for 2.5.2 document releaseScott Rifenbark2018-12-1511-34/+79
| | | | | | | | | | | | | Updated poky.ent to use "TBD" for the release date variable. Updated the mega-manual.sed file to use "2.5.2" Updated all the <manual>.xml files to include a new entry for the 2.5.2 release date Updated poky.ent to have all applicable 2.5.2 variables changed. (From yocto-docs rev: 189ec469aa8797d75567cfef444b9896d3467e7a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updated phrasing for what a "defconfig" file is.Scott Rifenbark2018-11-221-2/+5
| | | | | | | | | It was over simplistic. (From yocto-docs rev: 7eb909de44d5782ec1389c07df0cecf487e558d8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated for a 2.5.1 releaseScott Rifenbark2018-08-1511-31/+76
| | | | | | | | | | | | poky.ent - updated variables for 2.5.1 mega-manual.sed - updated string from "2.5" to "2.5.1" <manual>.xml - updated manual revision tables for 2.5.1 and September 2018 date (From yocto-docs rev: a47382f00ad1a5a1df02ffa3dead7a0bd597bf45) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS descriptionScott Rifenbark2018-08-151-1/+1
| | | | | | | | | Took out an occurrence of PACKAGE_WRITE_DEPENDS (From yocto-docs rev: e983c3215139b566ea02df6e6160b05fdcbce081) 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: 915f9e8e47ae95a3102063f5825730953afb1ff0) 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: 45e710923afb45066383877252af79faf3b2f5fc) 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: 24a77078af0e7a59dd180bdfe6a29afbaefdffcf) 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: e1f8c9bf3ef7028b48b38801557292434c872419) 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: b90de53859545a835629a56eab08fa58479c36ff) 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: 62028ea4df684e495e78d00a440318d061098f15) 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: 382c172fd9a51cd4c650333549210aa760ea9774) 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: f6710a7047c215f9a1a989b9a009399405770c06) 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: 7a035ffb4443f7920521ccd918ec844d1ca118e5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated DISTRO_NAME variable description.Scott Rifenbark2018-08-151-0/+40
| | | | | | | | | I provided some real detail on this variable. It was woefully brief. (From yocto-docs rev: 6b40243984b7cc69a291b6f90ed04b45b7ce3ac5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the DISTRO variable descriptionScott Rifenbark2018-08-151-7/+14
| | | | | | | | | | I added a cross-reference to the "DISTRO_NAME" variable as it is the long version of the distribution name. (From yocto-docs rev: c707da8121171cc81e0d07ac14369b0045de5119) 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: 76da8279290e3a5752443c097d993766438610a6) 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: bb0e6613b7dbe7f8c9ca80a64ee9c67a74e01fc1) 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: 592abe8fe11389b58e8c0cf7991a400bdd515b16) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELISTScott Rifenbark2018-08-151-5/+9
| | | | | | | | | Wording did not match that of similar SDK variables. (From yocto-docs rev: 6fab0bbc62e7f9caf020718a4a8fd047b9fb450f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST descriptionScott Rifenbark2018-08-151-2/+2
| | | | | | | (From yocto-docs rev: 4ead5a0a8b9ca862ba86e285a7981036018dfb70) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST varScott Rifenbark2018-08-151-0/+9
| | | | | | | | | | Put in a cross-reference to the section in the sdk-manual where it talks about customizing the configuration of the extensible SDK. (From yocto-docs rev: 23e4a2d0f461a8c672aa3780965ca4e30d1aac50) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_INHERIT_BLACKLIST variable descriptionScott Rifenbark2018-08-151-3/+16
| | | | | | | | | | | Added information on the class in which the default is set. Also, put in a reference for more information on customizing the extensible SDK configuration. (From yocto-docs rev: 1ca9f8dd90cccb4692c16d7757b80bfd50237495) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable descriptionScott Rifenbark2018-08-151-4/+16
| | | | | | | | | | | Enhanced this description by indicating the class that it is set in and by including a pointer back into the sdk-manual where filters are described for extending the extensible SDK. (From yocto-docs rev: 22dcaf2c75532f45111b79db067edfc92212441e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_LOCAL_CONF_BLACKLIST variable descriptionScott Rifenbark2018-08-151-2/+21
| | | | | | | | | | | Added more detail including the class that sets the default variables for exclusion and the list of actual variables that are excluded by default. (From yocto-docs rev: 7764a54add2911c2da8174e48e4d3166a873d63a) 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-153-7/+5
| | | | | | | | | | | This figure had changed. I updated the file and folder hierarchy. Also fixed some wording. (From yocto-docs rev: 40e89997f50fdaecee88c8c98e21cc212bf1ed13) 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-153-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: c21d76b885afedafe7b866d9f4997633a776902c) 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: 8655662b1f031463fafcf11fcd22243a75e817f8) 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: 8720b3ea9e7260f891db1be46fb756aba09d5f51) 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: 6c37cc5231ae560762c5bc8234331d53ebe7b69d) 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-07-071-11/+12
| | | | | | | | | | Updated some links. Also, rewrote the note about the libraries. It was inaccurate. (From yocto-docs rev: ca6593ea9336dd1974ce65ce1d9ca15af8583915) 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-07-071-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: aa88f3f09dce042a2f5b39bf059401b0cd08a6cc) 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: 0ca787b3ce91afbb4ea4aeb12052cff39892e99f) 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: 4c98d18ee3fbc57a369df4eb1251cafaaf16adee) 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: 5a67a115395d3e18523c4a3b3be24c214e560e54) 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: a2e17bd828ab1205bbb0c99fa00a76c2f5727e99) 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: c35168b623f6bece20ae7df1ae430259b2d20044) 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: 28b37c9b0785da50a0da19757d70429de06991b5) 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: 5f3272a0e327cae5f17700ba98aec6960b50ff8b) 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: 9e616582ee27d0bb976427d21d54b023f83eff56) 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: 956ee839f05d6608c315899c4444d125db338ef7) 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: 3d621a1fe552c6133517256c21efdfe4cacfe6ed) 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: 09b3252aaf49574e669b67e3ff00dceab89b40f5) 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: 426aa18db25dbc275674a8aef26ede586a79ed3f) 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: 9df184b4ed7e8a7fa5849624911b810129c099a7) 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: c60bc694a5b25fd2a9df5a10691ba301d39c5f16) 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-281-2/+2
| | | | | | | | | Using consistent wording. (From yocto-docs rev: 067cba1b925cca971e783bd7e4abc9c965b0d8de) 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-281-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: 6e3dbc9e123394d311da234e4457b9a6c253ff0d) 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-281-2/+1
| | | | | | | (From yocto-docs rev: 0869e5d1d2cc9239adbf58ad83c3305b34f38f01) 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-281-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: edba9e07d7029e9276ebfd288448f4849ff3aed4) 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-281-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: 4951b3f492c24724f1169068ee3593ad93b0c48a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-04-22 16:30:18 +0000