summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
Commit message (Collapse)AuthorAgeFilesLines
* sdk-manual: Added note about nullpointer error for launch eclipseScott Rifenbark2016-12-081-0/+18
| | | | | | | | | | | | | Fixes [YOCTO #10714] Apparently there is some issues with GTK3 libraries for the Mars Eclipse version. The note provides a workaround that requires editing the eclipse.ini file. (From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the section on adding docs to standard SDKScott Rifenbark2016-11-231-14/+9
| | | | | | | | | | | Fixes [YOCTO #8584] Made some edits to tighten this down and make it more efficient. (From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to support developing 2.3 YP docsScott Rifenbark2016-11-161-0/+5
| | | | | | | | | | | | | | | | | | Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added new appendix for customizing standard SDKScott Rifenbark2016-11-162-0/+65
| | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #8584] This fix essentially had to document how to add the API documentation to the standard SDK. The fix required adding a new appendix to the SDK manual on how to customize that standard SDK. I could not put just one topic in a new appendix so I also added a sub-section on how to add indidual packages to the standard SDK. Other changes here were the introduction of a new file for the new appendix, updated the mega-manual.xml file so that it would include the new chapter when the MM was built. Finally, I added some cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the distro features section on the api-documentation bullet. (From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added api-documentation to distro featuresScott Rifenbark2016-11-161-4/+2
| | | | | | | | | | | | Fixes [YOCTO #8584] Updated the "Distro Features" section to include the "api-documentation" feature. (From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision table for 2.2Scott Rifenbark2016-10-111-1/+1
| | | | | | | | | Added string "October 2016" as the release date. (From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed example in "Passing Host Options"Scott Rifenbark2016-10-111-2/+1
| | | | | | | | | | | Fixes [YOCTO #10267] Changed the example to use a single long line. (From yocto-docs rev: c80d8bb8773b7bbe9c85c48880f42ffb273729b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, sdk-manual: Applied review comments for SDK movementScott Rifenbark2016-09-281-14/+5
| | | | | | | | | | | | I applied several nits across the manuals based on reviewer comments. All these corrections relate to the task of shuffling topics around that have to do with the extensible SDK and the devtool. (From yocto-docs rev: 9f8079adc7fa2897fd885aff8e64f9721212e9c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, dev-manual: Applied SDK review edits.Scott Rifenbark2016-09-285-38/+47
| | | | | | | | | | | | | | | | | | | | | | | | | * Removed the note box formatting for the cross-reference from the sdk-manual and dev-manual sections that talk about devtool. The reference is now non-note form and goes to the ref-manual devtool quick ref. * Added devtool upgrade as a third item in the list that introduces methods to use devtool. * Fixed the working on the devtool finish step 5 for both the dev-manual and sdk-manual. * Renamed the new chapter that describes different projects you can use devtool on. The focus is on using the SDK toolchain directly. * Scrubbed the entire sdk-manual for the term "toolchain installer" and replaced with "SDK installer". (From yocto-docs rev: 6d4daef49cc6d54a700a8c3965c9e8814f75d20a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: New Projet chapter added and other fixesScott Rifenbark2016-09-285-2820/+3198
| | | | | | | | | | | | | I extracted the sections on Makefile, Autotools, and Eclipse into their own new chapter. Seemed to make sense as they are projet types for both standard and extensible SDK types. Also, swapped the order of appearance from standard first to extensible first. This swapping caused a bit of rewriting. (From yocto-docs rev: 138a4d5576123da800a8fd8d99462a138ceeb743) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: devtool upgrade and quick ref changes to mult manualsScott Rifenbark2016-09-281-0/+6
| | | | | | | | | | | | | | | | | | | Did the following: * Added the devtool upgrade flow to the SDK manual. * Removed the devtool Quick Reference from the dev-manual and added it as a new chapter to the ref-manual. * Made sure all the links and cross-references work now with the moved material. * Updated the Make file so that the manual set builds correctly regarding the new chapter in the ref-manual. * Created cross-referencing notes in both the sdk-manual and the dev-manual to the newly located devtool Quick Reference chapter. (From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added the devtool upgrade command flow to the manual.Scott Rifenbark2016-09-282-0/+164
| | | | | | | | | I needed a new figure and a new section. (From yocto-docs rev: d413ca7b9b946450af7c2c15ab0e68e9181517e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed two Git tag developer notes.Scott Rifenbark2016-09-232-27/+0
| | | | | | | | | | These notes can't be in the final version of the manual. Now is the time to get them out. (From yocto-docs rev: 600b4f2c7360b30d12fdc7ed0f5ba41bc09fc778) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed notes about the BitBake CommanderScott Rifenbark2016-09-232-18/+0
| | | | | | | | | | | | | | | Fixes [YOCTO #10032] The fix to remove the BitBake Commander from the tools to install when dealing with the Eclipse Yocto Plug-in has happened. Consequently, I removed the developer notes in the manual stating that the Commander was still showing up there. The manual set is now clean of this stuff. (From yocto-docs rev: fbe169b086faac571de8a2ebd9d32682162cfd31) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Passing host options exampleScott Rifenbark2016-09-231-1/+1
| | | | | | | | | | | | Fixes [YOCTO #10267] The example works better using OECORE_TARGET_SYSROOT for the aclocal line. I changed it to that. (From yocto-docs rev: 362b786e7bf2083c5809e961f61c0ad81b778d71) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to the devtool Finish command flow.Scott Rifenbark2016-09-231-10/+7
| | | | | | | (From yocto-docs rev: f980b7cfa021c3777acd8e26b00cf40ed58f10f4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated SDK workflowScott Rifenbark2016-09-234-73/+96
| | | | | | | | | | | | A new command devtool finish has superceded the final commands in the SDK workflow. I updated the two figures (add and modify) to reflect this new flow. I also updated the ordered number list to match reality. (From yocto-docs rev: 0ba31e730cd748d06eab8d46b38764cda5c4e3bd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, ref-manual: New variable for including toolchainScott Rifenbark2016-09-231-0/+10
| | | | | | | | | | | Added a new variable description for SDK_INCLUDE_TOOLCHAIN. Along with the new glossary entry, I updated a couple places where it would be relevant to cross-reference the new variable. (From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the connection steps for deploymentScott Rifenbark2016-09-232-10/+30
| | | | | | | | | | Provided clearer instruction on how to set up a new SSH connection when deploying an application to QEMU. (From yocto-docs rev: 93adc542a40e86377380684e1ce294edd0fd7268) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed spelling error.Scott Rifenbark2016-09-231-1/+1
| | | | | | | (From yocto-docs rev: 46794f1c852a12375764d80c7242312921d8bd20) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added new description for the PACKAGECONFIG_CONFARGS variable.Scott Rifenbark2016-09-231-5/+13
| | | | | | | | | | | | | | | | | Fixes [YOCTO #10183] Added a new variable entry for the PACKAGECONFIG_CONFARGS variable. With the introduction of the new PACKAGECONFIG_CONFARGS variable, many places in the mainstream YP documentation that referenced how to pass configure arguments using EXTRA_OECONF needed to also make mention of this new variable. I added many cross-references to the new variable. (From yocto-docs rev: 00f02d45319bab90b72eab89fcb69cbe8bd05bb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated neon JDK requirements to be 1.8+Scott Rifenbark2016-09-231-3/+3
| | | | | | | (From yocto-docs rev: 796fad8a20ece3ef5fdb0c7c1d325a18e37e676b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated legacy mars links to go to neon section.Scott Rifenbark2016-09-231-1/+7
| | | | | | | (From yocto-docs rev: 4c524f3763f676d4f60a8fb383019b6153901b9d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Working With Eclips" for NeonScott Rifenbark2016-09-231-293/+420
| | | | | | | | | | | | | | | Fixes [YOCTO #7546] Applied changes throughout this section to move it from Luna to the Neon version (latest) of Eclipse. We now provide a single thread for Eclipse, which is based on the latest version (Neon). Information for Mars, which is also supported) is in a new Appendix C. (From yocto-docs rev: 82995d9c49e4c55707591a1375c5d86874c589b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added developer note for updating to NeonScott Rifenbark2016-08-251-0/+5
| | | | | | | (From yocto-docs rev: bd21fdd102d7daa3f03b978760d9190a3815e243) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated boxes to check when installing pre-built mars yp plug-inScott Rifenbark2016-08-251-2/+1
| | | | | | | | | Removed the Bitbake commander item and renamed the ADT one to SDK. (From yocto-docs rev: 7bb7823bd9991ce95315b76bdfb3175c53198401) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed "snapshot" in an example version string.Scott Rifenbark2016-08-251-1/+1
| | | | | | | (From yocto-docs rev: 5ce7ad30cfc95b459a3da7b1cc540d1207d50dd8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added note to link to the wiki on building an SDKScott Rifenbark2016-08-251-13/+23
| | | | | | | (From yocto-docs rev: 29704fa495a97279c5d4e29bee22f0aaa9e15cba) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added an example name for an extensible SDKScott Rifenbark2016-08-251-3/+8
| | | | | | | (From yocto-docs rev: bbc2ac36d19713242307b73393035d3fca6ed5a0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed a broken "do_install" task linkScott Rifenbark2016-08-251-1/+1
| | | | | | | (From yocto-docs rev: bef1a51e0c0a5a0145e942c1cc3f868f1cfaa03c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed a broken link to the "base" classScott Rifenbark2016-08-251-1/+1
| | | | | | | (From yocto-docs rev: 22eba313276ea95030634eef8632e4e05cb1e484) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: "Linkified" the CC variable in section 3.3.4Scott Rifenbark2016-08-251-1/+2
| | | | | | | (From yocto-docs rev: d020cfc08e5d0679d7d5d3fd4269be877413e863) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Grammar fix.Scott Rifenbark2016-08-251-1/+2
| | | | | | | (From yocto-docs rev: 709481dd0711abda063120f775b35b58c9a2af15) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the extensible SDK installer exampleScott Rifenbark2016-08-251-4/+23
| | | | | | | (From yocto-docs rev: 3791f4abc21c565f7e258a550e66327dbbe7a384) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Re-worded Step 6 for deploying image in eclipse flow.Scott Rifenbark2016-08-251-7/+6
| | | | | | | (From yocto-docs rev: dd0b96a3917ab6b6c0a22af1d23f48beee6a2cd3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added note about building the image for QEMU useScott Rifenbark2016-08-251-8/+22
| | | | | | | | | | | | Placed a note in step 4 of the "Workflow Using Eclipse(tm)" section that an alternative method to getting the target root filesystem and toolchain is to build them out. Referenced the wiki. (From yocto-docs rev: 60720be0fe0d29a0b695005bb40f5b0c25475b55) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed bad linkScott Rifenbark2016-08-251-5/+3
| | | | | | | | | | Dumped a link to pre-built kernel naming information. The link was to the sdk-manual, which made no sense. (From yocto-docs rev: 9b7a9f8217d9251f2d7166afc0bb3b4235264201) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Provided better wording to intro running sdk env script.Scott Rifenbark2016-08-251-6/+7
| | | | | | | (From yocto-docs rev: 41b9b8170179a59b6534db9e926d5086be7d4328) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added note about building and SDKScott Rifenbark2016-08-251-0/+11
| | | | | | | (From yocto-docs rev: 6518e03bc0259af04f01596f3f66c123616063e7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Used &DISTRO; for some output release versions.Scott Rifenbark2016-08-251-5/+5
| | | | | | | (From yocto-docs rev: 4dbcd9957366665028adf955951af6256e67c152) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Created new Mars Eclipse appendixScott Rifenbark2016-08-254-189/+914
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #7546] First draft of the new appendix supporting the Mars version of eclipse. New appendix file created and entry made to the sdk-manual.xml file to include that new appendix file into the main book. (From yocto-docs rev: 2fb79c29bcbb5c0801f67d4c245c07c3aa9d2ca2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> sdk-manual: WIP on appendix C Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated configure.ac file in helloworld example.Scott Rifenbark2016-06-211-3/+3
| | | | | | | | | | | The file was named 'configure.in' and was slightly different than what it needed to be in order to work. The file needs to be named 'configure.ac' and have slightly different contents. Fixed both. (From yocto-docs rev: 1b80e90848d23737462f8b0e55b2ff604f9abf41) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared manuals for a 2.2 release.Scott Rifenbark2016-06-061-0/+5
| | | | | | | | | | | | | * Updated poky.ent to have the appropriate 2.2 variables * Updated all manual revision tables to have a new entry for 2.2 - used "Sometime in 2016" for the date. * Updated the mega-manual.sed file to process internal links for 2.2. (From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed three broken links to sections within manual.Scott Rifenbark2016-05-171-3/+3
| | | | | | | (From yocto-docs rev: 6c98ba1f0ac57e6ee9d2b77a4421e62bcb52a4c8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Applied review edits throughout the manual.Scott Rifenbark2016-04-293-32/+48
| | | | | | | | | | Updates included minor items for wordings and clarity. Review comments from David Kinder, Stephen Ballard, and Paul Eggleton. (From yocto-docs rev: b25e5cab60f9c1e059fadd844a3a75d9df450ebf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the normal customization.xml file.Scott Rifenbark2016-04-291-3/+2
| | | | | | | | | | Needs to used the downloadable XSL files and not the static local 1.76.1 versions. (From yocto-docs rev: 1dfc6081ffb745e424ff5f73c708e2559466831e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated eclipse customization file.Scott Rifenbark2016-04-291-4/+2
| | | | | | | | | | This file was still using the 1.76.1 XSL style sheets. They need to use the downloadable ones. (From yocto-docs rev: 27e29bedb2d1c080a23298fc0ae23054c40971aa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed references using the DISTRO_NAME variableScott Rifenbark2016-04-061-2/+2
| | | | | | | | | | | | With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences of the DISTRO_NAME variable had to be checked to see if they really should be using the "NO_CAP" variable instead. Output and actual branch names are case-sensitive. (From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date in manual history tables.Scott Rifenbark2016-04-061-2/+2
| | | | | | | | | Updated to "April 2016" for all manuals that use this table. (From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual, sdk-manual: Removing oprofile references.Scott Rifenbark2016-04-062-36/+1
| | | | | | | | | | | | | Fixes [YOCTO #9264] I handled the occurrences of "oprofile" and "tools-profile" throughout as I could. They are not all done yet. These in this commit have been removed. (From yocto-docs rev: d76e264ea210846ad8080134bacd56462ba69d24) 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 2024-11-14 14:34:41 +0000