diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 5ca6c4c0479..83c665232e4 100755 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -1,7 +1,7 @@ = Contributing to Spring Boot Spring Boot is released under the Apache 2.0 license. If you would like to contribute -something, or simply want to hack on the code this document should help you get started. +something, or want to hack on the code this document should help you get started. @@ -57,7 +57,7 @@ added after the original pull request but before a merge. * The build includes checkstyle rules for many of our code conventions. Run `./gradlew checkstyleMain checkstyleTest` if you want to check you changes are compliant. -* Make sure all new `.java` files to have a simple Javadoc class comment with at least an +* Make sure all new `.java` files have a Javadoc class comment with at least an `@author` tag identifying you, and preferably at least a paragraph on what the class is for. * Add the ASF license header comment to all new `.java` files (copy from existing files diff --git a/README.adoc b/README.adoc index 214179b067f..a3e2936a76f 100755 --- a/README.adoc +++ b/README.adoc @@ -2,7 +2,7 @@ :docs: https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference :github: https://github.com/spring-projects/spring-boot -Spring Boot makes it easy to create Spring-powered, production-grade applications and +Spring Boot helps you to create Spring-powered, production-grade applications and services with absolute minimum fuss. It takes an opinionated view of the Spring platform so that new and existing users can quickly get to the bits they need. @@ -127,7 +127,7 @@ There are a number of modules in Spring Boot, here is a quick overview: The main library providing features that support the other parts of Spring Boot, these include: -* The `SpringApplication` class, providing static convenience methods that make it easy +* The `SpringApplication` class, providing static convenience methods that can be used to write a stand-alone Spring Application. Its sole job is to create and refresh an appropriate Spring `ApplicationContext` * Embedded web applications with a choice of container (Tomcat, Jetty or Undertow) @@ -154,14 +154,14 @@ Starters are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for -database access just include the `spring-boot-starter-data-jpa` dependency in your +database access include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go. === spring-boot-cli -The Spring command line application compiles and runs Groovy source, making it super -easy to write the absolute minimum of code to get an application running. Spring CLI +The Spring command line application compiles and runs Groovy source, allowing you to +write the absolute minimum of code to get an application running. Spring CLI can also watch files, automatically recompiling and restarting when they change. @@ -222,7 +222,7 @@ The https://spring.io/[spring.io] site contains several guides that show how to Boot step-by-step: * https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot] is a - very basic guide that shows you how to create a simple application, run it and add some + very basic guide that shows you how to create an application, run it and add some management services. * https://spring.io/guides/gs/actuator-service/[Building a RESTful Web Service with Spring Boot Actuator] is a guide to creating a REST web service and also shows how the server diff --git a/spring-boot-project/spring-boot-actuator/README.adoc b/spring-boot-project/spring-boot-actuator/README.adoc index 3c1bb95eb9a..3adcc5550ba 100644 --- a/spring-boot-project/spring-boot-actuator/README.adoc +++ b/spring-boot-project/spring-boot-actuator/README.adoc @@ -8,7 +8,7 @@ https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#production covers the features in more detail. == Enabling the Actuator -The simplest way to enable the features is to add a dependency to the +The recommended way to enable the features is to add a dependency to the `spring-boot-starter-actuator` '`Starter`'. To add the actuator to a Maven-based project, add the following '`Starter`' dependency: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc index 8be5c41d423..bdaf3bae348 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/appendix-configuration-metadata.adoc @@ -14,7 +14,7 @@ However, it is possible to <> in the "`Getting Started`" section up and running in the Cloud. +In this section, we look at what it takes to get the <> in the "`Getting Started`" section up and running in the Cloud. @@ -286,7 +286,7 @@ The options include: * AWS Container Registry Each has different features and pricing models. -In this document, we describe only the simplest option: AWS Elastic Beanstalk. +In this document, we describe to approach using AWS Elastic Beanstalk. @@ -458,7 +458,7 @@ Then deploy with `mvn appengine:deploy` (if you need to authenticate first, the == Installing Spring Boot Applications In addition to running Spring Boot applications by using `java -jar`, it is also possible to make fully executable applications for Unix systems. A fully executable jar can be executed like any other executable binary or it can be <>. -This makes it very easy to install and manage Spring Boot applications in common production environments. +This helps when installing and managing Spring Boot applications in common production environments. CAUTION: Fully executable jars work by embedding an extra script at the front of the file. Currently, some tools do not accept this format, so you may not always be able to use this technique. @@ -808,7 +808,7 @@ The following environment properties are supported with the default script: | The explicit location of the jar file, in case the script is being used to launch a jar that it is not actually embedded. | `DEBUG` -| If not empty, sets the `-x` flag on the shell process, making it easy to see the logic in the script. +| If not empty, sets the `-x` flag on the shell process, allowing you to see the logic in the script. | `STOP_WAIT_TIME` | The time in seconds to wait when stopping the application before forcing a shutdown (`60` by default). diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started.adoc index 407d8c1e51f..11b95b4ae94 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/getting-started.adoc @@ -11,7 +11,7 @@ We then walk you through building your first Spring Boot application, discussing [[getting-started-introducing-spring-boot]] == Introducing Spring Boot -Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can run. +Spring Boot helps you to create stand-alone, production-grade Spring-based Applications that you can run. We take an opinionated view of the Spring platform and third-party libraries, so that you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration. @@ -170,7 +170,7 @@ Get SDKMAN! from https://sdkman.io and install Spring Boot by using the followin Spring Boot v{spring-boot-version} ---- -If you develop features for the CLI and want easy access to the version you built, use the following commands: +If you develop features for the CLI and want access to the version you built, use the following commands: [indent=0,subs="verbatim,quotes,attributes"] ---- @@ -334,7 +334,7 @@ If you manually installed the CLI, follow the <>`" for details of how to register handlers in the servlet container. @@ -2773,8 +2771,7 @@ This means that, in addition to being deployable to a servlet container, you can [[howto-convert-an-existing-application-to-spring-boot]] === Convert an Existing Application to Spring Boot -For a non-web application, it should be easy to convert an existing Spring application to a Spring Boot application. -To do so, throw away the code that creates your `ApplicationContext` and replace it with calls to `SpringApplication` or `SpringApplicationBuilder`. +To convert an existing non-web Spring application to a Spring Boot application, replace the code that creates your `ApplicationContext` and replace it with calls to `SpringApplication` or `SpringApplicationBuilder`. Spring MVC web applications are generally amenable to first creating a deployable war application and then migrating it later to an executable war or jar. See the https://spring.io/guides/gs/convert-jar-to-war/[Getting Started Guide on Converting a jar to a war]. @@ -2809,7 +2806,7 @@ If you have other features in your application (for instance, using other servle * A `@Bean` of type `Servlet` or `ServletRegistrationBean` installs that bean in the container as if it were a `` and `` in `web.xml`. * A `@Bean` of type `Filter` or `FilterRegistrationBean` behaves similarly (as a `` and ``). * An `ApplicationContext` in an XML file can be added through an `@ImportResource` in your `Application`. - Alternatively, simple cases where annotation configuration is heavily used already can be recreated in a few lines as `@Bean` definitions. + Alternatively, cases where annotation configuration is heavily used already can be recreated in a few lines as `@Bean` definitions. Once the war file is working, you can make it executable by adding a `main` method to your `Application`, as shown in the following example: @@ -2913,7 +2910,7 @@ You can do so by adding a `WEB-INF/weblogic.xml` file with the following content === Use Jedis Instead of Lettuce By default, the Spring Boot starter (`spring-boot-starter-data-redis`) uses https://github.com/lettuce-io/lettuce-core/[Lettuce]. You need to exclude that dependency and include the https://github.com/xetorthio/jedis/[Jedis] one instead. -Spring Boot manages these dependencies to help make this process as easy as possible. +Spring Boot manages both of these dependencies so you can switch to Jedis without specifying a version. The following example shows how to do so in Maven: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc index a7488c79ddf..9a8b398baa2 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/production-ready-features.adoc @@ -11,7 +11,7 @@ Auditing, health, and metrics gathering can also be automatically applied to you [[production-ready-enabling]] == Enabling Production-ready Features The {spring-boot-code}/spring-boot-project/spring-boot-actuator[`spring-boot-actuator`] module provides all of Spring Boot's production-ready features. -The simplest way to enable the features is to add a dependency to the `spring-boot-starter-actuator` '`Starter`'. +The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` '`Starter`'. .Definition of Actuator **** @@ -2178,7 +2178,7 @@ You can also add any number of `tag=KEY:VALUE` query parameters to the end of th ==== The reported measurements are the _sum_ of the statistics of all meters matching the meter name and any tags that have been applied. So in the example above, the returned "Value" statistic is the sum of the maximum memory footprints of "Code Cache", "Compressed Class Space", and "Metaspace" areas of the heap. -If you just wanted to see the maximum size for the "Metaspace", you could add an additional `tag=id:Metaspace`, i.e. `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`. +If you only wanted to see the maximum size for the "Metaspace", you could add an additional `tag=id:Metaspace`, i.e. `/actuator/metrics/jvm.memory.max?tag=area:nonheap&tag=id:Metaspace`. ==== diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-cli.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-cli.adoc index ba549b928ed..33fbb59ef58 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-cli.adoc @@ -18,7 +18,7 @@ See _<>_ in the "`Getti [[cli-using-the-cli]] == Using the CLI Once you have installed the CLI, you can run it by typing `spring` and pressing Enter at the command line. -If you run `spring` without any arguments, a simple help screen is displayed, as follows: +If you run `spring` without any arguments, a help screen is displayed, as follows: [indent=0,subs="verbatim,quotes,attributes"] ---- diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc index d2ad49ba0dd..96bdb7a2ab7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/spring-boot-features.adoc @@ -338,7 +338,7 @@ The context can be injected by implementing `ApplicationContextAware` or, if the [[boot-features-web-environment]] === Web Environment A `SpringApplication` attempts to create the right type of `ApplicationContext` on your behalf. -The algorithm used to determine a `WebApplicationType` is fairly simple: +The algorithm used to determine a `WebApplicationType` is the following: * If Spring MVC is present, an `AnnotationConfigServletWebServerApplicationContext` is used * If Spring MVC is not present and Spring WebFlux is present, an `AnnotationConfigReactiveWebServerApplicationContext` is used @@ -387,7 +387,7 @@ This lets you also inject single application arguments by using the `@Value` ann If you need to run some specific code once the `SpringApplication` has started, you can implement the `ApplicationRunner` or `CommandLineRunner` interfaces. Both interfaces work in the same way and offer a single `run` method, which is called just before `SpringApplication.run(...)` completes. -The `CommandLineRunner` interfaces provides access to application arguments as a simple string array, whereas the `ApplicationRunner` uses the `ApplicationArguments` interface discussed earlier. +The `CommandLineRunner` interfaces provides access to application arguments as a string array, whereas the `ApplicationRunner` uses the `ApplicationArguments` interface discussed earlier. The following example shows a `CommandLineRunner` with a `run` method: [source,java,indent=0] @@ -785,7 +785,7 @@ If the `development`, `production` and `eu-central` profiles are *not* enabled, [NOTE] ==== -`spring.profiles` can therefore contain a simple profile name (for example `production`) or a profile expression. +`spring.profiles` can therefore contain a profile name (for example `production`) or a profile expression. A profile expression allows for more complicated profile logic to be expressed, for example `production & (eu-central | eu-west)`. Check the {spring-framework-docs}/core.html#beans-definition-profiles-java[reference guide] for more details. ==== @@ -1466,7 +1466,7 @@ The following units are supported with the simple format: * `w` for weeks * `d` for days -NOTE: The `java.time.Period` type never actually stores the number of weeks, it is simply a shortcut that means "`7 days`". +NOTE: The `java.time.Period` type never actually stores the number of weeks, it is a shortcut that means "`7 days`". @@ -2046,7 +2046,7 @@ If you attempt to do so, making changes to the configuration file results in an The `` tag lets you optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the `` element. Use the `name` attribute to specify which profile accepts the configuration. -The `` tag can contain a simple profile name (for example `staging`) or a profile expression. +The `` tag can contain a profile name (for example `staging`) or a profile expression. A profile expression allows for more complicated profile logic to be expressed, for example `production & (eu-central | eu-west)`. Check the {spring-framework-docs}/core.html#beans-definition-profiles-java[reference guide] for more details. The following listing shows three sample profiles: @@ -2165,7 +2165,7 @@ If you have not yet developed a Spring Boot web application, you can follow the [[boot-features-spring-mvc]] === The "`Spring Web MVC Framework`" -The {spring-framework-docs}/web.html#mvc[Spring Web MVC framework] (often referred to as simply "`Spring MVC`") is a rich "`model view controller`" web framework. +The {spring-framework-docs}/web.html#mvc[Spring Web MVC framework] (often referred to as "`Spring MVC`") is a rich "`model view controller`" web framework. Spring MVC lets you create special `@Controller` or `@RestController` beans to handle incoming HTTP requests. Methods in your controller are mapped to HTTP by using `@RequestMapping` annotations. @@ -2415,7 +2415,7 @@ If you understand the caveats and would still like your application to use suffi spring.mvc.pathmatch.use-suffix-pattern=true ---- -Alternatively, rather than open all suffix patterns, it's more secure to just support registered suffix patterns: +Alternatively, rather than open all suffix patterns, it's more secure to only support registered suffix patterns: [source,properties,indent=0,subs="verbatim,quotes,attributes"] ---- @@ -3360,7 +3360,7 @@ https://oauth.net/2/[OAuth2] is a widely used authorization framework that is su [[boot-features-security-oauth2-client]] ==== Client -If you have `spring-security-oauth2-client` on your classpath, you can take advantage of some auto-configuration to make it easy to set up an OAuth2/Open ID Connect clients. +If you have `spring-security-oauth2-client` on your classpath, you can take advantage of some auto-configuration to set up an OAuth2/Open ID Connect clients. This configuration makes use of the properties under `OAuth2ClientProperties`. The same properties are applicable to both servlet and reactive applications. @@ -3499,7 +3499,7 @@ Until then, you can use the `spring-security-oauth2-autoconfigure` module to eas [[boot-features-security-saml2-relying-party]] ==== Relying Party -If you have `spring-security-saml2-service-provider` on your classpath, you can take advantage of some auto-configuration to make it easy to set up a SAML 2.0 Relying Party. +If you have `spring-security-saml2-service-provider` on your classpath, you can take advantage of some auto-configuration to set up a SAML 2.0 Relying Party. This configuration makes use of the properties under `Saml2RelyingPartyProperties`. A relying party registration represents a paired configuration between an Identity Provider, IDP, and a Service Provider, SP. @@ -3720,8 +3720,8 @@ The `spring-boot-starter-data-jpa` POM provides a quick way to get started. It provides the following key dependencies: * Hibernate: One of the most popular JPA implementations. -* Spring Data JPA: Makes it easy to implement JPA-based repositories. -* Spring ORMs: Core ORM support from the Spring Framework. +* Spring Data JPA: Helps you to implement JPA-based repositories. +* Spring ORM: Core ORM support from the Spring Framework. TIP: We do not go into too many details of JPA or {spring-data}[Spring Data] here. You can follow the https://spring.io/guides/gs/accessing-data-jpa/["`Accessing Data with JPA`"] guide from https://spring.io and read the {spring-data-jpa}[Spring Data JPA] and https://hibernate.org/orm/documentation/[Hibernate] reference documentation. @@ -4908,7 +4908,7 @@ Spring Boot auto-configures the cache infrastructure as long as caching support NOTE: Check the {spring-framework-docs}/integration.html#cache[relevant section] of the Spring Framework reference for more details. -In a nutshell, adding caching to an operation of your service is as easy as adding the relevant annotation to its method, as shown in the following example: +In a nutshell, to add caching to an operation of your service add the relevant annotation to its method, as shown in the following example: [source,java,indent=0] ---- @@ -5662,12 +5662,12 @@ Spring Boot auto-configures the required `KafkaStreamsConfiguration` bean as lon Enabling Kafka Streams means that the application id and bootstrap servers must be set. The former can be configured using `spring.kafka.streams.application-id`, defaulting to `spring.application.name` if not set. -The latter can be set globally or specifically overridden just for streams. +The latter can be set globally or specifically overridden only for streams. Several additional properties are available using dedicated properties; other arbitrary Kafka properties can be set using the `spring.kafka.streams.properties` namespace. See also <> for more information. -To use the factory bean, simply wire `StreamsBuilder` into your `@Bean` as shown in the following example: +To use the factory bean, wire `StreamsBuilder` into your `@Bean` as shown in the following example: [source,java,indent=0] ---- @@ -5903,7 +5903,7 @@ For instance, the following service triggers the validation of the first argumen [[boot-features-email]] == Sending Email -The Spring Framework provides an easy abstraction for sending email by using the `JavaMailSender` interface, and Spring Boot provides auto-configuration for it as well as a starter module. +The Spring Framework provides an abstraction for sending email by using the `JavaMailSender` interface, and Spring Boot provides auto-configuration for it as well as a starter module. TIP: See the {spring-framework-docs}/integration.html#mail[reference documentation] for a detailed explanation of how you can use `JavaMailSender`. @@ -7337,7 +7337,7 @@ The following example shows the `@WebServiceClientTest` annotation in use: [[boot-features-testing-spring-boot-applications-testing-auto-configured-additional-auto-config]] ==== Additional Auto-configuration and Slicing Each slice provides one or more `@AutoConfigure...` annotations that namely defines the auto-configurations that should be included as part of a slice. -Additional auto-configurations can be added by creating a custom `@AutoConfigure...` annotation or simply by adding `@ImportAutoConfiguration` to the test as shown in the following example: +Additional auto-configurations can be added by creating a custom `@AutoConfigure...` annotation or by adding `@ImportAutoConfiguration` to the test as shown in the following example: [source,java,indent=0] ---- @@ -7900,7 +7900,7 @@ Make sure that configuration keys are documented by adding field javadoc for eac } ---- -NOTE: You should only use simple text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON. +NOTE: You should only use plain text with `@ConfigurationProperties` field Javadoc, since they are not processed before being added to the JSON. Here are some rules we follow internally to make sure descriptions are consistent: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc index fb62270ebbd..a78e5e5e037 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using-spring-boot.adoc @@ -304,7 +304,7 @@ The actual contents of those classes, such as nested configuration classes or be [[using-boot-spring-beans-and-dependency-injection]] == Spring Beans and Dependency Injection You are free to use any of the standard Spring Framework techniques to define your beans and their injected dependencies. -For simplicity, we often find that using `@ComponentScan` (to find your beans) and using `@Autowired` (to do constructor injection) works well. +We often find that using `@ComponentScan` (to find your beans) and using `@Autowired` (to do constructor injection) works well. If you structure your code as suggested above (locating your application class in a root package), you can add `@ComponentScan` without any arguments. All of your application components (`@Component`, `@Service`, `@Repository`, `@Controller` etc.) are automatically registered as Spring Beans. @@ -417,7 +417,7 @@ In this example, `Application` is just like any other Spring Boot application ex [[using-boot-running-your-application]] == Running Your Application One of the biggest advantages of packaging your application as a jar and using an embedded HTTP server is that you can run your application as you would any other. -Debugging Spring Boot applications is also easy. +The sample applies to debugging Spring Boot applications. You do not need any special IDE plugins or extensions. NOTE: This section only covers jar based packaging. @@ -427,7 +427,7 @@ If you choose to package your application as a war file, you should refer to you [[using-boot-running-from-an-ide]] === Running from an IDE -You can run a Spring Boot application from your IDE as a simple Java application. +You can run a Spring Boot application from your IDE as a Java application. However, you first need to import your project. Import steps vary depending on your IDE and build system. Most IDEs can import Maven projects directly. @@ -503,7 +503,7 @@ You might also want to use the `JAVA_OPTS` operating system environment variable [[using-boot-hot-swapping]] === Hot Swapping -Since Spring Boot applications are just plain Java applications, JVM hot-swapping should work out of the box. +Since Spring Boot applications are plain Java applications, JVM hot-swapping should work out of the box. JVM hot swapping is somewhat limited with the bytecode that it can replace. For a more complete solution, https://www.jrebel.com/products/jrebel[JRebel] can be used. diff --git a/spring-boot-project/spring-boot-starters/README.adoc b/spring-boot-project/spring-boot-starters/README.adoc index d8e6b2b76e7..0ca5b5636e0 100644 --- a/spring-boot-project/spring-boot-starters/README.adoc +++ b/spring-boot-project/spring-boot-starters/README.adoc @@ -4,7 +4,7 @@ Spring Boot Starters are a set of convenient dependency descriptors that you can in your application. You get a one-stop-shop for all the Spring and related technology that you need without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and -JPA for database access just include the `spring-boot-starter-data-jpa` dependency in +JPA for database access include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go. For complete details see the @@ -12,7 +12,7 @@ https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot == Community Contributions If you create a starter for a technology that is not already in the standard list we can -list it here. Just send a pull request for this page. +list it here. To ask us to do so, please open a pull request that updates this page. WARNING: While the https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter[reference documentation] diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/managing-dependencies.adoc b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/managing-dependencies.adoc index f1c1477556e..60f9c096b65 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/managing-dependencies.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/managing-dependencies.adoc @@ -3,7 +3,7 @@ When you apply the {dependency-management-plugin}[`io.spring.dependency-management`] plugin, Spring Boot's plugin will automatically <> from the version of Spring Boot that you are using. This provides a similar dependency management experience to the one that's enjoyed by Maven users. For example, it allows you to omit version numbers when declaring dependencies that are managed in the bom. -To make use of this functionality, simply declare dependencies in the usual way but omit the version number: +To make use of this functionality, declare dependencies in the usual way but omit the version number: [source,groovy,indent=0,subs="verbatim",role="primary"] .Groovy diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc index 4592591e8fd..1cf342fbcb7 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/packaging.adoc @@ -357,7 +357,7 @@ Again, if you are using `spring-boot-starter-parent`, this can be simplified as [[repackage-example-custom-name]] ==== Custom Name -If you need the repackaged jar to have a different local name than the one defined by the `artifactId` attribute of the project, simply use the standard `finalName`, as shown in the following example: +If you need the repackaged jar to have a different local name than the one defined by the `artifactId` attribute of the project, use the standard `finalName`, as shown in the following example: [source,xml,indent=0,subs="verbatim,attributes"] ----