You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-issues@jackrabbit.apache.org by "Andrei Dulceanu (JIRA)" <ji...@apache.org> on 2017/01/27 12:06:24 UTC

[jira] [Comment Edited] (OAK-4648) Improve documentation about structure of TAR files

    [ https://issues.apache.org/jira/browse/OAK-4648?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15842625#comment-15842625 ] 

Andrei Dulceanu edited comment on OAK-4648 at 1/27/17 12:06 PM:
----------------------------------------------------------------

[~frm], I attached a first draft. Among changes covered:
* included a picture to better describe generic TAR file format
* added binary references file description
* updated info regarding how the graph file is stored
* included a picture of how all pieces fit together (segments, binary references file, graph. index)
* minor spelling corrections, wording, etc.

If this makes sense to you, I'll go ahead and commit the changes.

/cc [~mduerig]


was (Author: dulceanu):
[~frm], I attached a first draft. Among changes covered:
* included a picture to better describe generic TAR file format
* added binary references file description
* updated info regarding how the graph file is stored
* included a picture of how all pieces fit together (segments, binary references file, graph. index)
* minor spelling corrections, wording, etc.

If this makes sense to you, I'll go ahead and commit the changes.

> Improve documentation about structure of TAR files
> --------------------------------------------------
>
>                 Key: OAK-4648
>                 URL: https://issues.apache.org/jira/browse/OAK-4648
>             Project: Jackrabbit Oak
>          Issue Type: Sub-task
>          Components: doc, segment-tar
>            Reporter: Andrei Dulceanu
>            Assignee: Andrei Dulceanu
>            Priority: Minor
>              Labels: documentation
>             Fix For: 1.6
>
>         Attachments: OAK-4648.patch
>
>
> Improve the page at [1] to include a picture of the contents of a TAR file, as done for segments in [2], to cover missing parts (e.g. binary references files) and to better align it with latest oak-segment-tar improvements.
> [1] http://jackrabbit.apache.org/oak/docs/nodestore/segment/tar.html
> [2] http://jackrabbit.apache.org/oak/docs/nodestore/segment/records.html



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)