Skip to content

Commit c25b165

Browse files
committed
Merge pull request #15933 from govi20
* pr/15933: Polish "Fix broken links to appendix" Fix broken links to appendix
2 parents 2241837 + c3c22c0 commit c25b165

File tree

6 files changed

+32
-35
lines changed

6 files changed

+32
-35
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,8 +336,8 @@ This section contains three examples of using `findmainclass`.
336336
If you want to use a build tool other than Maven, Gradle, or Ant, you likely need to
337337
develop your own plugin. Executable jars need to follow a specific format and certain
338338
entries need to be written in an uncompressed form (see the
339-
"`<<appendix-executable-jar-format.adoc#executable-jar, executable jar format>>`" section
340-
in the appendix for details).
339+
"`<<appendix.adoc#executable-jar, executable jar format>>`" section in the appendix for
340+
details).
341341

342342
The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to
343343
actually generate jars. If you need to, you may use this library directly.

spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,7 @@ Finally, we have a few topics for more advanced users:
142142
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> |
143143
<<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>>
144144
* *Appendix:*
145-
<<appendix-application-properties.adoc#common-application-properties, Application
146-
Properties>> |
147-
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration
148-
classes>> |
149-
<<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>>
145+
<<appendix.adoc#common-application-properties, Application Properties>> |
146+
<<appendix.adoc#auto-configuration-classes, Auto-configuration classes>> |
147+
<<appendix.adoc#executable-jar, Executable Jars>>
150148

spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -728,8 +728,8 @@ this approach is that it becomes hard to see which libraries are in your applica
728728
can also be problematic if the same filename is used (but with different content) in
729729
multiple jars.
730730
731-
Spring Boot takes a <<appendix-executable-jar-format.adoc#executable-jar, different
732-
approach>> and lets you actually nest jars directly.
731+
Spring Boot takes a <<appendix.adoc#executable-jar, different approach>> and lets you
732+
actually nest jars directly.
733733
****
734734

735735
To create an executable jar, we need to add the `spring-boot-maven-plugin` to our

spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,7 @@ can come from additional jar files on your classpath.
489489
A running application with the Actuator features has a `configprops` endpoint that shows
490490
all the bound and bindable properties available through `@ConfigurationProperties`.
491491

492-
The appendix includes an <<appendix-application-properties#common-application-properties,
492+
The appendix includes an <<appendix.adoc#common-application-properties,
493493
`application.properties`>> example with a list of the most common properties supported by
494494
Spring Boot. The definitive list comes from searching the source code for
495495
`@ConfigurationProperties` and `@Value` annotations as well as the occasional use of
@@ -2866,9 +2866,9 @@ then be depended upon by your application and other projects.
28662866
If you cannot rearrange your code as recommended above, Spring Boot's Maven and Gradle
28672867
plugins must be configured to produce a separate artifact that is suitable for use as a
28682868
dependency. The executable archive cannot be used as a dependency as the
2869-
<<appendix-executable-jar-format.adoc#executable-jar-jar-file-structure,executable jar
2870-
format>> packages application classes in `BOOT-INF/classes`. This means
2871-
that they cannot be found when the executable jar is used as a dependency.
2869+
<<appendix.adoc#executable-jar-jar-file-structure,executable jar format>> packages
2870+
application classes in `BOOT-INF/classes`. This means that they cannot be found when the
2871+
executable jar is used as a dependency.
28722872

28732873
To produce the two artifacts, one that can be used as a dependency and one that is
28742874
executable, a classifier must be specified. This classifier is applied to the name of the

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,8 @@ Boot's default dependency metadata to deduce the artifact's group and version.
189189
NOTE: The default metadata is tied to the version of the CLI that you use. it changes only
190190
when you move to a new version of the CLI, putting you in control of when the versions of
191191
your dependencies may change. A table showing the dependencies and their versions that are
192-
included in the default metadata can be found in the <<appendix-dependency-versions,
193-
appendix>>.
192+
included in the default metadata can be found in the
193+
<<appendix.adoc#appendix-dependency-versions,appendix>>.
194194

195195

196196

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1044,7 +1044,7 @@ as any other bean, as shown in the following example:
10441044

10451045
TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be
10461046
used by IDEs to offer auto-completion for your own keys. See the
1047-
<<configuration-metadata>> appendix for details.
1047+
<<appendix.adoc#configuration-metadata,appendix>> for details.
10481048

10491049

10501050

@@ -1472,7 +1472,7 @@ features that are supported by `@ConfigurationProperties` and `@Value`:
14721472
| Yes
14731473
| No
14741474

1475-
| <<appendix-configuration-metadata.adoc#configuration-metadata,Meta-data support>>
1475+
| <<appendix.adoc#configuration-metadata,Meta-data support>>
14761476
| Yes
14771477
| No
14781478

@@ -6941,7 +6941,7 @@ mapper, which can be one of the following libraries:
69416941
* `Jsonb`
69426942

69436943
TIP: A list of the auto-configurations that are enabled by `@JsonTest` can be
6944-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
6944+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
69456945

