From 97493e5b41649246a02f00c512cafc31db8815a4 Mon Sep 17 00:00:00 2001 From: dibyendumajumdar Date: Mon, 10 Jun 2024 21:24:09 +0100 Subject: [PATCH] doc updates --- README.rst | 2 +- readthedocs/ravi-overview.rst | 2 +- src/README.rst | 7 ++++--- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 132411ec..f5b1beb5 100644 --- a/README.rst +++ b/README.rst @@ -131,7 +131,7 @@ History * 2021 - Integrated AOT and JIT compilation support - `Embedded C syntax `_ -* Future +* Current Priorities - Improve Embedded C support with more validation - Improve tests and documentation overall - Ensure new compiler is production grade (i.e. always generates correct code) diff --git a/readthedocs/ravi-overview.rst b/readthedocs/ravi-overview.rst index 132411ec..f5b1beb5 100644 --- a/readthedocs/ravi-overview.rst +++ b/readthedocs/ravi-overview.rst @@ -131,7 +131,7 @@ History * 2021 - Integrated AOT and JIT compilation support - `Embedded C syntax `_ -* Future +* Current Priorities - Improve Embedded C support with more validation - Improve tests and documentation overall - Ensure new compiler is production grade (i.e. always generates correct code) diff --git a/src/README.rst b/src/README.rst index cb9936d0..e0e8c351 100644 --- a/src/README.rst +++ b/src/README.rst @@ -23,9 +23,10 @@ Ravi uses Doug Lea's malloc implementation. The implementation is in: Some backends use C as the intermediate language. The common C code generator is in: -* ravi_jitshared.c - this is the C code generator for a given Ravi / Lua function +* ravi_jitshared.c - this is the C code generator for a given Ravi / Lua function - converts bytecode to C +* See folder ../ravicomp for the new source to C compiler The MIR JIT implementation is in: -* ravi_mirjit.c - defines the driver functions. The MIR backend has its own C preprocessor, parser and code generator. - +* ravi_mirjit.c - defines the driver functions. The MIR backend has its own C preprocessor, parser and code generator +* ravi_complib.c - interfaces with new compiler module (see ../ravicomp) that generates C code from Ravi source file