Login | Register For Free | Help
Search for: (Advanced)

Mailing List Archive: Lucene: Java-Dev

[jira] Updated: (LUCENE-2080) Improve the documentation of Version

 

 

Lucene java-dev RSS feed   Index | Next | Previous | View Threaded


jira at apache

Feb 7, 2010, 11:29 AM

Post #1 of 3 (276 views)
Permalink
[jira] Updated: (LUCENE-2080) Improve the documentation of Version

[ https://issues.apache.org/jira/browse/LUCENE-2080?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Muir updated LUCENE-2080:
--------------------------------

Attachment: LUCENE-2080.patch

attached is a patch that deprecates LUCENE_CURRENT, adds some scarier text about 'reindexing all your documents', and moves positive 'latest & greatest' text to LUCENE_31 instead.

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> Project: Lucene - Java
> Issue Type: Task
> Components: Javadocs
> Reporter: Robert Muir
> Assignee: Robert Muir
> Priority: Trivial
> Fix For: 2.9.2, 3.0, 3.1
>
> Attachments: LUCENE-2080.patch, LUCENE-2080.patch
>
>
> In my opinion, we should elaborate more on the effects of changing the Version parameter.
> Particularly, changing this value, even if you recompile your code, likely involves reindexing your data.
> I do not think this is adequately clear from the current javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene


jira at apache

Feb 7, 2010, 11:47 AM

Post #2 of 3 (266 views)
Permalink
[jira] Updated: (LUCENE-2080) Improve the documentation of Version [In reply to]

[ https://issues.apache.org/jira/browse/LUCENE-2080?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Muir updated LUCENE-2080:
--------------------------------

Attachment: LUCENE-2080.patch

I think this wording is even better and scarier:
* i bolded *re-index all your documents* in the previous wording.
* i added another sentence: Additionally, you may need to *re-test your entire application* to ensure it now does what you want, as some defaults may have changed and may break functionality in your application.

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> Project: Lucene - Java
> Issue Type: Task
> Components: Javadocs
> Reporter: Robert Muir
> Assignee: Robert Muir
> Priority: Trivial
> Fix For: 2.9.2, 3.0, 3.1
>
> Attachments: LUCENE-2080.patch, LUCENE-2080.patch, LUCENE-2080.patch
>
>
> In my opinion, we should elaborate more on the effects of changing the Version parameter.
> Particularly, changing this value, even if you recompile your code, likely involves reindexing your data.
> I do not think this is adequately clear from the current javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene


jira at apache

Feb 10, 2010, 8:10 PM

Post #3 of 3 (214 views)
Permalink
[jira] Updated: (LUCENE-2080) Improve the documentation of Version [In reply to]

[ https://issues.apache.org/jira/browse/LUCENE-2080?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Muir updated LUCENE-2080:
--------------------------------

Attachment: LUCENE-2080.patch

updated patch with simon's suggestion, some reformatting and edits to be slightly scarier.

if no one objects, will commit tomorrow (and backport, adjusting the 'latest and greatest' wordage to the appropriate versions)

> Improve the documentation of Version
> ------------------------------------
>
> Key: LUCENE-2080
> URL: https://issues.apache.org/jira/browse/LUCENE-2080
> Project: Lucene - Java
> Issue Type: Task
> Components: Javadocs
> Reporter: Robert Muir
> Assignee: Robert Muir
> Priority: Trivial
> Fix For: 2.9.2, 3.0, 3.1
>
> Attachments: LUCENE-2080.patch, LUCENE-2080.patch, LUCENE-2080.patch, LUCENE-2080.patch
>
>
> In my opinion, we should elaborate more on the effects of changing the Version parameter.
> Particularly, changing this value, even if you recompile your code, likely involves reindexing your data.
> I do not think this is adequately clear from the current javadocs.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: java-dev-unsubscribe [at] lucene
For additional commands, e-mail: java-dev-help [at] lucene

Lucene java-dev RSS feed   Index | Next | Previous | View Threaded
 
 


Interested in having your list archived? Contact Gossamer Threads
 
  Web Applications & Managed Hosting Powered by Gossamer Threads Inc.