summaryrefslogtreecommitdiffstats
path: root/tools/profiler/docs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:13:27 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 01:13:27 +0000
commit40a355a42d4a9444dc753c04c6608dade2f06a23 (patch)
tree871fc667d2de662f171103ce5ec067014ef85e61 /tools/profiler/docs
parentAdding upstream version 124.0.1. (diff)
downloadfirefox-40a355a42d4a9444dc753c04c6608dade2f06a23.tar.xz
firefox-40a355a42d4a9444dc753c04c6608dade2f06a23.zip
Adding upstream version 125.0.1.upstream/125.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'tools/profiler/docs')
-rw-r--r--tools/profiler/docs/markers-guide.rst10
1 files changed, 9 insertions, 1 deletions
diff --git a/tools/profiler/docs/markers-guide.rst b/tools/profiler/docs/markers-guide.rst
index 86744c523c..ed18b35867 100644
--- a/tools/profiler/docs/markers-guide.rst
+++ b/tools/profiler/docs/markers-guide.rst
@@ -319,7 +319,7 @@ A marker type must have a unique name, it is used to keep track of the type of
markers in the profiler storage, and to identify them uniquely on profiler.firefox.com.
(It does not need to be the same as the ``struct``'s name.)
-This name is defined in a special static data member ``Name``:
+This type name is defined in a special static data member ``Name``:
.. code-block:: cpp
@@ -333,6 +333,14 @@ In addition you must add a description of your marker in a special static data m
// …
static constexpr const char* Description = "This is my marker!";
+If you expect users to be passing unique names for individual instances of the marker,
+you may want to add the following to ensure those names get stored when using ETW:
+
+.. code-block:: cpp
+
+ // …
+ static constexpr bool StoreName = true;
+
Marker Type Data
^^^^^^^^^^^^^^^^