Bug 6432

Summary: Document an example SDK usage workflow
Product: [Documentation] ADT Manual Reporter: Richard Purdie <richard.purdie>
Component: SDKAssignee: Henry Bruce <henry.bruce>
Status: VERIFIED FIXED QA Contact: oscar lopez arandas <oscarx.lopez.arandas>
Severity: enhancement    
Priority: Medium+ CC: alexandru.c.georgescu, bluelightning, david.b.kinder, henry.bruce, jose.perez.carranza, joshuagloe, kristi, mhalstead, poky.doc.watcher, poky.watcher, ross.burton, sgw, srifenbark
Version: 1.9   
Target Milestone: 2.4 M2   
Hardware: x86   
OS: Multiple   
Whiteboard: 28 June 2017: RESOLVED
OS type for building Yocto: --- Type of Regression: ---
Verified: Documentation change: Done (doc changes complete)
Bug Depends on: 7675    
Bug Blocks:    

Description Richard Purdie 2014-06-11 16:53:53 UTC 
Lets imagine we're an application developer who has an application, A and a library B that the application links to.

This developer needs to take our SDK and a target device, compile the lib and application for the device and iterate through a couple of recompile and retest cycles of the lib *and* the app.

This bug is about documenting how you can do that with the tools as they stand today. Its known there may be some difficulties. In documenting the existing flow, its hoped the gaps can be identified and specific tooling to help those gaps can be added and documented.
Comment 1 Scott Rifenbark 2014-06-16 06:27:34 UTC 
Hi, 

So this scenario assumes that the user application (A) and library (B) exist and work for some existing device.  Now the user wants to get them working for a different target device and to do that they will use one of our SDKs. Assuming I understand the overall goal then:

1. user knows the device for which he is compiling and testing the app and library for.

2. user finds the right SDK that YP provides for that target device.

3. user installs the SDK

4. user compiles the application and the library using the SDK

5. user gets the application and library on the target 

6. user tests application and target

7. user identifies any issues

8. user fixes issues

9. repeat 4 through 8.


Is the above the general idea here?

(Adding Paul, Ross, and Saul to CC list).

Scott
Comment 2 Scott Rifenbark 2014-08-01 07:44:27 UTC 
I am setting this to NEEDINFO.  The bug is not assigned to me but I need the information.
Comment 3 Cristian Iorga 2014-09-15 09:53:44 UTC 
Investigation started.
Comment 4 Paul Eggleton 2015-06-16 10:22:30 UTC 
After some discussion with Richard I'm adjusting this task to documenting a worked example of how to use the extensible SDK. That probably means the content would go into the Application Development manual rather than the Development manual, and it'll need to happen after (or as part of) reworking that manual under bug 7675.
Comment 5 Scott Rifenbark 2016-04-22 16:44:07 UTC 
Paul, 

How does this bug stand now?  With the new SDK manual, we need an example in there?

Scott
Comment 6 Henry Bruce 2016-04-25 18:23:51 UTC 
I am working with David Kinder to create a"primer" that fills the gap between getting started guide and reference documentation. Perhaps the primer could address this need?
Comment 7 Scott Rifenbark 2016-04-25 19:32:51 UTC 
David, 

So what is going on here?  Is this Primer a new document into the YP documentation set?  We probably should discuss this effort. 

Thanks, 
Scott
Comment 8 Henry Bruce 2016-10-04 16:38:04 UTC 
OTC technical writing team went for for a cookbook rather than a primer.

devtool/esdk article can be found at https://wiki.yoctoproject.org/wiki/Application_Development_with_Extensible_SDK
Comment 9 Scott Rifenbark 2016-10-04 17:07:35 UTC 
Hi, 

So this bug is completed for the documentation?  If so, can I turn that flag off? When this bug was generated it was for 1.9 and the ADT manual was in existence.  That manual has been replaced for the last couple of releases by the new SDK manual, which is used in the wiki link mentioned in Comment 8.  

Scott
Comment 10 Henry Bruce 2016-10-04 17:59:22 UTC 
The eSDK section of the manual is mainly reference but I believe it addresses Richard's original question.

That said, eSDK maunal lacks an worked example (as done for the traditional SDK in http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#creating-and-running-a-project-based-on-gnu-autotools). However this is addressed by cookbook article on wiki.

I'm not sure of next steps for this bug. I see the following options
1. Close as eSDK manual addresses original wording of bug, although manual lacks a worked example
2. Leave open until worked example is added to eSDK manual
3. Leave open until pointer to wiki cookbook article is added to manual
Comment 11 Scott Rifenbark 2016-10-10 16:14:12 UTC 
Hi, 

We have a couple examples in the SDK manual.  The Autotools section has a worked example, see http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#autotools-based-projects.  And, the example in the Eclipse section, see http://www.yoctoproject.org/docs/2.2/sdk-manual/sdk-manual.html#sdk-developing-applications-using-eclipse.  I am not sure how much more of a worked example we would want.  Paul indicated that these examples are good for either the extensible or the standard SDK.  I suppose it would be possible to put a separate example in the chapter dedicated to the eSDK.  If that is what we want, I could take the Quick Start I wrote for Mendor.io and convert that for our use here.  Thoughts on all this stuff?

I can easily add a cross-reference link into the wiki.  That should probably be done regardless.  

Thanks, 
Scott
Comment 12 Scott Rifenbark 2017-06-08 13:51:05 UTC 
Henry, 

I think you can just close this bug as the examples in the SDK manual seem to be adequate here.

Scott
Comment 13 Kristi 2017-06-28 21:28:19 UTC 
Henry, 
Closing this per Scott even thought you own the bug. Setting the doc flag to "Done". 

Thanks, 
Kristi