Skip to content

Commit 1693774

Browse files
ericdahlwilkinsona
authored andcommitted
Fix some grammar issues in docs
1 parent 3228cfa commit 1693774

File tree

13 files changed

+45
-44
lines changed

13 files changed

+45
-44
lines changed

CONTRIBUTING.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ With the requisite eclipse plugins installed you can select
130130
need to import the root `spring-boot` pom and the `spring-boot-samples` pom separately.
131131

132132
=== Importing into eclipse without m2eclipse
133-
If you prefer not to use m2eclipse you can generate eclipse project meta-data using the
133+
If you prefer not to use m2eclipse you can generate eclipse project metadata using the
134134
following command:
135135

136136
[indent=0]

spring-boot-actuator/README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ For Gradle, use the declaration:
4747
authentication events by default. This can be very useful for reporting, and also to
4848
implement a lock-out policy based on authentication failures.
4949
* **Process Monitoring** In Spring Boot Actuator you can find `ApplicationPidListener`
50-
which creates file containing application PID (by default in application directory and
51-
file name is `application.pid`).
50+
which creates a file containing the application PID (by default in the application
51+
directory with a file name of `application.pid`).

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@ content into your application; rather pick only the properties that you need.
278278
spring.hornetq.embedded.serverId= # auto-generated id of the embedded server (integer)
279279
spring.hornetq.embedded.persistent=false # message persistence
280280
spring.hornetq.embedded.data-directory= # location of data content (when persistence is enabled)
281-
spring.hornetq.embedded.queues= # comma separate queues to create on startup
282-
spring.hornetq.embedded.topics= # comma separate topics to create on startup
281+
spring.hornetq.embedded.queues= # comma-separated queues to create on startup
282+
spring.hornetq.embedded.topics= # comma-separated topics to create on startup
283283
spring.hornetq.embedded.cluster-password= # customer password (randomly generated by default)
284284
285285
# JMS ({sc-spring-boot-autoconfigure}/jms/JmsProperties.{sc-ext}[JmsProperties])

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
@@ -15,7 +15,7 @@ curious about the underlying technology, this section provides some background.
1515
=== Nested JARs
1616
Java does not provide any standard way to load nested jar files (i.e. jar files that
1717
are themselves contained within a jar). This can be problematic if you are looking
18-
to distribute a self contained application that you can just run from the command line
18+
to distribute a self-contained application that you can just run from the command line
1919
without unpacking.
2020

2121
To solve this problem, many developers use ``shaded'' jars. A shaded jar simply packages

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 meta-data
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"]

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _cloud's_ notion of a running process.
1212
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,
15-
or it might be a full fledged application server. A buildpack is pluggable, but ideally
15+
or it might be a full-fledged application server. A buildpack is pluggable, but ideally
1616
you should be able to get by with as few customizations to it as possible.
1717
This reduces the footprint of functionality that is not under your control. It minimizes
1818
divergence between deployment and production environments.
@@ -103,7 +103,7 @@ able to hit the application at the URI given, in this case
103103

104104
[[cloud-deployment-cloud-foundry-services]]
105105
=== Binding to services
106-
By default, meta-data about the running application as well as service connection
106+
By default, metadata about the running application as well as service connection
107107
information is exposed to the application as environment variables (for example:
108108
`$VCAP_SERVICES`). This architecture decision is due to Cloud Foundry's polyglot
109109
(any language and platform can be supported as a buildpack) nature; process-scoped

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ that and be sure that it has initialized is to add a `@Bean` of type
365365
`ApplicationListener<EmbeddedServletContainerInitializedEvent>` and pull the container
366366
out of the event when it is published.
367367

368-
A really useful thing to do in is to use `@IntegrationTest` to set `server.port=0`
368+
A useful practice for use with `@IntegrationTest`s is to set `server.port=0`
369369
and then inject the actual ('`local`') port as a `@Value`. For example:
370370

