Skip to content

Commit e8e9592

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-43239
1 parent c27c699 commit e8e9592

38 files changed

+96
-96
lines changed

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

+1-1
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

+1-1
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.
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

+1-1
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

+1-1
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

+5-5
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.
@@ -244,7 +244,7 @@ Alternatively, if `ImplicitNamingStrategy` or `PhysicalNamingStrategy` beans are
244244
By default, Spring Boot configures the physical naming strategy with `CamelCaseToUnderscoresNamingStrategy`.
245245
Using this strategy, all dots are replaced by underscores and camel casing is replaced by underscores as well.
246246
Additionally, by default, all table names are generated in lower case.
247-
For example, a `TelephoneNumber` entity is mapped to the `telephone_number` table.
247+
For example, a `+TelephoneNumber+` entity is mapped to the `telephone_number` table.
248248
If your schema requires mixed-case identifiers, define a custom `CamelCaseToUnderscoresNamingStrategy` bean, as shown in the following example:
249249

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

291-
By default, Spring Boot registers a `BeanContainer` implementation that uses the `BeanFactory` so that converters and entity listeners can use regular dependency injection.
291+
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.
292292

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

@@ -317,8 +317,8 @@ Building upon xref:how-to:data-access.adoc#howto.data-access.configure-two-datas
317317
include-code::MyAdditionalEntityManagerFactoryConfiguration[]
318318

319319
The example above creates an `EntityManagerFactory` using the `DataSource` bean qualified with `@Qualifier("second")`.
320-
It scans entities located in the same package as `Order`.
321-
It is possible to map additional JPA properties using the `app.jpa` namespace.
320+
It scans entities located in the same package as `+Order+`.
321+
It is possible to map additional JPA properties using the `+app.jpa+` namespace.
322322
The use of `@Bean(defaultCandidate=false)` allows the `secondJpaProperties` and `secondEntityManagerFactory` beans to be defined without interfering with auto-configured beans of the same type.
323323

324324
NOTE: The {url-spring-framework-docs}/core/beans/dependencies/factory-autowire.html#beans-factory-autowire-candidate[Spring Framework reference documentation] describes this feature in more details.

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

+4-4
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

+3-3
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

+1-1
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

+1-1
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ dependencies {
170170

171171
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).
172172

173-
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`.
173+
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+`.
174174

175175

176176

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/native-image/developing-your-first-application.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ There are two main ways to build a Spring Boot native image application:
77
* Using GraalVM Native Build Tools to generate a native executable.
88

99
TIP: The easiest way to start a new native Spring Boot project is to go to https://start.spring.io[start.spring.io], add the `GraalVM Native Support` dependency and generate the project.
10-
The included `HELP.md` file will provide getting started hints.
10+
The included `+HELP.md+` file will provide getting started hints.
1111

1212

1313

spring-boot-project/spring-boot-docs/src/docs/antora/modules/how-to/pages/properties-and-configuration.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ app:
8989
description: "${description}"
9090
----
9191

92-
NOTE: Gradle's `expand` method uses Groovy's `SimpleTemplateEngine`, which transforms `${..}` tokens.
92+
NOTE: Gradle's `expand` method uses Groovy's `+SimpleTemplateEngine+`, which transforms `${..}` tokens.
9393
The `${..}` style conflicts with Spring's own property placeholder mechanism.
9494
To use Spring property placeholders together with automatic expansion, escape the Spring property placeholders as follows: `\${..}`.
9595

@@ -154,7 +154,7 @@ You can also provide the following System properties (or environment variables)
154154
No matter what you set in the environment, Spring Boot always loads `application.properties` as described above.
155155
By default, if YAML is used, then files with the '`.yaml`' and '`.yml`' extensions are also added to the list.
156156

157-
TIP: If you want detailed information about the files that are being loaded you can xref:reference:features/logging.adoc#features.logging.log-levels[set the logging level] of `org.springframework.boot.context.config` to `trace`.
157+
TIP: If you want detailed information about the files that are being loaded you can xref:reference:features/logging.adoc#features.logging.log-levels[set the logging level] of `+org.springframework.boot.context.config+` to `trace`.
158158

159159

160160

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ If you add your own, you have to be aware of the order and in which position you
205205
`WebMvcAutoConfiguration` adds the following `ViewResolvers` to your context:
206206

207207
* An `InternalResourceViewResolver` named '`defaultViewResolver`'.
208-
This one locates physical resources that can be rendered by using the `DefaultServlet` (including static resources and JSP pages, if you use those).
208+
This one locates physical resources that can be rendered by using the `+DefaultServlet+` (including static resources and JSP pages, if you use those).
209209
It applies a prefix and a suffix to the view name and then looks for a physical resource with that path in the servlet context (the defaults are both empty but are accessible for external configuration through `spring.mvc.view.prefix` and `spring.mvc.view.suffix`).
210210
You can override it by providing a bean of the same type.
211211
* A `BeanNameViewResolver` named '`beanNameViewResolver`'.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ For more details, see the Jetty documentation.
452452
If your application is running behind a proxy, a load-balancer or in the cloud, the request information (like the host, port, scheme...) might change along the way.
453453
Your application may be running on `10.10.10.10:8080`, but HTTP clients should only see `example.org`.
454454

