reachable: Update documentation on reachable function

wckzhang · wckzhang · commit 25c043833ac4 · 2019-11-14T19:32:17.000Z
We have decided to show interfaces that are identical to itself as
reachable through loopback. This is consistent with the previous netmask
logic when determining reachability.

Signed-off-by: William Zhang &lt;wilzhang@amazon.com&gt;
diff --git a/opal/mca/reachable/reachable.h b/opal/mca/reachable/reachable.h
@@ -75,6 +75,8 @@ typedef int (*opal_reachable_base_module_fini_fn_t)(void);
  * interfaces, but only a (comparable) reachability between any pair
  * of local/remote interfaces.
  *
+ * This function will show an identical local and remote interface as
+ * reachable through loopback.
  *
  */
 typedef opal_reachable_t*

Original file line number	Diff line number	Diff line change
`@@ -75,6 +75,8 @@ typedef int (*opal_reachable_base_module_fini_fn_t)(void);`
`75`	`75`	`* interfaces, but only a (comparable) reachability between any pair`
`76`	`76`	`* of local/remote interfaces.`
`77`	`77`	`*`
	`78`	`+ * This function will show an identical local and remote interface as`
	`79`	`+ * reachable through loopback.`
`78`	`80`	`*`
`79`	`81`	`*/`
`80`	`82`	`typedef opal_reachable_t*`