diff options
Diffstat (limited to 'doc/mon/README.txt')
| -rw-r--r-- | doc/mon/README.txt | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/mon/README.txt b/doc/mon/README.txt new file mode 100644 index 000000000..fa1bf791a --- /dev/null +++ b/doc/mon/README.txt @@ -0,0 +1,27 @@ +paxos-call-chain.dot describes to some detail the call chain involved in the +Paxos algorithm, paying special consideration to the messages involved. + +This information is not easily obtainable by Doxygen, as it does not follow +the call chain when messages are involved, since it becomes an async workflow. + +To obtain the graph one should run + + dot -T<format> paxos-call-chain.dot -o paxos-call-chain.<format> + +e.g., + + dot -Tps paxos-call-chain.dot -o paxos-call-chain.ps + +or + + dot -Tpng paxos-call-chain.dot -o paxos-call-chain.png + +It should do the trick. + +Also, for future reference, we consider that: + - boxed nodes refer to the Leader; + - elliptical nodes refer to the Peon; + - diamond shaped nodes refer to state changes; + - dotted lines illustrate a message being sent from the Leader to the Peon, + or vice-versa. + |