Skip to content

Commit 9a5d828

Browse files
author
Phillip Webb
committed
Polish docbook formatting
1 parent f619102 commit 9a5d828

File tree

5 files changed

+18
-14
lines changed

5 files changed

+18
-14
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ To build and run a project artifact, you can type the following:
282282

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

287287
[source,groovy,indent=0,subs="verbatim,attributes"]
288288
----
@@ -313,7 +313,7 @@ named "providedRuntime", e.g:
313313

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

318318
[indent=0]
319319
----

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ otherwise, read on for ``classic'' installation instructions.
5252
TIP: Although Spring Boot is compatible with Java 1.6, if possible, you should consider
5353
using the latest version of Java.
5454

55+
56+
5557
[[getting-started-installation-instructions-for-java]]
5658
=== Installation instructions for the Java developer
5759
You can use Spring Boot in the same way as any standard Java library. Simply include the

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,7 +1054,7 @@ for more details.
10541054
[[howto-use-custom-entity-manager]]
10551055
=== Use a custom EntityManagerFactory
10561056
To take full control of the configuration of the `EntityManagerFactory`, you need to add
1057-
a `@Bean` named "entityManagerFactory". Spring Boot auto-configuration switches off its
1057+
a `@Bean` named ``entityManagerFactory''. Spring Boot auto-configuration switches off its
10581058
entity manager based on the presence of a bean of that type.
10591059

10601060

@@ -1109,7 +1109,7 @@ might be able to use a JTA transaction manager spanning both.
11091109
Spring doesn't require the use of XML to configure the JPA provider, and Spring Boot
11101110
assumes you want to take advantage of that feature. If you prefer to use `persistence.xml`
11111111
then you need to define your own `@Bean` of type `LocalEntityManagerFactoryBean` (with
1112-
id "entityManagerFactory", and set the persistence unit name there.
1112+
id ``entityManagerFactory'', and set the persistence unit name there.
11131113

11141114
See
11151115
https://github.com/spring-projects/spring-boot/blob/master/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java[`JpaBaseConfiguration`]
@@ -1220,11 +1220,10 @@ independence: usually only one or at most couple of platforms is needed.
12201220
To automatically run Flyway database migrations on startup, add the
12211221
`org.flywaydb:flyway-core` to your classpath.
12221222

1223-
The migrations are scripts in the form `V<VERSION>__<NAME>.sql` (with
1224-
`<VERSION>` an underscore-separated version, e.g. "1" or "2_1"). By
1225-
default they live in a folder `classpath:db/migration` but you can
1226-
modify that using `flyway.locations` (a list). See the Flyway class from
1227-
flyway-core for details of available settings like schemas etc. In
1223+
The migrations are scripts in the form `V<VERSION>__<NAME>.sql` (with `<VERSION>` an
1224+
underscore-separated version, e.g. ``1'' or ``2_1''). By default they live in a folder
1225+
`classpath:db/migration` but you can modify that using `flyway.locations` (a list). See
1226+
the Flyway class from flyway-core for details of available settings like schemas etc. In
12281227
addition Spring Boot provides a small set of properties in
12291228
{sc-spring-boot-autoconfigure}/flyway/FlywayProperties.{sc-ext}[`FlywayProperties`]
12301229
that can be used to disable the migrations, or switch off the location checking.
@@ -1555,7 +1554,7 @@ archive as normal. To make it executable:
15551554
. Use the appropriate launcher as a `Main-Class`, e.g. `JarLauncher` for a jar file, and
15561555
specify the other properties it needs as manifest entries, principally a `Start-Class`.
15571556

1558-
. Add the runtime dependencies in a nested "lib" directory (for a jar) and the
1557+
. Add the runtime dependencies in a nested ``lib'' directory (for a jar) and the
15591558
`provided` (embedded container) dependencies in a nested `lib-provided` directory.
15601559
Remember *not* to compress the entries in the archive.
15611560

@@ -1614,7 +1613,7 @@ on the spring.io website and the sample below.
16141613
The war file can also be executable if you use the Spring Boot build tools. In that case
16151614
the embedded container classes (to launch Tomcat for instance) have to be added to the
16161615
war in a `lib-provided` directory. The tools will take care of that as long as the
1617-
dependencies are marked as "provided" in Maven or Gradle. Here's a Maven example
1616+
dependencies are marked as ``provided'' in Maven or Gradle. Here's a Maven example
16181617
{github-code}/spring-boot-samples/spring-boot-sample-traditional/pom.xml[in the Boot Samples].
16191618

16201619

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1151,7 +1151,7 @@ If the Actuator is also in use, you will find:
11511151

11521152
* The management endpoints are secure even if the application endpoints are unsecure.
11531153
* Security events are transformed into `AuditEvents` and published to the `AuditService`.
1154-
* The default user will have the "ADMIN" role as well as the "USER" role.
1154+
* The default user will have the `ADMIN` role as well as the `USER` role.
11551155

11561156
The Actuator security features can be modified using external properties
11571157
(`management.security.*`). To override the application access rules
@@ -1674,7 +1674,7 @@ You can inject an auto-configured `ElasticsearchTemplate` or Elasticsearch `Clie
16741674
instance as you would any other Spring Bean. By default the instance will attempt to
16751675
connect to a local in-memory server (a `NodeClient` in Elasticsearch terms), but you can
16761676
switch to a remote server (i.e. a `TransportClient`) by setting
1677-
`spring.data.elasticsearch.clusterNodes` to a comma-separated "host:port" list.
1677+
`spring.data.elasticsearch.clusterNodes` to a comma-separated ``host:port'' list.
16781678

16791679
[source,java,indent=0]
16801680
----

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,10 @@ Useful operating system environment variable:
593593
$ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M -Djava.security.egd=file:/dev/./urandom
594594
----
595595

596-
(The "egd" setting is to speed up Tomcat startup by giving it a faster source of entropy for session keys.)
596+
(The ``egd'' setting is to speed up Tomcat startup by giving it a faster source of
597+
entropy for session keys.)
598+
599+
597600

598601
[[using-boot-running-with-the-gradle-plugin]]
599602
=== Using the Gradle plugin

0 commit comments

Comments
 (0)