Bug 7546 - Streamline application development manual
Summary: Streamline application development manual
Status: RESOLVED FIXED
Alias: None
Product: Development Manual
Classification: Documentation
Component: development (show other bugs)
Version: 1.7.1
Hardware: x86 Multiple
: Medium enhancement
Target Milestone: 2.3 M2
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 08 Nov 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2015-03-31 11:09 UTC by Joshua Lock
Modified: 2016-11-08 17:50 UTC (History)
6 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Joshua Lock 2015-03-31 11:09:48 UTC
I've been trying to set up Eclipse for application development this morning and in the process started to feel a little overwhelmed by the amount of possible ways to do things.

I think it would make sense to streamline the manuals by referring to each of the possible options in the section introduction but then only document one recommended workflow in the main section body, moving the information about alternative methods to an appendix.

i.e. for 4.2.2 of the dev manual document the workflow for a standalone toolchain built with the -c populate_sdk workflow, remove mention of the ADT per #6404 and move documentation about a build directory based toolchain to an appendix.
Comment 1 Scott Rifenbark 2015-04-09 23:00:21 UTC
Joshua, 

That is probably a good idea.  We could just stick with the latest version of Eclipse.  I like it.  I added some others to the CC list that might have opinions.

Scott
Comment 2 Scott Rifenbark 2016-04-14 15:49:20 UTC
Now that this information is in the sdk-manual, I will apply it to that manual.

Scott
Comment 3 Scott Rifenbark 2016-08-01 21:14:13 UTC
Hi, 

After talking with Timothy Orling, I learned that Eclipse Neon is being attempted for YP 2.2.  And, that Eclipse Mars is in place.  Timothy suggests dropping support for Kepler.  That would potentially leave Neon, Mars, and Luna as supported Eclipse releases for YP 2.2.

If I change the section in the SDK manual that steps through Eclipse usage to use a single release, I would guess we would want to use Neon.  I would move the requirements for the user to use Mars and Luna (or should we just go with Mars?) to some sort of location or area where it is isolated.  

Timothy noted to me that right now, the http://git.yoctoproject.org/cgit/cgit.cgi/poky-contrib/log/?h=timo/neon-master branch could be built to check out Neon behavior and steps.  Must use "build.sh -l" to build the local branch.

I will be attempting to run through and document the procedures to use the Eclipse plug-in (Neon and Mars).  Here is the current section, which is badly out of date: http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#sdk-developing-applications-using-eclipse.

Scott
Comment 4 Scott Rifenbark 2016-08-10 19:39:27 UTC
I have created a new appendix C in the new SDK manual.  This appendix will run the user through the steps to develop a "helloworld" project using the Mars Eclipse version.  It is based on the existing flow of the main section in the manual that currently covers using Eclipse.  The idea is to separate out the -1 version of Eclipse that YP will support for 2.2 (Mars).  The current version (Neon) will be documented in the main part of the manual replacing what is there right now (a mix of Luna and Kepler).  

It is critical that this material is reviewed and tested by the engineers.  I have run through it and could not get it to work.  It failed when trying to run QEMU.  I suspect I don't have comapatible SDK and images or something of that nature.  

When reviewing this material, consider that we want it written for how things will work with the release of 2.2.  So, any temporary URLs and such would ultimately need to be where the real stuff lives.  Also, things did not map one-to-one with the Eclipse configuration steps I had with Luna and Kepler to Mars.  I did some guessing.  This is where I will need some verification as I might have made some bad assumptions when installing new software during the configuration part.

See the temporary HTML file at http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html and appendix C.

Thanks, 
Scott
Comment 5 brian avery 2016-08-10 19:47:19 UTC
 I'd remove the 1.1.5. User-Space Tools section.  It is no longer being tested by QA and some subset of them do not function.  They are largely superfluous in that linuxtools replace most of this functionality and is actively maintained.
Comment 6 Tim Orling 2016-08-10 21:43:09 UTC
By "linuxtools" we mean:
http://www.eclipse.org/linuxtools/
Comment 7 Scott Rifenbark 2016-08-11 14:23:50 UTC
Brian and Tim, 

So I looked at the linuxtools page and some of the same functionality exists there that was detailed in the "user-space" tools.  Should we create a laundry list of such tools to replace the spots in the manuals where we talk about the "user-space" tools?  Or, can we just mention the existence of linuxtools and reference the web page? 

For example, in the main part of of the SDK manual, we have that 1.1.5 section Brian mentioned in Comment 5.  Would a Note suffice there? Or, do we want to list out some of the tools like we did for "user tools"?

There are various other spots throughout the manual that reference these tools, which I can just reference linuxtools from.  Not sure on the list though if we should note it or replace with a list of stuff from "linuxtools".

Scott
Comment 8 brian avery 2016-08-11 16:38:13 UTC
I'm inclined to just point to http://www.eclipse.org/linuxtools/index.php and say that many performance related tools can be found here.  I'd also say that the performance tools in our plugin should be noted as deprecated.
Comment 9 Tim Orling 2016-08-11 17:14:27 UTC
I (we) owe OE Architecture ML a heads up that those tools are being deprecated (that came out of discussion two weeks ago in Bug Triage call)
Comment 10 Scott Rifenbark 2016-08-12 17:25:35 UTC
Hi, 

Here are some links that take care of the "user-space tools" stuff.  Note that I did not "scrub" the section in Chapter two that currently provides the main example for the most recent Eclipse version.  That section will be fixed when I work through the Neon example:

 * http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html#sdk-manual-intro - see the last bullet in the section.

 * http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html#eclipse-overview - See this section for a blurb on the new tools and a note indicating that the previous "user-space tools" have been deprecated.

 * See http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html#performance-enhancing-tools for the new 1.5.1 section that previously listed out the "user-space tools".  I have just introduced them and then pointed to the site.

 * See item 7 at http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html#workflow-using-eclipse for a re-write of this item.

 * See the last paragraph after the note - http://www.yoctoproject.org/docs/temp/sdk-manual/sdk-manual.html#adt-eclipse for altered text.
Comment 11 Scott Rifenbark 2016-08-12 19:32:34 UTC
Hi, 

I applied what changes I could from the email that Brian sent.  I have some questions there and need some more clarification.

Scott
Comment 12 Scott Rifenbark 2016-09-06 18:23:55 UTC
Hi,

The new material for Mars and Neon are now available in the SDK Manual.  Neon, which is the latest version of Eclipse, is featured in the main flow of the manual (http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#sdk-developing-applications-using-eclipse).  We no longer try to force the reader down one path while providing "differences" should they be using another supported version of Eclipse. 

Mars flow is described in a new appendix (http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#sdk-appendix-mars)

I have worked closely with Tim Orling to get this stuff working as it is being developed.  I was able to use a built SDK and build YP eclipse plug in.  For artifacts, I followed the instructions on the wiki page (https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage).  This wiki page is very helpful and should keep in sync with the manual.  In fact, the wiki page could be updated to cross-reference the sections in the SDK manual if the reader want to have a more comprehensive read.

Some things still do not work.  I am not able to deploy my "hello" application into the remote QEMU machine.  I keep getting file permission errors for the object even though I set the permissions manual to be wide open.

Please look over the two new areas and comment.

Thanks, 
Scott
Comment 13 Scott Rifenbark 2016-10-25 20:12:40 UTC
Moving to 2.3 M2
Comment 14 Scott Rifenbark 2016-11-08 17:50:34 UTC
This is done... Plenty of feedback addressed along the way.  I am marking as RESOLVED and setting the doc flag to "done."

Scott