[hibernate-issues] [Hibernate-JIRA] Updated: (HSEARCH-1075) Clarify documentation of JMS configuration parameter refresh

[Sanne Grinovero (JIRA)]

     [ https://hibernate.onjira.com/browse/HSEARCH-1075?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sanne Grinovero updated HSEARCH-1075:
-------------------------------------

    Summary: Clarify documentation of JMS configuration parameter refresh  (was: FSSlaveDirectoryProvider JMS configuration documentation is incomplete)

> Clarify documentation of JMS configuration parameter refresh
> ------------------------------------------------------------
>
>                 Key: HSEARCH-1075
>                 URL: https://hibernate.onjira.com/browse/HSEARCH-1075
>             Project: Hibernate Search
>          Issue Type: Improvement
>          Components: documentation
>    Affects Versions: 4.0.0.Final
>         Environment: all
>            Reporter: Eli Colner
>            Assignee: Sanne Grinovero
>            Priority: Minor
>              Labels: documentation
>             Fix For: 4.1.0.CR3
>
>   Original Estimate: 1h
>  Remaining Estimate: 1h
>
> The documentation for 'hibernate.search.default.refresh' property states that "The refresh period should be higher that the expected copy time." which is misleading imo.  It should read "The refresh period represents the least amount of time that slaves will be out of sync with the master.  It is recommended that the refresh period be higher than the expected copy time, however if the value becomes insufficient then the default implementation of FSSlaveDirectoryProvider will prevent multiple copies from occurring simultaneously using a mutex lock.  It's safe to set this value low anticipating that as your index grows the lock will be used appropriately."
> Based on the code, I believe the default value to be very high... but that's a separate issue.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira