Skip to content

Commit e31e02a

Browse files
committed
Merge pull request #28141 from ghostd
* pr/28141: Polish "Replace latin locutions in the documentation" Replace latin locutions in the documentation Closes gh-28141
2 parents ea68672 + 9e1ef76 commit e31e02a

File tree

15 files changed

+31
-30
lines changed

15 files changed

+31
-30
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -442,11 +442,11 @@ For example, you might declare the following section in `application.properties`
442442
TIP: You do not need to specify a driver class name, since Spring Boot obtains the driver from R2DBC's Connection Factory discovery.
443443

444444
NOTE: At least the url should be provided.
445-
Information specified in the URL takes precedence over individual properties, i.e. `name`, `username`, `password` and pooling options.
445+
Information specified in the URL takes precedence over individual properties, that is `name`, `username`, `password` and pooling options.
446446

447447
TIP: The "`How-to`" section includes a <<howto#howto.data-initialization.using-basic-sql-scripts, section on how to initialize a database>>.
448448

449-
To customize the connections created by a `ConnectionFactory`, i.e., set specific parameters that you do not want (or cannot) configure in your central database configuration, you can use a `ConnectionFactoryOptionsBuilderCustomizer` `@Bean`.
449+
To customize the connections created by a `ConnectionFactory`, that is, set specific parameters that you do not want (or cannot) configure in your central database configuration, you can use a `ConnectionFactoryOptionsBuilderCustomizer` `@Bean`.
450450
The following example shows how to manually override the database port while the rest of the options is taken from the application configuration:
451451

