Update docs

xdev-software · Jul 5, 2024 · 24b116e · 24b116e
1 parent 4e70fc9
commit 24b116e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/tci-base/src/main/java/software/xdev/tci/factory/prestart/PreStartableTCIFactory.java b/tci-base/src/main/java/software/xdev/tci/factory/prestart/PreStartableTCIFactory.java
@@ -48,7 +48,10 @@
 /**
  * A PreStarting-able implementation of {@link software.xdev.tci.factory.TCIFactory}.
  * <h3>What is PreStarting?</h3>
- * When running tests usually there are certain times when the available resources are barely utilized.
+ * <p>
+ * When running tests usually there are certain times when the available resources are barely utilized:
+ * <img src="https://raw.githubusercontent.com/xdev-software/tci-base/develop/assets/PreStartingCauseIdea.png"></img>
+ * </p>
  * <p>
  * PreStarting uses a "cached" pool of infrastructure and tries to utilizes these idle times to fill/replenish this
  * pool.<br/> So that when new infrastructure is requested there is no need to wait for the creation of it and use the

diff --git a/tci-base/src/main/java/software/xdev/tci/factory/prestart/config/DefaultPreStartConfig.java b/tci-base/src/main/java/software/xdev/tci/factory/prestart/config/DefaultPreStartConfig.java
@@ -21,7 +21,14 @@
 
 
 /**
- * Default implementation of {@link PreStartConfig} using system properties.
+ * Default implementation of {@link PreStartConfig} using {@link System#getProperties() System Properties}.
+ * <p>
+ * Properties can be defined in the following way:
+ * <pre>
+ * -Dinfra-pre-start.keep-ready=2
+ * -Dcoordinator.idle-cpu-percent=50
+ * </pre>
+ * </p>
  */
 public class DefaultPreStartConfig implements PreStartConfig
 {