Skip to content

Commit e9807a6

Browse files
authored
elaborate a little on mvmstartprofile and mvmendprofile
1 parent 8fe6274 commit e9807a6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/ops.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2716,11 +2716,11 @@ Turns on one of MoarVM's profilers. The configuration must have a `kind` key tha
27162716

27172717
* `instrumented`
27182718

2719-
takes no further configuration options
2719+
takes no further configuration options. records call graph, garbage collection, and object allocation information.
27202720

27212721
* `heap`
27222722

2723-
takes a path / filename in the `path` key
2723+
takes a path / filename in the `path` key. writes a snapshot of the heap's structure (objects and their connections) to the file every time the GC runs.
27242724

27252725
If a profiler is already active, an exception will be thrown; only one profiler can run at a time.
27262726

@@ -2735,7 +2735,7 @@ Turns off the profiler and returns data gathered.
27352735

27362736
* `heap`
27372737

2738-
currently doesn't return anything
2738+
currently doesn't return anything. it does, however, cause one heap snapshot to be taken immediately.
27392739

27402740
# <a id="nativecall"></a> Native Call / Interoperability Opcodes
27412741

0 commit comments

Comments
 (0)