Update documentation for 0.8.0

Author: sdeleuze

spring-graalvm-native-docs/pom.xml

@@ -6,12 +6,12 @@
 	<parent>
 		<groupId>org.springframework.experimental</groupId>
 		<artifactId>spring-graalvm-native-build</artifactId>
-		<version>0.8.0-SNAPSHOT</version>
+		<version>0.8.0</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 
 	<artifactId>spring-graalvm-native-docs</artifactId>
-	<version>0.8.0-SNAPSHOT</version>
+	<version>0.8.0</version>
 	<packaging>pom</packaging>
 
 	<name>Spring GraalVM Native docs</name>

spring-graalvm-native-docs/src/main/asciidoc/agent.adoc

@@ -1,5 +1,5 @@
 [[agent]]
-== Testing with the agent to compute configuration
+== Tracing agent
 
 When using the agent to compute configuration for native-image, there are a couple of approaches:
 
@@ -12,13 +12,14 @@ anything required by the test infrastructure, which is unnecessary when the appl
 To address this problem the agent supports an access-filter file that will cause certain data to
 be excluded from the generated output.
 
+=== Testing with the agent to compute configuration
 
-=== A basic access-filter file
+==== A basic access-filter file
 
 This is a simple `access-filter.json` file. 
 
 ====
