From 7dc497e15874beab7f6b495303a19dd62b65b340 Mon Sep 17 00:00:00 2001 From: Maxime Chevalier-Boisvert Date: Thu, 3 Jun 2021 11:47:11 -0400 Subject: Update README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index b116ab9a1a..be719c9b2b 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,15 @@ To cite this repository in your publications, please use this bibtex snippet: } ``` +## Current Limitations + +YJIT is a work in progress and as such may not yet be mature enough for mission-critical software. Below is a list of known limitations, all of which we plan to eventually address: + +- No support for the `TracePoint` API (see [#54](https://github.com/Shopify/yjit/issues/54)). +- No garbage collection for generated code. + +Because there is no GC for generated code yet, your software could run out of executable memory if it is large enough. You can change how much executable memory is allocated using [YJIT's command-line options](https://github.com/Shopify/yjit#command-line-options). + ## Installation Start by cloning the `yjit` branch of the `Shopify/ruby` repository: -- cgit v1.2.1