Improve javadoc of PreventFurtherStepsException

gsmet · Nov 16, 2022 · 894e341 · 894e341
1 parent 06c80b3
commit 894e341
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/core/runtime/src/main/java/io/quarkus/runtime/PreventFurtherStepsException.java b/core/runtime/src/main/java/io/quarkus/runtime/PreventFurtherStepsException.java
@@ -1,10 +1,12 @@
 package io.quarkus.runtime;
 
 /**
- * When this exception is thrown from a recorder method, then no other recorder steps
- * will be executed.
+ * When this exception is thrown from a runtime init recorder method, then no other recorder steps
+ * will be executed and the application will be terminated.
  * This is likely of very limited use, but it does allow us to boot the application up to a certain point
  * for example in AppCDS generation.
+ * It can also be used for sidecar type scenarios where the sidecar is the same application but only performs
+ * a small part of the bootstrap steps.
  */
 public final class PreventFurtherStepsException extends RuntimeException {
 }