Skip to content

Commit 84baadc

Browse files
committed
Synchronize the spelling of class path, module path, and other compounds
1 parent 902887d commit 84baadc

20 files changed

+46
-46
lines changed

docs/graalvm-as-a-platform/implement-language.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Apply the `--upgrade-module-path` option together with `-Dgraalvm.locatorDisable
227227
A sample POM using `--upgrade-module-path` to export Language API packages can be found in the [Simple Language POM.xml](https://github.com/graalvm/simplelanguage/blob/master/language/pom.xml#L58) file.
228228
229229
> Note: Disabling the locator effectively removes all installed languages from the module path as the locator also creates the class loader for the languages.
230-
To still use the builtin languages add them to the module-path by pointing the module-path to all needed language homes (for example, `$GRAALVM/languages/js`).
230+
To still use the built-in languages, add them to the module path by updating the module path to include the paths of all the languages you need (for example, `$GRAALVM/languages/js`).
231231
232232
### Other JVM Implementations
233233

docs/introduction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Subject to the conditions in the license, including the License for Early Adopte
2828
Oracle GraalVM is also free to use on Oracle Cloud Infrastructure.
2929
For more information about Oracle GraalVM licensing, see the [Oracle Java SE Licensing FAQ](https://www.oracle.com/java/technologies/javase/jdk-faqs.html#GraalVM-licensing).
3030

31-
GraalVM Community Edition is open-source software built from the sources available on [GitHub](https://github.com/oracle/graal) and distributed under [version 2 of the GNU General Public License with the “Classpath” Exception](https://github.com/oracle/graal/blob/master/LICENSE), which are the same terms as for Java.
31+
GraalVM Community Edition is open-source project built from the sources available on [GitHub](https://github.com/oracle/graal) and distributed under [version 2 of the GNU General Public License with the “Classpath” Exception](https://github.com/oracle/graal/blob/master/LICENSE), which are the same terms as for Java.
3232
Check the [licenses](https://github.com/oracle/graal#license) of individual GraalVM components which are generally derivative of the license of a particular language and may differ.
3333

3434
## What to Read Next

docs/reference-manual/embedding/embed-languages.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,16 @@ module com.mycompany.app {
8484
Whether your configuration can run with a Truffle runtime optimization depends on the GraalVM JDK you use.
8585
For further details, refer to the [Runtime Compilation section](#runtime-optimization-support).
8686

87-
We recommend configuring polyglot embeddings using modules and the module-path whenever possible.
88-
Be aware that using polyglot from the class-path instead will enable access to unsafe APIs for all libraries on the class-path.
89-
If the application is not yet modularized, hybrid use of the class and module-path is possible.
87+
We recommend configuring polyglot embeddings using modules and the module path whenever possible.
88+
Be aware that using `org.graalvm.polyglot` from the class path instead will enable access to unsafe APIs for all libraries on the class path.
89+
If the application is not yet modularized, hybrid use of the class path and module path is possible.
9090
For example:
9191
```
9292
$JAVA_HOME/bin/java -classpath=lib --module-path=lib/polyglot --add-modules=org.graalvm.polyglot ...
9393
```
9494
In this example, `lib/polyglot` directory should contain all polyglot and language JAR files.
95-
In order to access polyglot classes from the class-path you also need to specify the `--add-modules=org.graalvm.polyglot` JVM option.
96-
If you are using [native-image](https://www.graalvm.org/latest/reference-manual/embed-languages/#build-native-executables-from-polyglot-applications) polyglot modules on the class-path will be automatically upgraded to the module-path.
95+
To access polyglot classes from the class path, you must also specify the `--add-modules=org.graalvm.polyglot` JVM option.
96+
If you are using [native-image](https://www.graalvm.org/latest/reference-manual/embed-languages/#build-native-executables-from-polyglot-applications), polyglot modules on the class path will be automatically upgraded to the module path.
9797

9898
While we do support creating single uber JAR files from polyglot libraries, for example using the Maven Assembly plugin, we do not recommend it.
9999
Also note that uber JAR files are not supported in combination with creating native-images.
@@ -499,7 +499,7 @@ If the runtime was excluded successfully, you should see the following log messa
499499
```
500500
[engine] WARNING: The polyglot engine uses a fallback runtime that does not support runtime compilation to native code.
501501
Execution without runtime compilation will negatively impact the guest application performance.
502-
The following cause was found: No optimizing Truffle runtime found on the module or class-path.
502+
The following cause was found: No optimizing Truffle runtime found on the module or class path.
503503
For more information see: https://www.graalvm.org/latest/reference-manual/embed-languages/.
504504
To disable this warning use the '--engine.WarnInterpreterOnly=false' option or the '-Dpolyglot.engine.WarnInterpreterOnly=false' system property.
505505
```

docs/reference-manual/java-on-truffle/Interoperability.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class Embedding {
142142

143143
A number of useful context option can be set with `contextBuilder.option(key, value)`:
144144
* Java properties can be added by settings `java.Properties.property.name` to the desired value (in this case this would set the `property.name`).
145-
* `java.Properties.java.class.path` can be used to set the classpath of the Java on Truffle context.
145+
* `java.Properties.java.class.path` can be used to set the class path of the Java on Truffle context.
146146
* `java.Properties.java.library.path` can be used to set the native library path of the Java on Truffle context.
147147
* `java.EnableAssertions` can be set to `true` to enable assertions.
148148
* `java.EnableSystemAssertions` can be set to `true` to enable assertions in the Java standard library.

docs/reference-manual/java-on-truffle/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See the [Implementation Details](ImplementationDetails.md) for more information.
1414
The project name behind this implementation is "Espresso".
1515
Its open source version is available on [GitHub](https://github.com/oracle/graal/tree/master/espresso).
1616

17-
The Java on Truffle execution mode runs Java via a Java bytecode interpreter, implemented with the [Truffle framework](../../../truffle/docs/README.md) – an open-source library for writing interpreters for programming languages.
17+
The Java on Truffle execution mode runs Java via a Java bytecode interpreter, implemented with the [Truffle framework](../../../truffle/docs/README.md) – an open source library for writing interpreters for programming languages.
1818
Now Java can be executed by the same principle as other languages in the GraalVM ecosystem (JavaScript, Ruby, Python, R), directly interoperate with those languages, and pass data back and forth in the same memory space.
1919
Besides complete language interoperability, with Java on Truffle you can:
2020

docs/reference-manual/native-image/BuildConfiguration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,15 @@ However, you can prevent unwanted linking errors by specifying which classes are
144144
For that, use the `--link-at-build-time` option.
145145
If the option is used in the right context (see below), you can specify required classes to link at build time without explicitly listing classes and packages.
146146
It is designed in a way that libraries can only configure their own classes, to avoid any side effects on other libraries.
147-
You can pass the option to the `native-image` tool on the command line, embed it in a `native-image.properties` file on the module-path or the classpath.
147+
You can pass the option to the `native-image` tool on the command line, embed it in a _native-image.properties_ file on the module path or the class path.
148148

149149
Depending on how and where the option is used it behaves differently:
150150

151-
* If you use `--link-at-build-time` without arguments, all classes in the scope are required to be fully defined. If used without arguments on command line, all classes will be treated as "link-at-build-time" classes. If used without arguments embedded in a `native-image.properties` file on the module-path, all classes of the module will be treated as "link-at-build-time" classes. If you use `--link-at-build-time` embedded in a `native-image.properties` file on the classpath, the following error will be thrown:
151+
* If you use `--link-at-build-time` without arguments, all classes in the scope are required to be fully defined. If used without arguments on command line, all classes will be treated as "link-at-build-time" classes. If used without arguments embedded in a _native-image.properties_ file on the module path, all classes of the module will be treated as "link-at-build-time" classes. If you use `--link-at-build-time` embedded in a _native-image.properties_ file on the class path, the following error will be thrown:
152152
```
153-
Error: Using '--link-at-build-time' without args only allowed on module-path. 'META-INF/native-image/org.mylibrary/native-image.properties' in 'file:///home/test/myapp/MyLibrary.jar' not part of module-path.
153+
Error: Using '--link-at-build-time' without args only allowed on module path. 'META-INF/native-image/org.mylibrary/native-image.properties' in 'file:///home/test/myapp/MyLibrary.jar' not part of module path.
154154
```
155-
* If you use the `--link-at-build-time` option with arguments, for example, `--link-at-build-time=foo.bar.Foobar,demo.myLibrary.Name,...`, the arguments should be fully qualified class names or package names. When used on the module-path or classpath (embedded in `native-image.properties` files), only classes and packages defined in the same JAR file can be specified. Packages for libraries used on the classpath need to be listed explicitly. To make this process easy, use the `@<prop-values-file>` syntax to generate a package list (or a class list) in a separate file automatically.
155+
* If you use the `--link-at-build-time` option with arguments, for example, `--link-at-build-time=foo.bar.Foobar,demo.myLibrary.Name,...`, the arguments should be fully qualified class names or package names. When used on the module path or class path (embedded in `native-image.properties` files), only classes and packages defined in the same JAR file can be specified. Packages for libraries used on the class path need to be listed explicitly. To make this process easy, use the `@<prop-values-file>` syntax to generate a package list (or a class list) in a separate file automatically.
156156
157157
Another handy option is `--link-at-build-time-paths` which allows to specify which classes are required to be fully defined at build time by other means.
158158
This variant requires arguments that are of the same type as the arguments passed via `-p` (`--module-path`) or `-cp` (`--class-path`):

docs/reference-manual/native-image/BuildOptions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Run `native-image --help` for help on build options.
8989

9090
Run `native-image --help-extra` for help on additional options.
9191

92-
* `--exclude-config`: exclude configuration for a comma-separated pair of classpath/modulepath pattern and resource pattern. For example: `--exclude-config foo.jar,META-INF\/native-image\/.*.properties` ignores all properties files in _META-INF/native-image_ in all JAR files named _foo.jar_.
92+
* `--exclude-config`: exclude configuration for a comma-separated pair of class path/module path pattern and resource pattern. For example: `--exclude-config foo.jar,META-INF\/native-image\/.*.properties` ignores all properties files in _META-INF/native-image_ in all JAR files named _foo.jar_.
9393
* `--expert-options`: list image build options for experts
9494
* `--expert-options-all`: list all image build options for experts (use at your own risk). Options marked with _Extra help available_ contain help that can be shown with `--expert-options-detail`
9595
* `--expert-options-detail`: display all available help for a comma-separated list of option names. Pass `*` to show extra help for all options that contain it.

docs/reference-manual/native-image/BuildOverview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ redirect_from: /reference-manual/native-image/Build-Overview/
1010

1111
The syntax of the `native-image` command is:
1212

13-
- `native-image [options] <mainclass> [imagename] [options]` to build a native binary from the main class in the current working directory. The classpath may optionally be provided with the `-cp <classpath>` option where `<classpath>` is a colon-separated (on Windows, semicolon-separated) list of paths to directories and JAR files.
13+
- `native-image [options] <mainclass> [imagename] [options]` to build a native binary from the main class in the current working directory. The class path may optionally be provided with the `-cp <classpath>` option where `<classpath>` is a colon-separated (on Windows, semicolon-separated) list of paths to directories and JAR files.
1414
- `native-image [options] -jar jarfile [imagename] [options]` to build a native binary from a JAR file.
1515
- `native-image [options] -m <module>/<mainClass> [imagename] [options]` to build a native binary from a Java module.
1616

docs/reference-manual/native-image/Bundles.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ The full option help of `--bundle-apply` shows a more advanced use case that wil
175175
### Building in a Container
176176

177177
Another addition to the `--bundle-create` and `--bundle-apply` options is to perform image building inside a container image.
178-
This ensures that during the image build `native-image` can not access any resources that were not explicitly specified via the classpath or module path.
178+
This ensures that during the image build `native-image` can not access any resources that were not explicitly specified via the class path or module path.
179179

180180
Modify the `--bundle-create` argument in the Maven / Gradle Native Image plugin configuration above to `<buildArg>--bundle-create,container<buildArg>`.
181181
This still creates the same bundle as before.
@@ -322,7 +322,7 @@ native-image --bundle-apply=application-pgo-optimized.nib
322322

323323
As described later in [Bundle File Format](#bundle-file-format), a bundle file is a JAR file with a contained launcher for launching the bundled application.
324324
This means you can use a native image bundle with any JDK and execute it as a JAR file with `<jdk>/bin/java -jar [bundle-file.nib]`.
325-
The launcher uses the command line arguments stored in _run.json_ and adds all JAR files and folders in _input/classes/cp_ and _input/classes/p_ to the classpath and module path respectively.
325+
The launcher uses the command line arguments stored in _run.json_ and adds all JAR files and directories in _input/classes/cp/_ and _input/classes/p/_ to the class path and module path, respectively.
326326

327327
The launcher also comes with a separate command-line interface described in its help text:
328328
```
@@ -334,7 +334,7 @@ where options include:
334334
335335
--with-native-image-agent[,update-bundle[=<new-bundle-name>]]
336336
runs the application with a native-image-agent attached
337-
'update-bundle' adds the agents output to the bundle-files classpath.
337+
'update-bundle' adds the agents output to the bundle-files class path.
338338
'=<new-bundle-name>' creates a new bundle with the agent output instead.
339339
Note 'update-bundle' requires native-image to be installed
340340
@@ -395,7 +395,7 @@ Inside a bundle you can find the following inner structure:
395395
│ ├── path_substitutions.json <- Record of path-substitutions that happened
396396
│ │ during bundle creation for the input files
397397
│ └── run.json <- Full command line for executing the bundled application
398-
│ (minus classpath and module path)
398+
│ (minus class path and module path)
399399
└── output
400400
├── default
401401
│ ├── myimage <- Created image and other output created by the image builder

0 commit comments

Comments
 (0)