[LUDOC-270] Revise the protocol document outline and modularize it

• Type: Technical task
• Resolution: Fixed
• Priority: Minor
• Assignee: Andrew Uselton (Inactive)
• Reporter: Andrew Uselton (Inactive)

Description

The original outline commit in response to LUDOC-266 lists the project goals as they appear in the contract. While that is comprehensive, it is not necessarily an optimum outline for the presentation of the material. New content that actually addresses project goals will be added in response to this ticket, and it will be good to have that new content fit will within the outline.

The current outline is all one file. As we progress it will likely quickly become desirable to have the content available in a more modular form. The patches introduced for this will break the file up into topical pieces.

The update will also include a new 'basement' directory where content can be placed that does not need aggressive review and is not specifically targeted to be part of the project deliverables.

Comments

[Gerrit Updater]

Mike Pershin ([e-mail]) uploaded a new patch: http://review.whamcloud.com/15423
Subject: LUDOC-270 doc: update description of connection flags
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: ed97b6cf32e3e7ec6693422645019721146ef496

[Gerrit Updater]

Andrew Uselton ([e-mail]) merged in patch http://review.whamcloud.com/15191/
Subject: LUDOC-270 doc: describe more connect flags
Project: doc/protocol
Branch: master
Current Patch Set:
Commit: 6dd994a279ba773b290b4efac52b5d91b8252248

[Gerrit Updater]

Mike Pershin ([e-mail]) uploaded a new patch: http://review.whamcloud.com/15191
Subject: LUDOC-270 doc: describe more connect flags
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 5ed3262dee2064d8bc6e6ce97cde20bf0ef8b5b5

[Andrew Uselton (Inactive)]

Thanks Mike!

[Gerrit Updater]

Mike Pershin ([e-mail]) uploaded a new patch: http://review.whamcloud.com/14970
Subject: LUDOC-270 doc: connection doc update
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 1b6a31517a4cd89065c0f68f2ddd86c94d47cd2d

[Andrew Uselton (Inactive)]

The outline has been updated and some content put in place. The outline may still be imperfect, and the content needs a lot of work. Subsequent tickets and patches will address very specific changes rather than the "whole document" change represented in this issue.

[Gerrit Updater]

Andrew Uselton ([e-mail]) merged in patch http://review.whamcloud.com/13938/
Subject: LUDOC-270 protocol: Update the outline and add support files
Project: doc/protocol
Branch: master
Current Patch Set:
Commit: 1ed3ecf73459db3dede7cff1748644203bb76002

[Gerrit Updater]

Andrew Uselton ([e-mail]) uploaded a new patch: http://review.whamcloud.com/13938
Subject: LUDOC-270 protocol: Update the outline and add support files
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 28e70f40ecd7c95d86c4f26b60573ae20e227891

[Andrew Uselton (Inactive)]

At Andreas's suggestion, I am going to abandon these two patch sets and upload a single patch set that combines them. Still learning to drive...

[Andrew Uselton (Inactive)]

These two patch sets (13935, 13936) build one on the other. This is modifying the outline to look more like what we want to present. It adds a bunch of content related to the client-to-MDS interaction during a 'mount' operation. There are also some appendices with alphabetical listings of the various components that go into building Lustre messages.