[storm] branch master updated: [STORM-3653] Update javadoc for favored/unfavored nodes in scheduling.

[agresch]

This is an automated email from the ASF dual-hosted git repository.

agresch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/storm.git


The following commit(s) were added to refs/heads/master by this push:
     new 04ee172  [STORM-3653] Update javadoc for favored/unfavored nodes in 
scheduling.
     new a59d82f  Merge pull request #3288 from bipinprasad/storm3653
04ee172 is described below

commit 04ee172f9580cbae2f7974fb98323432b887af3c
Author: Bipin Prasad <bpra...@verizonmedia.com>
AuthorDate: Wed Jun 17 16:10:18 2020 -0500

    [STORM-3653] Update javadoc for favored/unfavored nodes in scheduling.
---
 storm-client/src/jvm/org/apache/storm/Config.java | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/storm-client/src/jvm/org/apache/storm/Config.java 
b/storm-client/src/jvm/org/apache/storm/Config.java
index c27b468..93c5499 100644
--- a/storm-client/src/jvm/org/apache/storm/Config.java
+++ b/storm-client/src/jvm/org/apache/storm/Config.java
@@ -385,12 +385,22 @@ public class Config extends HashMap<String, Object> {
     /**
      * A list of host names that this topology would prefer to be scheduled on 
(no guarantee is given though). This is intended for
      * debugging only.
+     *
+     * <p>Favored nodes are moved to the front of the node selection list.
+     * If the same node is also present in {@link 
#TOPOLOGY_SCHEDULER_UNFAVORED_NODES}
+     * then the node is considered only as a favored node and is removed from 
the unfavored list.
+     * </p>
      */
     @IsStringList
     public static final String TOPOLOGY_SCHEDULER_FAVORED_NODES = 
"topology.scheduler.favored.nodes";
     /**
      * A list of host names that this topology would prefer to NOT be 
scheduled on (no guarantee is given though). This is intended for
      * debugging only.
+     *
+     * <p>Unfavored nodes are moved to the end of the node selection list.
+     * If the same node is also present in {@link 
#TOPOLOGY_SCHEDULER_FAVORED_NODES}
+     * then the node is considered only as a favored node and is removed from 
the unfavored list.
+     * </p>
      */
     @IsStringList
     public static final String TOPOLOGY_SCHEDULER_UNFAVORED_NODES = 
"topology.scheduler.unfavored.nodes";