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

Details

Type: Technical task
Resolution: Fixed
Priority: Minor
Fix Version/s: None
Affects Version/s: None
Labels:
None

Rank (Obsolete):
17554

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.

Attachments

- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

protocol.pdf
100 kB
02/Mar/15 7:23 PM

Activity

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

Gerrit Updater added a comment - 27/May/15 8:15 PM

Mike Pershin (mike.pershin@intel.com) 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

Gerrit Updater added a comment - 27/May/15 8:15 PM Mike Pershin (mike.pershin@intel.com) 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) added a comment - 20/Apr/15 5:02 PM

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.

Andrew Uselton (Inactive) added a comment - 20/Apr/15 5:02 PM 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 added a comment - 14/Apr/15 3:27 AM

Andrew Uselton (andrew.c.uselton@intel.com) 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 added a comment - 14/Apr/15 3:27 AM Andrew Uselton (andrew.c.uselton@intel.com) 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 added a comment - 02/Mar/15 6:09 PM

Andrew Uselton (andrew.c.uselton@intel.com) 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

Gerrit Updater added a comment - 02/Mar/15 6:09 PM Andrew Uselton (andrew.c.uselton@intel.com) 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) added a comment - 02/Mar/15 5:28 PM

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) added a comment - 02/Mar/15 5:28 PM 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) added a comment - 02/Mar/15 5:23 PM

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.

Andrew Uselton (Inactive) added a comment - 02/Mar/15 5:23 PM 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.

Gerrit Updater added a comment - 02/Mar/15 5:14 PM

Andrew Uselton (andrew.c.uselton@intel.com) uploaded a new patch: http://review.whamcloud.com/13936
Subject: ~~LUDOC-270~~ protocol: More about Lustre messages
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: 44112de42db446cb4ae3987c9f6078a9b5699963

Gerrit Updater added a comment - 02/Mar/15 5:14 PM Andrew Uselton (andrew.c.uselton@intel.com) uploaded a new patch: http://review.whamcloud.com/13936 Subject: LUDOC-270 protocol: More about Lustre messages Project: doc/protocol Branch: master Current Patch Set: 1 Commit: 44112de42db446cb4ae3987c9f6078a9b5699963

Gerrit Updater added a comment - 02/Mar/15 5:14 PM

Andrew Uselton (andrew.c.uselton@intel.com) uploaded a new patch: http://review.whamcloud.com/13935
Subject: ~~LUDOC-270~~ protocol: Update the outline and add support files
Project: doc/protocol
Branch: master
Current Patch Set: 1
Commit: a494108620f7a0fd284b9f91c84ed027e9369faa

Gerrit Updater added a comment - 02/Mar/15 5:14 PM Andrew Uselton (andrew.c.uselton@intel.com) uploaded a new patch: http://review.whamcloud.com/13935 Subject: LUDOC-270 protocol: Update the outline and add support files Project: doc/protocol Branch: master Current Patch Set: 1 Commit: a494108620f7a0fd284b9f91c84ed027e9369faa

Gerrit Updater added a comment - 28/Feb/15 5:54 AM

Andreas Dilger (andreas.dilger@intel.com) merged in patch http://review.whamcloud.com/13919/
Subject: ~~LUDOC-270~~ protocol: Add a 'basement' dir with support files
Project: doc/protocol
Branch: master
Current Patch Set:
Commit: 083ac0ef937906fdf8b908b9f3d2e5cddc1919b3

Gerrit Updater added a comment - 28/Feb/15 5:54 AM Andreas Dilger (andreas.dilger@intel.com) merged in patch http://review.whamcloud.com/13919/ Subject: LUDOC-270 protocol: Add a 'basement' dir with support files Project: doc/protocol Branch: master Current Patch Set: Commit: 083ac0ef937906fdf8b908b9f3d2e5cddc1919b3

Andrew Uselton (Inactive) added a comment - 28/Feb/15 1:24 AM

N.B. This patch set just adds some support files in the 'basement'. I am happy to have people review and comment on them, but don't worry too much about it. That is, if you do not review it at all it will cause no great harm. It's just my notes-to-self. The real content is forthcoming.
Cheers,
Andrew

Andrew Uselton (Inactive) added a comment - 28/Feb/15 1:24 AM N.B. This patch set just adds some support files in the 'basement'. I am happy to have people review and comment on them, but don't worry too much about it. That is, if you do not review it at all it will cause no great harm. It's just my notes-to-self. The real content is forthcoming. Cheers, Andrew

Andrew Uselton (Inactive) added a comment - 28/Feb/15 1:22 AM

mac 17:13 protocol> git push origin HEAD:refs/for/master
X11 forwarding request failed on channel 0
Counting objects: 13, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (11/11), done.
Writing objects: 100% (11/11), 26.13 KiB | 0 bytes/s, done.
Total 11 (delta 1), reused 0 (delta 0)
remote: Resolving deltas: 100% (1/1)
remote: Processing changes: new: 1, refs: 1, done
remote:
remote: New Changes:
remote: http://review.whamcloud.com/13919
remote:
To ssh://uselton@review.whamcloud.com:29418/doc/protocol

[new branch] HEAD -> refs/for/master

Andrew Uselton (Inactive) added a comment - 28/Feb/15 1:22 AM mac 17:13 protocol> git push origin HEAD:refs/for/master X11 forwarding request failed on channel 0 Counting objects: 13, done. Delta compression using up to 8 threads. Compressing objects: 100% (11/11), done. Writing objects: 100% (11/11), 26.13 KiB | 0 bytes/s, done. Total 11 (delta 1), reused 0 (delta 0) remote: Resolving deltas: 100% (1/1) remote: Processing changes: new: 1, refs: 1, done remote: remote: New Changes: remote: http://review.whamcloud.com/13919 remote: To ssh://uselton@review.whamcloud.com:29418/doc/protocol [new branch] HEAD -> refs/for/master

People

Assignee:: Andrew Uselton (Inactive)

Reporter:: Andrew Uselton (Inactive)

Votes:: 0 Vote for this issue

Watchers:: 4 Start watching this issue

Dates

Created:: 19/Feb/15 10:46 PM

Updated:: 27/Jun/15 5:34 PM

Resolved:: 20/Apr/15 5:02 PM