Are the FSDirectory javadocs inconsistent?

[Michael Sokolov <ms...@gmail.com>]

In the class level javadoc it says, about NIOFSDIrectory, "...on all
other platforms [than Windows] this is the preferred choice." Later it
recommends calling #open() in order to follow recommendations for your
platform. Javadocs for open(), on the other hand, say "Currently this
returns {@link MMapDirectory} for Linux, MacOSX, Solaris, and Windows
64-bit JREs, ..." and looking at the code that is clearly what is
being done. I think we should we change the class-level javadocs to be
consistent, probably this was an oversight, but am I missing some
subtlety?

-Mike

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org

Re: Are the FSDirectory javadocs inconsistent?

[Michael McCandless <lu...@mikemccandless.com>]

I think the javadocs are just stale -- MMapDirectory is indeed (mostly?)
the default now and is preferred.  Let's just fix the class level javadocs
to suggest using #open which defaults well?

Mike McCandless

http://blog.mikemccandless.com


On Sat, Sep 7, 2019 at 9:52 AM Michael Sokolov <ms...@gmail.com> wrote:

> In the class level javadoc it says, about NIOFSDIrectory, "...on all
> other platforms [than Windows] this is the preferred choice." Later it
> recommends calling #open() in order to follow recommendations for your
> platform. Javadocs for open(), on the other hand, say "Currently this
> returns {@link MMapDirectory} for Linux, MacOSX, Solaris, and Windows
> 64-bit JREs, ..." and looking at the code that is clearly what is
> being done. I think we should we change the class-level javadocs to be
> consistent, probably this was an oversight, but am I missing some
> subtlety?
>
> -Mike
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>