[LUDOC-291] make RPC operation packet structure linkable to cross references. Created: 11/Jun/15  Updated: 21/Sep/16  Resolved: 21/Sep/16

Status: Resolved
Project: Lustre Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Minor
Reporter: Richard Henwood (Inactive) Assignee: Lustre Manual Triage
Resolution: Won't Fix Votes: 0
Labels: None

Rank (Obsolete): 9223372036854775807

 Description   

I.e. make the figure at the bottom of pg 50 here:

https://build.hpdd.intel.com/job/lustre-protocol-reviews/29/artifact/protocol.pdf

contain hyperlinks to the existing definitions of 'ptlrpc_body' etc.



 Comments   
Comment by Gerrit Updater [ 11/Jun/15 ]

Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/15229
Subject: LUDOC-291 crossref: table version of packet structure.
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: ee8e8075a321919fbfce9bef0541c614a935fbbe

Comment by Andrew Uselton (Inactive) [ 13/Jun/15 ]

The table mechanism seems like it does a reasonable job for laying out the packet structure. Do you have any ideas for how to make the structure definitions similarly crisp?

One thing we'll want to investigate is what the table approach looks like when the packet structure is too long to fit all on a single line.

Comment by Gerrit Updater [ 17/Jun/15 ]

Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/15329
Subject: LUDOC-291 design: add syntax highlighting.
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 098787f0b8248cd8e31bf8b2d9afbfe1a42fed7a

Comment by Gerrit Updater [ 19/Jun/15 ]

Richard Henwood (richard.henwood@intel.com) uploaded a new patch: http://review.whamcloud.com/15360
Subject: LUDOC-291 xref: make the sequence diagram cross reference.
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 39fe6729a386e0310797c04591e4acac7ff02f9e

Generated at Sat Feb 10 03:41:45 UTC 2024 using Jira 9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c.