Skip to content

Commit 7e842ae

Browse files
committed
Escape ...*... outputs using +...*...+
1 parent 4ecf50a commit 7e842ae

File tree

6 files changed

+35
-35
lines changed

6 files changed

+35
-35
lines changed

spring-boot-docs/src/main/asciidoc/appendix-executable-jar-format.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ file and it's used to setup an appropriate `URLClassLoader` and ultimately call
140140
There are 3 launcher subclasses (`JarLauncher`, `WarLauncher` and `PropertiesLauncher`).
141141
Their purpose is to load resources (`.class` files etc.) from nested jar files or war
142142
files in directories (as opposed to explicitly on the classpath). In the case of the
143-
`[Jar|War]Launcher` the nested paths are fixed `(lib/\*.jar` and `lib-provided/\*.jar` for
143+
`[Jar|War]Launcher` the nested paths are fixed (`+lib/*.jar+` and `+lib-provided/*.jar+` for
144144
the war case) so you just add extra jars in those locations if you want more. The
145145
`PropertiesLauncher` looks in `lib/` by default, but you can add additional locations by
146146
setting an environment variable `LOADER_PATH` or `loader.path` in `application.properties`

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ using the latest version of Java.
5757
[[getting-started-installation-instructions-for-java]]
5858
=== Installation instructions for the Java developer
5959
You can use Spring Boot in the same way as any standard Java library. Simply include the
60-
appropriate `spring-boot-*.jar` files on your classpath. Spring Boot does not require
60+
appropriate `+spring-boot-*.jar+` files on your classpath. Spring Boot does not require
6161
any special tools integration, so you can use any IDE or text editor; and there is
6262
nothing special about a Spring Boot application, so you can run and debug as you would
6363
any other Java program.

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ which not) by Spring Boot at runtime.
3737
Many more questions can be answered by looking at the source code and the javadoc. Some
3838
rules of thumb:
3939

