Commit 9a5d828f authored by Phillip Webb's avatar Phillip Webb

Polish docbook formatting

parent f619102c
...@@ -282,7 +282,7 @@ To build and run a project artifact, you can type the following: ...@@ -282,7 +282,7 @@ To build and run a project artifact, you can type the following:
To build a war file that is both executable and deployable into an external container, To build a war file that is both executable and deployable into an external container,
you need to mark the embedded container dependencies as belonging to a configuration you need to mark the embedded container dependencies as belonging to a configuration
named "providedRuntime", e.g: named ``providedRuntime'', e.g:
[source,groovy,indent=0,subs="verbatim,attributes"] [source,groovy,indent=0,subs="verbatim,attributes"]
---- ----
...@@ -313,7 +313,7 @@ named "providedRuntime", e.g: ...@@ -313,7 +313,7 @@ named "providedRuntime", e.g:
[[build-tool-plugins-gradle-running-applications]] [[build-tool-plugins-gradle-running-applications]]
=== Running a project in-place === Running a project in-place
To run a project in place without building a jar first you can use the "bootRun" task: To run a project in place without building a jar first you can use the ``bootRun'' task:
[indent=0] [indent=0]
---- ----
......
...@@ -52,6 +52,8 @@ otherwise, read on for ``classic'' installation instructions. ...@@ -52,6 +52,8 @@ otherwise, read on for ``classic'' installation instructions.
TIP: Although Spring Boot is compatible with Java 1.6, if possible, you should consider TIP: Although Spring Boot is compatible with Java 1.6, if possible, you should consider
using the latest version of Java. using the latest version of Java.
[[getting-started-installation-instructions-for-java]] [[getting-started-installation-instructions-for-java]]
=== Installation instructions for the Java developer === Installation instructions for the Java developer
You can use Spring Boot in the same way as any standard Java library. Simply include the You can use Spring Boot in the same way as any standard Java library. Simply include the
......
...@@ -1054,7 +1054,7 @@ for more details. ...@@ -1054,7 +1054,7 @@ for more details.
[[howto-use-custom-entity-manager]] [[howto-use-custom-entity-manager]]
=== Use a custom EntityManagerFactory === Use a custom EntityManagerFactory
To take full control of the configuration of the `EntityManagerFactory`, you need to add To take full control of the configuration of the `EntityManagerFactory`, you need to add
a `@Bean` named "entityManagerFactory". Spring Boot auto-configuration switches off its a `@Bean` named ``entityManagerFactory''. Spring Boot auto-configuration switches off its
entity manager based on the presence of a bean of that type. entity manager based on the presence of a bean of that type.
...@@ -1109,7 +1109,7 @@ might be able to use a JTA transaction manager spanning both. ...@@ -1109,7 +1109,7 @@ might be able to use a JTA transaction manager spanning both.
Spring doesn't require the use of XML to configure the JPA provider, and Spring Boot Spring doesn't require the use of XML to configure the JPA provider, and Spring Boot
assumes you want to take advantage of that feature. If you prefer to use `persistence.xml` assumes you want to take advantage of that feature. If you prefer to use `persistence.xml`
then you need to define your own `@Bean` of type `LocalEntityManagerFactoryBean` (with then you need to define your own `@Bean` of type `LocalEntityManagerFactoryBean` (with
id "entityManagerFactory", and set the persistence unit name there. id ``entityManagerFactory'', and set the persistence unit name there.
See See
https://github.com/spring-projects/spring-boot/blob/master/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java[`JpaBaseConfiguration`] 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. ...@@ -1220,11 +1220,10 @@ independence: usually only one or at most couple of platforms is needed.
To automatically run Flyway database migrations on startup, add the To automatically run Flyway database migrations on startup, add the
`org.flywaydb:flyway-core` to your classpath. `org.flywaydb:flyway-core` to your classpath.
The migrations are scripts in the form `V<VERSION>__<NAME>.sql` (with The migrations are scripts in the form `V<VERSION>__<NAME>.sql` (with `<VERSION>` an
`<VERSION>` an underscore-separated version, e.g. "1" or "2_1"). By underscore-separated version, e.g. ``1'' or ``2_1''). By default they live in a folder
default they live in a folder `classpath:db/migration` but you can `classpath:db/migration` but you can modify that using `flyway.locations` (a list). See
modify that using `flyway.locations` (a list). See the Flyway class from the Flyway class from flyway-core for details of available settings like schemas etc. In
flyway-core for details of available settings like schemas etc. In
addition Spring Boot provides a small set of properties in addition Spring Boot provides a small set of properties in
{sc-spring-boot-autoconfigure}/flyway/FlywayProperties.{sc-ext}[`FlywayProperties`] {sc-spring-boot-autoconfigure}/flyway/FlywayProperties.{sc-ext}[`FlywayProperties`]
that can be used to disable the migrations, or switch off the location checking. 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: ...@@ -1555,7 +1554,7 @@ archive as normal. To make it executable:
. Use the appropriate launcher as a `Main-Class`, e.g. `JarLauncher` for a jar file, and . Use the appropriate launcher as a `Main-Class`, e.g. `JarLauncher` for a jar file, and
specify the other properties it needs as manifest entries, principally a `Start-Class`. specify the other properties it needs as manifest entries, principally a `Start-Class`.
. Add the runtime dependencies in a nested "lib" directory (for a jar) and the . Add the runtime dependencies in a nested ``lib'' directory (for a jar) and the
`provided` (embedded container) dependencies in a nested `lib-provided` directory. `provided` (embedded container) dependencies in a nested `lib-provided` directory.
Remember *not* to compress the entries in the archive. Remember *not* to compress the entries in the archive.
...@@ -1614,7 +1613,7 @@ on the spring.io website and the sample below. ...@@ -1614,7 +1613,7 @@ on the spring.io website and the sample below.
The war file can also be executable if you use the Spring Boot build tools. In that case The war file can also be executable if you use the Spring Boot build tools. In that case
the embedded container classes (to launch Tomcat for instance) have to be added to the the embedded container classes (to launch Tomcat for instance) have to be added to the
war in a `lib-provided` directory. The tools will take care of that as long as the war in a `lib-provided` directory. The tools will take care of that as long as the
dependencies are marked as "provided" in Maven or Gradle. Here's a Maven example dependencies are marked as ``provided'' in Maven or Gradle. Here's a Maven example
{github-code}/spring-boot-samples/spring-boot-sample-traditional/pom.xml[in the Boot Samples]. {github-code}/spring-boot-samples/spring-boot-sample-traditional/pom.xml[in the Boot Samples].
......
...@@ -1151,7 +1151,7 @@ If the Actuator is also in use, you will find: ...@@ -1151,7 +1151,7 @@ If the Actuator is also in use, you will find:
* The management endpoints are secure even if the application endpoints are unsecure. * The management endpoints are secure even if the application endpoints are unsecure.
* Security events are transformed into `AuditEvents` and published to the `AuditService`. * Security events are transformed into `AuditEvents` and published to the `AuditService`.
* The default user will have the "ADMIN" role as well as the "USER" role. * The default user will have the `ADMIN` role as well as the `USER` role.
The Actuator security features can be modified using external properties The Actuator security features can be modified using external properties
(`management.security.*`). To override the application access rules (`management.security.*`). To override the application access rules
...@@ -1674,7 +1674,7 @@ You can inject an auto-configured `ElasticsearchTemplate` or Elasticsearch `Clie ...@@ -1674,7 +1674,7 @@ You can inject an auto-configured `ElasticsearchTemplate` or Elasticsearch `Clie
instance as you would any other Spring Bean. By default the instance will attempt to instance as you would any other Spring Bean. By default the instance will attempt to
connect to a local in-memory server (a `NodeClient` in Elasticsearch terms), but you can connect to a local in-memory server (a `NodeClient` in Elasticsearch terms), but you can
switch to a remote server (i.e. a `TransportClient`) by setting switch to a remote server (i.e. a `TransportClient`) by setting
`spring.data.elasticsearch.clusterNodes` to a comma-separated "host:port" list. `spring.data.elasticsearch.clusterNodes` to a comma-separated ``host:port'' list.
[source,java,indent=0] [source,java,indent=0]
---- ----
......
...@@ -593,7 +593,10 @@ Useful operating system environment variable: ...@@ -593,7 +593,10 @@ Useful operating system environment variable:
$ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M -Djava.security.egd=file:/dev/./urandom $ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M -Djava.security.egd=file:/dev/./urandom
---- ----
(The "egd" setting is to speed up Tomcat startup by giving it a faster source of entropy for session keys.) (The ``egd'' setting is to speed up Tomcat startup by giving it a faster source of
entropy for session keys.)
[[using-boot-running-with-the-gradle-plugin]] [[using-boot-running-with-the-gradle-plugin]]
=== Using the Gradle plugin === Using the Gradle plugin
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment