cluster: STABLE3 - fence_sandbox2: add short and long description for man page generation

[Fabio M. Di Nitto]

Gitweb:        http://git.fedorahosted.org/git/cluster.git?p=cluster.git;a=commitdiff;h=c94...
Commit:        c94dccba0dc1c7835d9797db92d67f5514fae2d8
Parent:        93ccda3ab24e76d3e3bcd8da372e2eee1fc23ce1
Author:        Fabio M. Di Nitto 
AuthorDate:    Tue Oct 20 05:39:52 2009 +0200
Committer:     Fabio M. Di Nitto 
CommitterDate: Tue Oct 20 05:39:52 2009 +0200

fence_sandbox2: add short and long description for man page generation

Signed-off-by: Fabio M. Di Nitto 
---
 fence/agents/sanbox2/Makefile         |    2 ++
 fence/agents/sanbox2/fence_sanbox2.py |    9 ++++++++-
 2 files changed, 10 insertions(+), 1 deletions(-)

diff --git a/fence/agents/sanbox2/Makefile b/fence/agents/sanbox2/Makefile
index bf46fd1..bfc886f 100644
--- a/fence/agents/sanbox2/Makefile
+++ b/fence/agents/sanbox2/Makefile
@@ -2,4 +2,6 @@ include ../../../make/defines.mk

TARGET= fence_sanbox2

+MANTARGET= $(TARGET).8
+
 include $(OBJDIR)/make/fencebuild.mk
diff --git a/fence/agents/sanbox2/fence_sanbox2.py b/fence/agents/sanbox2/fence_sanbox2.py
index 38adaa2..086fe32 100644
--- a/fence/agents/sanbox2/fence_sanbox2.py
+++ b/fence/agents/sanbox2/fence_sanbox2.py
@@ -123,7 +123,14 @@ def main():
    if 0 == options.has_key("-c"):
    	options["-c"] = [ " #> " ]

-	show_docs(options)
+	docs = { }
+	docs["shortdesc"] = "Fence agent for QLogic SANBox2 FC switches"
+	docs["longdesc"] = "fence_sanbox2 is an I/O Fencing agent which can be used with \
+QLogic SANBox2 FC switches.  It logs into a SANBox2 switch via telnet and disables a specified \
+port. Disabling  the port which a machine is connected to effectively fences that machine. \
+Lengthy telnet connections to the switch should be avoided while a GFS cluster is running \
+because the connection will block any necessary fencing actions."
+	show_docs(options, docs)

##
    ## Operate the fencing device