40-
* Look for classes called `\*AutoConfiguration` and read their sources, in particular the
41-
`@Conditional\*` annotations to find out what features they enable and when. Add
40+
* Look for classes called `+*AutoConfiguration+` and read their sources, in particular the
41+
`+@Conditional*+` annotations to find out what features they enable and when. Add
4242
`--debug` to the command line or a System property `-Ddebug` to get a log on the
4343
console of all the autoconfiguration decisions that were made in your app. In a running
4444
Actuator app look at the `autoconfig` endpoint (`/autoconfig' or the JMX equivalent) for
@@ -117,7 +117,7 @@ Application code that you want to run as your business logic can be implemented
117117
=== Externalize the configuration of SpringApplication
118118
A `SpringApplication` has bean properties (mainly setters) so you can use its Java API as
119119
you create the application to modify its behavior. Or you can externalize the
120-
configuration using properties in `spring.main.*`. E.g. in `application.properties` you
120+
configuration using properties in `+spring.main.*+`. E.g. in `application.properties` you
121121
might have.
122122

123123
[source,properties,indent=0,subs="verbatim,quotes,attributes"]
@@ -177,8 +177,8 @@ placeholders in `application.properties`, e.g.
177177

178178
TIP: If you are inheriting from the `spring-boot-starter-parent` POM, or if have enabled
179179
maven filtering for the `application.properties` directly, you may want to change the
180-
default filter token from `${\*}` since it conflicts with those placeholders.
181-
You can either use `@*@` (i.e. `@maven.token@` instead of `${maven.token}`) or you can
180+
default filter token from `+${*}+` since it conflicts with those placeholders.
181+
You can either use `+@*@+` (i.e. `@maven.token@` instead of `${maven.token}`) or you can
182182
configure the `maven-resources-plugin` to use
183183
http://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html#delimiters[other delimiters].
184184

@@ -391,7 +391,7 @@ and then inject the actual ('`local`') port as a `@Value`. For example:
391391

392392
[[howto-configure-ssl]]
393393
=== Configure SSL
394-
SSL can be configured declaratively by setting the various `server.ssl.*` properties,
394+
SSL can be configured declaratively by setting the various `+server.ssl.*+` properties,
395395
typically in `application.properties` or `application.yml`. For example:
396396

397397
[source,properties,indent=0,subs="verbatim,quotes,attributes"]
@@ -415,7 +415,7 @@ accessible on the filesystem, i.e. it cannot be read from within a jar file.
415415
Generally you can follow the advice from
416416
'<<howto-discover-build-in-options-for-external-properties>>' about
417417
`@ConfigurationProperties` (`ServerProperties` is the main one here), but also look at
418-
`EmbeddedServletContainerCustomizer` and various Tomcat specific `*Customizers` that you
418+
`EmbeddedServletContainerCustomizer` and various Tomcat specific `+*Customizers+` that you
419419
can add in one of those. The Tomcat APIs are quite rich so once you have access to the
420420
`TomcatEmbeddedServletContainerFactory` you can modify it in a number of ways. Or the
421421
nuclear option is to add your own `TomcatEmbeddedServletContainerFactory`.
@@ -1050,7 +1050,7 @@ configuration properties. The most common options to set are:
10501050
(Because of relaxed data binding hyphens or underscores should work equally well as
10511051
property keys.) The `ddl-auto` setting is a special case in that it has different
10521052
defaults depending on whether you are using an embedded database (`create-drop`) or not
1053-
(`none`). In addition all properties in `spring.jpa.properties.*` are passed through as
1053+
(`none`). In addition all properties in `+spring.jpa.properties.*+` are passed through as
10541054
normal JPA properties (with the prefix stripped) when the local `EntityManagerFactory` is
10551055
created.
10561056

@@ -1133,10 +1133,10 @@ Spring Data JPA and Spring Data Mongo can both create `Repository` implementatio
11331133
automatically. If they are both present on the classpath, you might have to do some extra
11341134
configuration to tell Spring Boot which one (or both) you want to create repositories for
11351135
you. The most explicit way to do that is to use the standard Spring Data
1136-
`@Enable*Repositories` and tell it the location of your `Repository` interfaces
1136+
`+@Enable*Repositories+` and tell it the location of your `Repository` interfaces
11371137
(where '`*`' is '`Jpa`' or '`Mongo`' or both).
11381138

1139-
There are also flags `spring.data.*.repositories.enabled` that you can use to switch the
1139+
There are also flags `+spring.data.*.repositories.enabled+` that you can use to switch the
11401140
auto-configured repositories on and off in external configuration. This is useful for
11411141
instance in case you want to switch off the Mongo repositories and still use the
11421142
auto-configured `MongoTemplate`.
@@ -1346,7 +1346,7 @@ how to register handlers in the servlet container.
13461346
=== Switch off the Spring Boot security configuration
13471347
If you define a `@Configuration` with `@EnableWebSecurity` anywhere in your application
13481348
it will switch off the default webapp security settings in Spring Boot. To tweak the
1349-
defaults try setting properties in `security.*` (see
1349+
defaults try setting properties in `+security.*+` (see
13501350
{sc-spring-boot-autoconfigure}/security/SecurityProperties.{sc-ext}[`SecurityProperties`]
13511351
for details of available settings) and `SECURITY` section of
13521352
<<common-application-properties-security,Common application properties>>.

spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ implementations. To configure the severity or order add the following to your ap
184184

185185
[[production-ready-application-info]]
186186
=== Custom application info information
187-
You can customize the data exposed by the `info` endpoint by setting `info.*` Spring
187+
You can customize the data exposed by the `info` endpoint by setting `+info.*+` Spring
188188
properties. All `Environment` properties under the info key will be automatically
189189
exposed. For example, you could add the following to your `application.properties`:
190190

@@ -234,7 +234,7 @@ You can then refer to your Maven '`project properties`' via placeholders, e.g.
234234
info.build.version=${project.version}
235235
----
236236

237-
NOTE: In the above example we used `project.*` to set some values to be used as
237+
NOTE: In the above example we used `+project.*+` to set some values to be used as
238238
fallbacks if the Maven resource filtering has not been switched on for some reason.
239239

240240

@@ -554,8 +554,8 @@ The remote shell can be extended in a number of interesting ways.
554554
You can write additional shell commands using Groovy or Java (see the CRaSH documentation
555555
for details). By default Spring Boot will search for commands in the following locations:
556556

557-
* `classpath*:/commands/**`
558-
* `classpath*:/crash/commands/**`
557+
* `+classpath*:/commands/**+`
558+
* `+classpath*:/crash/commands/**+`
559559

560560
TIP: You can change the search path by settings a `shell.commandPathPatterns` property.
561561

@@ -651,7 +651,7 @@ Here we can see basic `memory`, `heap`, `class loading`, `processor` and `thread
651651
information along with some HTTP metrics. In this instance the `root` ('`/`') and `/metrics`
652652
URLs have returned `HTTP 200` responses `20` and `3` times respectively. It also appears
653653
that the `root` URL returned `HTTP 401` (unauthorized) `4` times. The double asterix (`star-star`)
654-
comes from a request matched by Spring MVC as `/**` (normally a static resource).
654+
comes from a request matched by Spring MVC as `+/**+` (normally a static resource).
655655

656656
The `gauge` shows the last response time for a request. So the last request to `root` took
657657
`2ms` to respond and the last to `/metrics` took `3ms`.
@@ -729,7 +729,7 @@ a dependency to the `com.codahale.metrics:metrics-core` library; you can also re
729729
own `@Bean` instance if you need customizations.
730730

731731
Users can create Coda Hale metrics by prefixing their metric names with the appropriate
732-
type (e.g. `histogram.\*`, `meter.\*`).
732+
type (e.g. `+histogram.*+`, `+meter.*+`).
733733

734734

735735

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ sensible overriding of values, properties are considered in the the following or
206206
. Java System properties (`System.getProperties()`).
207207
. OS environment variables.
208208
. JNDI attributes from `java:comp/env`
209-
. A `RandomValuePropertySource` that only has properties in `random.*`.
209+
. A `RandomValuePropertySource` that only has properties in `+random.*+`.
210210
. Application properties outside of your packaged jar (`application.properties`
211211
including YAML and profile variants).
212212
. Application properties packaged inside your jar (`application.properties`
@@ -250,7 +250,7 @@ or test cases). It can produce integers, longs or strings, e.g.
250250
my.number.in.range=${random.int[1024,65536]}
251251
----
252252

253-
The `random.int*` syntax is `OPEN value (,max) CLOSE` where the `OPEN,CLOSE` are any
253+
The `+random.int*+` syntax is `OPEN value (,max) CLOSE` where the `OPEN,CLOSE` are any
254254
character and `value,max` are integers. If `max` is provided then `value` is the minimum
255255
value and `max` is the maximum (exclusive).
256256

@@ -737,7 +737,7 @@ As with console output, `ERROR`, `WARN` and `INFO` level messages are logged by
737737
=== Log Levels
738738

739739
All the supported logging systems can have the logger levels set in the Spring
740-
`Environment` (so for example in `application.properties`) using '`logging.level.*=LEVEL`'
740+
`Environment` (so for example in `application.properties`) using '`+logging.level.*=LEVEL+`'
741741
where '`LEVEL`' is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. Example
742742
`application.properties`:
743743

@@ -929,7 +929,7 @@ the default MVC configuration) because Spring will always be able to handle requ
929929
through the `DispatcherServlet`.
930930

931931
In addition to the '`standard`' static resource locations above, a special case is made for
932-
http://www.webjars.org/[Webjars content]. Any resources with a path in `/webjars/**` will
932+
http://www.webjars.org/[Webjars content]. Any resources with a path in `+/webjars/**+` will
933933
be served from jar files if they are packaged in the Webjars format.
934934

935935
TIP: Do not use the `src/main/webapp` folder if your application will be packaged as a
@@ -1045,7 +1045,7 @@ your `application.properties` during configuration.
10451045

10461046
By default, if the context contains only a single Servlet it will be mapped to `/`. In
10471047
the case of multiple Servlets beans the bean name will be used as a path prefix. Filters
1048-
will map to `/*`.
1048+
will map to `+/*+`.
10491049

10501050
If convention-based mapping is not flexible enough you can use the
10511051
`ServletRegistrationBean` and `FilterRegistrationBean` classes for complete control. You
@@ -1186,16 +1186,16 @@ The basic features you get out of the box in a web application are:
11861186

11871187
* An `AuthenticationManager` bean with in-memory store and a single user (see
11881188
`SecurityProperties.User` for the properties of the user).
1189-
* Ignored (unsecure) paths for common static resource locations (`/css/\*\*`, `/js/\*\*`,
1190-
`/images/\*\*` and `\*\*/favicon.ico`).
1189+
* Ignored (unsecure) paths for common static resource locations (`+/css/**+`, `+/js/**+`,
1190+
`+/images/**+` and `+**/favicon.ico+`).
11911191
* HTTP Basic security for all other endpoints.
11921192
* Security events published to Spring's `ApplicationEventPublisher` (successful and
11931193
unsuccessful authentication and access denied).
11941194
* Common low-level features (HSTS, XSS, CSRF, caching) provided by Spring Security are
11951195
on by default.
11961196

11971197
All of the above can be switched on and off or modified using external properties
1198-
(`security.*`). To override the access rules without changing any other autoconfigured
1198+
(`+security.*+`). To override the access rules without changing any other autoconfigured
11991199
features add a `@Bean` of type `WebConfigurerAdapter` with
12001200
`@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER)`.
12011201

@@ -1206,7 +1206,7 @@ If the Actuator is also in use, you will find:
12061206
* The default user will have the `ADMIN` role as well as the `USER` role.
12071207

12081208
The Actuator security features can be modified using external properties
1209-
(`management.security.*`). To override the application access rules
1209+
(`+management.security.*+`). To override the application access rules
12101210
add a `@Bean` of type `WebConfigurerAdapter` and use
12111211
`@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER)` if you _don't_ want to override
12121212
the actuator access rules, or `@Order(ManagementServerProperties.ACCESS_OVERRIDE_ORDER)`
@@ -1285,7 +1285,7 @@ NOTE: Additional connection pools can always be configured manually. If you defi
12851285
own `DataSource` bean, auto-configuration will not occur.
12861286

12871287
DataSource configuration is controlled by external configuration properties in
1288-
`spring.datasource.*`. For example, you might declare the following section
1288+
`+spring.datasource.*+`. For example, you might declare the following section
12891289
in `application.properties`:
12901290

12911291
[source,properties,indent=0]
@@ -1452,7 +1452,7 @@ their http://projects.spring.io/spring-data-jpa/[reference documentation].
14521452
==== Creating and dropping JPA databases
14531453
By default JPA database will be automatically created *only* if you use an embedded
14541454
database (H2, HSQL or Derby). You can explicitly configure JPA settings using
1455-
`spring.jpa.*` properties. For example, to create and drop tables you can add the
1455+
`+spring.jpa.*+` properties. For example, to create and drop tables you can add the
14561456
following to your `application.properties`.
14571457

14581458
[indent=0]
@@ -1462,7 +1462,7 @@ following to your `application.properties`.
14621462

14631463
NOTE: Hibernate's own internal property name for this (if you happen to remember it
14641464
better) is `hibernate.hbm2ddl.auto`. You can set it, along with other Hibernate native
1465-
properties, using `spring.jpa.properties.*` (the prefix is stripped before adding them
1465+
properties, using `+spring.jpa.properties.*+` (the prefix is stripped before adding them
14661466
to the entity manager). Example:
14671467

14681468
[indent=0]
@@ -1815,7 +1815,7 @@ to integrate with JMS. Adding `org.hornetq:hornetq-jms-server` to your applicati
18151815
you to use the embedded mode.
18161816

18171817
HornetQ configuration is controlled by external configuration properties in
1818-
`spring.hornetq.*`. For example, you might declare the following section in
1818+
`+spring.hornetq.*+`. For example, you might declare the following section in
18191819
`application.properties`:
18201820

18211821
[source,properties,indent=0]
@@ -1848,7 +1848,7 @@ available on the classpath. If the broker is present, an embedded broker is star
18481848
configured automatically (as long as no broker URL is specified through configuration).
18491849

18501850
ActiveMQ configuration is controlled by external configuration properties in
1851-
`spring.activemq.*`. For example, you might declare the following section in
1851+
`+spring.activemq.*+`. For example, you might declare the following section in
18521852
`application.properties`:
18531853

18541854
[source,properties,indent=0]

spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ running quickly and with a consistent, supported set of managed transitive depen
199199

200200
.What's in a name
201201
****
202-
All starters follow a similar naming pattern; `spring-boot-starter-\*`, where `*` is
202+
All starters follow a similar naming pattern; `+spring-boot-starter-*+`, where `+*+` is
203203
a particular type of application. This naming structure is intended to help when you need
204204
to find a starter. The Maven integration in many IDEs allow you to search dependencies by
205205
name. For example, with the appropriate Eclipse or STS plugin installed, you can simply
@@ -424,7 +424,7 @@ is also a good candidate as the primary `@Configuration`.
424424

425425
TIP: Many Spring configuration examples have been published on the Internet that use XML
426426
configuration. Always try to use the equivalent Java-base configuration if possible.
427-
Searching for `enable*` annotations can be a good starting point.
427+
Searching for `+enable*+` annotations can be a good starting point.
428428

429429

430430

0 commit comments

Comments
 (0)