File tree Expand file tree Collapse file tree
aeron-driver/src/main/java/io/aeron/driver Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -64,8 +64,8 @@ public final class Configuration
6464 public static final String DIR_WARN_IF_EXISTS_PROP_NAME = "aeron.dir.warn.if.exists" ;
6565
6666 /**
67- * Should driver attempt to an immediate forced delete of {@link CommonContext#AERON_DIR_PROP_NAME} on start
68- * if it exists.
67+ * Should the Media Driver attempt to immediately delete the directory {@link CommonContext#AERON_DIR_PROP_NAME}
68+ * on start if it exists before performing any additional checks .
6969 */
7070 public static final String DIR_DELETE_ON_START_PROP_NAME = "aeron.dir.delete.on.start" ;
7171
Original file line number Diff line number Diff line change @@ -814,8 +814,10 @@ public Context warnIfDirectoryExists(final boolean warnIfDirectoryExists)
814814
815815 /**
816816 * Will the driver attempt to immediately delete {@link #aeronDirectoryName()} on startup.
817+ * WARNING: {@link #aeronDirectoryName()} will be recreated regardless, unless set to false
818+ * and an active Media Driver is detected.
817819 *
818- * @return true when directory will be deleted , otherwise false.
820+ * @return true when directory will be recreated without checks , otherwise false.
819821 * @see Configuration#DIR_DELETE_ON_START_PROP_NAME
820822 */
821823 public boolean dirDeleteOnStart ()
@@ -825,8 +827,10 @@ public boolean dirDeleteOnStart()
825827
826828 /**
827829 * Should the driver attempt to immediately delete {@link #aeronDirectoryName()} on startup.
830+ * WARNING: {@link #aeronDirectoryName()} will be recreated regardless, unless set to false
831+ * and an active Media Driver is detected.
828832 *
829- * @param dirDeleteOnStart Attempt deletion.
833+ * @param dirDeleteOnStart Attempt deletion without checks .
830834 * @return this for a fluent API.
831835 * @see Configuration#DIR_DELETE_ON_START_PROP_NAME
832836 */
You can’t perform that action at this time.
0 commit comments