Skip to content

Commit 52176b8

Browse files
ghostdsnicoll
authored andcommitted
Remove english contractions from the documentation
See gh-28064
1 parent 3ef1782 commit 52176b8

File tree

25 files changed

+55
-55
lines changed

25 files changed

+55
-55
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/dockerfiles.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Available commands:
2828
----
2929

3030
The `extract` command can be used to easily split the application into layers to be added to the dockerfile.
31-
Here's an example of a Dockerfile using `jarmode`.
31+
Here is an example of a Dockerfile using `jarmode`.
3232

3333
[source,dockerfile,indent=0,subs="verbatim"]
3434
----

spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ One way to run an unpacked archive is by starting the appropriate launcher, as f
2222
----
2323

2424
This is actually slightly faster on startup (depending on the size of the jar) than running from an unexploded archive.
25-
At runtime you shouldn't expect any differences.
25+
At runtime you should not expect any differences.
2626

2727
Once you have unpacked the jar file, you can also get an extra boost to startup time by running the app with its "natural" main method instead of the `JarLauncher`. For example:
2828

spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ TIP: If you do not use Spring Data MongoDB, you can inject a `MongoClient` bean
109109
If you want to take complete control of establishing the MongoDB connection, you can also declare your own `MongoDatabaseFactory` or `MongoClient` bean.
110110

111111
NOTE: If you are using the reactive driver, Netty is required for SSL.
112-
The auto-configuration configures this factory automatically if Netty is available and the factory to use hasn't been customized already.
112+
The auto-configuration configures this factory automatically if Netty is available and the factory to use has not been customized already.
113113

114114

115115

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Once the pre-stop hook has completed, SIGTERM will be sent to the container and
140140

141141
NOTE: When Kubernetes sends a SIGTERM signal to the pod, it waits for a specified time called the termination grace period (the default for which is 30 seconds).
142142
If the containers are still running after the grace period, they are sent the SIGKILL signal and forcibly removed.
143-
If the pod takes longer than 30 seconds to shut down, which could be because you've increased configprop:spring.lifecycle.timeout-per-shutdown-phase[], make sure to increase the termination grace period by setting the `terminationGracePeriodSeconds` option in the Pod YAML.
143+
If the pod takes longer than 30 seconds to shut down, which could be because you have increased configprop:spring.lifecycle.timeout-per-shutdown-phase[], make sure to increase the termination grace period by setting the `terminationGracePeriodSeconds` option in the Pod YAML.
144144

145145

146146

spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/installing.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Firstly, configure its permissions so that it cannot be written and can only be
119119
$ chmod 500 your-app.jar
120120
----
121121

122-
Second, you should also take steps to limit the damage if your application or the account that's running it is compromised.
122+
Second, you should also take steps to limit the damage if your application or the account that is running it is compromised.
123123
If an attacker does gain access, they could make the jar file writable and change its contents.
124124
One way to protect against this is to make it immutable by using `chattr`, as shown in the following example:
125125

@@ -286,7 +286,7 @@ The following property substitutions are supported with the default script:
286286
|
287287

288288
| `useStartStopDaemon`
289-
| Whether the `start-stop-daemon` command, when it's available, should be used to control the process
289+
| Whether the `start-stop-daemon` command, when it is available, should be used to control the process
290290
| `true`
291291
| `true`
292292

@@ -319,7 +319,7 @@ The following environment properties are supported with the default script:
319319
When not set, the user that owns the jar file will be used.
320320

321321
| `USE_START_STOP_DAEMON`
322-
| Whether the `start-stop-daemon` command, when it's available, should be used to control the process.
322+
| Whether the `start-stop-daemon` command, when it is available, should be used to control the process.
323323
Defaults to `true`.
324324

325325
| `PID_FOLDER`

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ The only difference between using these conditions at the class level and markin
108108