452452
[source,java,indent=0,subs="verbatim"]

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ If you only have one module that combines the two, name it `acme-spring-boot-sta
245245
If your starter provides configuration keys, use a unique namespace for them.
246246
In particular, do not include your keys in the namespaces that Spring Boot uses (such as `server`, `management`, `spring`, and so on).
247247
If you use the same namespace, we may modify these namespaces in the future in ways that break your modules.
248-
As a rule of thumb, prefix all your keys with a namespace that you own (e.g. `acme`).
248+
As a rule of thumb, prefix all your keys with a namespace that you own (for example `acme`).
249249

250250
Make sure that configuration keys are documented by adding field javadoc for each property, as shown in the following example:
251251

@@ -261,7 +261,7 @@ Here are some rules we follow internally to make sure descriptions are consisten
261261
* Do not start the description by "The" or "A".
262262
* For `boolean` types, start the description with "Whether" or "Enable".
263263
* For collection-based types, start the description with "Comma-separated list"
264-
* Use `java.time.Duration` rather than `long` and describe the default unit if it differs from milliseconds, e.g. "If a duration suffix is not specified, seconds will be used".
264+
* Use `java.time.Duration` rather than `long` and describe the default unit if it differs from milliseconds, such as "If a duration suffix is not specified, seconds will be used".
265265
* Do not provide the default value in the description unless it has to be determined at runtime.
266266

267267
Make sure to <<configuration-metadata#configuration-metadata.annotation-processor,trigger meta-data generation>> so that IDE assistance is available for your keys as well.
@@ -346,5 +346,5 @@ If the library you are auto-configuring typically requires other starters, menti
346346
Providing a proper set of _default_ dependencies may be hard if the number of optional dependencies is high, as you should avoid including dependencies that are unnecessary for a typical usage of the library.
347347
In other words, you should not include optional dependencies.
348348

349-
NOTE: Either way, your starter must reference the core Spring Boot starter (`spring-boot-starter`) directly or indirectly (i.e. no need to add it if your starter relies on another starter).
349+
NOTE: Either way, your starter must reference the core Spring Boot starter (`spring-boot-starter`) directly or indirectly (there is no need to add it if your starter relies on another starter).
350350
If a project is created with only your custom starter, Spring Boot's core features will be honoured by the presence of the core starter.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/con
722722

723723

724724
NOTE: To use constructor binding the class must be enabled using `@EnableConfigurationProperties` or configuration property scanning.
725-
You cannot use constructor binding with beans that are created by the regular Spring mechanisms (e.g. `@Component` beans, beans created via `@Bean` methods or beans loaded using `@Import`)
725+
You cannot use constructor binding with beans that are created by the regular Spring mechanisms (for example `@Component` beans, beans created via `@Bean` methods or beans loaded using `@Import`)
726726

727727
TIP: If you have more than one constructor for your class you can also use `@ConstructorBinding` directly on the constructor that should be bound.
728728

@@ -1048,7 +1048,7 @@ If you expose a `java.time.Duration` property, the following formats in applicat
10481048

10491049
* A regular `long` representation (using milliseconds as the default unit unless a `@DurationUnit` has been specified)
10501050
* The standard ISO-8601 format {java-api}/java/time/Duration.html#parse-java.lang.CharSequence-[used by `java.time.Duration`]
1051-
* A more readable format where the value and the unit are coupled (e.g. `10s` means 10 seconds)
1051+
* A more readable format where the value and the unit are coupled (`10s` means 10 seconds)
10521052

10531053
Consider the following example:
10541054

@@ -1093,7 +1093,7 @@ The following formats can be used in application properties:
10931093

10941094
* An regular `int` representation (using days as the default unit unless a `@PeriodUnit` has been specified)
10951095
* The standard ISO-8601 format {java-api}/java/time/Period.html#parse-java.lang.CharSequence-[used by `java.time.Period`]
1096-
* A simpler format where the value and the unit pairs are coupled (e.g. `1y3d` means 1 year and 3 days)
1096+
* A simpler format where the value and the unit pairs are coupled (`1y3d` means 1 year and 3 days)
10971097

10981098
The following units are supported with the simple format:
10991099

@@ -1112,7 +1112,7 @@ Spring Framework has a `DataSize` value type that expresses a size in bytes.
11121112
If you expose a `DataSize` property, the following formats in application properties are available:
11131113

11141114
* A regular `long` representation (using bytes as the default unit unless a `@DataSizeUnit` has been specified)
1115-
* A more readable format where the value and the unit are coupled (e.g. `10MB` means 10 megabytes)
1115+
* A more readable format where the value and the unit are coupled (`10MB` means 10 megabytes)
11161116

11171117
Consider the following example:
11181118

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Spring Boot supports localized messages so that your application can cater to users of different language preferences.
44
By default, Spring Boot looks for the presence of a `messages` resource bundle at the root of the classpath.
55

6-
NOTE: The auto-configuration applies when the default properties file for the configured resource bundle is available (i.e. `messages.properties` by default).
6+
NOTE: The auto-configuration applies when the default properties file for the configured resource bundle is available (`messages.properties` by default).
77
If your resource bundle contains only language-specific properties files, you are required to add the default.
88
If no properties file is found that matches any of the configured base names, there will be no auto-configured `MessageSource`.
99

spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/task-execution-and-scheduling.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ In the absence of an `Executor` bean in the context, Spring Boot auto-configures
44

55
[TIP]
66
====
7-
If you have defined a custom `Executor` in the context, regular task execution (i.e. `@EnableAsync`) will use it transparently but the Spring MVC support will not be configured as it requires an `AsyncTaskExecutor` implementation (named `applicationTaskExecutor`).
7+
If you have defined a custom `Executor` in the context, regular task execution (that is `@EnableAsync`) will use it transparently but the Spring MVC support will not be configured as it requires an `AsyncTaskExecutor` implementation (named `applicationTaskExecutor`).
88
Depending on your target arrangement, you could change your `Executor` into a `ThreadPoolTaskExecutor` or define both a `ThreadPoolTaskExecutor` and an `AsyncConfigurer` wrapping your custom `Executor`.
99
1010
The auto-configured `TaskExecutorBuilder` allows you to easily create instances that reproduce what the auto-configuration does by default.
@@ -27,7 +27,7 @@ Those default settings can be fine-tuned using the `spring.task.execution` names
2727
This changes the thread pool to use a bounded queue so that when the queue is full (100 tasks), the thread pool increases to maximum 16 threads.
2828
Shrinking of the pool is more aggressive as threads are reclaimed when they are idle for 10 seconds (rather than 60 seconds by default).
2929

30-
A `ThreadPoolTaskScheduler` can also be auto-configured if need to be associated to scheduled task execution (e.g. `@EnableScheduling`).
30+
A `ThreadPoolTaskScheduler` can also be auto-configured if need to be associated to scheduled task execution (using `@EnableScheduling` for instance).
3131
The thread pool uses one thread by default and its settings can be fine-tuned using the `spring.task.scheduling` namespace, as shown in the following example:
3232

3333
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/actuator.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ See also the section on "`<<web#web.servlet.spring-mvc.error-handling, Error Han
3636

