1
0
mirror of https://github.com/samba-team/samba.git synced 2025-07-29 15:42:04 +03:00

KCC: improve docstring for kcc.graph.get_spanning_tree_edges()

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
This commit is contained in:
Douglas Bagnall
2015-05-01 15:06:22 +12:00
committed by Andrew Bartlett
parent 9af0a067f0
commit f8a68af6ff

View File

@ -109,6 +109,14 @@ def combine_repl_info(info_a, info_b, info_c):
def get_spanning_tree_edges(graph, my_site, label=None, verify=False,
dot_file_dir=None):
"""Find edges for the intersite graph
:param graph: a kcc.kcc_utils.Graph object
:param my_site: the topology generator's site
:param label: a label for use in dot files and verification
:param verify: if True, try to verify that graph properties are correct
:param dot_file_dir: if not None, write Graphviz dot files here
"""
# Phase 1: Run Dijkstra's to get a list of internal edges, which are
# just the shortest-paths connecting colored vertices