From 4919683354458efa52debd81141c362ab252268f Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Thu, 3 Feb 2022 15:08:09 -0800 Subject: [PATCH] Use consistent packages for doc samples Closes gh-29646 --- .../src/docs/asciidoc/actuator/endpoints.adoc | 2 +- .../src/docs/asciidoc/configuration-metadata/format.adoc | 2 +- .../spring-boot-docs/src/docs/asciidoc/data/sql.adoc | 2 +- .../docs/asciidoc/features/developing-auto-configuration.adoc | 2 +- .../src/docs/asciidoc/features/external-config.adoc | 4 ++-- .../spring-boot-docs/src/docs/asciidoc/using/devtools.adoc | 2 +- .../src/docs/asciidoc/web/spring-graphql.adoc | 2 +- .../src/docs/asciidoc/web/spring-security.adoc | 4 ++-- .../format/{group => property}/MyProperties.java | 2 +- .../CountryRepository.java | 2 +- .../{validate => validation}/MyProperties.java | 2 +- .../{validate => validation}/nested/MyProperties.java | 2 +- .../springgraphqltests/GreetingControllerTests.java | 2 +- .../{ => using}/devtools/restart/disable/MyApplication.java | 2 +- .../web/graphql/{ => runtimewiring}/GreetingController.java | 2 +- .../security/oauth2/client/MyOAuthClientConfiguration.java | 2 +- .../springwebflux/MyWebFluxSecurityConfiguration.java | 2 +- 17 files changed, 19 insertions(+), 19 deletions(-) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/{group => property}/MyProperties.java (98%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/{repositories => enversrepositories}/CountryRepository.java (98%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/{validate => validation}/MyProperties.java (96%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/{validate => validation}/nested/MyProperties.java (97%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/{ => using}/devtools/restart/disable/MyApplication.java (93%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/{ => runtimewiring}/GreetingController.java (93%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/{features => web}/security/oauth2/client/MyOAuthClientConfiguration.java (94%) rename spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/{features => web}/security/springwebflux/MyWebFluxSecurityConfiguration.java (95%) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc index 73a7bb283d..b7ee3fd026 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc @@ -482,7 +482,7 @@ You can use this to invoke a write operation that takes `String name` and `int c [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/actuator/endpoints/implementingcustom/MyEndpoint.java[tag=write] +include::{docs-java}/actuator/endpoints/implementingcustom/input/../MyEndpoint.java[tag=write] ---- TIP: Because endpoints are technology agnostic, only simple types can be specified in the method signature. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/configuration-metadata/format.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/configuration-metadata/format.adoc index e477628365..2e4c55a4df 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/configuration-metadata/format.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/configuration-metadata/format.adoc @@ -210,7 +210,7 @@ The following example shows how to handle that situation: [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/configurationmetadata/format/group/MyProperties.java[] +include::{docs-java}/configurationmetadata/format/property/MyProperties.java[] ---- NOTE: There is no way to set a `level`. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc index c451577396..daf322fd23 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc @@ -255,7 +255,7 @@ To use Spring Data Envers, make sure your repository extends from `RevisionRepos [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/data/sql/jpaandspringdata/repositories/CountryRepository.java[] +include::{docs-java}/data/sql/jpaandspringdata/enversrepositories/CountryRepository.java[] ---- NOTE: For more details, check the {spring-data-envers-doc}[Spring Data Envers reference documentation]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc index 011781b85a..52e98d7c79 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/features/developing-auto-configuration.adoc @@ -205,7 +205,7 @@ In the following example, we assert that if `MyService` is not present, the auto [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/features/developingautoconfiguration/testing/MyServiceAutoConfigurationTests.java[tag=test-classloader] +include::{docs-java}/features/developingautoconfiguration/testing/overridingclasspath/../MyServiceAutoConfigurationTests.java[tag=test-classloader] ---- 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 5a16943e7d..deb596beb0 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 @@ -1164,7 +1164,7 @@ To do so, ensure that a compliant JSR-303 implementation is on your classpath an [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/validate/MyProperties.java[] +include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/validation/MyProperties.java[] ---- TIP: You can also trigger validation by annotating the `@Bean` method that creates the configuration properties with `@Validated`. @@ -1174,7 +1174,7 @@ The following example builds on the preceding `MyProperties` example: [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/validate/nested/MyProperties.java[] +include::{docs-java}/features/externalconfig/typesafeconfigurationproperties/validation/nested/MyProperties.java[] ---- You can also add a custom Spring `Validator` by creating a bean definition called `configurationPropertiesValidator`. 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 7bac70c26a..eab4a3509b 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 @@ -180,7 +180,7 @@ If you need to _completely_ disable restart support (for example, because it doe [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/devtools/restart/disable/MyApplication.java[] +include::{docs-java}/using/devtools/restart/disable/MyApplication.java[] ---- diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-graphql.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-graphql.adoc index e197774c32..dc23080631 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-graphql.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-graphql.adoc @@ -56,7 +56,7 @@ Here's a sample implementation for our greeting query with a `@Controller` class [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/web/graphql/GreetingController.java[] +include::{docs-java}/web/graphql/runtimewiring/GreetingController.java[] ---- diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc index 5a098d7173..0a1ea2546e 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/spring-security.adoc @@ -62,7 +62,7 @@ For example, you can customize your security configuration by adding something l [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/features/security/springwebflux/MyWebFluxSecurityConfiguration.java[] +include::{docs-java}/web/security/springwebflux/MyWebFluxSecurityConfiguration.java[] ---- @@ -141,7 +141,7 @@ For example, for servlet applications, you can add your own `SecurityFilterChain [source,java,indent=0,subs="verbatim"] ---- -include::{docs-java}/features/security/oauth2/client/MyOAuthClientConfiguration.java[] +include::{docs-java}/web/security/oauth2/client/MyOAuthClientConfiguration.java[] ---- TIP: Spring Boot auto-configures an `InMemoryOAuth2AuthorizedClientService` which is used by Spring Security for the management of client registrations. diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/group/MyProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/property/MyProperties.java similarity index 98% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/group/MyProperties.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/property/MyProperties.java index 100d19bb63..3cfd108a72 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/group/MyProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/configurationmetadata/format/property/MyProperties.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.configurationmetadata.format.group; +package org.springframework.boot.docs.configurationmetadata.format.property; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.DeprecatedConfigurationProperty; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/repositories/CountryRepository.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/enversrepositories/CountryRepository.java similarity index 98% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/repositories/CountryRepository.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/enversrepositories/CountryRepository.java index 66bccc4955..01a10a651a 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/repositories/CountryRepository.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/data/sql/jpaandspringdata/enversrepositories/CountryRepository.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.data.sql.jpaandspringdata.repositories; +package org.springframework.boot.docs.data.sql.jpaandspringdata.enversrepositories; import org.springframework.boot.docs.data.sql.jpaandspringdata.entityclasses.Country; import org.springframework.data.domain.Page; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/MyProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/MyProperties.java similarity index 96% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/MyProperties.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/MyProperties.java index 138b8d4ecc..50df92cf8f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/MyProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/MyProperties.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.features.externalconfig.typesafeconfigurationproperties.validate; +package org.springframework.boot.docs.features.externalconfig.typesafeconfigurationproperties.validation; import java.net.InetAddress; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/nested/MyProperties.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/nested/MyProperties.java similarity index 97% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/nested/MyProperties.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/nested/MyProperties.java index fd87eeaf46..0f4e421856 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validate/nested/MyProperties.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/externalconfig/typesafeconfigurationproperties/validation/nested/MyProperties.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.features.externalconfig.typesafeconfigurationproperties.validate.nested; +package org.springframework.boot.docs.features.externalconfig.typesafeconfigurationproperties.validation.nested; import java.net.InetAddress; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/testing/springbootapplications/springgraphqltests/GreetingControllerTests.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/testing/springbootapplications/springgraphqltests/GreetingControllerTests.java index 1812730aca..e798e73df3 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/testing/springbootapplications/springgraphqltests/GreetingControllerTests.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/testing/springbootapplications/springgraphqltests/GreetingControllerTests.java @@ -19,7 +19,7 @@ package org.springframework.boot.docs.features.testing.springbootapplications.sp import org.junit.jupiter.api.Test; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.boot.docs.web.graphql.GreetingController; +import org.springframework.boot.docs.web.graphql.runtimewiring.GreetingController; import org.springframework.boot.test.autoconfigure.graphql.GraphQlTest; import org.springframework.graphql.test.tester.GraphQlTester; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/devtools/restart/disable/MyApplication.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/using/devtools/restart/disable/MyApplication.java similarity index 93% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/devtools/restart/disable/MyApplication.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/using/devtools/restart/disable/MyApplication.java index 44bc253f1a..cdfadc6ed4 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/devtools/restart/disable/MyApplication.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/using/devtools/restart/disable/MyApplication.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.devtools.restart.disable; +package org.springframework.boot.docs.using.devtools.restart.disable; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/GreetingController.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/runtimewiring/GreetingController.java similarity index 93% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/GreetingController.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/runtimewiring/GreetingController.java index 99566d9512..8e720a89a8 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/GreetingController.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/graphql/runtimewiring/GreetingController.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.web.graphql; +package org.springframework.boot.docs.web.graphql.runtimewiring; import org.springframework.graphql.data.method.annotation.Argument; import org.springframework.graphql.data.method.annotation.QueryMapping; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/oauth2/client/MyOAuthClientConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/oauth2/client/MyOAuthClientConfiguration.java similarity index 94% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/oauth2/client/MyOAuthClientConfiguration.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/oauth2/client/MyOAuthClientConfiguration.java index 6e15db5f2e..335e8a1313 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/oauth2/client/MyOAuthClientConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/oauth2/client/MyOAuthClientConfiguration.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.features.security.oauth2.client; +package org.springframework.boot.docs.web.security.oauth2.client; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; diff --git a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/springwebflux/MyWebFluxSecurityConfiguration.java b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/springwebflux/MyWebFluxSecurityConfiguration.java similarity index 95% rename from spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/springwebflux/MyWebFluxSecurityConfiguration.java rename to spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/springwebflux/MyWebFluxSecurityConfiguration.java index 05dca638ec..f5429b6511 100644 --- a/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/features/security/springwebflux/MyWebFluxSecurityConfiguration.java +++ b/spring-boot-project/spring-boot-docs/src/main/java/org/springframework/boot/docs/web/security/springwebflux/MyWebFluxSecurityConfiguration.java @@ -14,7 +14,7 @@ * limitations under the License. */ -package org.springframework.boot.docs.features.security.springwebflux; +package org.springframework.boot.docs.web.security.springwebflux; import org.springframework.boot.autoconfigure.security.reactive.PathRequest; import org.springframework.context.annotation.Bean;