summaryrefslogtreecommitdiffstats
path: root/documentation/sdk-manual
Commit message (Collapse)AuthorAgeFilesLines
* 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-151-0/+0
| | | | | | | | | | | | | | 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-152-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-151-0/+0
| | | | | | | | | | | | | | 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>
* sdk-manual: Edits to "Dependency Detection and Mapping"Scott Rifenbark2018-06-151-12/+13
| | | | | | | | | Updated various prose for better understanding. (From yocto-docs rev: ddbd66d7732bbc8b4940c660f8a8c941a5cc4ea2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "Name and Version"Scott Rifenbark2018-06-151-9/+13
| | | | | | | | | Poor writing left over in here. Updated some of the prose. (From yocto-docs rev: 8f71cd997c86610dd62780f74f39dad811098540) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to "A Closer look at devtool add" section.Scott Rifenbark2018-06-151-4/+4
| | | | | | | | | Corrected some prose to be clearer. (From yocto-docs rev: c73f3d486fab555e6c6ac3dd1f5fbaf4d531ab29) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated devtool add and upgrade figuresScott Rifenbark2018-06-152-0/+0
| | | | | | | | | | Took out the $TMPDIR part for the output and left more generically as "Build Output". (From yocto-docs rev: 4b0375e3293d67e4b5be433cd6c468532fee5a30) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Changes to the devtool upgrade section.Scott Rifenbark2018-06-151-29/+52
| | | | | | | | | Edits to improve this section. (From yocto-docs rev: f062882b3b3cf9c454466fa9d243284d97592bdc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated the devtool upgrade flow diagram.Scott Rifenbark2018-06-151-0/+0
| | | | | | | | | | Added more detail at the top for how the local recipe interacts with the Upstream Source. (From yocto-docs rev: c1d49a7c00c458b55396c0efc7a329acd870be6c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to the devtool add workflow section.Scott Rifenbark2018-06-151-2/+2
| | | | | | | | | Minor edits from the read-through. (From yocto-docs rev: d165438d3d02f3154fc59197d75ab1cb6a285320) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated devtool add flow diagramScott Rifenbark2018-06-151-0/+0
| | | | | | | | | | Added more detail on how the upstream source or files from srctree are located. (From yocto-docs rev: 5eff4b1b68c232071814969b6367188352639f17) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated devtool add workflow section.Scott Rifenbark2018-05-242-132/+121
| | | | | | | | | | | | | Had to update the figure to use "Upstream Source" labels and fix a wrong "devtool edit-recipe" command. That new figure went into both figures folders for the sdk-manual and mega-manual areas. Provideds some cleaner wording. (From yocto-docs rev: 6225d04dd0551a840d929b752225064a222962bc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to section on running the sdk installation scriptScott Rifenbark2018-05-241-6/+15
| | | | | | | | | | | | | I changed the way we handle the list of exported variables resulting from running the *.sh installation script. Rather than list them all out (they were getting to be quite numerous), I am referencing a few as examples and recommending the user look at the actual *.sh file if they would like to examine the entire list. (From yocto-docs rev: ce2c1491f4f0991cad5f8d4a220a102adb024624) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-241-0/+5
| | | | | | | | | | | poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Running the Extensible SDK Environment Setup Script"Scott Rifenbark2018-05-241-19/+29
| | | | | | | | | | | | Some Minor edits to this section. Also, a scrub of the list of variables exported when running the install script. The list is out of date and is missing many variables. I noted these in comments for now and will add them in later. (From yocto-docs rev: 739a2ca42ee798625492ddb51a32ad09f80aa960) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the "Installing the Extensible SDK" section.Scott Rifenbark2018-05-241-27/+36
| | | | | | | | | | | | | | | The text had not been updated to include the many architectures now supported in the Index of Releases toolchain directories. I added the list of architectures. Renamed the section to a more appropriate section heading. Verified the example and put in the latest output. (From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Minor edits to the intro chapter.Scott Rifenbark2018-05-241-27/+40
| | | | | | | (From yocto-docs rev: 706b4adfd925d247da2ce7405f12ce1e05666a9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved the "Simple Build" sectionScott Rifenbark2018-05-242-2/+2
| | | | | | | | | | | | | I had a section on building an image up in chapter that talks about getting set up to use YP. I moved the build section to a new parent section that will hold topics on building various things. I renamed the section to "Building a Simple Image". I had to fix several links in the sdk-manual, overview-manual, and dev-manual. (From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed title to remove redundancyScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | The "Setting Up the Development Host to Use the Yocto Project" title changed to "Preparing the Build Host". Fixed links in a lot of other manual. (From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual: Updated devtool modify workflow diagramScott Rifenbark2018-05-241-0/+0
| | | | | | | | | Added detail for the step one. Clearer. (From yocto-docs rev: ef95d547180ce53fade7a3764f8d362422472c7a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated devtool modify workflow section.Scott Rifenbark2018-05-241-96/+125
| | | | | | | | | | | I found this section a bit loosely worded and could result in confusion to a user ramping up with YP. I have done an extensive rewrite focusing on exact wordings. (From yocto-docs rev: af64c07d259e06fb13572fc224636ed240037b57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated Eclipse Oxygen plugin instructionsKristi Rifenbark2018-05-241-3/+8
| | | | | | | (From yocto-docs rev: 860f852b0aa99c9c65175fe5fe5035ea0bd26d63) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Removed redundant link to "Build Directory"Scott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 9ce5617e008ce18656cc04608c50186f3d3b05bf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Scrubbed "Neon" occurrences from the Oxygen chapter.Scott Rifenbark2018-05-241-15/+15
| | | | | | | (From yocto-docs rev: 5c53a75af70a6c6ddaaf5b1d298ea129006f2952) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed minor wording problem.Scott Rifenbark2018-05-241-3/+2
| | | | | | | (From yocto-docs rev: 030fa276d1fc462b321e43547a6da03ca05d590e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Fixed bad title in link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Link was going to the right place but had an old chapter title name. (From yocto-docs rev: 57a5d25180429a97d47678c0782198623bc06eef) 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 00:19:03 +0000