DESCRIPTION

tmf: developer guide update (trace type)

Change-Id: I31f8a9dd9fe8a454a81a3d01504a57029613e312
Signed-off-by: Ivy Mitchell xxx@xxx.xxx


COMMENTS

author: Brenden Conley
date: 2014-06-04 17:52:45.000000000

Patch Set 2:

Build Started https://hudson.eclipse.org/linuxtools/job/linuxtools-gerrit/7279/

-------------------------------------
author: Brenden Conley
date: 2014-06-04 18:38:23.000000000

Patch Set 2: Verified+1

Build Successful 

https://hudson.eclipse.org/linuxtools/job/linuxtools-gerrit/7279/ : SUCCESS

-------------------------------------
author: Ricky Reeves
date: 2014-06-05 11:18:05.000000000

Patch Set 2: Code-Review-1

(10 comments)

Line:150, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Here you should read the header information and if it's valid return a TmfValidationStatus with confidence > 0 (100?). This is for the auto-detection of trace types.

Line:280, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Update the description of the validate for the TmfValidationStatus. You should describe how TmfValidationStatus is used and when it should be used in the validate method and when not (i.e. it should not be used when the check is for file exists)

Line:289, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Here you could add a sentence on how to create a the persistent index (i.e. the trace has to implement the interface ITmfPersistentlyIndexable)

Line:298, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> This whole chapter needs to updated (incl. screenshots). There are now 2 extension points:
org.eclipse.linuxtools.tmf.core.tracetype and org.eclipse.lin
uxtools.tmf.ui.tracetypeui.  

Both need to be described accordingly.

Line:325, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Type: Thr

Line:339, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> This sentences doesn't make sense anymore because we have now an core and ui extension point.

Line:343, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> We should reference a gerrit review. This review might disappear. For the Luna release, upload a new version of the zip file that contains the updated code.

After Luna, you can add the code to the example plug-in and update the doc

Line:349, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> defaultEditor and eventsTableType are attributes of the org.eclipse.lin
uxtools.tmf.ui.tracetypeui extension point. Please clarify that.

Line:353, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> eventsTableType are attributes of the org.eclipse.lin
uxtools.tmf.ui.tracetypeui extension point. Please clarify that.

Line:355, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> statisticsViewerType doesn't exist anymore (I think). Please remove after checking that.

-------------------------------------
author: Gerrit Code Review
date: 2014-06-07 11:30:07.000000000

The change could not be merged due to a path conflict.

Please rebase the change locally and upload the rebased commit for review.

-------------------------------------
