[GitHub] [flink] curcur commented on a change in pull request #14460: [docs/javadoc][hotfix] Explicitly Document task cancellation timeout …

[GitBox <gi...@apache.org>]

curcur commented on a change in pull request #14460:
URL: https://github.com/apache/flink/pull/14460#discussion_r549560865



##########
File path: docs/_includes/generated/all_taskmanager_section.html
##########
@@ -18,7 +18,7 @@
             <td><h5>task.cancellation.timeout</h5></td>
             <td style="word-wrap: break-word;">180000</td>
             <td>Long</td>
-            <td>Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error. A value of 0 deactivates the watch dog.</td>
+            <td>Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error. A value of 0 deactivates the watch dog. Notice that a task cancellation is different from a task failure. So task cancellation timeout does not apply to task closing/clean-up caused by a task failure.</td>

Review comment:
       1. That's true in the sense that `cleanUpInvoke` is called both in the case of a task failure and a clean shutdown. But I thought `task-cancelation-timeout` naturally can not be considered as applied to a clean shutdown? The main confusion in general (and in the ticket FLINK-18983) is that people thought "task-cancelation-timeout" can be applied for "failed tasks" as well.
   
   2. Task cancelation does not always happen "manually", it can happen when a task fails and caused the rest of the tasks canceled by JM. So I would say "task cancelation" instead of saying "manually cancel the job"




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org