371371
[source,java,indent=0,subs="verbatim,quotes,attributes"]
@@ -415,17 +415,17 @@ 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`.
422422

423423

424424

425425
[[howto-enable-multiple-connectors-in-tomcat]]
426-
=== Enable Multiple Connectors Tomcat
426+
=== Enable Multiple Connectors with Tomcat
427427
Add a `org.apache.catalina.connector.Connector` to the
428-
`TomcatEmbeddedServletContainerFactory` which can allow multiple connectors eg a HTTP and
428+
`TomcatEmbeddedServletContainerFactory` which can allow multiple connectors, e.g. an HTTP and
429429
HTTPS connector:
430430

431431
[source,java,indent=0,subs="verbatim,quotes,attributes"]
@@ -855,7 +855,7 @@ then you can do that in `application.properties` using the "logging.level" prefi
855855
You can also set the location of a file to log to (in addition to the console) using
856856
"logging.file".
857857

858-
To configure the more fine grained settings of a logging system you need to use the native
858+
To configure the more fine-grained settings of a logging system you need to use the native
859859
configuration format supported by the `LoggingSystem` in question. By default Spring Boot
860860
picks up the native configuration from its default location for the system (e.g.
861861
`classpath:logback.xml` for Logback), but you can set the location of the config file
@@ -917,10 +917,10 @@ requires some jiggling with excludes, e.g. in Maven:
917917
<groupId>org.springframework.boot</groupId>
918918
<artifactId>spring-boot-starter</artifactId>
919919
<exclusions>
920-
<exclusion>
921-
<groupId>org.springframework.boot</groupId>
922-
<artifactId>spring-boot-starter-logging</artifactId>
923-
</exclusion>
920+
<exclusion>
921+
<groupId>org.springframework.boot</groupId>
922+
<artifactId>spring-boot-starter-logging</artifactId>
923+
</exclusion>
924924
</exclusions>
925925
</dependency>
926926
<dependency>
@@ -930,7 +930,7 @@ requires some jiggling with excludes, e.g. in Maven:
930930
----
931931

932932
NOTE: The use of the log4j starter gathers together the dependencies for common logging
933-
requirements (e.g. including having Tomcat use `java.util.logging` but configure the
933+
requirements (e.g. including having Tomcat use `java.util.logging` but configuring the
934934
output using Log4j). See the Actuator Log4j Sample for more detail and to see it in
935935
action.
936936

@@ -1246,7 +1246,7 @@ that can be used to disable the migrations, or switch off the location checking.
12461246
By default Flyway will autowire the (`@Primary`) `DataSource` in your context and
12471247
use that for migrations. If you like to use a different `DataSource` you can create
12481248
one and mark its `@Bean` as `@FlywayDataSource` - if you do that remember to create
1249-
another one and mark it as `@Primary` if you want 2 data sources.
1249+
another one and mark it as `@Primary` if you want two data sources.
12501250
Or you can use Flyway's native `DataSource` by setting `flyway.[url,user,password]`
12511251
in external properties.
12521252

@@ -1283,7 +1283,7 @@ Spring Batch auto configuration is enabled by adding `@EnableBatchProcessing`
12831283
By default it executes *all* `Jobs` in the application context on startup (see
12841284
{sc-spring-boot-autoconfigure}/batch/JobLauncherCommandLineRunner.{sc-ext}[JobLauncherCommandLineRunner]
12851285
for details). You can narrow down to a specific job or jobs by specifying
1286-
`spring.batch.job.names` (comma separated job name patterns).
1286+
`spring.batch.job.names` (comma-separated job name patterns).
12871287

12881288
If the application context includes a `JobRegistry` then the jobs in
12891289
`spring.batch.job.names` are looked up in the registry instead of being autowired from the
@@ -1527,7 +1527,7 @@ To configure IntelliJ correctly you can use the `idea` Gradle plugin:
15271527
15281528
----
15291529

1530-
NOTE: Intellij must be configured to use the same Java version as the command line Gradle
1530+
NOTE: IntelliJ must be configured to use the same Java version as the command line Gradle
15311531
task and `springloaded` *must* be included as a `buildscript` dependency.
15321532

15331533
You can also additionally enable '`Make Project Automatically`' inside Intellij to
@@ -1556,7 +1556,7 @@ you would add the following:
15561556
</properties>
15571557
----
15581558

1559-
NOTE: this only works if your Maven project inherits (directly or indirectly) from
1559+
NOTE: This only works if your Maven project inherits (directly or indirectly) from
15601560
`spring-boot-dependencies`. If you have added `spring-boot-dependencies` in your
15611561
own `dependencyManagement` section with `<scope>import</scope>` you have to redefine
15621562
the artifact yourself instead of overriding the property .

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -605,7 +605,7 @@ from your command:
605605
[[production-ready-remote-shell-plugins]]
606606
==== Remote shell plugins
607607
In addition to new commands, it is also possible to extend other CRaSH shell features.
608-
All Spring Beans that extends `org.crsh.plugin.CRaSHPlugin` will be automatically
608+
All Spring Beans that extend `org.crsh.plugin.CRaSHPlugin` will be automatically
609609
registered with the shell.
610610

611611
For more information please refer to the http://www.crashub.org/[CRaSH reference
@@ -832,8 +832,8 @@ In `META-INF/spring.factories` file you have to activate the listener:
832832
[[production-ready-process-monitoring-programmatically]]
833833
=== Programmatically
834834
You can also activate this listener by invoking `SpringApplication.addListeners(...)`
835-
method and passing `ApplicationPidListener` object. You can also customize file name
836-
and path through constructor.
835+
method and passing `ApplicationPidListener` object. You can also customize the file
836+
name and path through its constructor.
837837

838838

839839

@@ -845,5 +845,5 @@ might want to read about graphing tools such as http://graphite.wikidot.com/[Gra
845845

846846
Otherwise, you can continue on, to read about <<cloud-deployment.adoc#cloud-deployment,
847847
'`cloud deployment options`'>> or jump ahead
848-
for some in depth information about Spring Boot's
848+
for some in-depth information about Spring Boot's
849849
'<<build-tool-plugins.adoc#build-tool-plugins, build tool plugins>>'.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ using.
7676
[[cli-run]]
7777
=== Running applications using the CLI
7878
You can compile and run Groovy source code using the `run` command. The Spring Boot CLI
79-
is completely self contained so you don't need any external Groovy installation.
79+
is completely self-contained so you don't need any external Groovy installation.
8080

8181
Here is an example ``hello world'' web application written in Groovy:
8282

@@ -272,7 +272,7 @@ executable jar file. For example:
272272
The resulting jar will contain the classes produced by compiling the application and all
273273
of the application's dependencies so that it can then be run using `java -jar`. The jar
274274
file will also contain entries from the application's classpath. You can add explicit
275-
paths to the jar using `--include` and `--exclude` (both are comma separated, and both
275+
paths to the jar using `--include` and `--exclude` (both are comma-separated, and both
276276
accept prefixes to the values ``+'' and ``-'' to signify that they should be removed from
277277
the defaults). The default includes are
278278

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1028,7 +1028,6 @@ behaviour by setting `com.ibm.ws.webcontainer.invokeFlushAfterService` to `false
10281028

