DESCRIPTION

TMF: Add Analysis API documentation

Change-Id: Ia8dfc072073555d4f969ec811c07c420fe3a60af
Signed-off-by: Aryana Jones xxx@xxx.xxx


COMMENTS

author: Annalise Jimenez
date: 2013-12-20 17:03:19.000000000

Uploaded patch set 2.

-------------------------------------
author: Brenden Conley
date: 2013-12-20 19:19:48.000000000

Patch Set 2:

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

-------------------------------------
author: Brenden Conley
date: 2013-12-20 19:52:06.000000000

Patch Set 2: Verified+1

Build Successful 

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

-------------------------------------
author: Braxton Mccarthy
date: 2014-01-10 22:48:16.000000000

Patch Set 2: Code-Review-1

(26 comments)

Good stuff, some typos/comments

Line:3221, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> The section could be called "Analysis Framework"

Line:3223, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> "without having to know beforehand." Without having to know what?

Line:3225, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Plural of analysis is "analyses" (or "analyzes")

Line:3227, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> to be consistent with the other subsections, this could be "Creating a new module"

Line:3229, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> from the o.e.l.tmf.core project

Line:3233, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> an LTTng kernel trace

Line:3243, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> an

Line:3246, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> reviewing code in doc, oh yeah!

no space after !

Line:3262, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Just use 

 /*
  * Text there
  */

for multi-line coments

Line:3292, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> all the methods

Remove the last sentence, it won't mean anything once HistoryBuilder and TmfStateSystemFactory are removed.

Line:3294, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> functionalities (one n)

Line:3296, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> It's now called ITmfAnalysisModuleWithStateSystems

Line:3300, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Analyses are managed

Line:3306, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Design question here, why is resetAnalysis() protected? If an external component cancels the analysis, it has no way of restarting it?

Line:3310, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> You can add extensions from the MANIFEST.MF file?

Line:3335, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> who has default value -> which has

, or wait (add comma)

Line:3337, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> a same module -> the same module

comma before "but on which"

different analyses could provide

Line:3341, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Analyses

an XML file

Line:3343, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Anlyses

Line:3355, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Using

Line:3375, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> don't wrap this (we don't normally wrap at method invocations, it's a nightmare of readability).

Line:3429, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> don't wrap this

Line:3449, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> to the analysis "my.etc."

When the analysis module is created, the new module will register automatically to the...

Line:3455, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> the Eclipse Help facility

Line:3459, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> analyses

Line:3460, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> analyses

even if he has no imported traces

-------------------------------------
author: Annalise Jimenez
date: 2014-01-12 18:38:01.000000000

Patch Set 2:

(1 comment)

Line:3221, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> I was going to say that I hate the term Analysis Framework and prefer Analysis API (I still do), but after searching "framework vs api", I think this whole thing with analysis is really more a framework providing an API, so yes, I guess I could call this "Analysis Framework"...

-------------------------------------
author: Annalise Jimenez
date: 2014-01-14 15:06:11.000000000

Patch Set 2:

(2 comments)

Line:3306, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> It may go public one day when need arises. But for now, analyses are reset internally for example when parameters change. I don't remember why I put it protected but there must have been a reason that seemed good at the time...

Line:3310, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> :p you're right, "through the 'Extensions' tab of the Plug-in Manifest Editor"

-------------------------------------
author: Braxton Mccarthy
date: 2014-01-15 21:10:52.000000000

Patch Set 2:

(2 comments)

Line:3310, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> Ah ok, yeah that's what I assumed you got it from. Eclipse opens one editor for both the Manifest and the plugin.xml files. That tab only affects plugin.xml ;)

Line:3449, lttng/org.eclipse.linuxtools.tmf.help/doc/Developer-Guide.mediawiki -> first comment meant "add a "the"". but it works without too, so it doesn't matter.

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