Skip to content

Commit f58b836

Browse files
committed
Correct the syntax that's used for smart single and double quotes
Fixes gh-1753
1 parent ae503c6 commit f58b836

10 files changed

+118
-118
lines changed

spring-boot-docs/src/main/asciidoc/appendix-auto-configuration-classes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ application for more details of which features are switched on.
1010

1111

1212
[[auto-configuration-classes-from-autoconfigure-module]]
13-
=== From the ``spring-boot-autoconfigure'' module
13+
=== From the "`spring-boot-autoconfigure`" module
1414
The following auto-configuration classes are from the `spring-boot-autoconfigure` module:
1515

1616
include::../../../target/generated-resources/auto-configuration-classes-spring-boot-autoconfigure.adoc[]
1717

1818

1919

2020
[[auto-configuration-classes-from-actuator]]
21-
=== From the ``spring-boot-actuator'' module
21+
=== From the "`spring-boot-actuator`" module
2222
The following auto-configuration classes are from the `spring-boot-actuator` module:
2323

2424
include::../../../target/generated-resources/auto-configuration-classes-spring-boot-actuator.adoc[]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ are themselves contained within a jar). This can be problematic if you are looki
1818
to distribute a self-contained application that you can just run from the command line
1919
without unpacking.
2020

21-
To solve this problem, many developers use ``shaded'' jars. A shaded jar simply packages
21+
To solve this problem, many developers use "`shaded`" jars. A shaded jar simply packages
2222
all classes, from all jars, into a single 'uber jar'. The problem with shaded jars is
2323
that it becomes hard to see which libraries you are actually using in your application.
2424
It can also be problematic if the the same filename is used (but with different content)
@@ -91,7 +91,7 @@ a traditional web container should be placed in `WEB-INF/lib-provided`.
9191

9292

9393
[[executable-jar-jarfile]]
94-
=== Spring Boot's ``JarFile'' class
94+
=== Spring Boot's "`JarFile`" class
9595
The core class used to support loading nested jars is
9696
`org.springframework.boot.loader.jar.JarFile`. It allows you load jar
9797
content from a standard jar file, or from nested child jar data. When first loaded, the
@@ -121,7 +121,7 @@ need to read all entry data into memory.
121121

122122

123123
[[executable-jar-jarfile-compatibility]]
124-
==== Compatibility with the standard Java ``JarFile''
124+
==== Compatibility with the standard Java "`JarFile`"
125125
Spring Boot Loader strives to remain compatible with existing code and libraries.
126126
`org.springframework.boot.loader.jar.JarFile` extends from `java.util.jar.JarFile` and
127127
should work as a drop-in replacement. The `RandomAccessJarFile.getURL()` method will

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Spring Boot provides build tool plugins for Maven and Gradle. The plugins offer
77
variety of features, including the packaging of executable jars. This section provides
88
more details on both plugins, as well as some help should you need to extend an
99
unsupported build system. If you are just getting started, you might want to read
10-
``<<using-spring-boot.adoc#using-boot-build-systems>>'' from the
10+
"`<<using-spring-boot.adoc#using-boot-build-systems>>`" from the
1111
<<using-spring-boot.adoc#using-boot>> section first.
1212
--
1313

@@ -17,7 +17,7 @@ unsupported build system. If you are just getting started, you might want to rea
1717
== Spring Boot Maven plugin
1818
The {spring-boot-maven-plugin-site}/[Spring Boot Maven Plugin] provides Spring Boot
1919
support in Maven, allowing you to package executable jar or war archives and run an
20-
application ``in-place''. To use it you must be using Maven 3 (or better).
20+
application "`in-place`". To use it you must be using Maven 3 (or better).
2121

2222
NOTE: Refer to the {spring-boot-maven-plugin-site}/[Spring Boot Maven Plugin Site]
2323
for complete plugin documentation.
@@ -129,7 +129,7 @@ To build and run a project artifact, you can type the following:
129129
----
130130

