Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 241145 - [refactoring] move UA code into separate plug-ins
Summary: [refactoring] move UA code into separate plug-ins
Status: RESOLVED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.5   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 enhancement (vote)
Target Milestone: 3.5 M4   Edit
Assignee: Chris Aniszczyk CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 256995
Blocks: 253076
  Show dependency tree
 
Reported: 2008-07-16 15:39 EDT by Chris Aniszczyk CLA
Modified: 2008-12-01 17:43 EST (History)
4 users (show)

See Also:


Attachments
refactoring, refactoring, refactoring (1009.86 KB, patch)
2008-10-19 16:49 EDT, Benjamin Cabé CLA
no flags Details | Diff
actual content of the pde.ua.ui/icons folder (23.50 KB, application/octet-stream)
2008-10-19 16:54 EDT, Benjamin Cabé CLA
no flags Details
updated patch (1009.46 KB, patch)
2008-10-19 17:07 EDT, Benjamin Cabé CLA
no flags Details | Diff
icons/ folder of pde.ua.ui (13.90 KB, application/octet-stream)
2008-10-19 17:07 EDT, Benjamin Cabé CLA
no flags Details
updated patch (again) (1009.25 KB, patch)
2008-10-20 17:10 EDT, Benjamin Cabé CLA
caniszczyk: iplog+
Details | Diff
org.eclipse.pde.patch (1.11 MB, patch)
2008-11-30 15:35 EST, Chris Aniszczyk CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Aniszczyk CLA 2008-07-16 15:39:31 EDT
As part of the PDE incubator, I explored refactoring out the user assistance code from PDE. This is now almost complete and we will need to make the move.

http://wiki.eclipse.org/PDE/Incubator/UA
Comment 1 Chris Aniszczyk CLA 2008-07-16 15:40:04 EDT
I will open bugs against releng to notify them of this. We will have to add these plug-ins to the PDE feature.
Comment 2 Benjamin Cabé CLA 2008-07-16 15:47:24 EDT
Nice & useful job, Chris!
Comment 3 Chris Aniszczyk CLA 2008-07-16 15:48:24 EDT
Now I just need to find a new owner for User Assistance in PDE :)
Comment 4 Benjamin Cabé CLA 2008-07-17 15:25:38 EDT
Well, obviously, I'd be pleased to be this owner :)
Comment 5 Chris Aniszczyk CLA 2008-07-17 22:36:44 EDT
(In reply to comment #4)
> Well, obviously, I'd be pleased to be this owner :)

That's excellent!

Do you want to help finish the refactoring? I need help getting the images refactored out... currently org.eclipse.pde.ua.ui has some deps on PDEPluginImages... we need to have our own registry and minimize the dependencies on PDE UI :)

Let me know if you can do this, otherwise I will march on to after I'm done my NLS (about 95% done with this)
Comment 6 Benjamin Cabé CLA 2008-07-18 05:47:09 EDT
Of course I can help. I will finish the job wrt the UA image registry!
Comment 7 Chris Aniszczyk CLA 2008-07-18 10:11:45 EDT
(In reply to comment #6)
> Of course I can help. I will finish the job wrt the UA image registry!

Ben, as soon as you have the base code for the image registry, I suggest you post it here as we can do this work in tandem possibly. It wasn't really fun doing all the NLS stuff so maybe we can do this together to make things move faster.

After that is done, the next step will be to get a patch against pde core/ui to remove all UA related things and make sure the new plug-ins work seamlessly.

I will work on creating a new bugzilla category for User Assistance amongst other things.
Comment 8 Benjamin Cabé CLA 2008-07-18 10:55:13 EDT
I'll attach the patch regarding the image registry ASAP, but it'll probably be sometime in the week-end.
np for a tandem work :)
Comment 9 Chris Aniszczyk CLA 2008-07-18 10:55:42 EDT
Thanks!
Comment 10 Benjamin Cabé CLA 2008-07-21 02:55:06 EDT
Way too much sun during the weekend... :op
I'll do my best to tackle it in the coming days...
Comment 11 Chris Aniszczyk CLA 2008-08-03 17:21:27 EDT
This will happen in M2, not enough time for M1
Comment 12 Benjamin Cabé CLA 2008-08-04 02:16:03 EDT
Chris, I don't forget I've got to tackle this... :)

BTW, do you mind setting the same code formatting, errors, etc. rules than in the other PDE plug-ins? Perhaps you can set autoformat on save too (I don't remember if it's the case with others o.e.pde.*...)?
Comment 13 Chris Aniszczyk CLA 2008-08-07 12:03:31 EDT
ok, I will set the settings later today after lunch and reformat the whole thing. 

I was also going to add the wizards in the plugin.xml.

Have you made any progress that I may hurt by doing these changes?
Comment 14 Benjamin Cabé CLA 2008-08-07 12:10:36 EDT
You can make the changes ; I have some work in progress but nothing that will be impacted by your changes.
Comment 15 Benjamin Cabé CLA 2008-09-04 12:09:05 EDT
I'm on holiday so I guess I'll have the time to work on this, at last! Expect my patches in the days to come, I promise :)
Comment 16 Chris Aniszczyk CLA 2008-09-05 11:03:35 EDT
Fantastic Benjamin, once you post a patch, I can help you along with the painful process.

We will target this for M3!
Comment 17 Benjamin Cabé CLA 2008-10-07 16:23:19 EDT
Chris, could you please tell me how much time do I have before M3?
I really don't forget it, but I've got the head under water right now :-/
The real pity is I have some significant outgoing changes...
Comment 18 Chris Aniszczyk CLA 2008-10-13 15:51:51 EDT
We have about 2 weeks.

Let me know when you're ready for the fun :)
Comment 19 Curtis Windatt CLA 2008-10-17 11:26:43 EDT
To do this for M3, it really needs to be done as early as possible next week (Oct 20-22nd).  If it is ready by Tuesday we should discuss it at the PDE call.  Waiting any longer than that risks causing releng headaches during the warmup/milestone builds.
Comment 20 Chris Aniszczyk CLA 2008-10-17 12:12:08 EDT
agreed, it's getting late in the game.

However, we can drop this early in M4.
Comment 21 Benjamin Cabé CLA 2008-10-19 16:49:37 EDT
Created attachment 115523 [details]
refactoring, refactoring, refactoring

here is my incoming missile

* UA icons moved into the UA-UI plug-in
* UA editors & wizards (cheatsheets, ctxhelp, toc) now totally live in UA-UI (removed from both PDE UI plugin.xml and sources)
* refactoring on the way code-folding was computed on PDE source pages
* PDE UI messages.properties & NLS class cleaned off of any "UA" entry

At the moment, there are a lot of warnings due to heavy usage of internal PDE UI code (I've added some x-friends clauses, btw, more or less the same that were already there for DS UI): we have a lot of work to make PDE UI much more extensible (incoming PITA ;-) )
Comment 22 Benjamin Cabé CLA 2008-10-19 16:54:01 EDT
Created attachment 115524 [details]
actual content of the pde.ua.ui/icons folder

I intentionnaly only kept the entries relative to the deletion of icons in pde.ui in my previous patch, and here are the "new" icons in PDE UA UI. Hope it'll be OK
Comment 23 Benjamin Cabé CLA 2008-10-19 17:07:25 EDT
Created attachment 115525 [details]
updated patch

Corrected an error caused by missing wizard banner resources for ctxhelp & toc new wizards (i'll file a new bug)

I forgot to tell I also updated the pde.ui.tests project to remove the cheatsheet model tests which now live in ua.ui.tests
Comment 24 Benjamin Cabé CLA 2008-10-19 17:07:53 EDT
Created attachment 115526 [details]
icons/ folder of pde.ua.ui
Comment 25 Benjamin Cabé CLA 2008-10-20 17:10:59 EDT
Created attachment 115626 [details]
updated patch (again)

I made a mistake deleting the page_obj.gif in pde.ui ... Sorry ...
Comment 26 Chris Aniszczyk CLA 2008-10-20 17:13:26 EDT
Thanks Ben.

The patch will go in first week of M4.
Comment 27 Benjamin Cabé CLA 2008-11-12 08:59:10 EST
Chris, if something goes wrong when applying this patch against HEAD, just tell me and I'll help making a new one
Comment 28 Chris Aniszczyk CLA 2008-11-30 15:35:47 EST
Created attachment 119097 [details]
org.eclipse.pde.patch

An updated patch.
Comment 29 Chris Aniszczyk CLA 2008-11-30 16:42:49 EST
FYI all, refactoring is done in CVS HEAD. Thanks to everyone who helped PDE do some necessary house cleaning.

I created bug 256995 for the final releng issues. Once that is done, I'll close this bug.
Comment 30 Chris Aniszczyk CLA 2008-12-01 17:42:48 EST
done.

> 20091201