Skip to content

Commit d289d0a

Browse files
committed
Temporarily escape monospaced text that will not be linked
Escape elements that we know cannot be converted to a javadoc link. See gh-41614
1 parent 81ba8b6 commit d289d0a

37 files changed

+94
-94
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/antora/modules/api/pages/rest/actuator/logfile.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ include::partial$rest/actuator/logfile/entire/http-response.adoc[]
2323

2424
NOTE: Retrieving part of the log file is not supported when using Jersey.
2525

26-
To retrieve part of the log file, make a `GET` request to `/actuator/logfile` by using the `Range` header, as shown in the following curl-based example:
26+
To retrieve part of the log file, make a `GET` request to `/actuator/logfile` by using the `+Range+` header, as shown in the following curl-based example:
2727

2828
include::partial$rest/actuator/logfile/range/curl-request.adoc[]
2929

spring-boot-project/spring-boot-docs/src/docs/antora/modules/appendix/pages/test-auto-configuration/index.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
[[appendix.test-auto-configuration]]
33
= Test Auto-configuration Annotations
44

5-
This appendix describes the `@...Test` auto-configuration annotations that Spring Boot provides to test slices of your application.
5+
This appendix describes the `+@...Test+` auto-configuration annotations that Spring Boot provides to test slices of your application.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[[appendix.test-auto-configuration.slices]]
22
= Test Slices
33

4-
The following table lists the various `@...Test` annotations that can be used to test slices of your application and the auto-configuration that they import by default:
4+
The following table lists the various `+@...Test+` annotations that can be used to test slices of your application and the auto-configuration that they import by default:
55

66
include::partial$slices/documented-slices.adoc[]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/aot.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For Maven, this works by setting the `profiles` configuration of the `spring-boo
4343
</profile>
4444
----
4545

46-
For Gradle, you need to configure the `ProcessAot` task:
46+
For Gradle, you need to configure the `+ProcessAot+` task:
4747

4848
[source,gradle]
4949
----

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/application.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can extend from that so that your implementation gets a chance to handle the
1717
If, for whatever reason, you cannot handle the exception, return `null` to give another implementation a chance to handle the exception.
1818

1919
`FailureAnalyzer` implementations must be registered in `META-INF/spring.factories`.
20-
The following example registers `ProjectConstraintViolationFailureAnalyzer`:
20+
The following example registers `+ProjectConstraintViolationFailureAnalyzer+`:
2121

2222
[source,properties]
2323
----

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/data-access.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ app:
2828
pool-size: 30
2929
----
3030

31-
Assuming that `SomeDataSource` has regular JavaBean properties for the URL, the username, and the pool size, these settings are bound automatically before the `DataSource` is made available to other components.
31+
Assuming that `+SomeDataSource+` has regular JavaBean properties for the URL, the username, and the pool size, these settings are bound automatically before the `DataSource` is made available to other components.
3232

3333
Spring Boot also provides a utility builder class, called `DataSourceBuilder`, that can be used to create one of the standard data sources (if it is on the classpath).
3434
The builder can detect which one to use based on what is available on the classpath.
@@ -243,7 +243,7 @@ Alternatively, if `ImplicitNamingStrategy` or `PhysicalNamingStrategy` beans are
243243
By default, Spring Boot configures the physical naming strategy with `CamelCaseToUnderscoresNamingStrategy`.
244244
Using this strategy, all dots are replaced by underscores and camel casing is replaced by underscores as well.
245245
Additionally, by default, all table names are generated in lower case.
246-
For example, a `TelephoneNumber` entity is mapped to the `telephone_number` table.
246+
For example, a `+TelephoneNumber+` entity is mapped to the `telephone_number` table.
247247
If your schema requires mixed-case identifiers, define a custom `CamelCaseToUnderscoresNamingStrategy` bean, as shown in the following example:
248248

249249
include-code::spring/MyHibernateConfiguration[]
@@ -287,7 +287,7 @@ For details, see {url-hibernate-userguide}#caching-provider-jcache[the Hibernate
287287
[[howto.data-access.dependency-injection-in-hibernate-components]]
288288
== Use Dependency Injection in Hibernate Components
289289

290-
By default, Spring Boot registers a `BeanContainer` implementation that uses the `BeanFactory` so that converters and entity listeners can use regular dependency injection.
290+
By default, Spring Boot registers a `org.hibernate.resource.beans.container.spi.BeanContainer` implementation that uses the `BeanFactory` so that converters and entity listeners can use regular dependency injection.
291291

292292
You can disable or tune this behavior by registering a `HibernatePropertiesCustomizer` that removes or changes the `hibernate.resource.beans.container` property.
293293

@@ -311,7 +311,7 @@ You can also reuse `JpaProperties` to bind settings for each `EntityManagerFacto
311311
include-code::MyEntityManagerFactoryConfiguration[]
312312

313313
The example above creates an `EntityManagerFactory` using a `DataSource` bean named `firstDataSource`.
314-
It scans entities located in the same package as `Order`.
314+
It scans entities located in the same package as `+Order+`.
315315
It is possible to map additional JPA properties using the `app.first.jpa` namespace.
316316

317317
NOTE: When you create a bean for `LocalContainerEntityManagerFactoryBean` yourself, any customization that was applied during the creation of the auto-configured `LocalContainerEntityManagerFactoryBean` is lost.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/installing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ SuccessExitStatus=143
3333
WantedBy=multi-user.target
3434
----
3535

