LUDOC 299 protocol: Spell-check document

[doc/protocol.git] / ost_setattr.txt

diff --git a/ost_setattr.txt b/ost_setattr.txt
index 6b8c2e1..ae23caf 100644 (file)
--- a/ost_setattr.txt
+++ b/ost_setattr.txt
@@ -1,27 +1,53 @@
-Command 2: OST_SETATTR
-~~~~~~~~~~~~~~~~~~~~~~
+RPC 2: OST_SETATTR
+~~~~~~~~~~~~~~~~~~
 [[ost-setattr-rpc]]
 
 OST_SETATTR (pb_opc = 2) is an RPC that sets resource attributes.
 
-.OST_SETATTR Generic Packet Structure
-image::ost-setattr-generic.png["OST_SETATTR Generic Packet Structure",height=100]
+.OST_SETATTR Request Packet Structure
+image::ost-setattr-request.png["OST_SETATTR Request Packet Structure",height=50]
 
 //////////////////////////////////////////////////////////////////////
-The ost-setattr-generic.png diagram resembles this text art:
+The ost-setattr-request.png diagram resembles this text art:
 
        OST_SETATTR:
       --request-----------------
       | ptlrpc_body | ost_body |
       --------------------------
+//////////////////////////////////////////////////////////////////////
+
+include::struct_ptlrpc_body.txt[]
+
+[NOTE]
+The RPC descriptor just described is the first buffer in the
+OST_SETATTR request message. It will also appear as the first buffer
+of every other RPC request or reply sent between entities. Refer back
+to the above discussion when examining other RPC messages. The next
+section describes the 'struct ost_body' which is the second (and
+final) buffer in an OST_SETATTR request message.
+
+include::struct_ost_body.txt[]
+
+The above discussion described the structure of the OST_SETATTR
+request message. In this case the reply message structure looks much
+the same. It uses the same to buffers, and only changes their contents
+to reflect that the message is a reply rather than a request.
+
+.OST_SETATTR Reply Packet Structure
+image::ost-setattr-reply.png["OST_SETATTR Reply Packet Structure",height=50]
+
+//////////////////////////////////////////////////////////////////////
+The ost-setattr-reply.png diagram resembles this text art:
+
+       OST_SETATTR:
       --reply-------------------
       | ptlrpc_body | ost_body |
       --------------------------
 //////////////////////////////////////////////////////////////////////
 
 'ptlrpc_body'::
-RPC descriptor.
+The RPC descriptor. See <<struct-ptlrpc-body>>.
 
 'ost_body'::
-Metadata about the resource, as it appears on the OST.
+Metadata about the resource. See <<struct-ost-body>>.