Re: [PATCH 6/7] man: add *quorum_track* devel man pages

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




Reviewed-by: Steven Dake <sdake@xxxxxxxxxx>

Does this require spec.in changes?


On 02/09/2012 05:28 AM, Fabio M. Di Nitto wrote:
> From: "Fabio M. Di Nitto" <fdinitto@xxxxxxxxxx>
> 
> Signed-off-by: Fabio M. Di Nitto <fdinitto@xxxxxxxxxx>
> ---
> :100644 100644 057cef0... 18329b2... M	man/Makefile.am
> :000000 100644 0000000... ec37e72... A	man/quorum_trackstart.3.in
> :000000 100644 0000000... 19fe922... A	man/quorum_trackstop.3.in
> :000000 100644 0000000... 460df53... A	man/votequorum_trackstart.3.in
> :000000 100644 0000000... aeebb17... A	man/votequorum_trackstop.3.in
>  man/Makefile.am                |    4 ++
>  man/quorum_trackstart.3.in     |   64 ++++++++++++++++++++++++++++++++++++++++
>  man/quorum_trackstop.3.in      |   57 +++++++++++++++++++++++++++++++++++
>  man/votequorum_trackstart.3.in |   64 ++++++++++++++++++++++++++++++++++++++++
>  man/votequorum_trackstop.3.in  |   57 +++++++++++++++++++++++++++++++++++
>  5 files changed, 246 insertions(+), 0 deletions(-)
> 
> diff --git a/man/Makefile.am b/man/Makefile.am
> index 057cef0..18329b2 100644
> --- a/man/Makefile.am
> +++ b/man/Makefile.am
> @@ -74,6 +74,8 @@ autogen_man		= cpg_context_get.3 \
>  			  quorum_context_get.3 \
>  			  quorum_context_set.3 \
>  			  quorum_getquorate.3 \
> +			  quorum_trackstart.3 \
> +			  quorum_trackstop.3 \
>  			  votequorum_dispatch.3 \
>  			  votequorum_fd_get.3 \
>  			  votequorum_context_get.3 \
> @@ -87,6 +89,8 @@ autogen_man		= cpg_context_get.3 \
>  			  votequorum_qdevice_unregister.3 \
>  			  votequorum_setexpected.3 \
>  			  votequorum_setvotes.3 \
> +			  votequorum_trackstart.3 \
> +			  votequorum_trackstop.3 \
>  			  sam_data_getsize.3 \
>  			  sam_data_restore.3 \
>  			  sam_data_store.3 \
> diff --git a/man/quorum_trackstart.3.in b/man/quorum_trackstart.3.in
> new file mode 100644
> index 0000000..ec37e72
> --- /dev/null
> +++ b/man/quorum_trackstart.3.in
> @@ -0,0 +1,64 @@
> +.\"/*
> +.\" * 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_TRACKSTART 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +quorum_trackstart \- Enable callbacks notification.
> +.SH SYNOPSIS
> +.B #include <corosync/quorum.h>
> +.sp
> +.BI "int quorum_trackstart(quorum_handle_t *" handle ", unsigned int " flags ");
> +.SH DESCRIPTION
> +The
> +.B quorum_trackstart
> +function is used to enable callbacks notification from the quorum API.
> +.PP
> +Every time the voting configuraton changes (eg a node joins or leave the cluster)
> +or the quorum status change, the notification is queued.
> +.PP
> +The notification is dispatched via
> +.B quorum_dispatch()
> +function that will execute the callback.
> +.PP
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH ERRORS
> +@COMMONIPCERRORS@
> +.SH "SEE ALSO"
> +.BR quorum_initialize (3),
> +.BR quorum_finalize (3),
> +.BR quorum_fd_get (3),
> +.BR quorum_dispatch (3),
> +.BR quorum_trackstop (3),
> +.PP
> diff --git a/man/quorum_trackstop.3.in b/man/quorum_trackstop.3.in
> new file mode 100644
> index 0000000..19fe922
> --- /dev/null
> +++ b/man/quorum_trackstop.3.in
> @@ -0,0 +1,57 @@
> +.\"/*
> +.\" * 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_TRACKSTOP 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +quorum_trackstop \- Disable callbacks notification.
> +.SH SYNOPSIS
> +.B #include <corosync/quorum.h>
> +.sp
> +.BI "int quorum_trackstart(quorum_handle_t *" handle ");
> +.SH DESCRIPTION
> +The
> +.B quorum_trackstop
> +function is used to disable callbacks notification from the quorum API.
> +.PP
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH ERRORS
> +@COMMONIPCERRORS@
> +.SH "SEE ALSO"
> +.BR quorum_initialize (3),
> +.BR quorum_finalize (3),
> +.BR quorum_fd_get (3),
> +.BR quorum_dispatch (3),
> +.BR quorum_trackstart (3),
> +.PP
> diff --git a/man/votequorum_trackstart.3.in b/man/votequorum_trackstart.3.in
> new file mode 100644
> index 0000000..460df53
> --- /dev/null
> +++ b/man/votequorum_trackstart.3.in
> @@ -0,0 +1,64 @@
> +.\"/*
> +.\" * 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 VOTEQUORUM_TRACKSTART 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +votequorum_trackstart \- Enable callbacks notification.
> +.SH SYNOPSIS
> +.B #include <corosync/votequorum.h>
> +.sp
> +.BI "int votequorum_trackstart(votequorum_handle_t *" handle ", uint64_t " context ", unsigned int " flags ");
> +.SH DESCRIPTION
> +The
> +.B votequorum_trackstart
> +function is used to enable callbacks notification from the votequorum API.
> +.PP
> +Every time the voting configuraton changes (eg a node joins or leave the cluster)
> +or the quorum status change or the expected votes changes, the notification is queued.
> +.PP
> +The notification is dispatched via
> +.B votequorum_dispatch()
> +function that will execute the callback.
> +.PP
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH ERRORS
> +@COMMONIPCERRORS@
> +.SH "SEE ALSO"
> +.BR votequorum_initialize (3),
> +.BR votequorum_finalize (3),
> +.BR votequorum_fd_get (3),
> +.BR votequorum_dispatch (3),
> +.BR votequorum_trackstop (3),
> +.PP
> diff --git a/man/votequorum_trackstop.3.in b/man/votequorum_trackstop.3.in
> new file mode 100644
> index 0000000..aeebb17
> --- /dev/null
> +++ b/man/votequorum_trackstop.3.in
> @@ -0,0 +1,57 @@
> +.\"/*
> +.\" * 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 VOTEQUORUM_TRACKSTOP 3 @BUILDDATE@ "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
> +.SH NAME
> +votequorum_trackstop \- Disable callbacks notification.
> +.SH SYNOPSIS
> +.B #include <corosync/votequorum.h>
> +.sp
> +.BI "int votequorum_trackstart(votequorum_handle_t *" handle ");
> +.SH DESCRIPTION
> +The
> +.B votequorum_trackstop
> +function is used to disable callbacks notification from the votequorum API.
> +.PP
> +.SH RETURN VALUE
> +This call returns the CS_OK value if successful, otherwise an error is returned.
> +.PP
> +.SH ERRORS
> +@COMMONIPCERRORS@
> +.SH "SEE ALSO"
> +.BR votequorum_initialize (3),
> +.BR votequorum_finalize (3),
> +.BR votequorum_fd_get (3),
> +.BR votequorum_dispatch (3),
> +.BR votequorum_trackstart (3),
> +.PP

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


[Corosync Project]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Photo]     [Yosemite News]    [Yosemite Photos]    [Free Online Dating]     [Linux Kernel]     [Linux SCSI]     [XFree86]

Add to Google Powered by Linux