Gc.Tweak(3)

📦
version 5.5.0 · 2 versions
, in arch rolling

🌸 NAME 🌸

From the OCaml library manual, page Gc.Tweak(3): Gc.Tweak — bestie, these are GC Tweaks, aka unstable and undocumented configurable GC parameters, primarily intended for use by GC developers. 💅

🦋 MODULE 🦋

Module Gc.Tweak — yes ma'am, that's the module, and it's serving exactly that name. ✨

🎀 DOCUMENTATION 🎀

🧚 Module Tweak

: sig end

Okay so real talk: GC Tweaks are unstable and undocumented configurable GC parameters, primarily intended for use by GC developers. No cap, they're literally for the GC dev girlies. 🫶

As well as using Gc.Tweak.set "foo" 42, they can also be configured in OCAMLRUNPARAM, using the following syntax:

OCAMLRUNPARAM='Xfoo=42'

Additionally, OCAMLRUNPARAM=Xhelp will show the available GC tweaks. Iconic behavior, honestly. 🌈

Since 5.5 — periodt. 👑

  • val set : string -> int -> unit — change a parameter. Raises Invalid_argument if no such parameter exists. 🚨
  • val get : string -> int — retrieve a parameter value. Raises Invalid_argument if no such parameter exists. 🔍
  • val list_active : unit -> (string * int) list — returns the list of parameters and their values that currently have non-default values. ✨

Shoutout to OCamldoc for serving this on 2026-06-22 — page Gc.Tweak(3) signing off, mwah 💋💖

📦 where this page comes from