69466946
If you need to configure elements of the auto-configuration, you can use the
69476947
`@AutoConfigureJsonTesters` annotation.
@@ -7008,7 +7008,7 @@ scanned beans to `@Controller`, `@ControllerAdvice`, `@JsonComponent`, `Converte
70087008
Regular `@Component` beans are not scanned when using this annotation.
70097009

70107010
TIP: A list of the auto-configuration settings that are enabled by `@WebMvcTest` can be
7011-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7011+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
70127012

70137013
TIP: If you need to register extra components, such as the Jackson `Module`, you can
70147014
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
71287128
annotation is used.
71297129

71307130
TIP: A list of the auto-configurations that are enabled by `@WebFluxTest` can be
7131-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7131+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
71327132

71337133
TIP: If you need to register extra components, such as Jackson `Module`, you can import
71347134
additional configuration classes using `@Import` on your test.
@@ -7200,7 +7200,7 @@ Spring Data JPA repositories. Regular `@Component` beans are not loaded into the
72007200
`ApplicationContext`.
72017201

72027202
TIP: A list of the auto-configuration settings that are enabled by `@DataJpaTest` can be
7203-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7203+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
72047204

72057205
By default, data JPA tests are transactional and roll back at the end of each test. See
72067206
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
72897289
the `ApplicationContext`.
72907290

72917291
TIP: A list of the auto-configurations that are enabled by `@JdbcTest` can be
7292-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7292+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
72937293

72947294
By default, JDBC tests are transactional and roll back at the end of each test. See the
72957295
{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
73287328
the `ApplicationContext`.
73297329

73307330
TIP: A list of the auto-configurations that are enabled by `@DataJdbcTest` can be
7331-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7331+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
73327332

73337333
By default, Data JDBC tests are transactional and roll back at the end of each test. See
73347334
the {spring-reference}testing.html#testcontext-tx-enabling-transactions[relevant section]
@@ -7353,7 +7353,7 @@ jOOQ with Spring Boot, see "<<boot-features-jooq>>", earlier in this chapter.) R
73537353
`@Component` beans are not loaded into the `ApplicationContext`.
73547354

73557355
TIP: A list of the auto-configurations that are enabled by `@JooqTest` can be
7356-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7356+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
73577357

73587358
`@JooqTest` configures a `DSLContext`. Regular `@Component` beans are not loaded into the
73597359
`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
73937393
MongoDB with Spring Boot, see "<<boot-features-mongodb>>", earlier in this chapter.)
73947394

73957395
TIP: A list of the auto-configuration settings that are enabled by `@DataMongoTest` can be
7396-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7396+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
73977397

73987398
The following class shows the `@DataMongoTest` annotation in use:
73997399

@@ -7447,7 +7447,7 @@ the `ApplicationContext`. (For more about using Neo4J with Spring Boot, see
74477447
"<<boot-features-neo4j>>", earlier in this chapter.)
74487448

74497449
TIP: A list of the auto-configuration settings that are enabled by `@DataNeo4jTest` can be
7450-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7450+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
74517451

74527452
The following example shows a typical setup for using Neo4J tests in Spring Boot:
74537453

@@ -7503,7 +7503,7 @@ beans are not loaded into the `ApplicationContext`. (For more about using Redis
75037503
Spring Boot, see "<<boot-features-redis>>", earlier in this chapter.)
75047504

75057505
TIP: A list of the auto-configuration settings that are enabled by `@DataRedisTest` can be
7506-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7506+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
75077507

75087508
The following example shows the `@DataRedisTest` annotation in use:
75097509

@@ -7536,7 +7536,7 @@ loaded into the `ApplicationContext`. (For more about using LDAP with
75367536
Spring Boot, see "<<boot-features-ldap>>", earlier in this chapter.)
75377537

75387538
TIP: A list of the auto-configuration settings that are enabled by `@DataLdapTest` can be
7539-
<<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7539+
<<appendix.adoc#test-auto-configuration,found in the appendix>>.
75407540

75417541
The following example shows the `@DataLdapTest` annotation in use:
75427542

@@ -7588,7 +7588,7 @@ adds support for `MockRestServiceServer`. Regular `@Component` beans are not loa
75887588
the `ApplicationContext`.
75897589

75907590
TIP: A list of the auto-configuration settings that are enabled by `@RestClientTest` can
7591-
be <<appendix-test-auto-configuration#test-auto-configuration,found in the appendix>>.
7591+
be <<appendix.adoc#test-auto-configuration,found in the appendix>>.
75927592

75937593
The specific beans that you want to test should be specified by using the `value` or
75947594
`components` attribute of `@RestClientTest`, as shown in the following example:
@@ -8357,10 +8357,10 @@ particular, do not include your keys in the namespaces that Spring Boot uses (su
83578357
these namespaces in the future in ways that break your modules.
83588358

83598359
Make sure to
8360-
<<appendix-configuration-metadata#configuration-metadata-annotation-processor,trigger
8361-
meta-data generation>> so that IDE assistance is available for your keys as well. You may
8362-
want to review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to
8363-
make sure your keys are properly documented.
8360+
<<appendix.adoc#configuration-metadata-annotation-processor,trigger meta-data
8361+
generation>> so that IDE assistance is available for your keys as well. You may want to
8362+
review the generated meta-data (`META-INF/spring-configuration-metadata.json`) to make
8363+
sure your keys are properly documented.
83648364

83658365

83668366

@@ -8604,8 +8604,7 @@ class KotlinExampleProperties {
86048604
}
86058605
----
86068606

8607-
TIP: To generate
8608-
<<appendix-configuration-metadata#configuration-metadata-annotation-processor,your own
8607+
TIP: To generate <<appendix.adoc#configuration-metadata-annotation-processor,your own
86098608
metadata>> using the annotation processor, {kotlin-documentation}kapt.html[`kapt` should
86108609
be configured] with the `spring-boot-configuration-processor` dependency.
86118610

0 commit comments

Comments
 (0)