DESCRIPTION

Update Documentation to better reflect branch

* Describe time stamp formatting
* Update descriptions of event views to editors
* Update images to reflect better timestamps
* Add description of events properties view
* Update Description of statistics view

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


COMMENTS

author: Brenden Conley
date: 2012-11-29 23:13:59.000000000

Patch Set 1:

Build Started https://hudson.eclipse.org/sandbox/job/linuxtools/690/ 

-------------------------------------
author: Brenden Conley
date: 2012-11-29 23:27:34.000000000

Patch Set 1: Verified

Build Successful 

https://hudson.eclipse.org/sandbox/job/linuxtools/690/ : SUCCESS

-------------------------------------
author: Ricky Reeves
date: 2012-11-30 16:06:53.000000000

Patch Set 1: (10 inline comments)



Line:1136, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> This image seems very big. Make it smaller. If it's too big we'll have problems to upload them later on to the web wiki.

Line:1, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Generally, you have some trailing white spaces in your changes. Gerrit mark them red. So it's easy to spot them. Please remove.

Line:261, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Add something like "... corresponding trace has to be closed before renaming"

Line:286, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Add something like "... corresponding trace has to be closed before deleting trace"

Line:299, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Add something like "... corresponding trace has to be closed before deleting suppl. files"

Line:300, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Mention also the statistics supplementary file

Line:334, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Use upper case for editor in title (Events Editor). After changing it make sure that all references to this chapter also have the uppercase in it.

Line:453, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Add something like "... and is persisted on disk as a supplementary file". Have then a reference to the chapter about "Deleting Supplementary Files", too.

Line:1200, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> reference Events_Editor_2 doesn't exist

Line:1269, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Reference Events_Editor_2 doesn't exist

-------------------------------------
author: Ricky Reeves
date: 2012-11-30 16:21:37.000000000

Patch Set 1: (1 inline comment)



Line:515, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> The png name is not correct. It should be upper case. You also might want to update the image, because now it's organised in a tree structure.

-------------------------------------
author: Braxton Mccarthy
date: 2012-11-30 17:10:26.000000000

Patch Set 1: (6 inline comments)

Some comments.

Might want to run the PNG's through "optipng" once to save some extra space ;)

Line:453, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Maybe add "By default, " at the beginning of the sentence, since it's optional now.

Line:1284, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> , before except.

it provides

Line:1296, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> we usually write timestamp in one word.

Preferences with capital P

Line:1304, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Since you used a verb in the first two examples you should add one for the other lines too. Or remove the verbs and just have a :

Line:1312, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> displayed timestamps

Line:1316, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> the timestamps are assumed

CTF in capital

-------------------------------------
author: Luciana Barry
date: 2012-11-30 17:13:31.000000000

Patch Set 1: (8 inline comments)



Line:300, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> stateHistory.ht

Line:336, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Chronological is true for CTF traces but that is also the trace order. In fact, it is the trace order that is used to populate the table.

Line:338, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> The first sentence is inaccurate. An Events editor displays the events of its own trace. I would remove the sentence, and begin the next one with "Selecting an Events editor tab will...". Change the last sentence: "The <editors> can be dragged...".

Line:354, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> "a the"

Line:358, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Change "will switch to" to "will be updated with the trace data of".

Line:1296, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> I would change "All views" to "Most views" and "in the same way" to "using the same time format".

Line:1305, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> sub-second

Line:1316, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Change "local" to "in the local time zone". "ctf" to "CTF".

-------------------------------------
author: Ivy Mitchell
date: 2012-11-30 18:00:23.000000000

Patch Set 1: (19 inline comments)



Line:1, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:286, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:299, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:300, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:300, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:336, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> This is in the LTTng section.

Line:338, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:354, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:358, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:515, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1200, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1269, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1284, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1296, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1296, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1305, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1312, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1316, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

Line:1316, lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki -> Done

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