109109
TIP: When declaring a `@Bean` method, provide as much type information as possible in the method's return type.
110110
For example, if your bean's concrete class implements an interface the bean method's return type should be the concrete class and not the interface.
111-
Providing as much type information as possible in `@Bean` methods is particularly important when using bean conditions as their evaluation can only rely upon to type information that's available in the method signature.
111+
Providing as much type information as possible in `@Bean` methods is particularly important when using bean conditions as their evaluation can only rely upon to type information that is available in the method signature.
112112

113113

114114

@@ -209,7 +209,7 @@ include::{docs-java}/features/developingautoconfiguration/testing/MyServiceAutoC
209209

210210
[[features.developing-auto-configuration.custom-starter]]
211211
=== Creating Your Own Starter
212-
A typical Spring Boot starter contains code to auto-configure and customize the infrastructure of a given technology, let's call that "acme".
212+
A typical Spring Boot starter contains code to auto-configure and customize the infrastructure of a given technology, let us call that "acme".
213213
To make it easily extensible, a number of configuration keys in a dedicated namespace can be exposed to the environment.
214214
Finally, a single "starter" dependency is provided to help users get started as easily as possible.
215215

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The following example shows how to specify two distinct files:
134134
optional:classpath:/override.properties
135135
----
136136

137-
TIP: Use the prefix `optional:` if the <<features#features.external-config.files.optional-prefix,locations are optional>> and you don't mind if they don't exist.
137+
TIP: Use the prefix `optional:` if the <<features#features.external-config.files.optional-prefix,locations are optional>> and you do not mind if they do not exist.
138138

139139
WARNING: `spring.config.name`, `spring.config.location`, and `spring.config.additional-location` are used very early to determine which files have to be loaded.
140140
They must be defined as an environment property (typically an OS environment variable, a system property, or a command-line argument).
@@ -186,7 +186,7 @@ NOTE: If your application runs in a servlet container or application server, the
186186
==== Optional Locations
187187
By default, when a specified config data location does not exist, Spring Boot will throw a `ConfigDataLocationNotFoundException` and your application will not start.
188188

189-
If you want to specify a location, but you don't mind if it doesn't always exist, you can use the `optional:` prefix.
189+
If you want to specify a location, but you do not mind if it does not always exist, you can use the `optional:` prefix.
190190
You can use this prefix with the `spring.config.location` and `spring.config.additional-location` properties, as well as with <<features#features.external-config.files.importing, `spring.config.import`>> declarations.
191191

192192
For example, a `spring.config.import` value of `optional:file:./myconfig.properties` allows your application to start, even if the `myconfig.properties` file is missing.
@@ -261,7 +261,7 @@ The `Environment` has a set of default profiles (by default, `[default]`) that a
261261
In other words, if no profiles are explicitly activated, then properties from `application-default` are considered.
262262

263263
NOTE: Properties files are only ever loaded once.
264-
If you've already directly <<features#features.external-config.files.importing,imported>> a profile specific property files then it won't be imported a second time.
264+
If you have already directly <<features#features.external-config.files.importing,imported>> a profile specific property files then it will not be imported a second time.
265265

266266

267267

@@ -286,7 +286,7 @@ Values from the imported `dev.properties` will take precedence over the file tha
286286
In the above example, the `dev.properties` could redefine `spring.application.name` to a different value.
287287

288288
An import will only be imported once no matter how many times it is declared.
289-
The order an import is defined inside a single document within the properties/yaml file doesn't matter.
289+
The order an import is defined inside a single document within the properties/yaml file does not matter.
290290
For instance, the two examples below produce the same result:
291291

