merged thanks -steve
On Thu, 2009-07-23 at 14:49 +0100, Steven Whitehouse wrote: > Hi, > > I've been looking at the man pages for cpg and I found a few typos so > here are my suggested fixes. Please check them out and make sure that > they make some kind of sense, as in one or two places it wasn't clear > exactly what was meant. > > Also, please take this as a plea to document the return values from the > various functions as its tricky to handle errors if you have no idea > what they mean. > > Steve. > > Index: cpg_zcb_mcast_joined.3 > =================================================================== > --- cpg_zcb_mcast_joined.3 (revision 2369) > +++ cpg_zcb_mcast_joined.3 (working copy) > @@ -83,11 +83,11 @@ > .TP > .B CPG_TYPE_AGREED > All processors must agree on the order of delivery. If a message is sent > -from two or more processors at about the same time, the delivery will occur > -in the same order to all processors. > +from two or more processes at about the same time, the delivery will occur > +in the same order to all processes. > .TP > .B CPG_TYPE_SAFE > -All processors must agree on the order of delivery. Further all processors > +All processes must agree on the order of delivery. Further all processes > must have a copy of the message before any delivery takes place. This mode > is > unimplemented in the CPG library. > .PP > Index: cpg_initialize.3 > =================================================================== > --- cpg_initialize.3 (revision 2369) > +++ cpg_initialize.3 (working copy) > @@ -129,7 +129,7 @@ > .IP > .PP > where nodeid is a 32 bit unique node identifier, pid is the process ID of > the process that has joined/left the group > -or sent the message, and reason is an integer code indicating why the node > join/left the group. > +or sent the message, and reason is an integer code indicating why the node > joined/left the group. > .PP > .IP > .RS > Index: cpg_overview.8 > =================================================================== > --- cpg_overview.8 (revision 2369) > +++ cpg_overview.8 (working copy) > @@ -36,11 +36,11 @@ > cpg_overview \- CPG library overview > .SH OVERVIEW > The CPG library is delivered with the corosync project. This library is used > -to create distributed applications that operate properly during partitions, > merges, > -and faults. > +to create distributed applications that operate properly during cluster > +partitions, merges, and faults. > .PP > The library provides a mechanism to: > -* handle abstraction for multiple instances of an CPG library in one > application > +* handle abstraction for multiple instances of a CPG library in one > application > * join one or more groups > * leave one or more groups > * Deliver messages to members of that group > Index: cpg_membership_get.3 > =================================================================== > --- cpg_membership_get.3 (revision 2369) > +++ cpg_membership_get.3 (working copy) > @@ -33,7 +33,7 @@ > .\" */ > .TH CPG_MEMBERSHIP_GET 3 2006-02-06 "corosync Man Page" "Corosync Cluster > Engine Programmer's Manual" > .SH NAME > -cpg_membership_get \- Returns a list of members of a CPG library group > +cpg_membership_get \- Returns a list of members of a CPG group > .SH SYNOPSIS > .B #include <corosync/cpg.h> > .sp > Index: cpg_dispatch.3 > =================================================================== > --- cpg_dispatch.3 (revision 2369) > +++ cpg_dispatch.3 (working copy) > @@ -79,7 +79,7 @@ > Dispatch all waiting callbacks without blocking to wait for any callbacks. > .TP > .B CPG_DISPATCH_BLOCKING > -Dispatch all callbacks blocking indefinately. This is used in a threaded > +Dispatch all callbacks, blocking indefinitely. This is used in a threaded > program where a thread is created, and then cpg_dispatch() is called > immediately > from the created thread to execute callbacks. > > Index: cpg_mcast_joined.3 > =================================================================== > --- cpg_mcast_joined.3 (revision 2369) > +++ cpg_mcast_joined.3 (working copy) > @@ -44,7 +44,7 @@ > .B cpg_mcast_joined > function will multicast a message to all the processes that have been joined > with the > .B cpg_join(3) > -funtion for the same group name. > +function for the same group name. > Messages that are sent to any of the groups joined to the parameter > .I handle > will be delivered to all subscribed processes in the system. > @@ -82,18 +82,18 @@ > .TP > .B CPG_TYPE_AGREED > All processors must agree on the order of delivery. If a message is sent > -from two or more processors at about the same time, the delivery will occur > -in the same order to all processors. > +from two or more processes at about the same time, the delivery will occur > +in the same order to all processes. > .TP > .B CPG_TYPE_SAFE > -All processors must agree on the order of delivery. Further all processors > +All processes must agree on the order of delivery. Further all processes > must have a copy of the message before any delivery takes place. This mode > is > unimplemented in the CPG library. > .PP > The > .I iovec > argument describes the scatter/gather list which is used to transmit a > message. This > -is a standard socket structure described by: > +is a iovec described by: > .IP > .RS > .ne 18 > Index: cpg_local_get.3 > =================================================================== > --- cpg_local_get.3 (revision 2369) > +++ cpg_local_get.3 (working copy) > @@ -33,7 +33,7 @@ > .\" */ > .TH CPG_LOCAL_GET 3 2007-06-12 "corosync Man Page" "Corosync Cluster Engine > Programmer's Manual" > .SH NAME > -cpg_local_get \- Returns the local processor id > +cpg_local_get \- Returns the local node id > .SH SYNOPSIS > .B #include <corosync/cpg.h> > .sp > @@ -41,7 +41,7 @@ > .SH DESCRIPTION > The > .B cpg_local_get > -function is used to determine the local processor's identifier. > +function is used to determine the local node's identifier. > .BR > The argument > .I handle > Index: cpg_leave.3 > =================================================================== > --- cpg_leave.3 (revision 2369) > +++ cpg_leave.3 (working copy) > @@ -42,10 +42,10 @@ > The > .B cpg_leave > function is used to leave a group. Once a group has been left the process > will > -no longer receive messages or notifications about events in that group. > NOTE: that a group is > -only deemed to have left the group once it has been notified (by its confchg > callback) > -that is has left. So expect to receive at least one confchg callback after > calling > -this function. > +no longer receive messages or notifications about events in that group. > +Note that a process is only deemed to have left the group once it has been > +notified (by its confchg callback) that is has left. > +So expect to receive at least one confchg callback after calling this > function. > > The argument > .I group > Index: cpg_join.3 > =================================================================== > --- cpg_join.3 (revision 2369) > +++ cpg_join.3 (working copy) > @@ -41,9 +41,9 @@ > .SH DESCRIPTION > The > .B cpg_join > -function is used to join one group. When a group is joined, using the > +function is used to join one group. When a group is joined, the > .B cpg_mcast_joined(3) > -function will multicast to the groups joined in the argument > +is called internally to multicast to the groups joined in the argument > .I handle. > The process will also get notifications of other processes joining > and leaving the group. > @@ -53,11 +53,11 @@ > .B cpg_dispatch(3). > .PP > This function may be only be called once for each handle. When a group has > been joined > -the process will start to receive callbacks relating to messages send from > members > -of the group or notifications of process joining/leaving the group. > +the process will start to receive callbacks relating to messages sent from > members > +of the group or notifications of processes joining or leaving the group. > .PP > -Note that more than one process can join a CPG group and each will receive > its > -own copy of any messages sent using > +Note that more than one process on each node can join a CPG group and > +each will receive its own copy of any messages sent using > .I cpg_mcast_joined() > and its own confchg callback. > .PP > Index: cpg_context_set.3 > =================================================================== > --- cpg_context_set.3 (revision 2369) > +++ cpg_context_set.3 (working copy) > @@ -42,7 +42,7 @@ > The > .B cpg_context_set > function is used to set the context variable for a cpg instance. It has no > -meaning insire libcpg itself and will not be touched by the library. It can > +meaning inside libcpg itself and will not be touched by the library. It can > be retrieved using > .B cpg_context_get(3) > .SH RETURN VALUE > > > _______________________________________________ > Openais mailing list > [email protected] > https://lists.linux-foundation.org/mailman/listinfo/openais _______________________________________________ Openais mailing list [email protected] https://lists.linux-foundation.org/mailman/listinfo/openais
