Skip to content

Commit 33312f6

Browse files
authored
Merge pull request #271 from tonivega/feature/trendline-chore
Added additional documentation to the trend lines switch -s
2 parents bc08f4d + d98614e commit 33312f6

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,18 @@ Trend lines and its numeric slope can be plotted using the ``s`` flag, such as
218218

219219
mprof plot -s
220220

221+
.. image:: ./images/trend_slope.png
222+
:height: 350px
223+
224+
The intended usage of the -s switch is to check the labels' numerical slope over a significant time period for :
225+
226+
- ``>0`` it might mean a memory leak.
227+
- ``~0`` if 0 or near 0, the memory usage may be considered stable.
228+
- ``<0`` to be interpreted depending on the expected process memory usage patterns, also might mean that the sampling period is too small.
229+
230+
The trend lines are for ilustrative purposes and are plotted as (very) small dashed lines.
231+
232+
221233
Setting debugger breakpoints
222234
=============================
223235
It is possible to set breakpoints depending on the amount of memory used.

0 commit comments

Comments
 (0)