292292
[source,yaml,indent=0,subs="verbatim",configblocks]
@@ -320,7 +320,7 @@ The example above would import both `my.properties` as well as any `my-<profile>
320320
Spring Boot includes pluggable API that allows various different location addresses to be supported.
321321
By default you can import Java Properties, YAML and "`<<features#features.external-config.files.configtree, configuration trees>>`".
322322
323-
Third-party jars can offer support for additional technologies (there's no requirement for files to be local).
323+
Third-party jars can offer support for additional technologies (there is no requirement for files to be local).
324324
For example, you can imagine config data being from external stores such as Consul, Apache ZooKeeper or Netflix Archaius.
325325
326326
If you want to support your own locations, see the `ConfigDataLocationResolver` and `ConfigDataLoader` classes in the `org.springframework.boot.context.config` package.
@@ -349,7 +349,7 @@ You can import it from your `application.properties` using the following:
349349
[[features.external-config.files.configtree]]
350350
==== Using Configuration Trees
351351
When running applications on a cloud platform (such as Kubernetes) you often need to read config values that the platform supplies.
352-
It's not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.
352+
It is not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.
353353

354354
As an alternative to environment variables, many cloud platforms now allow you to map configuration into mounted data volumes.
355355
For example, Kubernetes can volume mount both https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap[`ConfigMaps`] and https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod[`Secrets`].
@@ -495,7 +495,7 @@ WARNING: Multi-document property files cannot be loaded by using the `@PropertyS
495495

496496
[[features.external-config.files.activation-properties]]
497497
==== Activation Properties
498-
It's sometimes useful to only activate a given get of properties when certain conditions are met.
498+
It is sometimes useful to only activate a given get of properties when certain conditions are met.
499499
For example, you might have properties that are only relevant when a specific profile is active.
500500

501501
You can conditionally activate a properties document using `spring.config.activate.*`.
@@ -903,7 +903,7 @@ For example, consider binding the following properties to a `Map<String,String>`
903903
NOTE: For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly.
904904

905905
The properties above will bind to a `Map` with `/key1`, `/key2` and `key3` as the keys in the map.
906-
The slash has been removed from `key3` because it wasn't surrounded by square brackets.
906+
The slash has been removed from `key3` because it was not surrounded by square brackets.
907907

908908
You may also occasionally need to use the bracket notation if your `key` contains a `.` and you are binding to non-scalar value.
909909
For example, binding `a.b=c` to `Map<String, Object>` will return a Map with the entry `{"a"={"b"="c"}}` whereas `[a.b]=c` will return a Map with the entry `{"a.b"="c"}`.
@@ -1081,7 +1081,7 @@ include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/con
10811081
----
10821082

10831083

1084-
TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DurationUnit`) if it isn't milliseconds.
1084+
TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DurationUnit`) if it is not milliseconds.
10851085
Doing so gives a transparent upgrade path while supporting a much richer format.
10861086

10871087

@@ -1142,7 +1142,7 @@ If you prefer to use constructor binding, the same properties can be exposed, as
11421142
include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/conversion/datasizes/constructorbinding/MyProperties.java[]
11431143
----
11441144

1145-
TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DataSizeUnit`) if it isn't bytes.
1145+
TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DataSizeUnit`) if it is not bytes.
11461146
Doing so gives a transparent upgrade path while supporting a much richer format.
11471147

11481148

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/logging.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ As a result, specific configuration keys (such as `logback.configurationFile` fo
161161

162162
[[features.logging.file-rotation]]
163163
=== File Rotation
164-
If you are using the Logback, it's possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file.
165-
For all other logging system, you'll need to configure rotation settings directly yourself (for example, if you use Log4J2 then you could add a `log4j.xml` file).
164+
If you are using the Logback, it is possible to fine-tune log rotation settings using your `application.properties` or `application.yaml` file.
165+
For all other logging system, you will need to configure rotation settings directly yourself (for example, if you use Log4J2 then you could add a `log4j.xml` file).
166166

167167
The following rotation policy properties are supported:
168168

@@ -176,7 +176,7 @@ The following rotation policy properties are supported:
176176
| If log archive cleanup should occur when the application starts.
177177

178178
| configprop:logging.logback.rollingpolicy.max-file-size[]
179-
| The maximum size of log file before it's archived.
179+
| The maximum size of log file before it is archived.
180180

181181
| configprop:logging.logback.rollingpolicy.total-size-cap[]
182182
| The maximum amount of size log archives can take before being deleted.
@@ -212,22 +212,22 @@ The following example shows potential logging settings in `application.propertie
212212
org.hibernate: "error"
213213
----
214214

