Review and move espresso-shell demo to archive

graalvm · Dec 17, 2024 · 5874f81 · 5874f81
1 parent b84ba48
commit 5874f81
Show file tree

Hide file tree

Showing 41 changed files with 16 additions and 36 deletions.
diff --git a/.github/workflows/espresso-jshell.yml → ...hub/workflows/archive-espresso-jshell.yml b/.github/workflows/espresso-jshell.yml → ...hub/workflows/archive-espresso-jshell.yml
@@ -1,21 +1,19 @@
-name: espresso-jshell
+name: archive/espresso-jshell
 on:
   push:
     paths:
-      - 'espresso-jshell/**'
-      - '.github/workflows/espresso-jshell.yml'
+      - 'archive/espresso-jshell/**'
+      - '.github/workflows/archive-espresso-jshell.yml'
   pull_request:
     paths:
-      - 'espresso-jshell/**'
-      - '.github/workflows/espresso-jshell.yml'
-  schedule:
-    - cron: "0 0 1 * *" # run every month
+      - 'archive/espresso-jshell/**'
+      - '.github/workflows/archive-espresso-jshell.yml'
   workflow_dispatch:
 permissions:
   contents: read
 jobs:
   run:
-    name: Run 'espresso-jshell'
+    name: Run 'archive/espresso-jshell'
     runs-on: ubuntu-latest
     timeout-minutes: 20
     steps:
@@ -26,8 +24,8 @@ jobs:
           distribution: 'graalvm'
           components: 'espresso'
           github-token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Run 'espresso-jshell'
+      - name: Run 'archive/espresso-jshell
         run: |
-          cd espresso-jshell
+          cd archive/espresso-jshell
           ./build-espresso-jshell.sh
-          echo "Math.PI" | ./espresso-jshell
+          echo "Math.PI" | ./espresso-jshell
diff --git a/README.md b/README.md
@@ -115,23 +115,6 @@ cd graalvm-demos
   </tbody>
 </table>
 
-### Java on Truffle (Espresso)
-
-<table>
-  <thead>
-    <tr>
-      <th align="left">Name</th>
-      <th align="left">Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr>
-      <td align="left" width="30%"><a href="/espresso-jshell/">espresso-jshell</a><br><a href="https://github.com/graalvm/graalvm-demos/actions/workflows/espresso-jshell.yml"><img alt="espresso-jshell" src="https://github.com/graalvm/graalvm-demos/actions/workflows/espresso-jshell.yml/badge.svg" /></a></td>
-      <td align="left" width="70%">Demonstrates how to build a native executable of JShell, that executes the dynamically generated bytecode on Espresso<br><strong>Technologies: </strong>Java on Truffle, Native Image, JShell<br><strong>Reference: </strong><a href="https://www.graalvm.org/dev/reference-manual/java-on-truffle/demos/#mixing-aot-and-jit-for-java">Mixing AOT and JIT for Java</a>, <a href="https://medium.com/graalvm/java-on-truffle-going-fully-metacircular-215531e3f840">Java on Truffle — Going Fully Metacircular</a></td>
-    </tr>
-  </tbody>
-</table>
-
 ### Micronaut
 
 <table>

diff --git a/espresso-jshell/LICENSE → archive/espresso-jshell/LICENSE b/espresso-jshell/LICENSE → archive/espresso-jshell/LICENSE
diff --git a/espresso-jshell/README.md → archive/espresso-jshell/README.md b/espresso-jshell/README.md → archive/espresso-jshell/README.md
@@ -1,20 +1,19 @@
 # Native JShell and Espresso: Mixing AOT and JIT for Java
 
