ArC: clarify the description of quarkus.arc.context-propagation.enabled

- fixes #34123
quarkusio · Dec 14, 2023 · b2e5cce · b2e5cce
1 parent 5290dc7
commit b2e5cce
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/...s/arc/deployment/src/main/java/io/quarkus/arc/deployment/ArcContextPropagationConfig.java b/...s/arc/deployment/src/main/java/io/quarkus/arc/deployment/ArcContextPropagationConfig.java
@@ -7,8 +7,14 @@
 public class ArcContextPropagationConfig {
 
     /**
-     * If set to true and SmallRye Context Propagation extension is present then enable the context propagation for CDI
+     * If set to true and the SmallRye Context Propagation extension is present then the CDI contexts will be propagated by
+     * means of the MicroProfile Context Propagation API. Specifically, a
+     * {@link org.eclipse.microprofile.context.spi.ThreadContextProvider} implementation is registered.
+     * 
+     * On the other hand, if set to false then the MicroProfile Context Propagation API will never be used to propagate the CDI
      * contexts.
+     * 
+     * Note that the CDI contexts may be propagated in a different way though. For example with the Vertx duplicated context.
      */
     @ConfigItem(defaultValue = "true")
     public boolean enabled;