root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 12 Packages Projects Releases Wiki Activity

Fix some typos in docs 

See gh-27968
This commit is contained in:
Dmitriy Bogdanov 2021-09-13 13:52:28 +04:00 committed by Stephane Nicoll
parent 92aee23ed2
commit 2ad3428039
6 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/data.adoc
View File

@ -3,4 +3,4 @@
If your application deals with a datastore, you can see how to configure that here: If your application deals with a datastore, you can see how to configure that here:
* *SQL:* <<data#data.sql, Configuring a SQL Datastore, Embedded Database support, Connection pools and more>> * *SQL:* <<data#data.sql, Configuring a SQL Datastore, Embedded Database support, Connection pools and more>>
* *NOSQL:* <<data#data.nosql, Auto-configuration for NOSQL stores such as Redis, MongoDB, Neo4j etc>> * *NOSQL:* <<data#data.nosql, Auto-configuration for NOSQL stores such as Redis, MongoDB, Neo4j, etc.>>

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

@ -12,7 +12,7 @@ Properties are considered in the following order (with values from lower items o
. {spring-framework-api}/context/annotation/PropertySource.html[`@PropertySource`] annotations on your `@Configuration` classes. . {spring-framework-api}/context/annotation/PropertySource.html[`@PropertySource`] annotations on your `@Configuration` classes.
Please note that such property sources are not added to the `Environment` until the application context is being refreshed. Please note that such property sources are not added to the `Environment` until the application context is being refreshed.
This is too late to configure certain properties such as `+logging.*+` and `+spring.main.*+` which are read before refresh begins. This is too late to configure certain properties such as `+logging.*+` and `+spring.main.*+` which are read before refresh begins.
. Config data (such as `application.properties` files) . Config data (such as `application.properties` files).
. A `RandomValuePropertySource` that has properties only in `+random.*+`. . A `RandomValuePropertySource` that has properties only in `+random.*+`.
. OS environment variables. . OS environment variables.
. Java System properties (`System.getProperties()`). . Java System properties (`System.getProperties()`).
@ -56,7 +56,7 @@ See the "<<actuator#actuator.endpoints, Production ready features>>" section for
[[features.external-config.command-line-args]] [[features.external-config.command-line-args]]
=== Accessing Command Line Properties === Accessing Command Line Properties
By default, `SpringApplication` converts any command line option arguments (that is, arguments starting with `--`, such as `--server.port=9000`) to a `property` and adds them to the Spring `Environment`. By default, `SpringApplication` converts any command line option arguments (that is, arguments starting with `--`, such as `--server.port=9000`) to a `property` and adds them to the Spring `Environment`.
As mentioned previously, command line properties always take precedence over file based property sources. As mentioned previously, command line properties always take precedence over file-based property sources.
If you do not want command line properties to be added to the `Environment`, you can disable them by using `SpringApplication.setAddCommandLineProperties(false)`. If you do not want command line properties to be added to the `Environment`, you can disable them by using `SpringApplication.setAddCommandLineProperties(false)`.
@ -668,11 +668,11 @@ The preceding POJO defines the following properties:
* `my.service.enabled`, with a value of `false` by default. * `my.service.enabled`, with a value of `false` by default.
* `my.service.remote-address`, with a type that can be coerced from `String`. * `my.service.remote-address`, with a type that can be coerced from `String`.
* `my.service.security.username`, with a nested "security" object whose name is determined by the name of the property. * `my.service.security.username`, with a nested "security" object whose name is determined by the name of the property.
In particular, the return type is not used at all there and could have been `SecurityProperties`. In particular, the type is not used at all there and could have been `SecurityProperties`.
* `my.service.security.password`. * `my.service.security.password`.
* `my.service.security.roles`, with a collection of `String` that defaults to `USER`. * `my.service.security.roles`, with a collection of `String` that defaults to `USER`.
NOTE: The properties that map to `@ConfigurationProperties` classes available in Spring Boot, which are configured via properties files, YAML files, environment variables etc., are public API but the accessors (getters/setters) of the class itself are not meant to be used directly. NOTE: The properties that map to `@ConfigurationProperties` classes available in Spring Boot, which are configured via properties files, YAML files, environment variables, etc., are public API but the accessors (getters/setters) of the class itself are not meant to be used directly.
[NOTE] [NOTE]
==== ====

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/devtools.adoc
View File

@ -274,7 +274,7 @@ You can configure global devtools settings by adding any of the following files
. `spring-boot-devtools.yaml` . `spring-boot-devtools.yaml`
. `spring-boot-devtools.yml` . `spring-boot-devtools.yml`
Any properties added to these file apply to _all_ Spring Boot applications on your machine that use devtools. Any properties added to these files apply to _all_ Spring Boot applications on your machine that use devtools.
For example, to configure restart to always use a <<using#using.devtools.restart.triggerfile, trigger file>>, you would add the following property to your `spring-boot-devtools` file: For example, to configure restart to always use a <<using#using.devtools.restart.triggerfile, trigger file>>, you would add the following property to your `spring-boot-devtools` file:
[source,yaml,indent=0,subs="verbatim",configprops,configblocks] [source,yaml,indent=0,subs="verbatim",configprops,configblocks]

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc
View File

@ -4,7 +4,7 @@ One of the biggest advantages of packaging your application as a jar and using a
The sample applies to debugging Spring Boot applications. The sample applies to debugging Spring Boot applications.
You do not need any special IDE plugins or extensions. You do not need any special IDE plugins or extensions.
NOTE: This section only covers jar based packaging. NOTE: This section only covers jar-based packaging.
If you choose to package your application as a war file, you should refer to your server and IDE documentation. If you choose to package your application as a war file, you should refer to your server and IDE documentation.

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/spring-beans-and-dependency-injection.adoc
View File

@ -4,7 +4,7 @@ You are free to use any of the standard Spring Framework techniques to define yo
We generally recommend using constructor injection to wire up dependencies and `@ComponentScan` to find beans. We generally recommend using constructor injection to wire up dependencies and `@ComponentScan` to find beans.
If you structure your code as suggested above (locating your application class in a top package), you can add `@ComponentScan` without any arguments or use the `@SpringBootApplication` annotation which implicitly includes it. If you structure your code as suggested above (locating your application class in a top package), you can add `@ComponentScan` without any arguments or use the `@SpringBootApplication` annotation which implicitly includes it.
All of your application components (`@Component`, `@Service`, `@Repository`, `@Controller` etc.) are automatically registered as Spring Beans. All of your application components (`@Component`, `@Service`, `@Repository`, `@Controller`, etc.) are automatically registered as Spring Beans.
The following example shows a `@Service` Bean that uses constructor injection to obtain a required `RiskAssessor` bean: The following example shows a `@Service` Bean that uses constructor injection to obtain a required `RiskAssessor` bean:

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/servlet.adoc
View File

@ -443,7 +443,7 @@ To do so, set the `spring.security.filter.dispatcher-types` property to `async,
[[web.servlet.spring-mvc.cors]] [[web.servlet.spring-mvc.cors]]
==== CORS Support ==== CORS Support
https://en.wikipedia.org/wiki/Cross-origin_resource_sharing[Cross-origin resource sharing] (CORS) is a https://www.w3.org/TR/cors/[W3C specification] implemented by https://caniuse.com/#feat=cors[most browsers] that lets you specify in a flexible way what kind of cross-domain requests are authorized., instead of using some less secure and less powerful approaches such as IFRAME or JSONP. https://en.wikipedia.org/wiki/Cross-origin_resource_sharing[Cross-origin resource sharing] (CORS) is a https://www.w3.org/TR/cors/[W3C specification] implemented by https://caniuse.com/#feat=cors[most browsers] that lets you specify in a flexible way what kind of cross-domain requests are authorized, instead of using some less secure and less powerful approaches such as IFRAME or JSONP.
As of version 4.2, Spring MVC {spring-framework-docs}/web.html#mvc-cors[supports CORS]. As of version 4.2, Spring MVC {spring-framework-docs}/web.html#mvc-cors[supports CORS].
Using {spring-framework-docs}/web.html#mvc-cors-controller[controller method CORS configuration] with {spring-framework-api}/web/bind/annotation/CrossOrigin.html[`@CrossOrigin`] annotations in your Spring Boot application does not require any specific configuration. Using {spring-framework-docs}/web.html#mvc-cors-controller[controller method CORS configuration] with {spring-framework-api}/web/bind/annotation/CrossOrigin.html[`@CrossOrigin`] annotations in your Spring Boot application does not require any specific configuration.