131131
To build a war file that is both executable and deployable into an external container you
132-
need to mark the embedded container dependencies as ``provided'', e.g:
132+
need to mark the embedded container dependencies as "`provided`", e.g:
133133

134134
[source,xml,indent=0,subs="verbatim,attributes"]
135135
----
@@ -163,7 +163,7 @@ Advanced configuration options and examples are available in the
163163
== Spring Boot Gradle plugin
164164
The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, allowing you to
165165
package executable jar or war archives, run Spring Boot applications and omit version
166-
information from your `build.gradle` file for ``blessed'' dependencies.
166+
information from your `build.gradle` file for "`blessed`" dependencies.
167167

168168

169169

@@ -201,7 +201,7 @@ If you are using a milestone or snapshot release you will also need to add appro
201201
[[build-tool-plugins-gradle-dependencies-without-versions]]
202202
=== Declaring dependencies without versions
203203
The `spring-boot` plugin will register a custom Gradle `ResolutionStrategy` with your
204-
build that allows you to omit version numbers when declaring dependencies to ``blessed''
204+
build that allows you to omit version numbers when declaring dependencies to "`blessed`"
205205
artifacts. To make use of this functionality, simply declare dependencies in the usual way,
206206
but leave the version number empty:
207207

@@ -215,7 +215,7 @@ but leave the version number empty:
215215
----
216216