-This demo showcases the integration between [GraalVM Native Image](https://www.graalvm.org/reference-manual/native-image/) and [Java-on-Truffle (Espresso)](https://www.graalvm.org/reference-manual/java-on-truffle/).  
-It builds a native executable version of `jshell`, that executes the dynamically generated bytecodes on Espresso. This hybrid mode achieves instant startup, beating the vanilla `jshell` in both: time to the first interaction and time to evaluate a simple expression.
+This demo showcases the integration between [GraalVM Native Image](https://www.graalvm.org/reference-manual/native-image/) and [Espresso (Java on Truffle)](https://www.graalvm.org/latest/reference-manual/espresso/).  
+It builds a native executable version of `jshell`, that executes the dynamically generated bytecode on Espresso. This hybrid mode achieves instant startup, beating the vanilla `jshell` in both: time to the first interaction and time to evaluate a simple expression.
 
 JShell is a Java read-eval-print loop tool first introduced in Java 9, this demo also allows running `jshell` on Java 8.  
 For further discussions and questions please join our `#espresso` channel on the [GraalVM Slack Community](https://graalvm.slack.com/).
 
 ## Prerequisites
 
 - GraalVM for Java 11, 17 or higher
-- Native Image support
-- Java-on-Truffle (Espresso) support
+- Espresso (Java on Truffle) support
 
 ## Preparation
 
-1. Download and install the latest GraalVM JDK with Native Image and Java on Truffle (Espresso) components using the [GraalVM JDK Downloader](https://github.com/graalvm/graalvm-jdk-downloader).
+1. Download and install the GraalVM JDK with Native Image and Espresso support using the [GraalVM JDK Downloader](https://github.com/graalvm/graalvm-jdk-downloader).
     ```bash
     bash <(curl -sL https://get.graalvm.org/jdk) -c 'espresso'
     ```
@@ -25,10 +24,10 @@ For further discussions and questions please join our `#espresso` channel on the
     git clone https://github.com/graalvm/graalvm-demos
     ```
     ```bash
-    cd graalvm-demos/espresso-jshell
+    cd graalvm-demos/archive/espresso-jshell
     ```
 
-## How to Build
+## Building Native `jshell`
 
 1. Execute the `build-espresso-jshell.sh` script:
     ```bash
@@ -97,4 +96,4 @@ Since the Java compiler is part of the host code compiled by `native-image`, dyn
 
 ### Learn more
 
-Learn more about Java on Truffle on the [GraalVM website](https://www.graalvm.org/latest/reference-manual/java-on-truffle/).
+Learn more about mixing JIT and native modes in the [official Espresso documentation](https://www.graalvm.org/latest/reference-manual/espresso/demos/#mixing-aot-and-jit-for-java).
diff --git a/espresso-jshell/build-espresso-jshell.sh → .../espresso-jshell/build-espresso-jshell.sh b/espresso-jshell/build-espresso-jshell.sh → .../espresso-jshell/build-espresso-jshell.sh
diff --git a/espresso-jshell/diagram.svg → archive/espresso-jshell/diagram.svg b/espresso-jshell/diagram.svg → archive/espresso-jshell/diagram.svg
diff --git a/...ad-patch/jdk/editpad/EditPadProvider.java → ...ad-patch/jdk/editpad/EditPadProvider.java b/...ad-patch/jdk/editpad/EditPadProvider.java → ...ad-patch/jdk/editpad/EditPadProvider.java
diff --git a/...jshell-patch/jdk/jshell/TaskFactory.class → ...jshell-patch/jdk/jshell/TaskFactory.class b/...jshell-patch/jdk/jshell/TaskFactory.class → ...jshell-patch/jdk/jshell/TaskFactory.class
diff --git a/espresso-jshell/jshell8.sh → archive/espresso-jshell/jshell8.sh b/espresso-jshell/jshell8.sh → archive/espresso-jshell/jshell8.sh
diff --git a/...hell/execution/DefaultLoaderDelegate.java → ...hell/execution/DefaultLoaderDelegate.java b/...hell/execution/DefaultLoaderDelegate.java → ...hell/execution/DefaultLoaderDelegate.java
diff --git a/...dk/jshell/execution/DemultiplexInput.java → ...dk/jshell/execution/DemultiplexInput.java b/...dk/jshell/execution/DemultiplexInput.java → ...dk/jshell/execution/DemultiplexInput.java
diff --git a/...ell/execution/DirectExecutionControl.java → ...ell/execution/DirectExecutionControl.java b/...ell/execution/DirectExecutionControl.java → ...ell/execution/DirectExecutionControl.java
diff --git a/.../execution/ExecutionControlForwarder.java → .../execution/ExecutionControlForwarder.java b/.../execution/ExecutionControlForwarder.java → .../execution/ExecutionControlForwarder.java
diff --git a/...ion/FailOverExecutionControlProvider.java → ...ion/FailOverExecutionControlProvider.java b/...ion/FailOverExecutionControlProvider.java → ...ion/FailOverExecutionControlProvider.java
diff --git a/...execution/JdiDefaultExecutionControl.java → ...execution/JdiDefaultExecutionControl.java b/...execution/JdiDefaultExecutionControl.java → ...execution/JdiDefaultExecutionControl.java
diff --git a/...jdk/jshell/execution/JdiEventHandler.java → ...jdk/jshell/execution/JdiEventHandler.java b/...jdk/jshell/execution/JdiEventHandler.java → ...jdk/jshell/execution/JdiEventHandler.java
diff --git a/...jshell/execution/JdiExecutionControl.java → ...jshell/execution/JdiExecutionControl.java b/...jshell/execution/JdiExecutionControl.java → ...jshell/execution/JdiExecutionControl.java
diff --git a/...xecution/JdiExecutionControlProvider.java → ...xecution/JdiExecutionControlProvider.java b/...xecution/JdiExecutionControlProvider.java → ...xecution/JdiExecutionControlProvider.java
diff --git a/...l8/jdk/jshell/execution/JdiInitiator.java → ...l8/jdk/jshell/execution/JdiInitiator.java b/...l8/jdk/jshell/execution/JdiInitiator.java → ...l8/jdk/jshell/execution/JdiInitiator.java
diff --git a/.../jdk/jshell/execution/LoaderDelegate.java → .../jdk/jshell/execution/LoaderDelegate.java b/.../jdk/jshell/execution/LoaderDelegate.java → .../jdk/jshell/execution/LoaderDelegate.java
diff --git a/...hell/execution/LocalExecutionControl.java → ...hell/execution/LocalExecutionControl.java b/...hell/execution/LocalExecutionControl.java → ...hell/execution/LocalExecutionControl.java
diff --git a/...cution/LocalExecutionControlProvider.java → ...cution/LocalExecutionControlProvider.java b/...cution/LocalExecutionControlProvider.java → ...cution/LocalExecutionControlProvider.java
diff --git a/...l/execution/MultiplexingOutputStream.java → ...l/execution/MultiplexingOutputStream.java b/...l/execution/MultiplexingOutputStream.java → ...l/execution/MultiplexingOutputStream.java
diff --git a/...jdk/jshell/execution/PipeInputStream.java → ...jdk/jshell/execution/PipeInputStream.java b/...jdk/jshell/execution/PipeInputStream.java → ...jdk/jshell/execution/PipeInputStream.java
diff --git a/...ll8/jdk/jshell/execution/RemoteCodes.java → ...ll8/jdk/jshell/execution/RemoteCodes.java b/...ll8/jdk/jshell/execution/RemoteCodes.java → ...ll8/jdk/jshell/execution/RemoteCodes.java
diff --git a/...ell/execution/RemoteExecutionControl.java → ...ell/execution/RemoteExecutionControl.java b/...ell/execution/RemoteExecutionControl.java → ...ell/execution/RemoteExecutionControl.java
diff --git a/.../execution/StreamingExecutionControl.java → .../execution/StreamingExecutionControl.java b/.../execution/StreamingExecutionControl.java → .../execution/StreamingExecutionControl.java
diff --git a/...ll/jshell8/jdk/jshell/execution/Util.java → ...ll/jshell8/jdk/jshell/execution/Util.java b/...ll/jshell8/jdk/jshell/execution/Util.java → ...ll/jshell8/jdk/jshell/execution/Util.java
diff --git a/...l8/jdk/jshell/execution/package-info.java → ...l8/jdk/jshell/execution/package-info.java b/...l8/jdk/jshell/execution/package-info.java → ...l8/jdk/jshell/execution/package-info.java
diff --git a/...ell8/jdk/jshell/spi/ExecutionControl.java → ...ell8/jdk/jshell/spi/ExecutionControl.java b/...ell8/jdk/jshell/spi/ExecutionControl.java → ...ell8/jdk/jshell/spi/ExecutionControl.java
diff --git a/.../jshell/spi/ExecutionControlProvider.java → .../jshell/spi/ExecutionControlProvider.java b/.../jshell/spi/ExecutionControlProvider.java → .../jshell/spi/ExecutionControlProvider.java
diff --git a/.../jshell8/jdk/jshell/spi/ExecutionEnv.java → .../jshell8/jdk/jshell/spi/ExecutionEnv.java b/.../jshell8/jdk/jshell/spi/ExecutionEnv.java → .../jshell8/jdk/jshell/spi/ExecutionEnv.java
diff --git a/...dk/jshell/spi/SPIResolutionException.java → ...dk/jshell/spi/SPIResolutionException.java b/...dk/jshell/spi/SPIResolutionException.java → ...dk/jshell/spi/SPIResolutionException.java
diff --git a/espresso-jshell/reflect-config.json → archive/espresso-jshell/reflect-config.json b/espresso-jshell/reflect-config.json → archive/espresso-jshell/reflect-config.json
diff --git a/espresso-jshell/resource-config.json → archive/espresso-jshell/resource-config.json b/espresso-jshell/resource-config.json → archive/espresso-jshell/resource-config.json
diff --git a/...esso/jshell/EspressoExecutionControl.java → ...esso/jshell/EspressoExecutionControl.java b/...esso/jshell/EspressoExecutionControl.java → ...esso/jshell/EspressoExecutionControl.java
diff --git a/...jshell/EspressoLocalExecutionControl.java → ...jshell/EspressoLocalExecutionControl.java b/...jshell/EspressoLocalExecutionControl.java → ...jshell/EspressoLocalExecutionControl.java
diff --git a/...spressoLocalExecutionControlProvider.java → ...spressoLocalExecutionControlProvider.java b/...spressoLocalExecutionControlProvider.java → ...spressoLocalExecutionControlProvider.java
diff --git a/...le/espresso/jshell/JavaShellLauncher.java → ...le/espresso/jshell/JavaShellLauncher.java b/...le/espresso/jshell/JavaShellLauncher.java → ...le/espresso/jshell/JavaShellLauncher.java
diff --git a/.../oracle/truffle/espresso/jshell/Lazy.java → .../oracle/truffle/espresso/jshell/Lazy.java b/.../oracle/truffle/espresso/jshell/Lazy.java → .../oracle/truffle/espresso/jshell/Lazy.java
diff --git a/...s/jdk.jshell.spi.ExecutionControlProvider → ...s/jdk.jshell.spi.ExecutionControlProvider b/...s/jdk.jshell.spi.ExecutionControlProvider → ...s/jdk.jshell.spi.ExecutionControlProvider