455-
https://tools.ietf.org/html/rfc7239[RFC7239 "Forwarded Headers"] defines the `Forwarded` HTTP header; proxies can use this header to provide information about the original request.
455+
https://tools.ietf.org/html/rfc7239[RFC7239 "Forwarded Headers"] defines the `+Forwarded+` HTTP header; proxies can use this header to provide information about the original request.
456456
You can configure your application to read those headers and automatically use that information when creating links and sending them to clients in HTTP 302 responses, JSON documents or HTML pages.
457457
There are also non-standard headers, like `X-Forwarded-Host`, `X-Forwarded-Port`, `X-Forwarded-Proto`, `X-Forwarded-Ssl`, and `X-Forwarded-Prefix`.
458458

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/endpoints.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ If your application is a web application (Spring MVC, Spring WebFlux, or Jersey)
108108

109109
| `logfile`
110110
| Returns the contents of the logfile (if the `logging.file.name` or the `logging.file.path` property has been set).
111-
Supports the use of the HTTP `Range` header to retrieve part of the log file's content.
111+
Supports the use of the HTTP `+Range+` header to retrieve part of the log file's content.
112112

113113
| `prometheus`
114114
| Exposes metrics in a format that can be scraped by a Prometheus server.
@@ -412,7 +412,7 @@ Operations on an endpoint receive input through their parameters.
412412
When exposed over the web, the values for these parameters are taken from the URL's query parameters and from the JSON request body.
413413
When exposed over JMX, the parameters are mapped to the parameters of the MBean's operations.
414414
Parameters are required by default.
415-
They can be made optional by annotating them with either `@javax.annotation.Nullable` or `@org.springframework.lang.Nullable`.
415+
They can be made optional by annotating them with either `+@javax.annotation.Nullable+` or `@org.springframework.lang.Nullable`.
416416

417417
You can map each root property in the JSON request body to a parameter of the endpoint.
418418
Consider the following JSON request body:
@@ -546,7 +546,7 @@ NOTE: Range requests are not supported when using Jersey.
546546
==== Web Endpoint Security
547547

548548
An operation on a web endpoint or a web-specific endpoint extension can receive the current `java.security.Principal` or `org.springframework.boot.actuate.endpoint.SecurityContext` as a method parameter.
549-
The former is typically used in conjunction with `@Nullable` to provide different behavior for authenticated and unauthenticated users.
549+
The former is typically used in conjunction with either `+@javax.annotation.Nullable+` or `@org.springframework.lang.Nullable` to provide different behavior for authenticated and unauthenticated users.
550550
The latter is typically used to perform authorization checks by using its `isUserInRole(String)` method.
551551

552552

@@ -1008,7 +1008,7 @@ Some external systems might not be shared by application instances, in which cas
10081008
Other external systems might not be essential to the application (the application could have circuit breakers and fallbacks), in which case they definitely should not be included.
10091009
Unfortunately, an external system that is shared by all application instances is common, and you have to make a judgement call: Include it in the readiness probe and expect that the application is taken out of service when the external service is down or leave it out and deal with failures higher up the stack, perhaps by using a circuit breaker in the caller.
10101010

1011-
NOTE: If all instances of an application are unready, a Kubernetes Service with `type=ClusterIP` or `NodePort` does not accept any incoming connections.
1011+
NOTE: If all instances of an application are unready, a Kubernetes Service with `type=ClusterIP` or `+NodePort+` does not accept any incoming connections.
10121012
There is no HTTP error response (503 and so on), since there is no connection.
10131013
A service with `type=LoadBalancer` might or might not accept connections, depending on the provider.
10141014
A service that has an explicit https://kubernetes.io/docs/concepts/services-networking/ingress/[ingress] also responds in a way that depends on the implementation -- the ingress service itself has to decide how to handle the "`connection refused`" from downstream.

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/loggers.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ For more details, see the https://github.com/open-telemetry/opentelemetry-java-i
5252

5353
TIP: You have to configure the appender in your `logback-spring.xml` or `log4j2-spring.xml` configuration to get OpenTelemetry logging working.
5454

55-
The `OpenTelemetryAppender` for both Logback and Log4j requires access to an `OpenTelemetry` instance to function properly.
55+
The `+OpenTelemetryAppender+` for both Logback and Log4j requires access to an `OpenTelemetry` instance to function properly.
5656
This instance must be set programmatically during application startup, which can be done like this:
5757

5858
include-code::OpenTelemetryAppenderInitializer[]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1261,7 +1261,7 @@ You can also add any number of `tag=KEY:VALUE` query parameters to the end of th
12611261
[TIP]
12621262
====
12631263
The reported measurements are the _sum_ of the statistics of all meters that match the meter name and any tags that have been applied.
1264-
In the preceding example, the returned `Value` statistic is the sum of the maximum memory footprints of the "`Code Cache`", "`Compressed Class Space`", and "`Metaspace`" areas of the heap.
1264+
In the preceding example, the returned `+Value+` statistic is the sum of the maximum memory footprints of the "`Code Cache`", "`Compressed Class Space`", and "`Metaspace`" areas of the heap.
12651265
If you wanted to see only the maximum size for the "`Metaspace`", you could add an additional `tag=id:Metaspace` -- that is, `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`.
12661266
====
12671267

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/tracing.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ include-code::CustomObservation[]
193193

194194
This will create an observation named "some-operation" with the tag "some-tag=some-value".
195195

196-
TIP: If you want to create a span without creating a metric, you need to use the {url-micrometer-tracing-docs}/api[lower-level `Tracer` API] from Micrometer.
196+
TIP: If you want to create a span without creating a metric, you need to use the {url-micrometer-tracing-docs}/api[lower-level `+Tracer+` API] from Micrometer.
197197

198198

199199

0 commit comments

Comments
 (0)