Skip to content

Commit 5241593

Browse files
committed
Update User's guide
1 parent 5843a30 commit 5241593

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

docs/user_guide.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -756,6 +756,10 @@ There are currently six power stepping tools :
756756
Custom power stepping is only supported in Clojure now.
757757
====
758758

759+
Power stepping automatically skips all values equals to `:flow-storm.power-step/skip`. This can be useful when combined
760+
with <<#_dealing_with_mutable_values, snapshot-value>> as a way of ignoring some of them, which provides a way of sampling
761+
tight loops like in games.
762+
759763

760764
=== Searching
761765

@@ -1852,6 +1856,14 @@ If this is important to you, you can still define snapshot-value for clojure.lan
18521856
walk it down snapshoting everything mutable inside.
18531857
====
18541858

1859+
[NOTE]
1860+
.snapshot-value and memory footprint
1861+
====
1862+
Although snapshot-value was created as a way to deal with mutable values it can be used to replace any value by another in the
1863+
recordings, which can be useful in other situations like reducing memory footprint when you don't need the entire
1864+
value to be recorded.
1865+
====
1866+
18551867
= Controlling instrumentation
18561868

18571869
If you are using _ClojureStorm_ or _ClojureScriptStorm_ it is important to learn how to control what gets instrumented and

docs/user_guide.html

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2003,6 +2003,11 @@ <h4 id="_power_stepping"><a class="anchor" href="#_power_stepping"></a><a class=
20032003
</tr>
20042004
</table>
20052005
</div>
2006+
<div class="paragraph">
2007+
<p>Power stepping automatically skips all values equals to <code>:flow-storm.power-step/skip</code>. This can be useful when combined
2008+
with <a href="#_dealing_with_mutable_values">snapshot-value</a> as a way of ignoring some of them, which provides a way of sampling
2009+
tight loops like in games.</p>
2010+
</div>
20062011
</div>
20072012
<div class="sect3">
20082013
<h4 id="_searching"><a class="anchor" href="#_searching"></a><a class="link" href="#_searching">3.1.3. Searching</a></h4>
@@ -3743,6 +3748,23 @@ <h2 id="_dealing_with_mutable_values"><a class="anchor" href="#_dealing_with_mut
37433748
</tr>
37443749
</table>
37453750
</div>
3751+
<div class="admonitionblock note">
3752+
<table>
3753+
<tr>
3754+
<td class="icon">
3755+
<div class="title">Note</div>
3756+
</td>
3757+
<td class="content">
3758+
<div class="title">snapshot-value and memory footprint</div>
3759+
<div class="paragraph">
3760+
<p>Although snapshot-value was created as a way to deal with mutable values it can be used to replace any value by another in the
3761+
recordings, which can be useful in other situations like reducing memory footprint when you don&#8217;t need the entire
3762+
value to be recorded.</p>
3763+
</div>
3764+
</td>
3765+
</tr>
3766+
</table>
3767+
</div>
37463768
</div>
37473769
</div>
37483770
<div class="sect1">
@@ -4749,7 +4771,7 @@ <h2 id="_internals_diagrams_and_documentation"><a class="anchor" href="#_interna
47494771
</div>
47504772
<div id="footer">
47514773
<div id="footer-text">
4752-
Last updated 2025-03-29 22:45:18 -0300
4774+
Last updated 2025-03-30 15:39:11 -0300
47534775
</div>
47544776
</div>
47554777
</body>

0 commit comments

Comments
 (0)