Commit c3c22c0a authored by Stephane Nicoll's avatar Stephane Nicoll

Polish "Fix broken links to appendix"

Closes gh-15933
parent 3428c0ef
...@@ -336,8 +336,8 @@ This section contains three examples of using `findmainclass`. ...@@ -336,8 +336,8 @@ This section contains three examples of using `findmainclass`.
If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to
develop your own plugin. Executable jars need to follow a specific format and certain develop your own plugin. Executable jars need to follow a specific format and certain
entries need to be written in an uncompressed form (see the entries need to be written in an uncompressed form (see the
"`<<appendix.adoc#executable-jar, executable jar format>>`" section "`<<appendix.adoc#executable-jar, executable jar format>>`" section in the appendix for
in the appendix for details). details).
The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to
actually generate jars. If you need to, you may use this library directly. actually generate jars. If you need to, you may use this library directly.
......
...@@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users: ...@@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users:
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> | <<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> |
<<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>> <<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>>
* *Appendix:* * *Appendix:*
<<appendix.adoc#common-application-properties, Application <<appendix.adoc#common-application-properties, Application Properties>> |
Properties>> | <<appendix.adoc#auto-configuration-classes, Auto-configuration classes>> |
<<appendix.adoc#auto-configuration-classes, Auto-configuration
classes>> |
<<appendix.adoc#executable-jar, Executable Jars>> <<appendix.adoc#executable-jar, Executable Jars>>
...@@ -728,8 +728,8 @@ this approach is that it becomes hard to see which libraries are in your applica ...@@ -728,8 +728,8 @@ this approach is that it becomes hard to see which libraries are in your applica
can also be problematic if the same filename is used (but with different content) in can also be problematic if the same filename is used (but with different content) in
multiple jars. multiple jars.
Spring Boot takes a <<appendix.adoc#executable-jar, different Spring Boot takes a <<appendix.adoc#executable-jar, different approach>> and lets you
approach>> and lets you actually nest jars directly. actually nest jars directly.
**** ****
To create an executable jar, we need to add the `spring-boot-maven-plugin` to our To create an executable jar, we need to add the `spring-boot-maven-plugin` to our
......
...@@ -2866,9 +2866,9 @@ then be depended upon by your application and other projects. ...@@ -2866,9 +2866,9 @@ then be depended upon by your application and other projects.
If you cannot rearrange your code as recommended above, Spring Boot's Maven and Gradle If you cannot rearrange your code as recommended above, Spring Boot's Maven and Gradle
plugins must be configured to produce a separate artifact that is suitable for use as a plugins must be configured to produce a separate artifact that is suitable for use as a
dependency. The executable archive cannot be used as a dependency as the dependency. The executable archive cannot be used as a dependency as the
<<appendix.adoc#executable-jar-jar-file-structure,executable jar <<appendix.adoc#executable-jar-jar-file-structure,executable jar format>> packages
format>> packages application classes in `BOOT-INF/classes`. This means application classes in `BOOT-INF/classes`. This means that they cannot be found when the
that they cannot be found when the executable jar is used as a dependency. executable jar is used as a dependency.
To produce the two artifacts, one that can be used as a dependency and one that is To produce the two artifacts, one that can be used as a dependency and one that is
executable, a classifier must be specified. This classifier is applied to the name of the executable, a classifier must be specified. This classifier is applied to the name of the
......
...@@ -189,7 +189,8 @@ Boot's default dependency metadata to deduce the artifact's group and version. ...@@ -189,7 +189,8 @@ Boot's default dependency metadata to deduce the artifact's group and version.
NOTE: The default metadata is tied to the version of the CLI that you use. it changes only NOTE: The default metadata is tied to the version of the CLI that you use. it changes only
when you move to a new version of the CLI, putting you in control of when the versions of when you move to a new version of the CLI, putting you in control of when the versions of
your dependencies may change. A table showing the dependencies and their versions that are your dependencies may change. A table showing the dependencies and their versions that are
included in the default metadata can be found in the <<appendix.adoc>>. included in the default metadata can be found in the
<<appendix.adoc#appendix-dependency-versions,appendix>>.
......
...@@ -1044,7 +1044,7 @@ as any other bean, as shown in the following example: ...@@ -1044,7 +1044,7 @@ as any other bean, as shown in the following example:
TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be
used by IDEs to offer auto-completion for your own keys. See the used by IDEs to offer auto-completion for your own keys. See the
<<configuration-metadata>> appendix for details. <<appendix.adoc#configuration-metadata,appendix>> for details.
...@@ -8357,10 +8357,10 @@ particular, do not include your keys in the namespaces that Spring Boot uses (su ...@@ -8357,10 +8357,10 @@ particular, do not include your keys in the namespaces that Spring Boot uses (su
these namespaces in the future in ways that break your modules. these namespaces in the future in ways that break your modules.
Make sure to Make sure to
<<appendix.adoc#configuration-metadata-annotation-processor,trigger <<appendix.adoc#configuration-metadata-annotation-processor,trigger meta-data
meta-data generation>> so that IDE assistance is available for your keys as well. You may generation>> so that IDE assistance is available for your keys as well. You may want to
want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make
make sure your keys are properly documented. sure your keys are properly documented.
...@@ -8604,8 +8604,7 @@ class KotlinExampleProperties { ...@@ -8604,8 +8604,7 @@ class KotlinExampleProperties {
} }
---- ----
TIP: To generate TIP: To generate <<appendix.adoc#configuration-metadata-annotation-processor,your own
<<appendix.adoc#configuration-metadata-annotation-processor,your own
metadata>> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should metadata>> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should
be configured] with the `spring-boot-configuration-processor` dependency. be configured] with the `spring-boot-configuration-processor` dependency.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment