diff --git a/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index 607ea8ce6f..2c47896cfb 100644 --- a/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -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, 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"] ---- @@ -313,7 +313,7 @@ named "providedRuntime", e.g: [[build-tool-plugins-gradle-running-applications]] === 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] ---- diff --git a/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-docs/src/main/asciidoc/getting-started.adoc index 599b9ef85e..a610d0c259 100644 --- a/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -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 using the latest version of Java. + + [[getting-started-installation-instructions-for-java]] === Installation instructions for the Java developer You can use Spring Boot in the same way as any standard Java library. Simply include the diff --git a/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-docs/src/main/asciidoc/howto.adoc index 336ddf3651..95f5150dae 100644 --- a/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -1054,7 +1054,7 @@ for more details. [[howto-use-custom-entity-manager]] === Use a custom EntityManagerFactory 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. @@ -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 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 -id "entityManagerFactory", and set the persistence unit name there. +id ``entityManagerFactory'', and set the persistence unit name there. 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`] @@ -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 `org.flywaydb:flyway-core` to your classpath. -The migrations are scripts in the form `V__.sql` (with -`` an underscore-separated version, e.g. "1" or "2_1"). By -default they live in a folder `classpath:db/migration` but you can -modify that using `flyway.locations` (a list). See the Flyway class from -flyway-core for details of available settings like schemas etc. In +The migrations are scripts in the form `V__.sql` (with `` an +underscore-separated version, e.g. ``1'' or ``2_1''). By default they live in a folder +`classpath:db/migration` but you can modify that using `flyway.locations` (a list). See +the Flyway class from flyway-core for details of available settings like schemas etc. In addition Spring Boot provides a small set of properties in {sc-spring-boot-autoconfigure}/flyway/FlywayProperties.{sc-ext}[`FlywayProperties`] 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: . 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`. -. 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. Remember *not* to compress the entries in the archive. @@ -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 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 -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]. diff --git a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index 33b155e22d..fb258b1e1a 100644 --- a/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -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. * 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 (`management.security.*`). To override the application access rules @@ -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 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 -`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] ---- diff --git a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc index 297f554564..9be0f0510a 100644 --- a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc +++ b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc @@ -593,7 +593,10 @@ Useful operating system environment variable: $ 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 the Gradle plugin