Final review gradle-plugin.adoc and maven-plugin.adoc. #679
Conversation
oracle-contributor-agreement
bot
added
the
OCA Verified
| @@ -294,7 +266,23 @@ If you want to **enable the agent on the command line**, you can specify in whic | |||
| ./gradlew -Pagent=direct nativeTest | |||
| ---- | |||
|
|
|||
| ==== MetadataCopy task | |||
| [[resources-autodetecting]] | |||
There was a problem hiding this comment.
New Resources Autodetecting section
| @@ -836,57 +825,8 @@ include::../snippets/gradle/kotlin/build.gradle.kts[tags=include-metadata] | |||
|
|
|||
| For more advanced configurations you can declare the `org.graalvm.buildtools.gradle.tasks.CollectReachabilityMetadata` task and set the appropriate properties. | |||
|
|
|||
| [[pgo-support]] | |||
There was a problem hiding this comment.
How to optimize with PGO is now part of end-to-end guide: https://github.com/graalvm/native-build-tools/blob/master/docs/src/docs/asciidoc/end-to-end-gradle-guide.adoc#gather-execution-profiles-and-build-optimized-images
I don't think we should have it in 2 places. Plus, in Maven doc, there isn't any mention of PGO. The structure should be consistent, at lease close.
There was a problem hiding this comment.
I am also against duplicating stuff but my only concern is that experienced users would maybe look into main plugins documentation and not into an end-to-end guide.
@melix what is your opinion? Should we have pgo section in the main plugin documentation as well or just in the end-to-end guides?
There was a problem hiding this comment.
Yes I agree, I think this should be documented in the main docs.
There was a problem hiding this comment.
What if we add a subtitle followed by a short paragraph that a user can build optimized images with PGO, and then send them to end-to-end guides?
There was a problem hiding this comment.
I don't know. Personally I'm not much interested in the end-to-end guide, so I see linking to it as an annoyance. I'd prefer to have all required information in the reference docs.
| </pluginRepository> | ||
| </pluginRepositories> | ||
| ---- | ||
| The plugin requires that you install a https://www.graalvm.org/downloads/[GraalVM JDK]. |
|
|
||
| [NOTE] | ||
| ==== | ||
| The plugin requires that you install a https://www.graalvm.org/downloads/[GraalVM JDK]. |
olyagpl
force-pushed
the
og/GR-61276-resources-autodetection
branch
from
317b705 to
628e490
Compare
This PR includes the following:
Compare the TOCs before and after:
Gradle
Maven