-[source,xml,subs="attributes,verbatim"]
+[source,json,subs="attributes,verbatim"]
 ----
 { "rules": [
   {"excludeClasses": "org.apache.maven.surefire.**"},
@@ -38,15 +39,15 @@ Most of these lines would apply to any Spring application, except for the last o
 specific and will need tweaking to match the package of a specific applications tests.
 
 
-=== Using the access-filter file
+==== Using the access-filter file
 
 The access-filter.json file is specified with the `access-filter-file` option as part of the agentlib string:
 
 `-Dorg.graalvm.nativeimage.imagecode=true -agentlib:native-image-agent=access-filter-file=access-filter.json,config-output-dir=target/classes/META-INF/native-image`
 
 Note the inclusion of the `-D` to set the `org.graalvm.nativeimage.imagecode` property. In normal operation a built native executable will have this property set (automatically by the image building process). If there is any code that will behave differently due to it being set (which may occur if trying to work around something not supported by GraalVM) then we should set it when running with the agent too, so that code executed whilst the agent is attached matches the code that will run in the final executable.
 
-=== Using it with maven
+==== Using it with maven
 
 Let's look at how to pull the ideas here together and apply them to a project.
 
@@ -110,18 +111,18 @@ Finally, this following snippet would go into the maven pom:
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-surefire-plugin</artifactId>
                         <configuration>
-                            <argLine>-Dorg.graalvm.nativeimage.imagecode=agent -Dspring.backgroundpreinitializer.ignore=true -Dspring.xml.ignore=true -Dspring.spel.ignore=true -agentlib:native-image-agent=access-filter-file=target/classes/access-filter.json,config-merge-dir=target/classes/META-INF/native-image</argLine>
-							<includes>
-							  <include>**/AppContextStartupTest.java</include>
-							</includes>
+                            <argLine>-Dorg.graalvm.nativeimage.imagecode=agent -Dspring.xml.ignore=true -Dspring.spel.ignore=true -agentlib:native-image-agent=access-filter-file=target/classes/access-filter.json,config-merge-dir=target/classes/META-INF/native-image</argLine>
+                            <includes>
+                              <include>**/AppContextStartupTest.java</include>
+                            </includes>
                         </configuration>
                     </plugin>
                     <plugin>
                         <groupId>org.graalvm.nativeimage</groupId>
                         <artifactId>native-image-maven-plugin</artifactId>
                         <version>{graalvm-version}</version>
                         <configuration>
-                        	<mainClass>com.example.demo.DemoApplication</mainClass>
+                            <mainClass>com.example.demo.DemoApplication</mainClass>
                             <imageName>example-compiled-app</imageName>
                             <buildArgs>-Dspring.native.remove-yaml-support=true -Dspring.spel.ignore=true</buildArgs>
                         </configuration>

spring-graalvm-native-docs/src/main/asciidoc/index.adoc

@@ -4,7 +4,7 @@
 :icons: font
 :hide-uri-scheme:
 :project-home: https://github.com/spring-projects-experimental/spring-graalvm-native
-:version: 0.8.0-SNAPSHOT
+:version: 0.8.0
 :repository: milestone
 :boot-version: 2.4.0-M2
 :graalvm-version: 20.2.0
@@ -39,7 +39,7 @@ There are two primary ways to communicate this information to the build process:
 
 It is worth mentioning that there are limitations on what GraalVM supports with respect to native images.
 If your application is doing any of these, it may not be possible to build a native image.
-The limitations are discussed https://github.com/oracle/graal/blob/master/substratevm/LIMITATIONS.md[here].
+The limitations are discussed https://github.com/oracle/graal/blob/master/substratevm/Limitations.md[here].
 
 == Spring GraalVM Native
 
@@ -75,7 +75,7 @@ include::getting-started-native-image.adoc[]
 
 include::samples.adoc[]
 
-include::support-scope.adoc[]
+include::support.adoc[]
 
 include::options.adoc[]
 
@@ -90,6 +90,5 @@ include::how-to-contribute.adoc[]
 Finally, before you post about it not working, please check the <<troubleshooting,troubleshooting guide>>, which is full of information on pitfalls, common problems, and how to deal with them (through fixes and workarounds).
 
 We would love to hear about your successes and failures through the project issue tracker.
-Work has been started on an extension model that makes it easy to support areas of Spring the feature does not yet reach.
-If you want to make a contribution here, see the <<extension_guide,extension guide>>.
-Please be aware this is pre-1.0 and, as such, some of these options and extension APIs are still evolving and may change before it is finally considered done.
+If you want to make a contribution here, see the <<how-to-contribute,how to contribute guide>>.
+Please be aware this project is still incubating and, as such, some of these options and extension APIs are still evolving and may change before it is finally considered done.

spring-graalvm-native-docs/src/main/asciidoc/support-scope.adoc spring-graalvm-native-docs/src/main/asciidoc/support.adoc

@@ -1,5 +1,5 @@
-[[support-scope]]
-== Support scope
+[[support]]
+== Support
 
 === Language
 
@@ -41,4 +41,5 @@ Group ID is `org.springframework.cloud`.
 
 === Limitations
 
+- `@Configuration` and related annotations like `@SpringBootApplication` should specify `proxyBeanMethods = false` in order to not require CGLIB proxies. In practice, the main limitation with attribute set is that bean dependencies should be specified as explicit method parameter rather that by `@Bean` method invocation. Notice this attribute https://github.com/spring-projects-experimental/spring-graalvm-native/issues/248[could be inferred in the future].
 - Only proxies on interfaces are supported for now

spring-graalvm-native-docs/src/main/asciidoc/troubleshooting.adoc

@@ -30,7 +30,7 @@ If you see an error like:
 ----
 ====
 
-It could be due to https://github.com/oracle/graal/issues/2748[oracle/graal#2748] bug which impact GraalVM 20.2.0. This is a transient error so re-run
+It could be due to https://github.com/oracle/graal/issues/2748[oracle/graal#2748] bug which impact GraalVM 20.2.0. This is a transient error so run again
 the build. If a newer GraalVM 20.2.x is available, please update to use it.
 
 ==== DataSize was unintentionally initialized at build time
@@ -72,7 +72,7 @@ Execution default-cli of goal org.springframework.boot:spring-boot-maven-plugin:
 ----
 ====
 
-This is due to https://github.com/spring-projects/spring-boot/issues/23130[this bug] that will be fixed asap.
+This is due to https://github.com/spring-projects/spring-boot/issues/23130[this bug] that will be fixed in Spring Boot 2.4.0-M3.
 The workaround is to try to modify the content (change space to tabs, add or remove line breaks, etc.) to not hit that bug or
 to replace `<BP_BOOT_NATIVE_IMAGE_BUILD_ARGUMENTS>` element by a `META-INF/native-image/<GROUP_ID>/<ARTIFACT_ID>/native-image.properties`
 file with `Args = ...` content.
@@ -133,7 +133,7 @@ You have a number of options to address it:
 * Download a new version of GraalVM that includes a fixed agent.
 
 * Raise a bug against the `spring-graalvm-native` project, as a key aim of the feature is to make sure these things get registered.
-If it is not "`obvious`" that it should be registered, it may be necessary for a new or expanded hint to the added to the `spring-graalvm-native-configuration` project (see the <<extension_guide,extension guide>> if you want to explore that).
+If it is not "`obvious`" that it should be registered, it may be necessary for a new or expanded hint to the added to the `spring-graalvm-native-configuration` project (see the <<how-to-contribute,how to contribute guide>> if you want to explore that).
 
 * Manually add it.
 The `native-image` run picks up any configuration it finds.
@@ -211,7 +211,7 @@ Snapshots are regularly published and obviously ahead of releases and milestones
 Sometimes, you want to use the feature but cannot.
 Maybe you like that the feature offers that more optimal mode of discarding unnecessary configuration at image-build time, which the agent mode does not.
 When you use the feature, you either get an error about some missing piece of configuration or, worse, you get no error and it does not work (implying there is probably missing configuration that is not critical for the app to start but is just critical for it to actually work).
-If the error is clear, you can follow the guidelines in the <<extension_guide,extension guide>> and perhaps contribute it back.
+If the error is clear, you can follow the guidelines in the <<how-to-contribute,how to contribute guide>> and perhaps contribute it back.
 But in the case where you have no idea, what do you do?
 
 The first step to take here is try and run it with the agent, as follows:
@@ -323,4 +323,4 @@ Now create `src/main/resources/META-INF/native-image/reflect-config.json` with c
 ====
 
 As we add the details found in the diff, we can rebuild the `native-image` each time and see which bits help.
-Once computed, we can create a hint in the feature configuration project that captures this knowledge (see the <<extension_guide,extension guide>> for more info on that) or, if it is more related to this specific application than the infrastructure, we might leave that `reflect-config.json` in the project and commit it to our repository alongside the source for future use.
+Once computed, we can create a hint in the feature configuration project that captures this knowledge (see the <<how-to-contribute,how to contribute guide>> for more info on that) or, if it is more related to this specific application than the infrastructure, we might leave that `reflect-config.json` in the project and commit it to our repository alongside the source for future use.