36-
IMPORTANT: Remember to change the `Description`, `User`, `Group`, `ExecStart` and `WorkingDirectory` fields for your application.
36+
IMPORTANT: Remember to change the `+Description+`, `+User+`, `+Group+`, `+ExecStart+` and `+WorkingDirectory+` fields for your application.
3737

38-
NOTE: The `ExecStart` field does not declare the script action command, which means that the `run` command is used by default.
38+
NOTE: The `+ExecStart+` field does not declare the script action command, which means that the `run` command is used by default.
3939

4040
The user that runs the application, the PID file, and the console log file are managed by `systemd` itself and therefore must be configured by using appropriate fields in the '`service`' script.
4141
Consult the https://www.freedesktop.org/software/systemd/man/systemd.service.html[service unit configuration man page] for more details.
@@ -206,7 +206,7 @@ The following property substitutions are supported with the default script:
206206
| `auto`
207207

208208
| `initInfoProvides`
209-
| The `Provides` section of "`INIT INFO`"
209+
| The `+Provides+` section of "`INIT INFO`"
210210
| `${task.baseName}`
211211
| `${project.artifactId}`
212212

@@ -236,7 +236,7 @@ The following property substitutions are supported with the default script:
236236
| `${project.name}`
237237

238238
| `initInfoDescription`
239-
| `Description` section of "`INIT INFO`".
239+
| `+Description+` section of "`INIT INFO`".
240240
| `${project.description}` (falling back to `${task.baseName}`)
241241
| `${project.description}` (falling back to `${project.name}`)
242242

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/deployment/traditional-deployment.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ This means that, in addition to being deployable to a servlet container, you can
7575
To convert an existing non-web Spring application to a Spring Boot application, replace the code that creates your `ApplicationContext` and replace it with calls to `SpringApplication` or `SpringApplicationBuilder`.
7676
Spring MVC web applications are generally amenable to first creating a deployable war application and then migrating it later to an executable war or jar.
7777

78-
To create a deployable war by extending `SpringBootServletInitializer` (for example, in a class called `Application`) and adding the Spring Boot `@SpringBootApplication` annotation, use code similar to that shown in the following example:
78+
To create a deployable war by extending `SpringBootServletInitializer` (for example, in a class called `+Application+`) and adding the Spring Boot `@SpringBootApplication` annotation, use code similar to that shown in the following example:
7979

8080
include-code::MyApplication[tag=!main]
8181

@@ -87,14 +87,14 @@ Static resources can be moved to `/public` (or `/static` or `/resources` or `/ME
8787
The same applies to `messages.properties` (which Spring Boot automatically detects in the root of the classpath).
8888

8989
Vanilla usage of Spring `DispatcherServlet` and Spring Security should require no further changes.
90-
If you have other features in your application (for instance, using other servlets or filters), you may need to add some configuration to your `Application` context, by replacing those elements from the `web.xml`, as follows:
90+
If you have other features in your application (for instance, using other servlets or filters), you may need to add some configuration to your `+Application+` context, by replacing those elements from the `web.xml`, as follows:
9191

9292
* A `@Bean` of type `Servlet` or `ServletRegistrationBean` installs that bean in the container as if it were a `<servlet/>` and `<servlet-mapping/>` in `web.xml`.
9393
* A `@Bean` of type `Filter` or `FilterRegistrationBean` behaves similarly (as a `<filter/>` and `<filter-mapping/>`).
9494
* An `ApplicationContext` in an XML file can be added through an `@ImportResource` in your `Application`.
9595
Alternatively, cases where annotation configuration is heavily used already can be recreated in a few lines as `@Bean` definitions.
9696

97-
Once the war file is working, you can make it executable by adding a `main` method to your `Application`, as shown in the following example:
97+
Once the war file is working, you can make it executable by adding a `main` method to your `+Application+`, as shown in the following example:
9898

9999
include-code::MyApplication[tag=main]
100100

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/docker-compose.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This section includes topics relating to the Docker Compose support in Spring Bo
99
== Customizing the JDBC URL
1010

1111
When using `JdbcConnectionDetails` with Docker Compose, the parameters of the JDBC URL
12-
can be customized by applying the `org.springframework.boot.jdbc.parameters` label to the
12+
can be customized by applying the `+org.springframework.boot.jdbc.parameters+` label to the
1313
service. For example:
1414

1515
[source,yaml]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/logging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ dependencies {
168168

169169
NOTE: The Log4j starters gather together the dependencies for common logging requirements (such as having Tomcat use `java.util.logging` but configuring the output using Log4j 2).
170170

171-
NOTE: To ensure that debug logging performed using `java.util.logging` is routed into Log4j 2, configure its https://logging.apache.org/log4j/2.x/log4j-jul.html[JDK logging adapter] by setting the `java.util.logging.manager` system property to `org.apache.logging.log4j.jul.LogManager`.
171+
NOTE: To ensure that debug logging performed using `java.util.logging` is routed into Log4j 2, configure its https://logging.apache.org/log4j/2.x/log4j-jul.html[JDK logging adapter] by setting the `java.util.logging.manager` system property to `+org.apache.logging.log4j.jul.LogManager+`.
172172

173173

174174

0 commit comments

Comments
 (0)