10291029

10301030

1031-
10321031
[[boot-features-embedded-container]]
10331032
=== Embedded servlet container support
10341033
Spring Boot includes support for embedded Tomcat and Jetty servers. Most developers will
@@ -1044,7 +1043,7 @@ Spring beans. This can be particularly convenient if you want to refer to a valu
10441043
your `application.properties` during configuration.
10451044

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

10501049
If convention-based mapping is not flexible enough you can use the
@@ -1272,7 +1271,7 @@ auto-configured. In this example it's pulled in transitively via
12721271
[[boot-features-connect-to-production-database]]
12731272
==== Connection to a production database
12741273
Production database connections can also be auto-configured using a pooling
1275-
`DataSource`. Here's the algorithm for choosing a specific implementation.
1274+
`DataSource`. Here's the algorithm for choosing a specific implementation:
12761275

12771276
* We prefer the Tomcat pooling `DataSource` for its performance and concurrency, so if
12781277
that is available we always choose it.
@@ -1304,6 +1303,8 @@ NOTE: For a pooling `DataSource` to be created we need to be able to verify that
13041303
`spring.datasource.driverClassName=com.mysql.jdbc.Driver` then that class has to be
13051304
loadable.
13061305

1306+
1307+
13071308
[[boot-features-using-jdbc-template]]
13081309
=== Using JdbcTemplate
13091310
Spring's `JdbcTemplate` and `NamedParameterJdbcTemplate` classes are auto-configured and
@@ -1450,7 +1451,7 @@ their http://projects.spring.io/spring-data-jpa/[reference documentation].
14501451

