LUDOC 299 protocol: Spell-check document

[doc/protocol.git] / lustre_rpcs.txt

diff --git a/lustre_rpcs.txt b/lustre_rpcs.txt
index c13df8f..bbe04ae 100644 (file)
--- a/lustre_rpcs.txt
+++ b/lustre_rpcs.txt
@@ -2,15 +2,21 @@ Lustre RPCs
 -----------
 [[lustre-rpcs]]
 
-Lustre operations are denoted by the 'pb_opc' op-code field of the
-RPC descriptor. Each operation is implemented as a pair of messages,
-with the 'pb_type' field set to PTLRPC_MSG_REQUEST for requests
-initiating the operation, and PTLRPC_MSG_REPLY for replies. Note that
-as a general matter, the receipt by a client of the reply message only
-assures the client hat the server has initiated the action, if
-any. See the discussion on <<transno,transaction numbers>>
-and <<recovery>> for how the client is given confirmation that a
-request has been completed.
+The Lustre protocol consists of a collection of remote procedure calls
+(RPCs) collectively known as PtlRPCs. Each Lustre RPC is an operation
+that consists of a pair of messages, a request and its reply.  The
+'pb_type' field is set to PTLRPC_MSG_REQUEST for requests initiating
+the operation, and normally PTLRPC_MSG_REPLY for replies unless the
+message encountered a fatal error before it could be processed, in
+which case it will contain PTLRPC_MSG_ERR.
+
+The type of operation requested is denoted by the 'pb_opc' op-code
+field of the RPC request. Note that as a general matter, the receipt
+by a client of the reply message only assures the client that the
+server has initiated the action, if any, but does not guarantee that
+any modification has been committed to persistent storage. See the
+discussion in <<transno>> and <<recovery>> for how the client is given
+confirmation that a request has been completed.
 
 include::ost_setattr.txt[]
 
@@ -58,18 +64,5 @@ include::llog_origin_handle_next_block.txt[]
 
 include::llog_origin_handle_read_header.txt[]
 
-#################################################################
-Fixme: Move the RPC message sturucture includes to where they
-first gets introduced. In the sections that have the relevant
-operations.
-#################################################################
+include::struct_lustre_msg.txt[]
 
-include::data_types.txt[]
-
-include::mdt_structs.txt[]
-
-include::mds_reint_structs.txt[]
-
-include::ost_setattr_structs.txt[]
-
-include::statfs_structs.txt[]