Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 122979

Summary: [Help] Remove access restrictions on lucene packages
Product: [Eclipse Project] Platform Reporter: Janek Lasocki-Biczysko <janek.lb>
Component: User AssistanceAssignee: platform-ua-inbox <platform-ua-inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: konradk
Version: 3.2   
Target Milestone: 3.2 RC1   
Hardware: PC   
OS: Windows XP   
Whiteboard:

Description Janek Lasocki-Biczysko CLA 2006-01-06 16:42:19 EST
The lucene packages shouldn't be marked as internal.  All lucene packages should be visible to all plug-ins so that they may make use of them.
Comment 1 Dejan Glozic CLA 2006-01-07 21:48:29 EST
All Lucene packages except 'demo.html' are visible. The demo package is marked as internal with help.base plug-in being the only 'friend'. 

There must be a reason for this (perhaps this package is not API and help.base is using it as-is. I would rather add pde as another friend than make it API. This way we could treat possible problems in the demo package easier.
Comment 2 Wassim Melhem CLA 2006-04-05 21:29:14 EDT
what's the status on this request for 3.2?

PDE/UI is a pretty big API offender according to the build logs, and we would like to restore our good name.
Comment 3 Curtis d'Entremont CLA 2006-04-06 10:34:26 EDT
From what I read, there are a set of demos provided by lucene to demonstrate some sample usage. Help uses the html demo because it provides html indexing, but I'm not sure if exposing this package is the right way to go, because it seems to imply API, which it is not. For all we know, the demo may be completely reworked in the next lucene version and anyone using it would be broken. I think this is why it was kept internal.. can you confirm Konrad?
Comment 4 Wassim Melhem CLA 2006-04-06 11:04:04 EDT
The reason why we are using this package in the first place is because PDE is graciously providing tooling for UA.

What do we get in return?  Access violations.

I am going on a hunger strike until this issue is resolved.

Comment 5 Dejan Glozic CLA 2006-04-06 11:08:22 EDT
This is hard to solve.

1) We own both PDE and the internal package we are talking about, therefore we can safely call the method knowing that we will not shoot ourselves in the foot.

2) We don't want to open up that package to the world because we don't want everybody and his dog start making dependencies on our own copy of the demo code that we tweaked.

3) We don't want to see the warning but we don't want to promote PDE to help's friend because it crosses feature boundaries.

This is hard to solve. Either we add the friend statement or live with the warning knowing that it is a false alarm. Removing the conversion tool is not an option. Pick your poison.
Comment 6 Wassim Melhem CLA 2006-04-06 11:12:21 EDT
I pick poison 3 - add PDE/UI as a friend.
Comment 7 Wassim Melhem CLA 2006-04-06 11:14:06 EDT
although I am not sure poison 2 is realistically much of an issue.
Comment 8 Janek Lasocki-Biczysko CLA 2006-04-06 11:18:31 EDT
I'm not sure if this is true or not, but I though I heard that Lucene updated its code to fix the defects that we had addressed ourselves. If this is the case we could update our lucence code with the official version and poision #2 wouldn't be a poision anymore.
Comment 9 Curtis d'Entremont CLA 2006-04-06 11:42:00 EDT
Any objections from anyone about making PDE a friend? Going once, going twice..
Comment 10 Dejan Glozic CLA 2006-04-06 11:53:51 EDT
I suggest that we add PDE as a temporary friend but mark somewhere that we test if we can move to the official 'demo' package and open it up to the world. I am hesitant to upgrade Lucene at this point.
Comment 11 Curtis d'Entremont CLA 2006-04-06 12:21:08 EDT
org.eclipse.pde.ui is now a friend for package org.apache.lucene.demo.html. Added a note to bug 130345 to remove friend and expose the official demo package after we upgrade to the latest lucene, assuming the fixes we added were added to lucene.
Comment 12 Curtis d'Entremont CLA 2006-04-06 12:21:53 EDT
Forgot to mark as fixed.
Comment 13 Christopher Daly CLA 2006-04-06 14:21:15 EDT
(In reply to comment #4)
> I am going on a hunger strike until this issue is resolved.
> 

I'm relieved to see this was resolved just in time for lunch.  :-)