Skip to content

Commit

Permalink
References for memory measurements to grasp it
Browse files Browse the repository at this point in the history
#262 reminded me of just how strange this code might be to people new to the code base and also to myself after a couple of months. This general information should help :)
  • Loading branch information
PragTob committed Jan 26, 2019
1 parent cb5b399 commit b3b4d5f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions lib/benchee/benchmark/measure/memory.ex
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ defmodule Benchee.Benchmark.Measure.Memory do

# Measure memory consumption of a function.
#
# This is somewhat tricky and hence some resources can be recommended reading alongside
# this code:
# * description of the approach: https://devonestes.herokuapp.com/using-erlang-trace-3
# * devon describing the journey that this feature put us through (includes remarks
# on why certain parts are very important: https://www.youtube.com/watch?v=aqLujfzvUgM)
# * erlang docs on the info data structure we use:
# http://erlang.org/doc/man/erlang.html#gc_minor_start
#
# Returns `{nil, return_value}` in case the memory measurement went bad.

@behaviour Benchee.Benchmark.Measure
Expand Down

0 comments on commit b3b4d5f

Please sign in to comment.