From 0d025b672edfcd00e9d2d6f28cd6c5cb7d62532d Mon Sep 17 00:00:00 2001 From: Jay Bryant Date: Mon, 1 Nov 2021 09:43:43 -0500 Subject: [PATCH 1/2] Remove 'etc' in reference documentation Update the reference documentation to replace 'etc' with 'other'. See gh-28497 --- .../spring-boot-docs/src/docs/asciidoc/documentation/data.adoc | 2 +- .../src/docs/asciidoc/features/external-config.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/howto/testing.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/using/devtools.adoc | 2 +- .../asciidoc/using/spring-beans-and-dependency-injection.adoc | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/data.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/data.adoc index e72b9a2b5f..3a0a7dd820 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/data.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/data.adoc @@ -3,4 +3,4 @@ If your application deals with a datastore, you can see how to configure that here: * *SQL:* <> -* *NOSQL:* <> +* *NOSQL:* <> diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc index 919d003a25..60e099af58 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/external-config.adoc @@ -675,7 +675,7 @@ The preceding POJO defines the following properties: * `my.service.security.password`. * `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 through 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 through properties files, YAML files, environment variables, and other mechanisms, are public API but the accessors (getters/setters) of the class itself are not meant to be used directly. [NOTE] ==== diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc index 196ae7803b..13681ae05e 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc @@ -171,7 +171,7 @@ Spring Data can create implementations of `@Repository` interfaces of various fl Spring Boot handles all of that for you, as long as those `@Repositories` are included in the same package (or a sub-package) of your `@EnableAutoConfiguration` class. For many applications, all you need is to put the right Spring Data dependencies on your classpath. -There is a `spring-boot-starter-data-jpa` for JPA, `spring-boot-starter-data-mongodb` for Mongodb, etc. +There is a `spring-boot-starter-data-jpa` for JPA, `spring-boot-starter-data-mongodb` for Mongodb, and other starters. To get started, create some repository interfaces to handle your `@Entity` objects. Spring Boot tries to guess the location of your `@Repository` definitions, based on the `@EnableAutoConfiguration` it finds. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc index f500158f52..4f2f8610b9 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc @@ -26,7 +26,7 @@ For additional details on Spring Security's testing support, refer to Spring Sec === Use Testcontainers for Integration Testing The https://www.testcontainers.org/[Testcontainers] library provides a way to manage services running inside Docker containers. It integrates with JUnit, allowing you to write a test class that can start up a container before any of the tests run. -Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra etc. +Testcontainers is especially useful for writing integration tests that talk to a real backend service such as MySQL, MongoDB, Cassandra and others. Testcontainers can be used in a Spring Boot test as follows: [source,java,indent=0,subs="verbatim"] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc index fb59746140..a9b6f44758 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/webserver.adoc @@ -233,7 +233,7 @@ As of Undertow 1.4.0+, both `h2` and `h2c` are supported on JDK 8 without any ad [[howto.webserver.configure]] === Configure the Web Server -Generally, you should first consider using one of the many available configuration keys and customize your web server by adding new entries in your `application.properties` (or `application.yml`, or environment, etc. see "`<>`"). +Generally, you should first consider using one of the many available configuration keys and customize your web server by adding new entries in your `application.properties` (or `application.yml`, or environment, or other settings). See "`<>`"). The `server.{asterisk}` namespace is quite useful here, and it includes namespaces like `server.tomcat.{asterisk}`, `server.jetty.{asterisk}` and others, for server-specific features. See the list of <>. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/devtools.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/devtools.adoc index e6b4f451c9..1330d904e6 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/devtools.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/devtools.adoc @@ -54,7 +54,7 @@ For example, Thymeleaf offers the configprop:spring.thymeleaf.cache[] property. Rather than needing to set these properties manually, the `spring-boot-devtools` module automatically applies sensible development-time configuration. Because you need more information about web requests while developing Spring MVC and Spring WebFlux applications, developer tools suggests you to enable `DEBUG` logging for the `web` logging group. -This will give you information about the incoming request, which handler is processing it, the response outcome, etc. +This will give you information about the incoming request, which handler is processing it, the response outcome, and other details. If you wish to log all request details (including potentially sensitive information), you can turn on the configprop:spring.mvc.log-request-details[] or configprop:spring.codec.log-request-details[] configuration properties. NOTE: If you do not want property defaults to be applied you can set configprop:spring.devtools.add-properties[] to `false` in your `application.properties`. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/spring-beans-and-dependency-injection.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/spring-beans-and-dependency-injection.adoc index 050c51edd4..3ef36daebd 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/spring-beans-and-dependency-injection.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/spring-beans-and-dependency-injection.adoc @@ -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. 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`, and others) are automatically registered as Spring Beans. The following example shows a `@Service` Bean that uses constructor injection to obtain a required `RiskAssessor` bean: From c7e61e448e7f2990a9bf453928aec4626515cd5a Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 8 Nov 2021 13:24:01 -0800 Subject: [PATCH 2/2] Polish "Remove 'etc' in reference documentation" See gh-28497 --- .../web/documentation/sample.log.2021-06-15.0.gz | Bin 0 -> 1271 bytes .../src/docs/asciidoc/howto/data-access.adoc | 2 +- .../src/docs/asciidoc/howto/webserver.adoc | 3 ++- 3 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 spring-boot-project/spring-boot-actuator-autoconfigure/src/test/resources/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/sample.log.2021-06-15.0.gz diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/resources/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/sample.log.2021-06-15.0.gz b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/resources/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/sample.log.2021-06-15.0.gz new file mode 100644 index 0000000000000000000000000000000000000000..0e7d92ff8d07b39378576a4d1efd8174fc304276 GIT binary patch literal 1271 zcmVdiwFP!000000Nq$^Q{y%e{+?g4b6-eqh!TgFByPDmpfGSl?rsQo?M#xP zimk)~$8sf^mzMtbt|Xg;o+)mxl$%-^Bik$Ov+pYa2mqYp1^3s=)O^C{^BT0qV`v$| zwe$R4{k&nP?s4o!tqyf)jLm*`u;y-eZaT*0KjXBZgfYG`J2sHO-imPtb-M@}ZqxwQ z0BP{L1A;g6HNPXPbtG-MQG=c0!p}PoF0;P1(>k}K2EGr&RPtmFdqQY@tkpVguiI?* z@CRPk_d5PYoAkXl!14RT58(BC+uP7=Hes})p9ST~1QeN(Azh>~`;ko#C1V3BFPYp; z)0hWTbCKla$W&9Q4cjN^@fQiDNh|^y!!_3td_4Zap?C!8#=nd7y#N|$e#Ib_V#Z?z zis^Nj(Kt5vr!=?(Eg)nwn#H;xQhxEK9OYK00?K`n%=moB2WlXStZg}fwFG%mSjQ=;5vBycOqZjuOH>{W@`+wS(%Yj?LceNe`T zSqdT53`S=egWYTnD{{i#@C=OnlkY$p{}MCEIYY#mq%w$ZOBCdhUbk04L4qhUCD(*4 zrYsCuNVHfWSaN3n+zVmM=w1O&xaKtGzp~JIQ!1pctA-D~cCQWfNb9swj;PnKgovgz zh!{a;$R?qvX~_t>dlFI^8azB;4?{rZFGmjJq?~=fN(36)|0RHfWX==zFan*)!F}>! z*RIbM*6NWh;+2J(NBU(p!eDJ$zZhzfHa)8m65!Y;g?waWquInY&RdiFP&+P+V_~_p zRG1dfnqNBOSK(4NB8o`JcRUd^G#<0OFu08Cmh$(P4&|~&AWTxxh?ghewL3jns1lGJ zV!W*yNaNr|*ygr6Wpl2yv@G`+O$^8ZP1C}gki>_zkgJqxw580Kt(ioH3V#I9=05;* z$Yagqmv~kH%`6Gx2_h;nl`?sd1R}&wZm~h-Bdpgig)8FdV960i{($L7gx?A*1oSb} zhe9r_w{M&Io={q0KW9nIOs{?$wV0GbPJVxd4Ho8vG@GJ?rCKvy zi2JHkB#Ip*n(N!|FX$B|ndULU9o>`"). +Generally, you should first consider using one of the many available configuration keys and customize your web server by adding new entries in your `application.properties` or `application.yml` file. +See "`<>`"). The `server.{asterisk}` namespace is quite useful here, and it includes namespaces like `server.tomcat.{asterisk}`, `server.jetty.{asterisk}` and others, for server-specific features. See the list of <>.