summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2018-08-15sdk-manual: Grammar fixScott Rifenbark
(From yocto-docs rev: b850e0d520401a52fbba083975f05f529b2b554d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15sdk-manual: Updates to "Adjusting the Extensible SDK to Suit Build Host"Scott Rifenbark
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>
2018-08-15sdk-manual: Updates to "Configuring the Extensible SDK" sectionScott Rifenbark
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>
2018-08-15ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELISTScott Rifenbark
Wording did not match that of similar SDK variables. (From yocto-docs rev: 696eb9ff0b89222dc696adc0bd28247c0a0c731a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST descriptionScott Rifenbark
(From yocto-docs rev: 0a5775f7ad3e0b6531fcfd1d328d8e0da8727400) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST varScott Rifenbark
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: 062db19dd56cc1827ebd7614eb8a54660421df62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Updated the SDK_INHERIT_BLACKLIST variable descriptionScott Rifenbark
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: a0145996aeac1bb45fea9f613789b00327f92d1e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable descriptionScott Rifenbark
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: 355b05366aadc337ec3337c0a3c918a23027923b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Updated the SDK_LOCAL_CONF_BLACKLIST variable descriptionScott Rifenbark
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: f24287851998d554575c6aaf9dcc50d198931e48) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15sdk-manual, mega-manual: Updated the fig for installed ext. SDKScott Rifenbark
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>
2018-08-15sdk-manual, mega-manual: Updated standard SDK install directory figureScott Rifenbark
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>
2018-08-15sdk-manual: Final edits to the extracting root filesystem sectionScott Rifenbark
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>
2018-08-15sdk-manual: Added note in step to set SDKMACHINEScott Rifenbark
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>
2018-07-07sdk-manual: Updates to section on obtaining the SDKScott Rifenbark
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>
2018-06-28ref-manual: Removed the do_rm_work_all TaskKristi Rifenbark
(From yocto-docs rev: 74a90f766a38c425a6ceb8a50ad24b23460f9640) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28dev-manual, ref-manual: Documented NO_GENERIC_LICENSEKristi Rifenbark
FIXES [YOCTO #12734] Added a new variable description and created a new section in the dev-manual. (From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28sdk-manual: Updates to "Building an SDK Installer" section.Scott Rifenbark
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>
2018-06-28sdk-manual: Updates to the section for locating SDK installersScott Rifenbark
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>
2018-06-28sdk-manual: Updates to Depolying and DebuggingScott Rifenbark
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>
2018-06-28sdk-manual: Updates to neon section building the projectScott Rifenbark
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>
2018-06-28sdk-manual: Updates to configuring the cross-toolchains section.Scott Rifenbark
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>
2018-06-28sdk-manual: Updated Neon creating the project sectionScott Rifenbark
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>
2018-06-28sdk-manual: Updates to configuring targe options sectionsScott Rifenbark
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>
2018-06-28sdk-manual: Updates to configuring the cross compiler optionsScott Rifenbark
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>
2018-06-28sdk-manual: Fixed section capitalization problem.Scott Rifenbark
(From yocto-docs rev: caf927123da995378116a3653232859992e8f8ec) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-28sdk-manual: Used ordered list for sequence-dependent items.Scott Rifenbark
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>
2018-06-28sdk-manual: Updates to Neon intalling YP plug-in from latest sourceScott Rifenbark
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>
2018-06-28sdk-manual: Updated the step to install the pre-build YP plug-inScott Rifenbark
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>
2018-06-28sdk-manual: Updated steps to configure Neon Eclipse IDEScott Rifenbark
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>
2018-06-28sdk-manual: Updated the Neon step to unpack the tarballScott Rifenbark
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>
2018-06-28sdk-manual: Updates to step to download Neon Eclipse.Scott Rifenbark
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>
2018-06-28sdk-manual: Fixed link in the intro section for NeonScott Rifenbark
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>
2018-06-15sdk-manual: Updated the note in Eclipse configuration sectionScott Rifenbark
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>
2018-06-15sdk-manual: Updated step to install OxygenScott Rifenbark
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>
2018-06-15sdk-manual: Removed superfluous text from Step 5 of the flow.Scott Rifenbark
(From yocto-docs rev: 3df35b5f313da7d2394c75ac6924f1add7f2af71) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Updated workflow step on getting the imageScott Rifenbark
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>
2018-06-15sdk-manual: Updates to Eclipse Workflow sectionScott Rifenbark
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>
2018-06-15sdk-manual: Small edits correcting bits and pieces in Eclipse chapter.Scott Rifenbark
(From yocto-docs rev: 3ef3a4c7f424d0f16ab3e8093372210fa2c58be0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Edits to the Oxygen sectionScott Rifenbark
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>
2018-06-15sdk-manual: Updated the "Makefile-Based Projects" section.Scott Rifenbark
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>
2018-06-15sdk-manual: Created a new Makefile flow diagramScott Rifenbark
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>
2018-06-15sdk-manual: Review edits to the "Autotools-Based Projects" section.Scott Rifenbark
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>
2018-06-15sdk-manual: Updates to the "Makefile-Based Projects" section.Scott Rifenbark
I wrote the section to include a flow diagram using "make" and provided a working example highlighting how to override environment variables. (From yocto-docs rev: 00e8e09a51a1f0305317f38975a9d7695c92bdb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Added cross-reference to Makefile section. Fixed syntaxScott Rifenbark
Two changes here. One was a note to the "make" step of the Autotools-based section. I cross-referenced the Makefile section for information on how SDK installation environment variables are respected and or overridden when using make variables. Also, fixed the quotation syntax of the four environment variable examples used in the "Makefile-Based Projects" section. (From yocto-docs rev: 5bd4e056496ff3478e213ccd9e49adfe1fac67ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual, mega-manual: Added Autotools flow figureScott Rifenbark
New figure for the section on Autotools workflow. The figure goes in the folders for both the sdk-manual and the mega-manual. Updated the Makefile to include the new figure in the tarball when creating both manuals. (From yocto-docs rev: ccb2c4b9ebd0b0aaa55b5790eb6a916701e10af4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Updated the Autotools workflow example.Scott Rifenbark
Did a re-write of this section with better explanations. I also pulled the bit about passing parameters to the configure script into the step that talks about that. (From yocto-docs rev: 79432ba0eb0cc2f6bdb3410fbf99f227fb666b2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Changed "configure.ac" file in the autotools-based exampleScott Rifenbark
The line used to be "AC_PROG_INSTALL". I did some digging and can't really figure out why the example is not following the standard "helloworld" stuff out there all over the internet. So, I have the user create a configure.in file as follows now: AC_INIT(hello,0.1) AM_INIT_AUTOMAKE([foreign]) AC_PROG_CC AC_CONFIG_FILES(makefile) AC_OUTPUT The original was as follows: AC_INIT(HELLO,0.1) AM_INIT_AUTOMAKE([foreign]) AC_PROG_CC AC_PROG_INSTALL AC_OUTPUT(Makefile) (From yocto-docs rev: ed86d61178f86df3248b34d52602121c39bd56b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Updated link to variables set for cross-toolchain scriptScott Rifenbark
The link was going to a spot from which another link was suggested. Too many redirections for the reader. Linked to the original place instead. (From yocto-docs rev: 9fc383a99ae0a7ff8cae761c0c31b27030f765cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Updated formatting for "configure" scriptScott Rifenbark
Formatting used for the "configure" script created using the "autoconf" command in the example. (From yocto-docs rev: dd55ceb2c19f9e013c13e776acf7201c25501ff7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-06-15sdk-manual: Replaced "configure.in" with "configure.ac"Scott Rifenbark
The Autotools example called for a "configure.in" file as part of the "hello-world" example. When working through the example, a warning occurs saying that the file needs to be "configure.ac". I changed the example. (From yocto-docs rev: 7f677e3bbf0331228ed5aed1ace7c55d523d3121) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>