Github user tzulitai commented on a diff in the pull request:
https://github.com/apache/flink/pull/4684#discussion_r139929465
--- Diff: docs/ops/cli.md ---
@@ -138,17 +138,30 @@ This allows the job to finish processing all inflight
data.
[Savepoints]({{site.baseurl}}/ops/state/savepoints.html) are controlled
via the command line client:
-#### Trigger a savepoint
+#### Trigger a Savepoint
{% highlight bash %}
-./bin/flink savepoint <jobID> [savepointDirectory]
+./bin/flink savepoint <jobId> [savepointDirectory]
{% endhighlight %}
-Returns the path of the created savepoint. You need this path to restore
and dispose savepoints.
+This will trigger a savepoint for the job with ID `jobId`, and returns the
path of the created savepoint. You need this path to restore and dispose
savepoints.
-You can optionally specify a `savepointDirectory` when triggering the
savepoint. If you don't specify one here, you need to configure a default
savepoint directory for the Flink installation (see
[Savepoints]({{site.baseurl}}/ops/state/savepoints.html#configuration)).
-##### Cancel with a savepoint
+Furthermore, you can optionally specify a target file system directory to
store the savepoint in. The directory needs to be accessible by the JobManager.
--- End diff --
Perhaps also mention the option to specify the target path?
---
