Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthew Khouzam2013-05-27 15:54:34 +0000
committerMatthew Khouzam2013-05-30 14:58:34 +0000
commitbdf5a5a2ab41520a7db31cd990510d273aa6ed59 (patch)
tree669f677ae72df88870d143dd32aab07ffedf1574
parentb696c40d4e67aa83d2df428315ac36b6d8bd807d (diff)
downloadorg.eclipse.linuxtools-bdf5a5a2ab41520a7db31cd990510d273aa6ed59.tar.gz
org.eclipse.linuxtools-bdf5a5a2ab41520a7db31cd990510d273aa6ed59.tar.xz
org.eclipse.linuxtools-bdf5a5a2ab41520a7db31cd990510d273aa6ed59.zip
tmf: update wiki for batch import trace wizard.
Signed-off-by: Matthew Khouzam <matthew.khouzam@ericsson.com> Change-Id: Id605d0f628fa306dc87c5414161304ed5859326e Reviewed-on: https://git.eclipse.org/r/13230 Tested-by: Hudson CI Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com> IP-Clean: Bernd Hufmann <bernd.hufmann@ericsson.com> Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com> Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com> IP-Clean: Matthew Khouzam <matthew.khouzam@ericsson.com> Tested-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki85
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importAddFile.pngbin0 -> 19812 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importBatchImport.pngbin0 -> 52264 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importFinish.pngbin0 -> 11297 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importImportMenu.pngbin0 -> 49888 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importMenuSelect.pngbin0 -> 37415 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOpenProject.pngbin0 -> 9730 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOptions.pngbin0 -> 20655 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan1.pngbin0 -> 34092 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan2.pngbin0 -> 45702 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan3.pngbin0 -> 59239 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan4.pngbin0 -> 6248 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan5.pngbin0 -> 17256 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan6.pngbin0 -> 51638 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectFilesToScan.pngbin0 -> 25222 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeComplete.pngbin0 -> 34235 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeToImport.pngbin0 -> 31765 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTracingProject.pngbin0 -> 22792 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectedDirectory.pngbin0 -> 27992 bytes
-rw-r--r--lttng/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/wizards/importtrace/messages.properties6
20 files changed, 85 insertions, 6 deletions
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
index 180777ae98..8ddeeea33a 100644
--- a/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/User-Guide.mediawiki
@@ -189,8 +189,87 @@ A new project will appear in the '''Project Explorer''' view.
Tracing projects have two sub-folders: '''Traces''' which holds the individual traces, and '''Experiments''' which holds sets of traces that we want to correlate.
=== Importing Traces in a Project ===
+==== Batch Importing ====
+The '''Batch Import Trace Wizard''' allows users to search their media for traces and import multiple traces of varying trace types simultaneously. It also handles name clashes and renaming of traces.
-The '''Traces''' folder holds the set of traces available for experiments. To import a trace to the traces folder, select the Traces folder and click the right mouse button. Then select '''Import...''' menu item in the context-sensitive menu.
+The '''Traces''' folder holds the set of traces available for a tracing project. To import a set of traces to the '''Traces''' folder, one can open the '''Import...''' menu from the '''File''' main menu.
+
+[[Image:images/importImages/importImportMenu.png]]
+
+Then select '''Batch Trace Import'''
+
+[[Image:images/importImages/importMenuSelect.png]]
+
+Or one can select the '''Traces''' folder by double clicking on the project name.
+
+[[Image:images/importImages/importSelectTracingProject.png]]
+
+Then click the right mouse button on the '''Traces''' folder. Then select '''Batch Import...''' menu item in the context-sensitive menu.
+
+[[Image:images/importImages/importBatchImport.png]]
+
+At this point, the '''Batch import wizard''' is opened.
+
+The '''Available trace types''' page is visible. Select a trace type to scan for by clicking an item in trace types tree. If one selects a parent element, the new state will be propagated to the children.
+
+[[Image:images/importImages/importSelectTraceTypeToImport.png]]
+
+When that is done, the warning message will go away and the user can click '''Next >'''.
+
+[[Image:images/importImages/importSelectTraceTypeComplete.png]]
+
+Then select one or more files or directories to scan for traces. The directories added will be recursively scanned, all children files and directories will be scanned. This can be slow depending on the size of the directory to scan.
+
+[[Image:images/importImages/importSelectFilesToScan.png]]
+
+One can add a directory by clicking on '''Add Directory...''' then selecting a directory to import.
+
+[[Image:images/importImages/importSelectedDirectory.png]]
+
+One can also add a file by clicking on '''Add File...''' then selecting a file to import.
+
+[[Image:images/importImages/importAddFile.png]]
+
+Once the files and directories are selected, a background scanner will already start scanning them for potential matches. to select the candidates, click '''Next >'''.
+
+Here the user will see the results of the scan. The list will grow as more files are scanned.
+To select a trace to import, first open a trace type.
+
+[[Image:images/importImages/importScan1.png]]
+
+Then select the trace to import.
+
+[[Image:images/importImages/importScan2.png]]
+
+When that is done, typically one can press '''Finish''', and the trace will be imported. They can set the trace to be '''linked''' or '''copied'''. A '''linked''' trace is not copied to the user's workspace, rather, the original file is used. This is useful for traces that are very large and that the user does not want to copy several times. '''Copied''' traces are as their name indicates, copied to the local workspace. This is useful if there is a trace on a network or on some removable media. The user can also specify if the trace should '''overwrite''' the resources in the workspace or not.
+
+[[Image:images/importImages/importScan3.png]]
+
+One can select several traces also and import them simultaneously. In this case there is a problem, the name of both traces are the same, this is a conflicting name and needs to be resolved.
+
+[[Image:images/importImages/importScan4.png]]
+
+To do so, select one of the conflicting traces, then '''click on its name'''. Then type in a new name.
+
+[[Image:images/importImages/importScan5.png]]
+
+Here the traces shall be copied instead of linked.
+
+[[Image:images/importImages/importScan6.png]]
+
+At this point, press '''Finish''' to import the traces.
+
+If the '''Finish''' button is grayed, or if the user wishes to import to a different project, they need to press '''Next >'''. The user then needs to select a project to import to on the '''options''' page.
+
+[[Image:images/importImages/importOptions.png]]
+
+You will then see the traces in the '''Traces''' folder as shown below and can '''open''' them by '''double-clicking''' on them. For more details on how to open a trace see section [[#Opening_a_Trace_or_Experiment|Opening a Trace or Experiment]].
+
+[[Image:images/importImages/importFinish.png]]
+
+==== Importing ====
+
+The previous way of importing a trace is still available. To access it, simply select '''Import...''' menu item in the context-sensitive menu.
[[Image:images/ProjectImportTraceAction.png]]
@@ -621,7 +700,7 @@ The first line of a matching entry is highlighted with darker colors.
By default only the first matching entry will be highlighted. To highlight all matching entries in the preview input data, click the '''Highlight All''' button. This might take a few seconds to process, depending on the input size.
-Click the '''Next''' button to go to the second page of the wizard.
+Click the '''Next >''' button to go to the second page of the wizard.
[[Image:images/CustomTextParserOutput.png]]
@@ -693,7 +772,7 @@ The '''Preview input''' text box can be used to enter any XML log data that will
The '''Preview:''' text field of each capturing element and attribute and of the Time Stamp will be filled from the parsed data of the first matching log entry. Also, when creating a new child element or attribute, its element or attribute name will be suggested if possible from the preview input data.
-Click the '''Next''' button to go to the second page of the wizard.
+Click the '''Next >''' button to go to the second page of the wizard.
[[Image:images/CustomXMLParserOutput.png]]
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importAddFile.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importAddFile.png
new file mode 100644
index 0000000000..303cbf860d
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importAddFile.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importBatchImport.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importBatchImport.png
new file mode 100644
index 0000000000..7af30c1898
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importBatchImport.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importFinish.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importFinish.png
new file mode 100644
index 0000000000..55cd63dbf7
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importFinish.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importImportMenu.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importImportMenu.png
new file mode 100644
index 0000000000..3c77a191ed
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importImportMenu.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importMenuSelect.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importMenuSelect.png
new file mode 100644
index 0000000000..0f8d98f763
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importMenuSelect.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOpenProject.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOpenProject.png
new file mode 100644
index 0000000000..1f38731250
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOpenProject.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOptions.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOptions.png
new file mode 100644
index 0000000000..0d6ce2a859
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importOptions.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan1.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan1.png
new file mode 100644
index 0000000000..c55f3cdde0
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan1.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan2.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan2.png
new file mode 100644
index 0000000000..b532db310e
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan2.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan3.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan3.png
new file mode 100644
index 0000000000..61742f4520
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan3.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan4.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan4.png
new file mode 100644
index 0000000000..425334387f
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan4.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan5.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan5.png
new file mode 100644
index 0000000000..ade020e987
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan5.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan6.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan6.png
new file mode 100644
index 0000000000..c99a18052d
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importScan6.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectFilesToScan.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectFilesToScan.png
new file mode 100644
index 0000000000..a20b4aa892
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectFilesToScan.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeComplete.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeComplete.png
new file mode 100644
index 0000000000..8180f8215d
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeComplete.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeToImport.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeToImport.png
new file mode 100644
index 0000000000..bcc30566e3
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTraceTypeToImport.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTracingProject.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTracingProject.png
new file mode 100644
index 0000000000..4959a6f5de
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectTracingProject.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectedDirectory.png b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectedDirectory.png
new file mode 100644
index 0000000000..9ca13633e9
--- /dev/null
+++ b/lttng/org.eclipse.linuxtools.lttng.help/doc/images/importImages/importSelectedDirectory.png
Binary files differ
diff --git a/lttng/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/wizards/importtrace/messages.properties b/lttng/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/wizards/importtrace/messages.properties
index a972114ef1..61ab4e5cc0 100644
--- a/lttng/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/wizards/importtrace/messages.properties
+++ b/lttng/org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/project/wizards/importtrace/messages.properties
@@ -21,7 +21,7 @@ ImportTraceWizardRemove=Remove
ImportTraceWizardDirectoryTitle=Pick directories and files to scan
ImportTraceWizardDirectoryHint=Select at least one directory to scan
ImportTraceWizardScanPageRenameError=Each selected trace must have a unique name, please rename.
-ImportTraceWizardScanPageSelectAtleastOne=Please select at least one trace to import
+ImportTraceWizardScanPageSelectAtleastOne=Select at least one trace to import
ImportTraceWizardSelectAll=Select All
ImportTraceWizardScanPageTitle=Valid traces
ImportTraceWizardSelectTraceTypePageTitle=Available trace types
@@ -29,9 +29,9 @@ ImportTraceWizardPageOptionsTitle=Trace import options
ImportTraceWizardPageScanDone=Done\!
ImportTraceWizardPageScanScanning=Scanning:
ImportTraceWizardPageSelectNone=Deselect All
-ImportTraceWizardPageSelectHint=Please Select at least one trace type
+ImportTraceWizardPageSelectHint=Select at least one trace type
BatchImportTraceWizardRemove=Removing
BatchImportTraceWizardAdd=Adding
BatchImportTraceWizardErrorImportingTraceResource=Error importing trace resource
ImportTraceWizardImportProblem=Error
-SharedSelectProject=Please select a project to import to
+SharedSelectProject=Select a project to import to

Back to the top