From 43a01b8f68e618488890b23d0f3b3348bc05dcc7 Mon Sep 17 00:00:00 2001
From: Carsten Behring <carsten.behring@gmail.com>
Date: Sun, 20 Nov 2022 12:50:09 +0100
Subject: [PATCH] document to use aliases to set JVM args

available since clojurebridge 0.0.8:

See here for background on this feature.
https://github.com/behrica/clojurebridge/issues/4
---
 topics/embedded.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/topics/embedded.md b/topics/embedded.md
index 5de0e63..1a32278 100644
--- a/topics/embedded.md
+++ b/topics/embedded.md
@@ -81,12 +81,36 @@ two important libraries for clojure loaded, nrepl and cider which allow a rich,
 interactive development experience so let's now connect to that port with our favorite
 Clojure editor - emacs of course ;-).
 
+### Passing JVM arguments 
+
 If you want to specify arbitrary arguments for the JVM to be started by Python,
 you can use the environment variable `JDK_JAVA_OPTIONS` to do so. It will be picked up by 
 the JVM when starting.
+
+Since clojurebridge 0.0.8, you can as well specify a list of aliases, which get resolved 
+from the `deps.edn` file. This allows as well to specify JVM arguments and JVM properties.
+
+Example: 
+
+Starting Clojure embedded from python via
+
+```python
+cljbridge.init_jvm(aliases=["jdk-17","fastcall"],start_repl=True)
 ```
+and a `deps.edn` with
+
+```clojure
+:aliases {
+
+           :fastcall
+           {:jvm-opts ["-Dlibpython_clj.manual_gil=true"]}
+           :jdk-17
+           {:jvm-opts ["--add-modules=jdk.incubator.foreign"
+                       "--enable-native-access=ALL-UNNAMED"]}}
 ```
 
+would add then the appropriate JVM options.
+
 ## From the Clojure REPL