[
https://issues.apache.org/jira/browse/OAK-5547?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15848222#comment-15848222
]
Andrei Dulceanu commented on OAK-5547:
--------------------------------------
[~mduerig] Looks good to me. The only thing I could find was the presence of
the deprecated "root record references" concept in the segment header
description from {{records.md}}. Should I align the header to match the
description given in {{tar.md#Segment Files}}?
/cc [~frm]
> Document TarMK design
> ---------------------
>
> Key: OAK-5547
> URL: https://issues.apache.org/jira/browse/OAK-5547
> Project: Jackrabbit Oak
> Issue Type: Technical task
> Components: segment-tar
> Reporter: Michael Dürig
> Assignee: Francesco Mari
> Labels: documentation
> Fix For: 1.8, 1.6.1
>
>
> We should improve our documentation of the internal design of the the TarMK.
> There is currently a [single
> section|http://jackrabbit.apache.org/oak/docs/nodestore/segment/overview.html#design].
>
> * Add a high level class diagram and description of the overall structure of
> the TarMK.
> * Decide what to do with {{segmentmk.md}}. My preference would be to
> incorporate everything from it we didn't cover so far into
> {{segment/overview.md}}, {{segment/records.md}} and {{segment/tar.md}}.
> * Rewrite, clarify the design section in {{segment/overview.md}}.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