3737
[[howto.actuator.sanitize-sensitive-values]]
3838
=== Sanitize Sensitive Values
39-
Information returned by the `env` and `configprops` endpoints can be somewhat sensitive so keys matching certain patterns are sanitized by default (i.e. their values are replaced by `+******+`). Spring Boot uses sensible defaults for such keys: any key ending with the word "password", "secret", "key", "token", "vcap_services", "sun.java.command" is entirely sanitized.
40-
Additionally, any key that holds the word `credentials` (configured as a regular expression, i.e. `+*credentials.*+`) as part of the key is also entirely sanitized.
39+
Information returned by the `env` and `configprops` endpoints can be somewhat sensitive so keys matching certain patterns are sanitized by default (that is their values are replaced by `+******+`).
40+
Spring Boot uses sensible defaults for such keys: any key ending with the word "password", "secret", "key", "token", "vcap_services", "sun.java.command" is entirely sanitized.
41+
Additionally, any key that holds the word `credentials` (configured as a regular expression, that is `+*credentials.*+`) as part of the key is also entirely sanitized.
4142

4243
Furthermore, Spring Boot sanitizes the sensitive portion of URI-like values for keys with one of the following endings:
4344

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,6 @@ See "`<<features#features.spring-application.fluent-builder-api>>`" in the '`Spr
106106
Not all Spring applications have to be web applications (or web services).
107107
If you want to execute some code in a `main` method but also bootstrap a Spring application to set up the infrastructure to use, you can use the `SpringApplication` features of Spring Boot.
108108
A `SpringApplication` changes its `ApplicationContext` class, depending on whether it thinks it needs a web application or not.
109-
The first thing you can do to help it is to leave server-related dependencies (e.g. servlet API) off the classpath.
109+
The first thing you can do to help it is to leave server-related dependencies (such as the servlet API) off the classpath.
110110
If you cannot do that (for example, you run two applications from the same code base) then you can explicitly call `setWebApplicationType(WebApplicationType.NONE)` on your `SpringApplication` instance or set the `applicationContextClass` property (through the Java API or with external properties).
111111
Application code that you want to run as your business logic can be implemented as a `CommandLineRunner` and dropped into the context as a `@Bean` definition.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/batch.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See {spring-boot-autoconfigure-module-code}/batch/BatchAutoConfiguration.java[Ba
3333
=== Running from the Command Line
3434
Spring Boot converts any command line argument starting with `--` to a property to add to the `Environment`, see <<features#features.external-config.command-line-args,accessing command line properties>>.
3535
This should not be used to pass arguments to batch jobs.
36-
To specify batch arguments on the command line, use the regular format (i.e. without `--`), as shown in the following example:
36+
To specify batch arguments on the command line, use the regular format (that is without `--`), as shown in the following example:
3737

3838
[source,shell,indent=0,subs="verbatim"]
3939
----

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-initialization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ To automatically run Liquibase database migrations on startup, add the `org.liqu
162162
====
163163
When you add the `org.liquibase:liquibase-core` to your classpath, database migrations run by default for both during application startup and before your tests run.
164164
This behavior can be customized by using the configprop:spring.liquibase.enabled[] property, setting different values in the `main` and `test` configurations.
165-
It is not possible to use two different ways to initialize the database (e.g. Liquibase for application startup, JPA for test runs).
165+
It is not possible to use two different ways to initialize the database (for example Liquibase for application startup, JPA for test runs).
166166
====
167167

168168
By default, the master change log is read from `db/changelog/db.changelog-master.yaml`, but you can change the location by setting `spring.liquibase.change-log`.

spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ When you do so, auto-configured customizers are still applied on your custom fac
284284

285285
[[howto.webserver.add-servlet-filter-listener]]
286286
=== Add a Servlet, Filter, or Listener to an Application
287-
In a servlet stack application, i.e. with the `spring-boot-starter-web`, there are two ways to add `Servlet`, `Filter`, `ServletContextListener`, and the other listeners supported by the Servlet API to your application:
287+
In a servlet stack application, that is with the `spring-boot-starter-web`, there are two ways to add `Servlet`, `Filter`, `ServletContextListener`, and the other listeners supported by the Servlet API to your application:
288288

289289
* <<howto#howto.webserver.add-servlet-filter-listener.spring-bean>>
290290
* <<howto#howto.webserver.add-servlet-filter-listener.using-scanning>>

spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/rsocket.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The required dependencies are provided by the `spring-boot-starter-rsocket`.
3333
Spring Boot allows exposing RSocket over WebSocket from a WebFlux server, or standing up an independent RSocket server.
3434
This depends on the type of application and its configuration.
3535

36-
For WebFlux application (i.e. of type `WebApplicationType.REACTIVE`), the RSocket server will be plugged into the Web Server only if the following properties match:
36+
For WebFlux application (that is of type `WebApplicationType.REACTIVE`), the RSocket server will be plugged into the Web Server only if the following properties match:
3737

3838
[source,yaml,indent=0,subs="verbatim",configprops,configblocks]
3939
----

spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following table shows the environment variables and their values:
2323
| Environment variable | Description
2424

2525
| DOCKER_HOST
26-
| URL containing the host and port for the Docker daemon - e.g. `tcp://192.168.99.100:2376`
26+
| URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376`
2727

2828
| DOCKER_TLS_VERIFY
2929
| Enable secure HTTPS protocol when set to `1` (optional)
@@ -41,7 +41,7 @@ The following table summarizes the available properties:
4141
| Property | Description
4242

4343
| `host`
44-
| URL containing the host and port for the Docker daemon - e.g. `tcp://192.168.99.100:2376`
44+
| URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376`
4545

4646
| `tlsVerify`
4747
| Enable secure HTTPS protocol when set to `true` (optional)

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging-oci-image.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ include::../maven/packaging-oci-image/pom.xml[tags=packaging-oci-image]
1515
----
1616

1717
TIP: While the buildpack runs from an <<packaging,executable archive>>, it is not necessary to execute the `repackage` goal first as the executable archive is created automatically if necessary.
18-
When the `build-image` repackages the application, it applies the same settings as the `repackage` goal would, i.e. dependencies can be excluded using one of the exclude options, and Devtools is automatically excluded by default (you can control that using the `excludeDevtools` property).
18+
When the `build-image` repackages the application, it applies the same settings as the `repackage` goal would, that is dependencies can be excluded using one of the exclude options, and Devtools is automatically excluded by default (you can control that using the `excludeDevtools` property).
1919

2020

2121

@@ -32,7 +32,7 @@ The following table shows the environment variables and their values:
3232
| Environment variable | Description
3333

3434
| DOCKER_HOST
35-
| URL containing the host and port for the Docker daemon - e.g. `tcp://192.168.99.100:2376`
35+
| URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376`
3636

3737
| DOCKER_TLS_VERIFY
3838
| Enable secure HTTPS protocol when set to `1` (optional)
@@ -50,7 +50,7 @@ The following table summarizes the available parameters:
5050
| Parameter | Description
5151

5252
| `host`
53-
| URL containing the host and port for the Docker daemon - e.g. `tcp://192.168.99.100:2376`
53+
| URL containing the host and port for the Docker daemon - for example `tcp://192.168.99.100:2376`
5454

5555
| `tlsVerify`
5656
| Enable secure HTTPS protocol when set to `true` (optional)

spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ TIP: If you are using `spring-boot-starter-parent`, such execution is already pr
1414
The example above repackages a `jar` or `war` archive that is built during the package phase of the Maven lifecycle, including any `provided` dependencies that are defined in the project.
1515
If some of these dependencies need to be excluded, you can use one of the `exclude` options; see the <<packaging.examples.exclude-dependency,dependency exclusion>> for more details.
1616

17-
The original (i.e. non-executable) artifact is renamed to `.original` by default but it is also possible to keep the original artifact using a custom classifier.
17+
The original (that is non-executable) artifact is renamed to `.original` by default but it is also possible to keep the original artifact using a custom classifier.
1818

1919
NOTE: The `outputFileNameMapping` feature of the `maven-war-plugin` is currently not supported.
2020

0 commit comments

Comments
 (0)