From: Loïc Prieur-Drevon <loic.prieurdrevon@gmail.com>
Date: Thu, 15 Sep 2016 20:25:09 +0000 (-0400)
Subject: lttng: Document Attribute Tree for UstMemoryStateProvider
X-Git-Url: http://git.efficios.com/?a=commitdiff_plain;h=e4ba10eea61dbd65ab6bd420cf232027e7e5508d;p=deliverable%2Ftracecompass.git

lttng: Document Attribute Tree for UstMemoryStateProvider

Change-Id: I35594e499ddcdd7d2e4f4969ce83c76320a85600
Signed-off-by: Loïc Prieur-Drevon <loic.prieurdrevon@gmail.com>
Reviewed-on: https://git.eclipse.org/r/81199
Reviewed-by: Matthew Khouzam <matthew.khouzam@ericsson.com>
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Reviewed-by: Hudson CI
---

diff --git a/lttng/org.eclipse.tracecompass.lttng2.ust.core/src/org/eclipse/tracecompass/internal/lttng2/ust/core/analysis/memory/UstMemoryStateProvider.java b/lttng/org.eclipse.tracecompass.lttng2.ust.core/src/org/eclipse/tracecompass/internal/lttng2/ust/core/analysis/memory/UstMemoryStateProvider.java
index 412b997c0a..47dc1dd294 100644
--- a/lttng/org.eclipse.tracecompass.lttng2.ust.core/src/org/eclipse/tracecompass/internal/lttng2/ust/core/analysis/memory/UstMemoryStateProvider.java
+++ b/lttng/org.eclipse.tracecompass.lttng2.ust.core/src/org/eclipse/tracecompass/internal/lttng2/ust/core/analysis/memory/UstMemoryStateProvider.java
@@ -37,6 +37,14 @@ import com.google.common.collect.ImmutableMap;
  * State provider to track the memory of the threads using the UST libc wrapper
  * memory events.
  *
+ * Attribute tree:
+ *
+ * <pre>
+ * |- <TID number>
+ * |  |- UST_MEMORY_MEMORY_ATTRIBUTE -> Memory Usage
+ * |  |- UST_MEMORY_PROCNAME_ATTRIBUTE -> Process name
+ * </pre>
+ *
  * @author Matthew Khouzam
  * @author Geneviève Bastien
  */