LUDOC-296 protocol: Rearrange presentation to be more top-down

[doc/protocol.git] / ldlm_enqueue.txt

diff --git a/ldlm_enqueue.txt b/ldlm_enqueue.txt
index 18b1e7b..22b7254 100644 (file)
--- a/ldlm_enqueue.txt
+++ b/ldlm_enqueue.txt
@@ -87,23 +87,18 @@ art:
 //////////////////////////////////////////////////////////////////////
 
 'ptlrpc_body'::
-RPC descriptor.
+RPC descriptor <<struct-ptlrpc-body>>.
 
-'ldlm_request'::
-Description of the lock being requested. Which resource is the target,
-what lock is current, and what lock desired.
+include::struct_ldlm_request.txt[]
 
-'ldlm_intent'::
-Description of the intent being included with the lock request.
+include::struct_ldlm_intent.txt[]
 
-'layout_intent'::
-Description of the layout information that is the subject of a layout
-intent.
+include::struct_layout_intent.txt[]
 
 'mdt_body'::
 In a request, an indication (in the 'mbo_valid' field) of what
 attributes the requester would like. In a reply, (again based on
-'mbo_valid') the values being returned.
+'mbo_valid') the values being returned. <<struct-mdt-body>>
 
 'lustre_capa'::
 So called "capabilities" structure. This is deprecated in recent
@@ -113,16 +108,7 @@ length buffer.
 'name'::
 A text field supplying the name of the desired resource.
 
-'ldlm_reply'::
-Resembling the 'ldlm_request', but in this case indicating what the
-LDLM actually granted as well as relevant policy data.
-
-'mdt_md'::
-Layout data for the resource. This buffer is optional and will appear
-as zero length in some packets.
-
-'mdt_body'::
-Metadata about a given resource.
+include::struct_ldlm_reply.txt[]
 
 'ACL data'::
 Access Control List data associated with a resource.
@@ -146,18 +132,11 @@ Lock Value Block::
 A Lock Value Block (LVB) is included in the LDLM_ENQUEUE reply message
 when one of three things needs to be communicated back to the
 requester. The three alternatives are captured by the
-'ost_lvb'structure, the 'lov_mds_md' structure, and one other related
+'ost_lvb' structure, the 'lov_mds_md' structure, and one other related
 to quotas (and not yet incorporated into this document). LDLM_ENQUEUE
 reply RPCs may include a zero length instance of an LVB.
 
-'ost_lvb'::
-An LVB to communicate attribute data for an extent associated with a
-resource on a lock. It is returned from an OST to a client requesting
-an extent lock.
-
-'lov_mds_md'::
-An LVB to communicate layout data associated with a resource. It is
-returned from an MDT to a client requesting a lock a lock with a
-layout intent. In an intent request (as opposed to a reply and as yet
-unimplemanted) it will modify the layout. It will not be included
-(zero length) in requests in current releases.
+include::struct_ost_lvb.txt[]
+
+include::struct_lov_mds_md.txt[]
+