summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Removed the do_rm_work_all TaskKristi Rifenbark2018-06-281-9/+0
| | | | | | | (From yocto-docs rev: 74a90f766a38c425a6ceb8a50ad24b23460f9640) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Documented NO_GENERIC_LICENSEKristi Rifenbark2018-06-282-0/+59
| | | | | | | | | | | 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>
* 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-153-2/+2
| | | | | | | | | | | | | | 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-153-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>
* sdk-manual: Updates to the "Makefile-Based Projects" section.Scott Rifenbark2018-06-151-33/+96
| | | | | | | | | | | 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>
* sdk-manual: Added cross-reference to Makefile section. Fixed syntaxScott Rifenbark2018-06-151-4/+12
| | | | | | | | | | | | | | | 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>
* sdk-manual, mega-manual: Added Autotools flow figureScott Rifenbark2018-06-153-2/+2
| | | | | | | | | | | | | | 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>
* sdk-manual: Updated the Autotools workflow example.Scott Rifenbark2018-06-151-165/+167
| | | | | | | | | | | 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>
* sdk-manual: Changed "configure.ac" file in the autotools-based exampleScott Rifenbark2018-06-151-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* sdk-manual: Updated link to variables set for cross-toolchain scriptScott Rifenbark2018-06-151-2/+2
| | | | | | | | | | | 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>
* sdk-manual: Updated formatting for "configure" scriptScott Rifenbark2018-06-151-3/+5
| | | | | | | | | | 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>
* sdk-manual: Replaced "configure.in" with "configure.ac"Scott Rifenbark2018-06-151-1/+1
| | | | | | | | | | | | 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>
* sdk-manual: Added cross-referencing to "Autotools-Based Projects"Scott Rifenbark2018-06-151-2/+4
| | | | | | | | | | Needed to reference a couple terms for first use: "cross-development toolchain" and "OpenEmbedded build system". (From yocto-docs rev: 2370c3508574efe05e768f4515fec5b17f0ca177) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Running the SDK Environment Setup Script"Scott Rifenbark2018-06-151-8/+9
| | | | | | | | | Minor edits to this section. (From yocto-docs rev: 68a6e4cac6cecd14e87d4f05f558d79165761d4d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to standard SDK intro and install sectionsScott Rifenbark2018-06-151-28/+26
| | | | | | | | | | | Changed the output to reflect the real command's output. Updated prose to match (mostly) that used in the similar extensible SDK sections. (From yocto-docs rev: fb6c8895f2afda0c43bbaa49870c425e25841ec4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Creating a Derivative SDK With Additional Components"Scott Rifenbark2018-06-151-16/+19
| | | | | | | | | Fixed some poor writing in this section. (From yocto-docs rev: 5709c2c2c1c37166ec5df1193b58ff82bb10b4c3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Installing Additional Items Into the Extensible SDK"Scott Rifenbark2018-06-151-13/+13
| | | | | | | | | Minor edits. (From yocto-docs rev: 3ed2c1026bf03feb03001e00daec55b94d7dc35b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Restoring the Target Device to its Original State"Scott Rifenbark2018-06-151-7/+7
| | | | | | | | | Fixed a grammar error and made a few other corrections. (From yocto-docs rev: 369a22ffe3780fd00514344f1b3b8a944305e320) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Packaging" section.Scott Rifenbark2018-06-151-16/+17
| | | | | | | | | Edits to improve writing. (From yocto-docs rev: 04d2df37ad718508c7f78a204d0d5e5fff431ce8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Sharing Files Between Recipes"Scott Rifenbark2018-06-151-3/+5
| | | | | | | | | | Added a cross-reference to the term "build host". Corrected a subject/verb grammar error. (From yocto-docs rev: 8763e333867d0039315f0ca0aa96fdadea676783) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Finding Logs and Work Files"Scott Rifenbark2018-06-151-35/+46
| | | | | | | | | | This section was poorly organized with a mile long sentence as the opener. Fixed it. (From yocto-docs rev: c7624244e40c807d1c3cea80d2eced3cd9948019) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added links to sample tasks to "Working With Recipes"Scott Rifenbark2018-06-151-13/+18
| | | | | | | (From yocto-docs rev: 6dd62a3f97dc4e70a532faae0055ef7937f40afc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Adding Node.js Modules"Scott Rifenbark2018-06-151-10/+9
| | | | | | | | | Fixed a few sentences up by providing clearer text. (From yocto-docs rev: e81984d73c05f2d722bc082a100d01c3cc0173ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Adding Native Tools"Scott Rifenbark2018-06-151-5/+7
| | | | | | | | | | Added a cross-reference link to the term "bulid host" and removed the redundant word "system". (From yocto-docs rev: 205d6fb6030cecb02301ec9cdc92ac908d250160) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Adding Makefile-Only Software"Scott Rifenbark2018-06-151-17/+17
| | | | | | | | | Fixed some prose in various places. (From yocto-docs rev: f754969eff4c314d9f4c489cca2b3c2f8fd87fff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "License Detection"Scott Rifenbark2018-06-151-14/+17
| | | | | | | | | Updates to prose for better understanding. (From yocto-docs rev: 44a07560845c973a0da4c27969c740d3d712d323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>