From 741a4f4b2bc9e68373ef5c48273e3fd1081f6ea8 Mon Sep 17 00:00:00 2001 From: dreis2211 Date: Mon, 27 Jan 2020 21:34:59 +0100 Subject: [PATCH] Fix links in Maven Plugin documentation See gh-19952 --- .../boot/build/mavenplugin/DocumentPluginGoals.java | 2 +- .../spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc | 2 +- .../spring-boot-maven-plugin/src/docs/asciidoc/running.adoc | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java index 2a16072dbb..9e417954b9 100644 --- a/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java +++ b/buildSrc/src/main/java/org/springframework/boot/build/mavenplugin/DocumentPluginGoals.java @@ -109,7 +109,7 @@ public class DocumentPluginGoals extends DefaultTask { writer.println(); writer.printf("[[%s-required]]%n", parametersSectionId); writer.println("=== Required parameters"); - writeParametersTable(writer, mojo.getGoal(), requiredParameters); + writeParametersTable(writer, detailsSectionId, requiredParameters); } List optionalParameters = parameters.stream().filter((parameter) -> !parameter.isRequired()) .collect(Collectors.toList()); diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc index 1588a0561e..005e3c591a 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc @@ -332,7 +332,7 @@ Spring Boot repackages the jar file for this project using a custom layout facto The layout factory is provided as an implementation of `LayoutFactory` (from `spring-boot-loader-tools`) explicitly specified in the pom. If there is only one custom `LayoutFactory` on the plugin classpath and it is listed in `META-INF/spring.factories` then it is unnecessary to explicitly set it in the plugin configuration. -Layout factories are always ignored if an explicit <> is set. +Layout factories are always ignored if an explicit <> is set. diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/running.adoc b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/running.adoc index 901afbd921..bdcf279647 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/running.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/running.adoc @@ -10,7 +10,7 @@ The plugin includes a run goal which can be used to launch your application from By default the application is executed in a forked process and setting properties on the command-line will not affect the application. If you need to specify some JVM arguments (i.e. for debugging purposes), you can use the `jvmArguments` parameter, see <> for more details. -There is also explicit support for <> and <>. +There is also explicit support for <> and <>. As enabling a profile is quite common, there is dedicated `profiles` property that offers a shortcut for `-Dspring-boot.run.jvmArguments="-Dspring.profiles.active=dev"`, see <>. @@ -71,7 +71,7 @@ It is also a helpful way of allowing your front end developers to work without n NOTE: A side effect of using this feature is that filtering of resources at build time will not work. In order to be consistent with the `repackage` goal, the `run` goal builds the classpath in such a way that any dependency that is excluded in the plugin's configuration gets excluded from the classpath as well. -For more details, see <>. +For more details, see <>. Sometimes it is useful to include test dependencies when running the application. For example, if you want to run your application in a test mode that uses stub classes.