Skip to content

Commit a032c56

Browse files
olyagplolyagpl
committed
Follow Benoit Daloze comments
1 parent ccccfda commit a032c56

27 files changed

+71
-71
lines changed

‎docs/enterprise-overview/architecture-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It is designed to accelerate the execution of applications written in Java and o
1010
GraalVM Enterprise's polyglot capabilities make it possible to mix multiple programming languages in a single application while eliminating any foreign language call costs.
1111

1212
This page provides developers, solution architects, and infrastructure architects with an architectural overview of GraalVM Enterprise, as well as information about runtime modes, supported platforms, available distributions, core and additional functionalities, and support levels for various features.
13-
The conceptual overview and advantages of GraalVM Enterprise are described on the [Solutions Overview](overview.md) page.
13+
The conceptual overview and advantages of GraalVM Enterprise are described on the [Solutions Overview](solutions-overview.md) page.
1414

1515
* [GraalVM Enterprise Architecture](#graalvm-enterprise-architecture)
1616
* [Runtime Modes](#runtime-modes)

‎docs/examples/java-kotlin-aot.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export GRAALVM_HOME=/Users/${current_user}/path/to/graalvm/Contents/Home
3838
```
3939
Note that your paths are likely to be different depending on the download location.
4040

41-
3. [Install Native Image](../reference-manual/native-image/README.md/#install-native-image) to make use of the `native-image` utility.
41+
3. [Install Native Image](../reference-manual/native-image/README.md#install-native-image) to make use of the `native-image` utility.
4242

4343
4. Then execute:
4444
```shell

‎docs/examples/native-image-examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export GRAALVM_HOME=/Users/${current_user}/path/to/graalvm/Contents/Home
3838
```
3939
Note that your paths are likely to be different depending on the download location.
4040

41-
3. [Install Native Image](../reference-manual/native-image/README.md/#install-native-image) to make use of the `native-image` utility.
41+
3. [Install Native Image](../reference-manual/native-image/README.md#install-native-image) to make use of the `native-image` utility.
4242

4343
4. Then execute:
4444
```shell

‎docs/examples/polyglot-javascript-java-r.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ git clone https://github.com/graalvm/graalvm-demos
1717
cd graalvm-demos/polyglot-javascript-java-r
1818
```
1919

20-
2. [Install GraalVM](../getting-started/graalvm-community/get-started-graalvm-community.md/#install-graalvm) on your platform.
20+
2. [Install GraalVM](../getting-started/graalvm-community/get-started-graalvm-community.md#install-graalvm) on your platform.
2121

2222
3. To run the demo, you need to enable Node.js support in GraalVM:
2323
```shell

‎docs/getting-started/graalvm-community/get-started-graalvm-community.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ public class HelloWorld {
284284
}
285285
```
286286

287-
> Note: For compilation `native-image` depends on the local toolchain. Make sure your system meets the [prerequisites](../../reference-manual/native-image/README.md/#prerequisites).
287+
> Note: For compilation `native-image` depends on the local toolchain. Make sure your system meets the [prerequisites](../../reference-manual/native-image/README.md#prerequisites).
288288
289289
Compile _HelloWorld.java_ to bytecode and then build a native image:
290290
```shell

‎docs/getting-started/graalvm-community/linux.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -36,18 +36,18 @@ The base distribution of GraalVM Community Edition for Linux (AMD64) platforms i
3636
The base installation can be extended with:
3737

3838
Tools/Utilities:
39-
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
40-
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md/#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
41-
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
39+
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
40+
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
41+
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
4242

4343
Runtimes:
44-
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
45-
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
46-
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
47-
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
48-
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
44+
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
45+
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
46+
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
47+
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
48+
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
4949
​
5050
These runtimes are not part of the GraalVM Community base distribution and must be installed separately.
5151

5252
To assist a user with installation, GraalVM includes **GraalVM Updater**, a command line utility to install and manage additional functionalities.
53-
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md/#component-installation) to add any necessary language runtime or utility from above to GraalVM.
53+
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md#component-installation) to add any necessary language runtime or utility from above to GraalVM.

‎docs/getting-started/graalvm-community/macos.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,18 @@ The base distribution of GraalVM Community Edition for macOS includes OpenJDK wi
6666
The base installation can be extended with:
6767

6868
Tools/Utilities:
69-
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
70-
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md/#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
71-
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
69+
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
70+
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
71+
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
7272

7373
Runtimes:
74-
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
75-
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
76-
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
77-
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
78-
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
74+
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
75+
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
76+
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
77+
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
78+
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
7979
​
8080
These runtimes are not part of the GraalVM Community base distribution and must be installed separately.
8181

8282
To assist a user with installation, GraalVM includes **GraalVM Updater**, a command line utility to install and manage additional functionalities.
83-
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md/#component-installation) to add any necessary language runtime or utility from above to GraalVM.
83+
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md#component-installation) to add any necessary language runtime or utility from above to GraalVM.

‎docs/getting-started/graalvm-enterprise/get-started-graalvm-enterprise.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ public class HelloWorld {
284284
}
285285
```
286286

287-
> Note: For compilation `native-image` depends on the local toolchain. Make sure your system meets the [prerequisites](../../reference-manual/native-image/README.md/#prerequisites).
287+
> Note: For compilation `native-image` depends on the local toolchain. Make sure your system meets the [prerequisites](../../reference-manual/native-image/README.md#prerequisites).
288288
289289
Compile _HelloWorld.java_ to bytecode and then build a native image:
290290
```shell

‎docs/getting-started/graalvm-enterprise/installation-linux.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,18 @@ The base distribution of GraalVM Enterprise for Linux (AMD64) platforms includes
3535
The base installation can be extended with:
3636

3737
Tools/Utilities:
38-
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
39-
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md/#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
40-
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
38+
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
39+
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
40+
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
4141

4242
Runtimes:
43-
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
44-
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
45-
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
46-
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
47-
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
43+
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
44+
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
45+
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
46+
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
47+
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
4848
​
4949
These runtimes are not part of the GraalVM Enterprise base distribution and must be installed separately.
5050

5151
To assist a user with installation, GraalVM includes **GraalVM Updater**, a command line utility to install and manage additional functionalities.
52-
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md/#component-installation) to add any necessary language runtime or utility from above to GraalVM.
52+
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md#component-installation) to add any necessary language runtime or utility from above to GraalVM.

‎docs/getting-started/graalvm-enterprise/installation-macos.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -66,18 +66,18 @@ The base distribution of GraalVM Enterprise for macOS platforms includes Oracle
6666
The base installation can be extended with:
6767

6868
Tools/Utilities:
69-
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
70-
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md/#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
71-
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
69+
* [Native Image](../../reference-manual/native-image/README.md) -- a technology to compile an application ahead-of-time into a native executable
70+
* [LLVM toolchain](../../reference-manual/llvm/Compiling.md#llvm-toolchain-for-compiling-cc) -- a set of tools and APIs for compiling native programs to bitcode that can be executed with on the GraalVM runtime
71+
* [Java on Truffle](../../reference-manual/java-on-truffle/README.md) -- a Java Virtual Machine implementation based on a Truffle interpreter for GraalVM
7272

7373
Runtimes:
74-
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
75-
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
76-
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
77-
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
78-
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
74+
* [Node.js](../../reference-manual/js/README.md) -- Node.js v14.17.6 compatible
75+
* [Python](../../reference-manual/python/README.md) -- Python 3.8.5 compatible
76+
* [Ruby](../../reference-manual/ruby/README.md) -- Ruby 2.7.2 compatible
77+
* [R](/../../reference-manual/r/README.md) -- GNU R 4.0.3 compatible
78+
* [Wasm](../../reference-manual/wasm/README.md) -- WebAssembly (Wasm)
7979
​
8080
These runtimes are not part of the GraalVM Enterprise base distribution and must be installed separately.
8181

8282
To assist a user with installation, GraalVM includes **GraalVM Updater**, a command line utility to install and manage additional functionalities.
83-
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md/#component-installation) to add any necessary language runtime or utility from above to GraalVM.
83+
Proceed to the [installation steps](../../reference-manual/graalvm-updater.md#component-installation) to add any necessary language runtime or utility from above to GraalVM.

‎docs/reference-manual/java-on-truffle/Demos.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,8 @@ This design naturally fits the point we are trying to illustrate. We can build a
145145

146146
Prerequisites:
147147
* [GraalVM 21.0](https://www.graalvm.org/downloads/)
148-
* [Native Image](../native-image/README.md/#install-native-image)
149-
* [Java on Truffle](README.md/#install-java-on-truffle)
148+
* [Native Image](../native-image/README.md#install-native-image)
149+
* [Java on Truffle](README.md#install-java-on-truffle)
150150

151151

152152
1. Clone the [project](https://github.com/graalvm/graalvm-demos) with the demo applications and navigate to the `espresso-jshell` directory:

‎docs/reference-manual/java-on-truffle/HotSwapPluginAPI.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ permalink: /reference-manual/java-on-truffle/hotswap-plugin/
77

88
# Truffle on Java HotSwap Plugin API
99

10-
With Java on Truffle you can benefit from enhanced HotSwap [capabilites](Demos.md/#enhanced-hotswap-capabilities-with-java-on-truffle) that allow the code to evolve naturally during development without the need for restarting a running application.
10+
With Java on Truffle you can benefit from enhanced HotSwap [capabilites](Demos.md#enhanced-hotswap-capabilities-with-java-on-truffle) that allow the code to evolve naturally during development without the need for restarting a running application.
1111
​
1212
While code reloading (HotSwap) is a powerful tool, it is not sufficient to reflect all kinds of changes, e.g., changes to annotations, framework-specific changes such as implemented services or beans.
1313
For these things the code often needs to be executed to reload configurations or contexts before the changes are fully reflected in the running instance.
@@ -138,7 +138,7 @@ Here is a sample application created from the tutorial ["Creating your first Mic
138138
Example's sources can be downloaded as a ready-made Gradle project from [here](https://guides.micronaut.io/latest/micronaut-creating-first-graal-app-gradle-java.zip).
139139
Download, unzip and open the project in your IDE.
140140

141-
Before you proceed, make sure that you have Java on Truffle [installed](README.md/#install-java-on-truffle) and set the GraalVM as the project SDK.
141+
Before you proceed, make sure that you have Java on Truffle [installed](README.md#install-java-on-truffle) and set the GraalVM as the project SDK.
142142
​
143143
1. In your IDE navigate to the root `build.gradle` within the sample project. Add:
144144

‎docs/reference-manual/java-on-truffle/ImplementationDetails.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ This mode is not used when running in a native image since there will be no conf
3535
* Java on Truffle does not implement the `java.lang.instrument` interface. As a result it does not support the `-javaagent` VM option.
3636
* Java on Truffle currently uses the standard native libraries from the Java core library. This requires allowing a polyglot `Context` native access. Because of the way these libraries are loaded (via [Truffle NFI](../../graalvm-as-a-platform/truffle/NFI.md)), running on top of HotSpot only works on Linux (with `glibc`). Running as part of a native image works on Linux, Windows, and macOS but it currently limited to one context.
3737
* Support for [Java Management Extensions (JMX)](https://docs.oracle.com/javase/tutorial/jmx/index.html) is partial and some methods might return partial data.
38-
* The [Debugger Protocol Implementation (JDWP)](https://docs.oracle.com/javase/8/docs/technotes/guides/jpda/jdwp-spec.html) lacks some capabilities compared to HotSpot. It will correctly report the supported [capabilities](https://docs.oracle.com/javase/8/docs/platform/jpda/jdwp/jdwp-protocol.html#JDWP_VirtualMachine_Capabilities). In particular actions that require to enumerate all Java objects are not supported. However it does support a few hot reloading cases that HotSpot does not. See [Enhanced HotSwap Capabilities with Java on Truffle](Demos.md/#enhanced-hotswap-capabilities-with-java-on-truffle).
38+
* The [Debugger Protocol Implementation (JDWP)](https://docs.oracle.com/javase/8/docs/technotes/guides/jpda/jdwp-spec.html) lacks some capabilities compared to HotSpot. It will correctly report the supported [capabilities](https://docs.oracle.com/javase/8/docs/platform/jpda/jdwp/jdwp-protocol.html#JDWP_VirtualMachine_Capabilities). In particular actions that require to enumerate all Java objects are not supported. However it does support a few hot reloading cases that HotSpot does not. See [Enhanced HotSwap Capabilities with Java on Truffle](Demos.md#enhanced-hotswap-capabilities-with-java-on-truffle).
3939
* When the `java.MultiThreaded` option is set to "false", [reference processing](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ref/package-summary.html) will not happen. Depending on the application, this could create resource leaks. Note that this option is set to "false" automatically if Java on Truffle runs in a context where a single-threaded language is enabled (e.g., JavaScript).
4040
* Java on Truffle does not support the [Polyglot API](https://www.graalvm.org/sdk/javadoc/org/graalvm/polyglot/package-summary.html) yet. However, it provides a guest Java Polyglot API, described in `polyglot.jar`. For more information, see [Interoperability with Truffle Languages](Interoperability.md).

‎docs/reference-manual/java/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This is the default and recommended mode of operation.
2828
- **jargraal**: the GraalVM compiler goes through the same warm-up phase that the rest of the Java application does. That is, it is first interpreted before its hot methods are compiled.
2929
This mode is selected with the `-XX:-UseJVMCINativeLibrary` command-line option.
3030
This will delay the time to reach peak performance as the compiler itself needs to be compiled before it produces code quickly.
31-
This mode allows you to [debug the GraalVM compiler with a Java debugger](Operations.md/#troubleshooting-the-graalvm-compiler).
31+
This mode allows you to [debug the GraalVM compiler with a Java debugger](Operations.md#troubleshooting-the-graalvm-compiler).
3232

3333

3434
## Interoperability

‎docs/reference-manual/llvm/Compiling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $GRAALVM_HOME/bin/gu install llvm-toolchain
3636
```
3737

3838
The above command will install the LLVM toolchain from the GitHub catalog for GraalVM Community users.
39-
For GraalVM Enterprise users, the [manual installation](../graalvm-updater.md/#manual-installation) is required.
39+
For GraalVM Enterprise users, the [manual installation](../graalvm-updater.md#manual-installation) is required.
4040

4141
To get the location of the toolchain, use the `--print-toolchain-path` argument of `lli`:
4242
```shell

0 commit comments

Comments
 (0)