From 57539d1abc09e5aef322cb9cca5b3e6c496cfae9 Mon Sep 17 00:00:00 2001
From: Jan Friesse <jfriesse@redhat.com>
Date: Thu, 9 Oct 2014 16:19:39 +0200
Subject: [PATCH] man page: Improve description of token timeout
With introduction of token_coefficient, token timeout defined in
configuration file may be no longer reflect real token timeout, what may
be confusing.
Enhanced description hopefully fix that.
Signed-off-by: Jan Friesse <jfriesse@redhat.com>
Reviewed-by: Christine Caulfield <ccaulfie@redhat.com>
---
man/corosync.conf.5 | 8 +++++++-
1 files changed, 7 insertions(+), 1 deletions(-)
diff --git a/man/corosync.conf.5 b/man/corosync.conf.5
index 8fb7a0b..95eca2d 100644
--- a/man/corosync.conf.5
+++ b/man/corosync.conf.5
@@ -280,11 +280,17 @@ by reducing the token timeout.
.TP
token
-This timeout specifies in milliseconds until a token loss is declared after not
+This timeout is used directly or as a base for real token timeout calculation (explained in
+.B token_coefficient
+section). Token timeout specifies in milliseconds until a token loss is declared after not
receiving a token. This is the time spent detecting a failure of a processor
in the current configuration. Reforming a new configuration takes about 50
milliseconds in addition to this timeout.
+For real token timeout used by totem it's possible to read cmap value of
+.B runtime.config.token
+key.
+
The default is 1000 milliseconds.
.TP
--
1.7.1