217217
NOTE: The version of the `spring-boot` gradle plugin that you declare determines the
218-
actual versions of the ``blessed'' dependencies (this ensures that builds are always
218+
actual versions of the "`blessed`" dependencies (this ensures that builds are always
219219
repeatable). You should always set the version of the `spring-boot` gradle plugin to the
220220
actual Spring Boot version that you wish to use. Details of the versions that are
221221
provided can be found in the <<appendix-dependency-versions, appendix>>.
@@ -237,7 +237,7 @@ example:
237237
[[build-tool-plugins-gradle-custom-version-management]]
238238
==== Custom version management
239239
If is possible to customize the versions used by the `ResolutionStrategy` if you need
240-
to deviate from Spring Boot's ``blessed'' dependencies. Alternative version metadata
240+
to deviate from Spring Boot's "`blessed`" dependencies. Alternative version metadata
241241
is consulted using the `versionManagement` configuration. For example:
242242

243243
[source,groovy,indent=0,subs="verbatim,attributes"]
@@ -263,7 +263,7 @@ to override version numbers if necessary.
263263

264264
[[build-tool-plugins-gradle-exclude-rules]]
265265
=== Default exclude rules
266-
Gradle handles ``exclude rules'' in a slightly different way to Maven which can cause
266+
Gradle handles "`exclude rules`" in a slightly different way to Maven which can cause
267267
unexpected results when using the starter POMs. Specifically, exclusions declared on
268268
a dependency will not be applied when the dependency can be reached through a different
269269
path. For example, if a starter POM declares the following:
@@ -296,7 +296,7 @@ which does not have an `exclusion` element.
296296

297297
To ensure that correct exclusions are actually applied, the Spring Boot Gradle plugin will
298298
automatically add exclusion rules. All exclusions defined in the
299-
`spring-boot-dependencies` POM and implicit rules for the ``starter'' POMs will be added.
299+
`spring-boot-dependencies` POM and implicit rules for the "`starter`" POMs will be added.
300300

301301
If you don't want exclusion rules automatically applied you can use the following
302302
configuration:
@@ -331,7 +331,7 @@ To build and run a project artifact, you can type the following:
331331

332332
To build a war file that is both executable and deployable into an external container,
333333
you need to mark the embedded container dependencies as belonging to a configuration
334-
named ``providedRuntime'', e.g:
334+
named "`providedRuntime`", e.g:
335335

336336
[source,groovy,indent=0,subs="verbatim,attributes"]
337337
----
@@ -362,7 +362,7 @@ named ``providedRuntime'', e.g:
362362

363363
[[build-tool-plugins-gradle-running-applications]]
364364
=== Running a project in-place
365-
To run a project in place without building a jar first you can use the ``bootRun'' task:
365+
To run a project in place without building a jar first you can use the "`bootRun`" task:
366366

367367
[indent=0]
368368
----
@@ -513,7 +513,7 @@ The following configuration options are available:
513513
(defaults to a guess based on the archive type).
514514

515515
|`requiresUnpack`
516-
|A list of dependencies (in the form ``groupId:artifactId'' that must be unpacked from
516+
|A list of dependencies (in the form "`groupId:artifactId`" that must be unpacked from
517517
fat jars in order to run. Items are still packaged into the fat jar, but they will be
518518
automatically unpacked when it runs.
519519
|===
@@ -573,7 +573,7 @@ you may find that it includes unnecessary dependencies.
573573
If you want to use a build tool other than Maven or Gradle, you will likely need to develop
574574
your own plugin. Executable jars need to follow a specific format and certain entries need
575575
to be written in an uncompressed form (see the
576-
'<<appendix-executable-jar-format.adoc#executable-jar, executable jar format>>' section
576+
_<<appendix-executable-jar-format.adoc#executable-jar, executable jar format>>_ section
577577
in the appendix for details).
578578

579579
The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to
@@ -637,4 +637,4 @@ technical details of the <<appendix-executable-jar-format.adoc#executable-jar, e
637637
jar format>> are covered in the appendix.
638638

639639
If you have specific build-related questions you can check out the
640-
`<<howto.adoc#howto, how-to>>' guides.
640+
"`<<howto.adoc#howto, how-to>>`" guides.

spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
--
66
Spring Boot's executable jars are ready-made for most popular cloud PaaS
77
(platform-as-a-service) providers. These providers tend to require that you
8-
_`bring your own container'_; they manage application processes (not Java applications
8+
"`bring your own container`"; they manage application processes (not Java applications
99
specifically), so they need some intermediary layer that adapts _your_ application to the
1010
_cloud's_ notion of a running process.
1111

12-
Two popular cloud providers, Heroku and Cloud Foundry, employ a ``buildpack'' approach.
12+
Two popular cloud providers, Heroku and Cloud Foundry, employ a "`buildpack`" approach.
1313
The buildpack wraps your deployed code in whatever is needed to _start_ your
1414
application: it might be a JDK and a call to `java`, it might be an embedded webserver,
1515
or it might be a full-fledged application server. A buildpack is pluggable, but ideally
@@ -22,7 +22,7 @@ to run packaged within it.
2222

2323
In this section we'll look at what it takes to get the
2424
<<getting-started.adoc#getting-started-first-application, simple application that we
25-
developed>> in the ``Getting Started'' section up and running in the Cloud.
25+
developed>> in the "`Getting Started`" section up and running in the Cloud.
2626
--
2727

2828

@@ -226,7 +226,7 @@ Your application should now be up and running on Heroku.
226226

227227
[[cloud-deployment-cloudbees]]
228228
== CloudBees
229-
CloudBees provides cloud-based ``continuous integration'' and ``continuous delivery''
229+
CloudBees provides cloud-based "`continuous integration`" and "`continuous delivery`"
230230
services as well as Java PaaS hosting. https://github.com/msgilligan[Sean Gilligan]
231231
has contributed an excellent
232232
https://github.com/CloudBees-community/springboot-gradle-cloudbees-sample[Spring Boot
@@ -308,9 +308,9 @@ features that a PaaS can offer. These are just three of the most popular Java Pa
308308
providers, since Spring Boot is so amenable to cloud-based deployment you're free to
309309
consider other providers as well.
310310

311-
The next section goes on to cover the '<<spring-boot-cli.adoc#cli, Spring Boot CLI>>';
311+
The next section goes on to cover the _<<spring-boot-cli.adoc#cli, Spring Boot CLI>>_;
312312
or you can jump ahead to read about
313-
'<<build-tool-plugins.adoc#build-tool-plugins, build tool plugins>>'.
313+
_<<build-tool-plugins.adoc#build-tool-plugins, build tool plugins>>_.
314314

315315

316316

0 commit comments

Comments
 (0)