Clarify property docs. Fixes #1264

spring-cloud · Sep 8, 2023 · ea1fc56 · ea1fc56
1 parent db4a1bb
commit ea1fc56
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc
@@ -5,7 +5,7 @@
 |spring.cloud.compatibility-verifier.enabled | `+++false+++` | Enables creation of Spring Cloud compatibility verification.
 |spring.cloud.config.allow-override | `+++true+++` | Flag to indicate that {@link #isOverrideSystemProperties() systemPropertiesOverride} can be used. Set to false to prevent users from changing the default accidentally. Default true.
 |spring.cloud.config.initialize-on-context-refresh | `+++false+++` | Flag to initialize bootstrap configuration on context refresh event. Default false.
-|spring.cloud.config.override-none | `+++false+++` | Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false.
+|spring.cloud.config.override-none | `+++false+++` | Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is true, external properties should take lowest priority and should not override any existing property sources (including local config files). Default false. This will only have an effect when using config first bootstrap.
 |spring.cloud.config.override-system-properties | `+++true+++` | Flag to indicate that the external properties should override system properties. Default true.
 |spring.cloud.decrypt-environment-post-processor.enabled | `+++true+++` | Enable the DecryptEnvironmentPostProcessor.
 |spring.cloud.discovery.client.composite-indicator.enabled | `+++true+++` | Enables discovery client composite health indicator.

diff --git a/...in/java/org/springframework/cloud/bootstrap/config/PropertySourceBootstrapProperties.java b/...in/java/org/springframework/cloud/bootstrap/config/PropertySourceBootstrapProperties.java
@@ -42,7 +42,8 @@ public class PropertySourceBootstrapProperties {
 	/**
 	 * Flag to indicate that when {@link #setAllowOverride(boolean) allowOverride} is
 	 * true, external properties should take lowest priority and should not override any
-	 * existing property sources (including local config files). Default false.
+	 * existing property sources (including local config files). Default false. This will
+	 * only have an effect when using config first bootstrap.
 	 */
 	private boolean overrideNone = false;