[OAK-4292] Document oak-segment-tar

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.6.1, 1.8.0
• Component/s: doc, segment-tar
• Labels: documentation gc
• Epic Link: Segment Tar
• Assignee: Francesco Mari
• Reporter: Michael Dürig
• Created: 22/Apr/16 19:43
• Updated: 06/Mar/17 13:51
• Resolved: 01/Feb/17 15:31

Description

Document Oak Segment Tar. Specifically:

• New and changed configuration and monitoring options
• Changes in gc (OAK-3348 et. all)
• Changes in segment / tar format (OAK-3348)

Issue Links

• incorporates: OAK-4648 Improve documentation about structure of TAR files
• relates to: OAK-3348 Cross gc sessions might introduce references to pre-compacted segments

Sub-Tasks

• Improve documentation about structure of TAR files: Closed
• Document storage format changes: Resolved
• Extend documentation for SegmentNodeStoreService in http://jackrabbit.apache.org/oak/docs/osgi_config.html#SegmentNodeStore: Closed
• Document garbage collection: Resolved
• Document CLI tools for oak-segment-tar: Closed
• The README in oak-run should link to the documentation for oak-segment-tar: Closed
• Document TarMK design: Closed