Jelajahi Sumber

Man page cleanups from Steven Whitehouse for cpg service.

git-svn-id: http://svn.fedorahosted.org/svn/corosync/trunk@2378 fd59a12c-fef9-0310-b244-a6a79926bd2f
Steven Dake 16 tahun lalu
induk
melakukan
547bdd85c2

+ 1 - 1
man/cpg_context_set.3

@@ -42,7 +42,7 @@ cpg_context_set \- Sets the context variable for a CPG instance
 The
 The
 .B cpg_context_set
 .B cpg_context_set
 function is used to set the context variable for a cpg instance. It has no
 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
 be retrieved using
 .B cpg_context_get(3)
 .B cpg_context_get(3)
 .SH RETURN VALUE
 .SH RETURN VALUE

+ 1 - 1
man/cpg_dispatch.3

@@ -79,7 +79,7 @@ Dispatch atleast one callback, blocking until the callback is dispatched.
 Dispatch all waiting callbacks without blocking to wait for any callbacks.
 Dispatch all waiting callbacks without blocking to wait for any callbacks.
 .TP
 .TP
 .B CPG_DISPATCH_BLOCKING
 .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
 program where a thread is created, and then cpg_dispatch() is called immediately
 from the created thread to execute callbacks.
 from the created thread to execute callbacks.
 
 

+ 1 - 1
man/cpg_initialize.3

@@ -129,7 +129,7 @@ struct cpg_address {
 .IP
 .IP
 .PP
 .PP
 where nodeid is a 32 bit unique node identifier, pid is the process ID of the process that has joined/left the group
 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
 .PP
 .IP
 .IP
 .RS
 .RS

+ 6 - 6
man/cpg_join.3

@@ -41,9 +41,9 @@ cpg_join \- Joins one or more groups in the CPG library
 .SH DESCRIPTION
 .SH DESCRIPTION
 The
 The
 .B cpg_join
 .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)
 .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.
 .I handle.
 The process will also get notifications of other processes joining
 The process will also get notifications of other processes joining
 and leaving the group.
 and leaving the group.
@@ -53,11 +53,11 @@ will be delivered by
 .B cpg_dispatch(3).
 .B cpg_dispatch(3).
 .PP
 .PP
 This function may be only be called once for each handle. When a group has been joined
 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
 .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()
 .I cpg_mcast_joined()
 and its own confchg callback.
 and its own confchg callback.
 .PP
 .PP

+ 4 - 4
man/cpg_leave.3

@@ -42,10 +42,10 @@ cpg_leave \- Leave a group in the CPG library
 The
 The
 .B cpg_leave
 .B cpg_leave
 function is used to leave a group.  Once a group has been left the process will
 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
 The argument
 .I group
 .I group

+ 2 - 2
man/cpg_local_get.3

@@ -33,7 +33,7 @@
 .\" */
 .\" */
 .TH CPG_LOCAL_GET 3 2007-06-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .TH CPG_LOCAL_GET 3 2007-06-12 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 .SH NAME
-cpg_local_get \- Returns the local processor id
+cpg_local_get \- Returns the local node id
 .SH SYNOPSIS
 .SH SYNOPSIS
 .B #include <corosync/cpg.h>
 .B #include <corosync/cpg.h>
 .sp
 .sp
@@ -41,7 +41,7 @@ cpg_local_get \- Returns the local processor id
 .SH DESCRIPTION
 .SH DESCRIPTION
 The
 The
 .B cpg_local_get
 .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
 .BR
 The argument
 The argument
 .I handle
 .I handle

+ 5 - 5
man/cpg_mcast_joined.3

@@ -44,7 +44,7 @@ The
 .B cpg_mcast_joined
 .B cpg_mcast_joined
 function will multicast a message to all the processes that have been joined with the
 function will multicast a message to all the processes that have been joined with the
 .B cpg_join(3)
 .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
 Messages that are sent to any of the groups joined to the parameter
 .I handle
 .I handle
 will be delivered to all subscribed processes in the system.
 will be delivered to all subscribed processes in the system.
@@ -82,18 +82,18 @@ In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee.
 .TP
 .TP
 .B CPG_TYPE_AGREED
 .B CPG_TYPE_AGREED
 All processors must agree on the order of delivery.  If a message is sent
 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
 .TP
 .B CPG_TYPE_SAFE
 .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
 must have a copy of the message before any delivery takes place.  This mode is
 unimplemented in the CPG library.
 unimplemented in the CPG library.
 .PP
 .PP
 The
 The
 .I iovec
 .I iovec
 argument describes the scatter/gather list which is used to transmit a message.  This
 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
 .IP
 .RS
 .RS
 .ne 18
 .ne 18

+ 1 - 1
man/cpg_membership_get.3

@@ -33,7 +33,7 @@
 .\" */
 .\" */
 .TH CPG_MEMBERSHIP_GET 3 2006-02-06 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .TH CPG_MEMBERSHIP_GET 3 2006-02-06 "corosync Man Page" "Corosync Cluster Engine Programmer's Manual"
 .SH NAME
 .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
 .SH SYNOPSIS
 .B #include <corosync/cpg.h>
 .B #include <corosync/cpg.h>
 .sp
 .sp

+ 3 - 3
man/cpg_overview.8

@@ -36,11 +36,11 @@
 cpg_overview \- CPG library overview
 cpg_overview \- CPG library overview
 .SH OVERVIEW
 .SH OVERVIEW
 The CPG library is delivered with the corosync project.  This library is used
 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
 .PP
 The library provides a mechanism to:
 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
 * join one or more groups
 * leave one or more groups
 * leave one or more groups
 * Deliver messages to members of that group
 * Deliver messages to members of that group

+ 3 - 3
man/cpg_zcb_mcast_joined.3

@@ -83,11 +83,11 @@ In fact, this guarantee is equivalent to the CPG_TYPE_AGREED guarantee.
 .TP
 .TP
 .B CPG_TYPE_AGREED
 .B CPG_TYPE_AGREED
 All processors must agree on the order of delivery.  If a message is sent
 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
 .TP
 .B CPG_TYPE_SAFE
 .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
 must have a copy of the message before any delivery takes place.  This mode is
 unimplemented in the CPG library.
 unimplemented in the CPG library.
 .PP
 .PP