Преглед на файлове

man: hook quorum and votequorum devel man pages with genman script

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
Reviewed-by: Steven Dake <sdake@redhat.com>
Fabio M. Di Nitto преди 14 години
родител
ревизия
7e6ad73ebf

+ 2 - 2
man/quorum_context_get.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_CONTEXT_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_CONTEXT_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_context_get \- Gets the context variable for a QUORUM instance
 .SH SYNOPSIS
@@ -47,7 +47,7 @@ function is used to retrieve the context variable previously stored using
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_finalize (3),

+ 2 - 2
man/quorum_context_set.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_CONTEXT_SET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_CONTEXT_SET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_context_set \- Sets the context variable for a QUORUM instance
 .SH SYNOPSIS
@@ -49,7 +49,7 @@ be retrieved using
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_finalize (3),

+ 2 - 2
man/quorum_dispatch.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_DISPATCH 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_DISPATCH 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_dispatch \- Dispatches callbacks from the quorum service
 .SH SYNOPSIS
@@ -90,7 +90,7 @@ CS_ERR_TRY_AGAIN is returned.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_finalize (3),

+ 2 - 2
man/quorum_fd_get.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_FD_GET 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_FD_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_fd_get \- Dispatches callbacks from the quorum service
 .SH SYNOPSIS
@@ -54,7 +54,7 @@ by the quorum library.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_finalize (3),

+ 2 - 2
man/quorum_finalize.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_FINALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_FINALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_finalize \- Terminate a connection to the quorum service
 .SH SYNOPSIS
@@ -50,7 +50,7 @@ No more callbacks will be dispatched from the
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_dispatch (3),

+ 2 - 2
man/quorum_getquorate.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_GETQUORATE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_GETQUORATE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_getquorate \- Gets the quorate status of the node.
 .SH SYNOPSIS
@@ -47,7 +47,7 @@ is not part of a quorate partition or 1 otherwise.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_initialize (3),
 .BR quorum_finalize (3),

+ 2 - 5
man/quorum_initialize.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH QUORUM_INITIALIZE 3 2012-01-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH QUORUM_INITIALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 quorum_initialize \- Create a new connection to the Quorum service
 .SH SYNOPSIS
@@ -116,11 +116,8 @@ function.
 .SH RETURN VALUE
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
-.SH BUGS
-Callbacks are not support at the moment.
-.PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR quorum_finalize (3),
 .BR quorum_fd_get (3),

+ 3 - 3
man/votequorum_context_get.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2007 Red Hat, Inc.
+.\" * Copyright (c) 2007,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_CONTEXT_GET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_CONTEXT_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_context_get \- Gets the context variable for a VOTEQUORUM instance
 .SH SYNOPSIS
@@ -47,7 +47,7 @@ function is used to retrieve the context variable previously stored using
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_initialize (3),
 .BR votequorum_finalize (3),

+ 3 - 3
man/votequorum_context_set.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2007 Red Hat, Inc.
+.\" * Copyright (c) 2007,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_CONTEXT_SET 3 2004-08-31 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_CONTEXT_SET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_context_set \- Sets the context variable for a VOTEQUORUM instance
 .SH SYNOPSIS
@@ -49,7 +49,7 @@ be retrieved using
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_initialize (3),
 .BR votequorum_finalize (3),

+ 3 - 3
man/votequorum_dispatch.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_DISPATCH 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_DISPATCH 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_dispatch \- Dispatches callbacks from the votequorum service
 .SH SYNOPSIS
@@ -90,7 +90,7 @@ CS_ERR_TRY_AGAIN is returned.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 3 - 3
man/votequorum_fd_get.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_FD_GET 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_FD_GET 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_fd_get \- Dispatches callbacks from the votequorum service
 .SH SYNOPSIS
@@ -54,7 +54,7 @@ by the votequorum library.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 3 - 3
man/votequorum_finalize.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_FINALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_FINALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_finalize \- Terminate a connection to the votequorum service
 .SH SYNOPSIS
@@ -50,7 +50,7 @@ No more callbacks will be dispatched from the
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 3 - 6
man/votequorum_getinfo.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_GETINFO 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_GETINFO 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_getinfo \- Get information about the VoteQuorum service
 .SH SYNOPSIS
@@ -80,11 +80,8 @@ general to the voting system.
 .SH RETURN VALUE
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
-.SH BUGS
-Callbacks are not support at the moment.
-.PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_finalize (3),

+ 3 - 7
man/votequorum_initialize.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_INITIALIZE 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_INITIALIZE 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_initialize \- Create a new connection to the VoteQuorum service
 .SH SYNOPSIS
@@ -92,12 +92,8 @@ function.
 .PP
 .SH RETURN VALUE
 This call returns the CS_OK value if successful, otherwise an error is returned.
-.PP
-.SH BUGS
-Callbacks are not support at the moment.
-.PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_finalize (3),

+ 2 - 2
man/votequorum_qdevice_getinfo.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_QDEVICE_GETINFO 3 2012-01-27 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_QDEVICE_GETINFO 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_qdevice_getinfo \- Get details of the quorum device
 .SH SYNOPSIS
@@ -67,7 +67,7 @@ struct votequorum_qdevice_info {
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 2 - 2
man/votequorum_qdevice_poll.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_QDEVICE_POLL 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_QDEVICE_POLL 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_qdevice_poll \- Tells votequorum the result of the quorum device poll
 .SH SYNOPSIS
@@ -56,7 +56,7 @@ quorum.quorumdev_poll.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 2 - 2
man/votequorum_qdevice_register.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_QDEVICE_REGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_QDEVICE_REGISTER 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_qdevice_register \- Registers a new quorum device
 .SH SYNOPSIS
@@ -55,7 +55,7 @@ to keep all nodes informed of the quorum device status.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 2 - 2
man/votequorum_qdevice_unregister.3.in

@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_QDEVICE_UNREGISTER 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_QDEVICE_UNREGISTER 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_qdevice_unregister \- Unregisters a new quorum device
 .SH SYNOPSIS
@@ -47,7 +47,7 @@ make the cluster inquorate.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 3 - 3
man/votequorum_setexpected.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_SETEXPECTED 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_SETEXPECTED 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_setexpected \- Sets the expected votes for the cluster
 .SH SYNOPSIS
@@ -50,7 +50,7 @@ It is not possible to set expected votes up so that it makes the cluster inquora
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),

+ 3 - 3
man/votequorum_setvotes.3.in

@@ -1,5 +1,5 @@
 .\"/*
-.\" * Copyright (c) 2009 Red Hat, Inc.
+.\" * Copyright (c) 2009,2012 Red Hat, Inc.
 .\" *
 .\" * All rights reserved.
 .\" *
@@ -31,7 +31,7 @@
 .\" * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 .\" * THE POSSIBILITY OF SUCH DAMAGE.
 .\" */
-.TH VOTEQUORUM_VOTES 3 2009-01-26 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
+.TH VOTEQUORUM_VOTES 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 votequorum_setvotes \- Sets the number of votes for a node
 .SH SYNOPSIS
@@ -47,7 +47,7 @@ to change the number of node votes such that the cluster goes inquorate.
 This call returns the CS_OK value if successful, otherwise an error is returned.
 .PP
 .SH ERRORS
-The errors are undocumented.
+@COMMONIPCERRORS@
 .SH "SEE ALSO"
 .BR votequorum_overview (8),
 .BR votequorum_initialize (3),