Merge pull request #3288 from bipinprasad/storm3653
[STORM-3653] Update javadoc for favored/unfavored nodes in scheduling.
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 @@
/**
* 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";