215-
It's also possible to set logging levels using environment variables.
215+
It is also possible to set logging levels using environment variables.
216216
For example, `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG` will set `org.springframework.web` to `DEBUG`.
217217

218218
NOTE: The above approach will only work for package level logging.
219-
Since relaxed binding always converts environment variables to lowercase, it's not possible to configure logging for an individual class in this way.
219+
Since relaxed binding always converts environment variables to lowercase, it is not possible to configure logging for an individual class in this way.
220220
If you need to configure logging for a class, you can use <<features#features.external-config.application-json, the `SPRING_APPLICATION_JSON`>> variable.
221221

222222

223223

224224
[[features.logging.log-groups]]
225225
=== Log Groups
226-
It's often useful to be able to group related loggers together so that they can all be configured at the same time.
227-
For example, you might commonly change the logging levels for _all_ Tomcat related loggers, but you can't easily remember top level packages.
226+
It is often useful to be able to group related loggers together so that they can all be configured at the same time.
227+
For example, you might commonly change the logging levels for _all_ Tomcat related loggers, but you can not easily remember top level packages.
228228

229229
To help with this, Spring Boot allows you to define logging groups in your Spring `Environment`.
230-
For example, here's how you could define a "`tomcat`" group by adding it to your `application.properties`:
230+
For example, here is how you could define a "`tomcat`" group by adding it to your `application.properties`:
231231

232232
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
233233
----

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/spring-application.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For instance, if you start a web application on port `8080` and that port is alr
6161
6262
Action:
6363
64-
Identify and stop the process that's listening on port 8080 or configure this application to listen on another port.
64+
Identify and stop the process that is listening on port 8080 or configure this application to listen on another port.
6565
----
6666

6767
NOTE: Spring Boot provides numerous `FailureAnalyzer` implementations, and you can <<howto#howto.application.failure-analyzer,add your own>>.
@@ -152,7 +152,7 @@ The printed banner is registered as a singleton bean under the following name: `
152152
[NOTE]
153153
====
154154
The `${application.version}` and `${application.formatted-version}` properties are only available if you are using Spring Boot launchers.
155-
The values won't be resolved if you are running an unpacked jar and starting it with `java -cp <classpath> <mainclass>`.
155+
The values will not be resolved if you are running an unpacked jar and starting it with `java -cp <classpath> <mainclass>`.
156156
157157
This is why we recommend that you always launch unpacked jars using `java org.springframework.boot.loader.JarLauncher`.
158158
This will initialize the `application.*` banner variables before building the classpath and launching your app.
@@ -209,7 +209,7 @@ In addition, you can also obtain availability states by injecting the `Applicati
209209

210210
[[features.spring-application.application-availability.liveness]]
211211
==== Liveness State
212-
The "`Liveness`" state of an application tells whether its internal state allows it to work correctly, or recover by itself if it's currently failing.
212+
The "`Liveness`" state of an application tells whether its internal state allows it to work correctly, or recover by itself if it is currently failing.
213213
A broken "`Liveness`" state means that the application is in a state that it cannot recover from, and the infrastructure should restart the application.
214214

215215
NOTE: In general, the "Liveness" state should not be based on external checks, such as <<actuator#actuator.endpoints.health, Health checks>>.
@@ -225,7 +225,7 @@ An application is considered live as soon as the context has been refreshed, see
225225
==== Readiness State
226226
The "`Readiness`" state of an application tells whether the application is ready to handle traffic.
227227
A failing "`Readiness`" state tells the platform that it should not route traffic to the application for now.
228-
This typically happens during startup, while `CommandLineRunner` and `ApplicationRunner` components are being processed, or at any time if the application decides that it's too busy for additional traffic.
228+
This typically happens during startup, while `CommandLineRunner` and `ApplicationRunner` components are being processed, or at any time if the application decides that it is too busy for additional traffic.
229229

230230
An application is considered ready as soon as application and command-line runners have been called, see <<features#features.spring-application.application-events-and-listeners, Spring Boot application lifecycle and related Application Events>>.
231231

0 commit comments

Comments
 (0)