lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dawid Weiss (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
Date Tue, 04 Sep 2018 07:26:00 GMT

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

Dawid Weiss commented on LUCENE-8481:
-------------------------------------

I looked at it quickly. The code in overview is out of sync with the actual TestDemo and it
doesn't seem to be generated (as the note there implies). RAMDirectory is also used in 
{code}
lucene\analysis\common\src\java\org\apache\lucene\collation\package-info.java
lucene\analysis\icu\src\java\overview.html 
{code}

I didn't check Solr's folder at all, but I bet there are refs there as well. I can replace
those occurrences with ByteBuffersDirectory, although I think it'd be better to use FSDirectory
in those examples in the spirit of what we truly encourage people to use. A terminating {{IOUtils.rm(indexLocation)}}
would be required to clean up the temporary folder (and I'd use a real call to Files.createTemporaryDirectory
or whatever it's called in NIO).

> Javadocs should no longer reference RAMDirectory
> ------------------------------------------------
>
>                 Key: LUCENE-8481
>                 URL: https://issues.apache.org/jira/browse/LUCENE-8481
>             Project: Lucene - Core
>          Issue Type: Task
>            Reporter: Adrien Grand
>            Priority: Minor
>
> Since RAMDirectory is deprecated, we shouldn't show examples using it anymore. See eg.
https://github.com/apache/lucene-solr/blob/a1ec716e107807f1dc24923cc7a91d0c5e64a7e1/lucene/core/src/java/overview.html#L36.
cc [~dweiss]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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


Mime
View raw message