Re: [PATCH 05/11] quorum: libquorum API documentation (quorum_fd_get)

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Reviewed-by: Steven Dake <sdake@xxxxxxxxxx>

On 01/12/2012 08:17 AM, Fabio M. Di Nitto wrote:
> From: "Fabio M. Di Nitto" <fdinitto@xxxxxxxxxx>
> 
> Signed-off-by: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx>
> ---
> :100644 100644 9c75b72... a18e836... M	man/Makefile.am
> :000000 100644 0000000... b41eba1... A	man/quorum_fd_get.3
>  man/Makefile.am     |    1 +
>  man/quorum_fd_get.3 |   62 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 63 insertions(+), 0 deletions(-)
> 
> diff --git a/man/Makefile.am b/man/Makefile.am
> index 9c75b72..a18e836 100644
> --- a/man/Makefile.am
> +++ b/man/Makefile.am
> @@ -96,6 +96,7 @@ dist_man_MANS = \
>  	evs_context_set.3 \
>  	quorum_initialize.3 \
>  	quorum_finalize.3 \
> +	quorum_fd_get.3 \
>  	votequorum_dispatch.3 \
>  	votequorum_fd_get.3 \
>  	votequorum_context_get.3 \
> diff --git a/man/quorum_fd_get.3 b/man/quorum_fd_get.3
> new file mode 100644
> index 0000000..b41eba1
> --- /dev/null
> +++ b/man/quorum_fd_get.3
> @@ -0,0 +1,62 @@
> +.\"/*
> +.\" * Copyright (c) 2012 Red Hat, Inc.
> +.\" *
> +.\" * All rights reserved.
> +.\" *
> +.\" * Author: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx>
> +.\" *
> +.\" * This software licensed under BSD license, the text of which follows:
> +.\" *
> +.\" * Redistribution and use in source and binary forms, with or without
> +.\" * modification, are permitted provided that the following conditions are met:
> +.\" *
> +.\" * - Redistributions of source code must retain the above copyright notice,
> +.\" *   this list of conditions and the following disclaimer.
> +.\" * - Redistributions in binary form must reproduce the above copyright notice,
> +.\" *   this list of conditions and the following disclaimer in the documentation
> +.\" *   and/or other materials provided with the distribution.
> +.\" * - Neither the name of the MontaVista Software, Inc. nor the names of its
> +.\" *   contributors may be used to endorse or promote products derived from this
> +.\" *   software without specific prior written permission.
> +.\" *
> +.\" * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
> +.\" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
> +.\" * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
> +.\" * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
> +.\" * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
> +.\" * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
> +.\" * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
> +.\" * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
> +.\" * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
> +.\" * 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"
> +.SH NAME
> +quorum_fd_get \- Dispatches callbacks from the quorum service
> +.SH SYNOPSIS
> +.B #include <corosync/quorum.h>
> +.sp
> +.BI "int quorum_fd_get(quorum_handle_t " handle ", int *" fd ");"
> +.SH DESCRIPTION
> +The
> +.B quorum_fd_get
> +function is used to retrieve the file descriptor that may be used with the poll
> +system call to determine when
> +.B quorum_dispatch(3)
> +won't block.  The
> +.I handle
> +argument may not be used directly with
> +.B poll
> +because it is not the file descriptor, but instead an internal identifier used
> +by the quorum library.
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH ERRORS
> +The errors are undocumented.
> +.SH "SEE ALSO"
> +.BR quorum_initialize (3),
> +.BR quorum_finalize (3),
> +.BR quorum_dispatch (3),
> +.PP

_______________________________________________
discuss mailing list
discuss@xxxxxxxxxxxx
http://lists.corosync.org/mailman/listinfo/discuss


[Index of Archives]     [Linux Clusters]     [Corosync Project]     [Linux USB Devel]     [Linux Audio Users]     [Photo]     [Yosemite News]    [Yosemite Photos]    [Linux Kernel]     [Linux SCSI]     [X.Org]

  Powered by Linux