From c6f13372be99a8274ed415c11a3ddaba70724a65 Mon Sep 17 00:00:00 2001 From: Simon Byrne Date: Thu, 11 Jan 2024 12:36:34 -0800 Subject: [PATCH] improve docs --- docs/src/index.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 251b465..bd8a108 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -24,9 +24,14 @@ NVTX.@annotate function myfunction(args...) end ``` -## Instrumenting Julia garbage collector +## Instrumenting Julia internals -Additionally, it is possible to annotate the Julia garbage collector by calling [`NVTX.enable_gc_hooks()`](@ref) and [`NVTX.enable_inference_hook()`](@ref), or setting the `JULIA_NVTX_CALLBACKS` environment variable. +Additionally, it is possible to annotate the Julia garbage collector and inference by calling [`NVTX.enable_gc_hooks()`](@ref) and [`NVTX.enable_inference_hook()`](@ref), or setting the `JULIA_NVTX_CALLBACKS` environment variable to a comma (`,`) or bar (`|`) separated list of: + +- `gc`: instrument the Julia garbage collector +- `alloc`: instrument calls to alloc +- `free`: instrument calls to free +- `inference`: instrument calls to compiler inference. ## Running the profiler