Merge pull request #7 from jglick/CpsThreadDump-JENKINS-31842

[JENKINS-31842] Thread dump improvements
jenkinsci · Jun 29, 2016 · fcfd111 · fcfd111
2 parents 2f20fe1 + 3705e3f
commit fcfd111
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/src/main/java/org/jenkinsci/plugins/workflow/pickles/Pickle.java b/src/main/java/org/jenkinsci/plugins/workflow/pickles/Pickle.java
@@ -50,6 +50,7 @@ public ListenableFuture<?> rehydrate() {
      * An implementation should return quickly and avoid acquiring locks in this method itself (as opposed to the future).
      * {@link ListenableFuture#cancel} should be implemented if possible.
      * @param owner an owner handle on which you may, for example, call {@link FlowExecutionOwner#getListener}
+     * @return a future on which {@link ListenableFuture#cancel} might be called; also polite to override {@link ListenableFuture#toString} for diagnostics
      */
     public ListenableFuture<?> rehydrate(FlowExecutionOwner owner) {
         if (Util.isOverridden(Pickle.class, getClass(), "rehydrate")) {