[hotfix] Improve execution.checkpointing.unaligned.interruptible-time…

…rs.enabled documentation
Gerrrr · Jun 14, 2024 · 6f47913 · 6f47913
1 parent 6c05981
commit 6f47913
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/layouts/shortcodes/generated/checkpointing_configuration.html b/docs/layouts/shortcodes/generated/checkpointing_configuration.html
@@ -174,7 +174,7 @@
             <td><h5>execution.checkpointing.unaligned.interruptible-timers.enabled</h5></td>
             <td style="word-wrap: break-word;">false</td>
             <td>Boolean</td>
-            <td>Allows unaligned checkpoints to skip timers that are currently being fired.</td>
+            <td>Allows unaligned checkpoints to skip timers that are currently being fired. For this feature to be enabled, it must be also supported by the operator. Currently this is supported by all TableStreamOperators and CepOperator.</td>
         </tr>
         <tr>
             <td><h5>execution.checkpointing.unaligned.max-subtasks-per-channel-state-file</h5></td>

diff --git a/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/CheckpointingOptions.java
@@ -649,7 +649,9 @@ public class CheckpointingOptions {
                     .booleanType()
                     .defaultValue(false)
                     .withDescription(
-                            "Allows unaligned checkpoints to skip timers that are currently being fired.");
+                            "Allows unaligned checkpoints to skip timers that are currently being fired."
+                                    + " For this feature to be enabled, it must be also supported by the operator."
+                                    + " Currently this is supported by all TableStreamOperators and CepOperator.");
 
     public static final ConfigOption<Boolean> ENABLE_CHECKPOINTS_AFTER_TASKS_FINISH =
             ConfigOptions.key("execution.checkpointing.checkpoints-after-tasks-finish")