diff --git a/docs/src/main/asciidoc/writing-native-applications-tips.adoc b/docs/src/main/asciidoc/writing-native-applications-tips.adoc index aef14713a464a..1c03cea02b2cf 100644 --- a/docs/src/main/asciidoc/writing-native-applications-tips.adoc +++ b/docs/src/main/asciidoc/writing-native-applications-tips.adoc @@ -60,13 +60,13 @@ will include: ==== Using a configuration file If globs are not sufficiently precise for your use case and you need to rely on regular expressions, or if you prefer relying on the GraalVM infrastructure, -you can also create a `resources-config.json` (the most common location is within `src/main/resources`) JSON file defining which resources should be included. +you can also create a `resource-config.json` (the most common location is within `src/main/resources`) JSON file defining which resources should be included. [WARNING] ==== Relying on the GraalVM infrastructure means that you are responsible for keeping the configuration file up to date as new Mandrel and GraalVM versions are released. -Please also note that the `resources-config.json` file will be overwritten by Quarkus if placed directly under `src/main/resources/META-INF/native-image/` as Quarkus generates its own configuration file in this directory. +Please also note that the `resource-config.json` file will be overwritten by Quarkus if placed directly under `src/main/resources/META-INF/native-image/` as Quarkus generates its own configuration file in this directory. ==== An example of such a file is the following: @@ -99,17 +99,17 @@ The final order of business is to make the configuration file known to the `nati ---- quarkus.native.additional-build-args =\ -H:+UnlockExperimentalVMOptions,\ - -H:ResourceConfigurationFiles=resources-config.json,\ + -H:ResourceConfigurationFiles=resource-config.json,\ -H:-UnlockExperimentalVMOptions ---- [NOTE] ==== -Starting with Mandrel 23.1 and GraalVM for JDK 21, `-H:ResourceConfigurationFiles=resources-config.json` results in a warning being shown unless wrapped in `-H:+UnlockExperimentalVMOptions` and `-H:-UnlockExperimentalVMOptions`. +Starting with Mandrel 23.1 and GraalVM for JDK 21, `-H:ResourceConfigurationFiles=resource-config.json` results in a warning being shown unless wrapped in `-H:+UnlockExperimentalVMOptions` and `-H:-UnlockExperimentalVMOptions`. The absence of these options will result in build failures in the future. ==== -In the previous snippet we were able to simply use `resources-config.json` instead of specifying the entire path of the file simply because it was added to `src/main/resources`. +In the previous snippet we were able to simply use `resource-config.json` instead of specifying the entire path of the file simply because it was added to `src/main/resources`. If the file had been added to another directory, the proper file path would have had to be specified manually. [TIP] @@ -120,8 +120,8 @@ Multiple options may be separated by a comma. For example, one could use: ---- quarkus.native.additional-build-args =\ -H:+UnlockExperimentalVMOptions,\ - -H:ResourceConfigurationFiles=resources-config.json,\ - -H:ReflectionConfigurationFiles=reflection-config.json,\ + -H:ResourceConfigurationFiles=resource-config.json,\ + -H:ReflectionConfigurationFiles=reflect-config.json,\ -H:-UnlockExperimentalVMOptions ---- @@ -140,7 +140,7 @@ When using Maven, we could use the following configuration: native - -H:+UnlockExperimentalVMOptions,-H:ResourceConfigurationFiles=resources-config.json,-H:-UnlockExperimentalVMOptions + -H:+UnlockExperimentalVMOptions,-H:ResourceConfigurationFiles=resource-config.json,-H:-UnlockExperimentalVMOptions @@ -258,7 +258,7 @@ You can also use a configuration file to register classes for reflection, if you Relying on the GraalVM infrastructure means that you are responsible for keeping the configuration file up to date as new Mandrel and GraalVM versions are released. ==== -As an example, in order to register all methods of class `com.acme.MyClass` for reflection, we create `reflection-config.json` (the most common location is within `src/main/resources`) +As an example, in order to register all methods of class `com.acme.MyClass` for reflection, we create `reflect-config.json` (the most common location is within `src/main/resources`) [source,json] ---- @@ -286,17 +286,17 @@ The final order of business is to make the configuration file known to the `nati ---- quarkus.native.additional-build-args =\ -H:+UnlockExperimentalVMOptions,\ - -H:ReflectionConfigurationFiles=reflection-config.json,\ + -H:ReflectionConfigurationFiles=reflect-config.json,\ -H:-UnlockExperimentalVMOptions ---- [NOTE] ==== -Starting with Mandrel 23.1 and GraalVM for JDK 21, `-H:ResourceConfigurationFiles=resources-config.json` results in a warning being shown unless wrapped in `-H:+UnlockExperimentalVMOptions` and `-H:-UnlockExperimentalVMOptions`. +Starting with Mandrel 23.1 and GraalVM for JDK 21, `-H:ResourceConfigurationFiles=resource-config.json` results in a warning being shown unless wrapped in `-H:+UnlockExperimentalVMOptions` and `-H:-UnlockExperimentalVMOptions`. The absence of these options will result in build failures in the future. ==== -In the previous snippet we were able to simply use `reflection-config.json` instead of specifying the entire path of the file simply because it was added to `src/main/resources`. +In the previous snippet we were able to simply use `reflect-config.json` instead of specifying the entire path of the file simply because it was added to `src/main/resources`. If the file had been added to another directory, the proper file path would have had to be specified manually. [TIP] @@ -307,8 +307,8 @@ Multiple options may be separated by a comma. For example, one could use: ---- quarkus.native.additional-build-args =\ -H:+UnlockExperimentalVMOptions,\ - -H:ResourceConfigurationFiles=resources-config.json,\ - -H:ReflectionConfigurationFiles=reflection-config.json,\ + -H:ResourceConfigurationFiles=resource-config.json,\ + -H:ReflectionConfigurationFiles=reflect-config.json,\ -H:-UnlockExperimentalVMOptions ---- @@ -327,7 +327,7 @@ When using Maven, we could use the following configuration: native - -H:+UnlockExperimentalVMOptions,-H:ReflectionConfigurationFiles=reflection-config.json,-H:-UnlockExperimentalVMOptions + -H:+UnlockExperimentalVMOptions,-H:ReflectionConfigurationFiles=reflect-config.json,-H:-UnlockExperimentalVMOptions