Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/5928#discussion_r188549219
--- Diff: docs/ops/state/checkpoints.md ---
@@ -35,60 +35,62 @@ the same semantics as a failure-free execution.
See [Checkpointing]({{ site.baseurl
}}/dev/stream/state/checkpointing.html) for how to enable and
configure checkpoints for your program.
-## Externalized Checkpoints
+## Retain The Checkpoints
Checkpoints are by default not persisted externally and are only used to
resume a job from failures. They are deleted when a program is cancelled.
You can, however, configure periodic checkpoints to be persisted externally
-similarly to [savepoints](savepoints.html). These *externalized
checkpoints*
-write their meta data out to persistent storage and are *not* automatically
-cleaned up when the job fails. This way, you will have a checkpoint around
-to resume from if your job fails.
+similarly to [savepoints](savepoints.html). This way, you will have a
persisted
+checkpoint around to resume from if your job fails.
{% highlight java %}
CheckpointConfig config = env.getCheckpointConfig();
config.enableExternalizedCheckpoints(ExternalizedCheckpointCleanup.RETAIN_ON_CANCELLATION);
{% endhighlight %}
-The `ExternalizedCheckpointCleanup` mode configures what happens with
externalized checkpoints when you cancel the job:
+The `ExternalizedCheckpointCleanup` mode configures what happens with
checkpoints when you cancel the job:
-- **`ExternalizedCheckpointCleanup.RETAIN_ON_CANCELLATION`**: Retain the
externalized checkpoint when the job is cancelled. Note that you have to
manually clean up the checkpoint state after cancellation in this case.
+- **`ExternalizedCheckpointCleanup.RETAIN_ON_CANCELLATION`**: Retain the
checkpoint when the job is cancelled. Note that you have to manually clean up
the checkpoint state after cancellation in this case.
-- **`ExternalizedCheckpointCleanup.DELETE_ON_CANCELLATION`**: Delete the
externalized checkpoint when the job is cancelled. The checkpoint state will
only be available if the job fails.
+- **`ExternalizedCheckpointCleanup.DELETE_ON_CANCELLATION`**: Delete the
checkpoint when the job is cancelled. The checkpoint state will only be
available if the job fails.
### Directory Structure
-Similarly to [savepoints](savepoints.html), an externalized checkpoint
consists
-of a meta data file and, depending on the state back-end, some additional
data
-files. The **target directory** for the externalized checkpoint's meta
data is
-determined from the configuration key `state.checkpoints.dir` which,
currently,
-can only be set via the configuration files.
+Similarly to [savepoints](savepoints.html), an checkpoint consists
--- End diff --
typo: "a checkpoint"
---
