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

Valentin Olteanu commented on OAK-4309:
---------------------------------------

[~mduerig], as a general note, should we specify the default values (hardcoded) 
in the descriptions so one can quickly see which values are changed when 
looking at the console page?

For the rest, I have some individual comments:
bq. +            description = "TarMK mode (64 for memory mapped file access, 
32 for normal file access)."
Any hint on when to use one or the other?

bq. +            description = "Cache size for storing most recently used 
segments in megabytes."
This is valid for all the cache properties: specify that increasing this will 
cause higher heap consumption so they need to ensure memory availability

bq. +            label = "Disable estimation phase",
I would completely remove this option and specify that setting 
{{compaction.sizeDeltaEstimation}} to 0 will skip estimation. Should I open a 
separate issue for this?

{quote}
+            description = "Boolean value indicating that a custom BlobStore is 
used for storing " +
+                    "large binary values."
{quote}
Is it {{BlobStore}} or {{DataStore}}? Should we mention that an additional 
config file for the specific DataStore is required ?

{quote}
+            description = "Directory for storing repository backups. Defaults 
to 'segmentstore-backup' " +
+                    "subdirectory under 'repository.home'."
{quote}
Does this accept relative paths? If yes, relative to what?


Also, something a little outside of the scope of this issue: I would love to 
see the names of the properties also aligned, e.g. instead of 
{{pauseCompaction}} have {{compaction.pause}} etc. Yet, this might introduce 
even more backward non-compatibility...

> Align property labels and descriptions in SegmentNodeStoreService
> -----------------------------------------------------------------
>
>                 Key: OAK-4309
>                 URL: https://issues.apache.org/jira/browse/OAK-4309
>             Project: Jackrabbit Oak
>          Issue Type: Task
>          Components: segment-tar
>            Reporter: Michael Dürig
>            Assignee: Michael Dürig
>              Labels: production
>             Fix For: 1.5.16, 1.6
>
>
> We need to align / improve the labels and descriptions in 
> {{SegmentNodeStoreService}} to match their actual purpose. At the same time I 
> would opt for changing "compaction" to "revision gc" in all places where it 
> is used synonymously for the latter. 



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

Reply via email to