jackrabbit-oak-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrei Dulceanu (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (OAK-5335) Clarify the various directories and their usages in SegmentNodeStoreService
Date Wed, 21 Dec 2016 14:26:58 GMT

     [ https://issues.apache.org/jira/browse/OAK-5335?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Andrei Dulceanu updated OAK-5335:
---------------------------------
    Attachment: OAK-5335-02.patch

[~mduerig] I attached a new version of the patch proposed earlier. 

bq. we should still consider the question and investigate who put those methods there and
why.
The need for a {{rootDirectory}} appeared with OAK-4782. More details here [1]. That code
was then refactored and that's how {{getRootDirectory}} appeared.

This time I tried to better align all the names (properties and methods) and ended up with
these changes:
* renamed {{getRootDirectory}} to {{getRepositoryHome}}
* renamed {{DIRECTORY}} to {{REPOSITORY_HOME_DIRECTORY}}
* updated description of {{REPOSITORY_HOME_DIRECTORY}} to include "Directory for storing (in
separate sub-directories) tar files, cache data, indices, etc.". I thought that this better
addresses the purpose of this directory, than to simply state that it holds segments, somehow
validating the assumption that these segments are stored right there and not in a sub-directory
as it's the case.
* added JavaDoc to all methods dealing with directories

Can you take a look at the patch, please?

[1] http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-segment-tar/src/main/java/org/apache/jackrabbit/oak/segment/SegmentNodeStoreService.java?r1=1758770&r2=1759971&pathrev=1759971&diff_format=h

> 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)

Mime
View raw message