From 3428c0efa22670808aeb76ce84ecf7dd6fd0073c Mon Sep 17 00:00:00 2001 From: Govinda Date: Mon, 11 Feb 2019 23:40:11 +0530 Subject: [PATCH 1/2] Fix broken links to appendix See gh-15933 --- .../src/main/asciidoc/build-tool-plugins.adoc | 2 +- .../main/asciidoc/documentation-overview.adoc | 6 ++-- .../src/main/asciidoc/getting-started.adoc | 2 +- .../src/main/asciidoc/howto.adoc | 4 +-- .../src/main/asciidoc/spring-boot-cli.adoc | 3 +- .../main/asciidoc/spring-boot-features.adoc | 30 +++++++++---------- 6 files changed, 23 insertions(+), 24 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index 7ffbe62c3c5..ab669fcd6e9 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -336,7 +336,7 @@ 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 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 -"`<>`" section +"`<>`" section in the appendix for details). The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc index 07cea6a61df..43a96ce4e76 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc @@ -142,9 +142,9 @@ Finally, we have a few topics for more advanced users: <> | <> * *Appendix:* -<> | -<> | -<> +<> diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 43f82711e2b..7dd551b9fd5 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -728,7 +728,7 @@ 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 multiple jars. -Spring Boot takes a <> and lets you actually nest jars directly. **** diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc index dd032ee73dc..616de4da56f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -489,7 +489,7 @@ can come from additional jar files on your classpath. A running application with the Actuator features has a `configprops` endpoint that shows all the bound and bindable properties available through `@ConfigurationProperties`. -The appendix includes an <> example with a list of the most common properties supported by Spring Boot. The definitive list comes from searching the source code for `@ConfigurationProperties` and `@Value` annotations as well as the occasional use of @@ -2866,7 +2866,7 @@ 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 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 -<> packages application classes in `BOOT-INF/classes`. This means that they cannot be found when the executable jar is used as a dependency. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc index 252281433d2..0ac10eec18f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc @@ -189,8 +189,7 @@ 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 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 -included in the default metadata can be found in the <>. +included in the default metadata can be found in the <>. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 82349728fa9..77de439a305 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -1472,7 +1472,7 @@ features that are supported by `@ConfigurationProperties` and `@Value`: | Yes | No -| <> +| <> | Yes | No @@ -6941,7 +6941,7 @@ mapper, which can be one of the following libraries: * `Jsonb` TIP: A list of the auto-configurations that are enabled by `@JsonTest` can be -<>. +<>. If you need to configure elements of the auto-configuration, you can use the `@AutoConfigureJsonTesters` annotation. @@ -7008,7 +7008,7 @@ scanned beans to `@Controller`, `@ControllerAdvice`, `@JsonComponent`, `Converte Regular `@Component` beans are not scanned when using this annotation. TIP: A list of the auto-configuration settings that are enabled by `@WebMvcTest` can be -<>. +<>. TIP: If you need to register extra components, such as the Jackson `Module`, you can import additional configuration classes by using `@Import` on your test. @@ -7128,7 +7128,7 @@ auto-configures the Spring WebFlux infrastructure and limits scanned beans to annotation is used. TIP: A list of the auto-configurations that are enabled by `@WebFluxTest` can be -<>. +<>. TIP: If you need to register extra components, such as Jackson `Module`, you can import additional configuration classes using `@Import` on your test. @@ -7200,7 +7200,7 @@ Spring Data JPA repositories. Regular `@Component` beans are not loaded into the `ApplicationContext`. TIP: A list of the auto-configuration settings that are enabled by `@DataJpaTest` can be -<>. +<>. By default, data JPA tests are transactional and roll back at the end of each test. See the {spring-reference}testing.html#testcontext-tx-enabling-transactions[relevant section] @@ -7289,7 +7289,7 @@ embedded database and a `JdbcTemplate`. Regular `@Component` beans are not loade the `ApplicationContext`. TIP: A list of the auto-configurations that are enabled by `@JdbcTest` can be -<>. +<>. By default, JDBC tests are transactional and roll back at the end of each test. See the {spring-reference}testing.html#testcontext-tx-enabling-transactions[relevant section] in @@ -7328,7 +7328,7 @@ and Spring Data JDBC repositories. Regular `@Component` beans are not loaded int the `ApplicationContext`. TIP: A list of the auto-configurations that are enabled by `@DataJdbcTest` can be -<>. +<>. By default, Data JDBC tests are transactional and roll back at the end of each test. See the {spring-reference}testing.html#testcontext-tx-enabling-transactions[relevant section] @@ -7353,7 +7353,7 @@ jOOQ with Spring Boot, see "<>", earlier in this chapter.) R `@Component` beans are not loaded into the `ApplicationContext`. TIP: A list of the auto-configurations that are enabled by `@JooqTest` can be -<>. +<>. `@JooqTest` configures a `DSLContext`. Regular `@Component` beans are not loaded into the `ApplicationContext`. The following example shows the `@JooqTest` annotation in use: @@ -7393,7 +7393,7 @@ in-memory embedded MongoDB (if available), configures a `MongoTemplate`, scans f MongoDB with Spring Boot, see "<>", earlier in this chapter.) TIP: A list of the auto-configuration settings that are enabled by `@DataMongoTest` can be -<>. +<>. The following class shows the `@DataMongoTest` annotation in use: @@ -7447,7 +7447,7 @@ the `ApplicationContext`. (For more about using Neo4J with Spring Boot, see "<>", earlier in this chapter.) TIP: A list of the auto-configuration settings that are enabled by `@DataNeo4jTest` can be -<>. +<>. The following example shows a typical setup for using Neo4J tests in Spring Boot: @@ -7503,7 +7503,7 @@ beans are not loaded into the `ApplicationContext`. (For more about using Redis Spring Boot, see "<>", earlier in this chapter.) TIP: A list of the auto-configuration settings that are enabled by `@DataRedisTest` can be -<>. +<>. The following example shows the `@DataRedisTest` annotation in use: @@ -7536,7 +7536,7 @@ loaded into the `ApplicationContext`. (For more about using LDAP with Spring Boot, see "<>", earlier in this chapter.) TIP: A list of the auto-configuration settings that are enabled by `@DataLdapTest` can be -<>. +<>. The following example shows the `@DataLdapTest` annotation in use: @@ -7588,7 +7588,7 @@ adds support for `MockRestServiceServer`. Regular `@Component` beans are not loa the `ApplicationContext`. TIP: A list of the auto-configuration settings that are enabled by `@RestClientTest` can -be <>. +be <>. The specific beans that you want to test should be specified by using the `value` or `components` attribute of `@RestClientTest`, as shown in the following example: @@ -8357,7 +8357,7 @@ 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. Make sure to -<> so that IDE assistance is available for your keys as well. You may want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make sure your keys are properly documented. @@ -8605,7 +8605,7 @@ class KotlinExampleProperties { ---- TIP: To generate -<> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should be configured] with the `spring-boot-configuration-processor` dependency. From c3c22c0a8a38a6f7e8eabf0b3ba480cdd03b9c29 Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Wed, 13 Feb 2019 10:52:42 +0100 Subject: [PATCH 2/2] Polish "Fix broken links to appendix" Closes gh-15933 --- .../src/main/asciidoc/build-tool-plugins.adoc | 4 ++-- .../src/main/asciidoc/documentation-overview.adoc | 6 ++---- .../src/main/asciidoc/getting-started.adoc | 4 ++-- .../spring-boot-docs/src/main/asciidoc/howto.adoc | 6 +++--- .../src/main/asciidoc/spring-boot-cli.adoc | 3 ++- .../src/main/asciidoc/spring-boot-features.adoc | 13 ++++++------- 6 files changed, 17 insertions(+), 19 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index ab669fcd6e9..d6f5a3ff115 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -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 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 -"`<>`" section -in the appendix for details). +"`<>`" section in the appendix for +details). 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. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc index 43a96ce4e76..905f21bf061 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc @@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users: <> | <> * *Appendix:* -<> | -<> | +<> | +<> | <> diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 7dd551b9fd5..ae00637f943 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -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 multiple jars. -Spring Boot takes a <> and lets you actually nest jars directly. +Spring Boot takes a <> and lets you +actually nest jars directly. **** To create an executable jar, we need to add the `spring-boot-maven-plugin` to our diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc index 616de4da56f..a9422a83ad6 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -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 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 -<> packages application classes in `BOOT-INF/classes`. This means -that they cannot be found when the executable jar is used as a dependency. +<> packages +application classes in `BOOT-INF/classes`. This means that they cannot be found when the +executable jar is used as a dependency. 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 diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc index 0ac10eec18f..ecafe73b92e 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc @@ -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 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 -included in the default metadata can be found in the <>. +included in the default metadata can be found in the +<>. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 77de439a305..76a77506b1b 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -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 used by IDEs to offer auto-completion for your own keys. See the -<> appendix for details. +<> for details. @@ -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. Make sure to -<> so that IDE assistance is available for your keys as well. You may -want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to -make sure your keys are properly documented. +<> so that IDE assistance is available for your keys as well. You may want to +review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make +sure your keys are properly documented. @@ -8604,8 +8604,7 @@ class KotlinExampleProperties { } ---- -TIP: To generate -<> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should be configured] with the `spring-boot-configuration-processor` dependency.