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

Michael Dürig commented on OAK-5335:
------------------------------------

+1. Re. the description of {{REPOSITORY_HOME_DIRECTORY}}, I'd leave away the 
implementation details. That is, instead of mentioning the separate 
sub-directories etc., just say something like "path on the file system where 
repository data will be stored". This is also inline with 
https://github.com/apache/jackrabbit-oak/blob/trunk/oak-doc/src/site/markdown/osgi_config.md#orgapachejackrabbitoaksegmentsegmentnodestoreservice

> Clarify the various directories and their usages in SegmentNodeStoreService
> ---------------------------------------------------------------------------
>
>                 Key: OAK-5335
>                 URL: https://issues.apache.org/jira/browse/OAK-5335
>             Project: Jackrabbit Oak
>          Issue Type: Task
>          Components: segment-tar
>            Reporter: Michael Dürig
>            Assignee: Andrei Dulceanu
>              Labels: technical_debt
>             Fix For: 1.5.18, 1.6
>
>         Attachments: OAK-5335-01.patch, OAK-5335-02.patch
>
>
> In {{SegmentNodeStoreService}} there is {{repository.home}}, {{DIRECTORY}}, 
> {{getRootDirectory()}}, {{getDirectory()}} and {{getBaseDirectory()}} mostly 
> without documentation about their intention. I think we should clarify, 
> document and consolidate them. 



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

Reply via email to