[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16650117#comment-16650117 ] ASF subversion and git services commented on LUCENE-8481: - Commit 90608ea6e6e9668cde12e9d87b8d538458348789 in lucene-solr's branch refs/heads/branch_7x from [~dawid.weiss] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=90608ea ] LUCENE-8481: Javadocs should no longer reference RAMDirectory. Use an empty set of stop words in 7.x so that TestDemo passes. > 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 >Assignee: Dawid Weiss >Priority: Minor > Fix For: 7.5 > > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16605454#comment-16605454 ] ASF subversion and git services commented on LUCENE-8481: - Commit fc8d9eba1ebf779e3cbda487bae854f7b17549b0 in lucene-solr's branch refs/heads/branch_7x from [~dawid.weiss] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=fc8d9eb ] Revert "LUCENE-8481: Javadocs should no longer reference RAMDirectory." This reverts commit 3cd58d130e403f11cbbd0cd2673a6a58da361854. > 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 >Assignee: Dawid Weiss >Priority: Minor > Fix For: 7.5 > > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16605449#comment-16605449 ] ASF subversion and git services commented on LUCENE-8481: - Commit 3cd58d130e403f11cbbd0cd2673a6a58da361854 in lucene-solr's branch refs/heads/branch_7x from [~dawid.weiss] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=3cd58d1 ] LUCENE-8481: Javadocs should no longer reference RAMDirectory. > 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 > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16605429#comment-16605429 ] ASF subversion and git services commented on LUCENE-8481: - Commit 922295a94d537c32681c1d9af4d751e18efe6b4d in lucene-solr's branch refs/heads/master from [~dawid.weiss] [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=922295a ] LUCENE-8481: Javadocs should no longer reference RAMDirectory. > 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 > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16605334#comment-16605334 ] Dawid Weiss commented on LUCENE-8481: - Ok, sounds good. > 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 > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16604268#comment-16604268 ] Adrien Grand commented on LUCENE-8481: -- This patch still looks like a net improvement to me by removing references to RAMDirectory. +1 to merge it and +1 to address consistency issues as a follow-up? > 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 > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16604267#comment-16604267 ] Dawid Weiss commented on LUCENE-8481: - I honestly don't know if this patch should be applied at all; it clearly shows that those snippets of code in the documentation go out of sync with the codebase very quickly. Perhaps we should use some kind of snippet injection or linking to keep the code "real" and not rely on manual updates. That "TestDemo" class is not just out of sync with package documentation, it's also odd and uses test randomization infrastructure, which is way beyond the scope of a simple introductory example. There is also the "demo" module which contains another "TestDemo", which only adds to the confusion. > 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 > Attachments: LUCENE-8481.patch > > > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16602837#comment-16602837 ] Adrien Grand commented on LUCENE-8481: -- OK fair enough. > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[
https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16602714#comment-16602714
]
Dawid Weiss commented on LUCENE-8481:
-
I agree we should fix javadocs too, they're stale. As for removal at the end:
it's really an arbitrary decision. I though we could introduce a real temp dir
(and a local variable) so that the example would work on Windows and other
systems; then the IOUtils.rm(indexLocation) would actually refer to the
variable (not hardcoded path), so chances of copy-pasting and doing an {{rm -rf
/}} are slim and you don't leave unused stuff in the temp folder. Having an rm
at the end seems cleaner to me and if you really copy-paste _so_ badly as to
introduce a wrong path there... then you deserve the consequences?
> 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-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16602711#comment-16602711 ] Adrien Grand commented on LUCENE-8481: -- I saw LUCENE-8474 but was thinking that we do not only need to fix javadocs on the branch where RAMDirectory is removed but also where it is deprecated since it is awkward to have code examples that use deprecated classes? +1 to use FSDirectory in examples. I'm a bit more nervous about removing the index location in the end, as I'm afraid of what could happen with copy-pasting. > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[
https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=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-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (LUCENE-8481) Javadocs should no longer reference RAMDirectory
[ https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16602660#comment-16602660 ] Dawid Weiss commented on LUCENE-8481: - Correct. I'd just leave FSDirectory in this example. There's also a larger issue (LUCENE-8474) that would handle removal of all refs to RAMDirectory after 8.x is cut. Should this be also applied to 7.x? > 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-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
