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 412b997c0a08024584a5d8e049d3d030f3751a2c..47dc1dd29479b176a4f5a0a4b628a85a5827f47e 100644 (file)
--- 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
  */