14511452
[[boot-features-creating-and-dropping-jpa-databases]]
14521453
==== Creating and dropping JPA databases
1453-
By default JPA database will be automatically created *only* if you use an embedded
1454+
By default, JPA databases will be automatically created *only* if you use an embedded
14541455
database (H2, HSQL or Derby). You can explicitly configure JPA settings using
14551456
`+spring.jpa.*+` properties. For example, to create and drop tables you can add the
14561457
following to your `application.properties`.
@@ -1475,7 +1476,7 @@ passes `hibernate.globally_quoted_identifiers` to the Hibernate entity manager.
14751476
By default the DDL execution (or validation) is deferred until
14761477
the `ApplicationContext` has started. There is also a `spring.jpa.generate-ddl` flag, but
14771478
it is not used if Hibernate autoconfig is active because the `ddl-auto`
1478-
settings are more fine grained.
1479+
settings are more fine-grained.
14791480

14801481

14811482

@@ -1809,7 +1810,7 @@ connect to a broker using the the `netty` transport protocol. When the latter is
18091810
configured, Spring Boot configures a `ConnectionFactory` connecting to a broker running
18101811
on the local machine with the default settings.
18111812

1812-
NOTE: if you are using `spring-boot-starter-hornetq` the necessary dependencies to
1813+
NOTE: If you are using `spring-boot-starter-hornetq` the necessary dependencies to
18131814
connect to an existing HornetQ instance are provided, as well as the Spring infrastructure
18141815
to integrate with JMS. Adding `org.hornetq:hornetq-jms-server` to your application allows
18151816
you to use the embedded mode.
@@ -1826,7 +1827,7 @@ HornetQ configuration is controlled by external configuration properties in
18261827
----
18271828

18281829
When embedding the broker, you can chose if you want to enable persistence, and the list
1829-
of destinations that should be made available. These can be specified as a comma separated
1830+
of destinations that should be made available. These can be specified as a comma-separated
18301831
list to create them with the default options; or you can define bean(s) of type
18311832
`org.hornetq.jms.server.config.JMSQueueConfiguration` or
18321833
`org.hornetq.jms.server.config.TopicConfiguration`, for advanced queue and topic
@@ -1933,7 +1934,7 @@ If you use the
19331934
the following provided libraries:
19341935

19351936
* Spring Test -- integration test support for Spring applications.
1936-
* Junit -- The de-facto standard for unit testing Java applications.
1937+
* JUnit -- The de-facto standard for unit testing Java applications.
19371938
* Hamcrest -- A library of matcher objects (also known as constraints or predicates)
19381939
allowing `assertThat` style JUnit assertions.
19391940
* Mockito -- A Java mocking framework.
@@ -2001,7 +2002,7 @@ it with HTTP (e.g. using `RestTemplate`), annotate your test class (or one of it
20012002
superclasses) with `@IntegrationTest`. This can be very useful because it means you can
20022003
test the full stack of your application, but also inject its components into the test
20032004
class and use them to assert the internal state of the application after an HTTP
2004-
interaction. For Example:
2005+
interaction. For example:
20052006

20062007
[source,java,indent=0,subs="verbatim,quotes,attributes"]
20072008
----
@@ -2206,7 +2207,7 @@ You can use the
22062207
{sc-spring-boot-autoconfigure}/AutoConfigureAfter.{sc-ext}[`@AutoConfigureAfter`] or
22072208
{sc-spring-boot-autoconfigure}/AutoConfigureBefore.{sc-ext}[`@AutoConfigureBefore`]
22082209
annotations if your configuration needs to be applied in a specific order. For example,
2209-
if you provide web specific configuration, your class may need to be applied after
2210+
if you provide web-specific configuration, your class may need to be applied after
22102211
`WebMvcAutoConfiguration`.
22112212

22122213

@@ -2227,7 +2228,7 @@ code by annotating `@Configuration` classes or individual `@Bean` methods.
22272228
==== Class conditions
22282229
The `@ConditionalOnClass` and `@ConditionalOnMissingClass` annotations allows configuration
22292230
to be skipped based on the presence or absence of specific classes. Due to the fact that
2230-
annotation meta-data is parsed using http://asm.ow2.org/[ASM] you can actually use the
2231+
annotation metadata is parsed using http://asm.ow2.org/[ASM] you can actually use the
22312232
`value` attribute to refer to the real class, even though that class might not actually
22322233
appear on the running application classpath. You can also use the `name` attribute if you
22332234
prefer to specify the class name using a `String` value.

0 commit comments

Comments
 (0)