From 8d032143897f50b0d444f6984b64ec8083b4da56 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Mon, 1 Jul 2019 11:47:12 -0700 Subject: [PATCH] Import attributes from appendix files See gh-12005 --- spring-boot-project/spring-boot-docs/pom.xml | 3 ++- .../src/main/asciidoc/appendix/application-properties.adoc | 3 +++ .../main/asciidoc/appendix/auto-configuration-classes.adoc | 3 +++ .../src/main/asciidoc/appendix/configuration-metadata.adoc | 3 +++ .../src/main/asciidoc/appendix/dependency-versions.adoc | 5 ++++- .../src/main/asciidoc/appendix/executable-jar-format.adoc | 3 +++ .../src/main/asciidoc/appendix/test-auto-configuration.adoc | 4 +++- 7 files changed, 21 insertions(+), 3 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/pom.xml b/spring-boot-project/spring-boot-docs/pom.xml index 110d16dfe6..c08e49826a 100644 --- a/spring-boot-project/spring-boot-docs/pom.xml +++ b/spring-boot-project/spring-boot-docs/pom.xml @@ -1451,7 +1451,8 @@ - ${project.basedir}/src/ + ${project.basedir}/src + ${project.basedir}/src/main/asciidoc ${project.basedir}/target/generated-resources ${spring-boot-repo} ${github-tag} diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc index 56e6cb95c2..c8b2584037 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc @@ -2,6 +2,9 @@ [appendix] [[common-application-properties]] == Common application properties + +include::{asciidoc-sources-root}/attributes.adoc[] + Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches. This appendix provides a list of common Spring Boot properties and references to the underlying classes that consume diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc index 9511ace998..53f641f824 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc @@ -1,6 +1,9 @@ [appendix] [[auto-configuration-classes]] == Auto-configuration classes + +include::{asciidoc-sources-root}/attributes.adoc[] + Here is a list of all auto-configuration classes provided by Spring Boot, with links to documentation and source code. Remember to also look at the conditions report in your application for more details of which features are switched on. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc index 6d953c37e9..8b437aea60 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc @@ -1,6 +1,9 @@ [appendix] [[configuration-metadata]] == Configuration Metadata + +include::{asciidoc-sources-root}/attributes.adoc[] + Spring Boot jars include metadata files that provide details of all supported configuration properties. The files are designed to let IDE developers offer contextual help and "`code completion`" as users are working with `application.properties` diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc index 0fc8eab8c7..f81c50bd3c 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc @@ -1,9 +1,12 @@ [appendix] [[appendix-dependency-versions]] == Dependency versions + +include::{asciidoc-sources-root}/attributes.adoc[] + The following table provides details of all of the dependency versions that are provided by Spring Boot in its CLI (Command Line Interface), Maven dependency management, and Gradle plugin. When you declare a dependency on one of these artifacts without declaring a version, the version listed in the table is used. -include::{generated-resources-root}/effective-pom.adoc[] \ No newline at end of file +include::{generated-resources-root}/effective-pom.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc index fc15368344..adb8055c51 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc @@ -1,6 +1,9 @@ [appendix] [[executable-jar]] == The Executable Jar Format + +include::{asciidoc-sources-root}/attributes.adoc[] + The `spring-boot-loader` modules lets Spring Boot support executable jar and war files. If you use the Maven plugin or the Gradle plugin, executable jars are automatically generated, and you generally do not need to know the details of how diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc index 6a9f1ad153..9efd04df42 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc @@ -2,7 +2,9 @@ [[test-auto-configuration]] == Test Auto-configuration Annotations +include::{asciidoc-sources-root}/attributes.adoc[] + The following table lists the various `@…Test` annotations that can be used to test slices of your application and the auto-configuration that they import by default: -include::{generated-resources-root}/test-slice-auto-configuration.adoc[] \ No newline at end of file +include::{generated-resources-root}/test-slice-auto-configuration.adoc[]