Bug 186121 - [relengtool] Fix Copyrights... shows confusing dialog
Summary: [relengtool] Fix Copyrights... shows confusing dialog
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Releng (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.4 M2   Edit
Assignee: Platform-Releng-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed
Depends on:
Blocks:
 
Reported: 2007-05-09 06:51 EDT by Dani Megert CLA
Modified: 2007-09-07 12:36 EDT (History)
3 users (show)

See Also:


Attachments
The dialog (3.38 KB, image/png)
2007-05-09 06:52 EDT, Dani Megert CLA
no flags Details
Patch to reword the contents of the dialog based on what was noted in bug #190361. (2.00 KB, patch)
2007-08-29 15:54 EDT, Remy Suen CLA
no flags Details | Diff
Screencap of the two different dialogs. (29.83 KB, image/jpeg)
2007-08-30 08:14 EDT, Remy Suen CLA
no flags Details
Updated patch to put the text description below the field as well as providing a title for the dialog. (3.50 KB, patch)
2007-09-02 09:09 EDT, Remy Suen CLA
no flags Details | Diff
Updated dialog screenshot with an alternate text field label. (27.20 KB, image/jpeg)
2007-09-03 10:51 EDT, Remy Suen CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2007-05-09 06:51:28 EDT
3.3 M7

Fix Copyrights... shows confusing dialog:
1. I have no idea what this message means i.e. to what "last comment" refers to.
   Is it CVS comment? Last comment in Java file? ...
2. it has no title
3. the entry field doesn't look like an entry field
Comment 1 Dani Megert CLA 2007-05-09 06:52:30 EDT
Created attachment 66428 [details]
The dialog
Comment 2 Dani Megert CLA 2007-05-29 08:22:31 EDT
Ping.

Could you explain what this dialog means? I would like to start fixing out copyrights.
Comment 3 Kim Moir CLA 2007-05-29 08:48:45 EDT
I have no idea.  Perhaps this was a new dialog that was added last year when the UI team's co-op worked on the tool. Michael - do you have any information about this dialog?
Comment 4 Dani Megert CLA 2007-05-29 08:52:11 EDT
OK, I looked at the code: what it does is checking the revision's CVS commit comment and if it contains the substring entered into that dialog it does not update the copyright of that file.
Comment 5 Remy Suen CLA 2007-08-29 15:54:39 EDT
Created attachment 77297 [details]
Patch to reword the contents of the dialog based on what was noted in bug #190361.
Comment 6 Dani Megert CLA 2007-08-30 02:20:15 EDT
Patch looks good but still misses to set a title.
Also, it might look better if we display the explanation below the Text widget (that's what we usually do).
Comment 7 Remy Suen CLA 2007-08-30 08:14:13 EDT
Created attachment 77369 [details]
Screencap of the two different dialogs.

(In reply to comment #6)
> Patch looks good but still misses to set a title.
> Also, it might look better if we display the explanation below the Text widget
> (that's what we usually do).

Really? Hm...I was thinking maybe this should just be an InputDialog instead? The label is on top in this case and is how the dialog works.

On the topic of titles, the releng tools should probably migrate to using the NLS class instead of resource bundles. :)

I also noticed there's an "Advanced Fix Copyrights" action. This or that needs to be removed or the two's functionality needs to be merged / made customizable (via an "Advanced" button to display more functionality or whatever).
Comment 8 Dani Megert CLA 2007-08-30 09:37:34 EDT
If it's short then it is above or on the left but if there's half a novel to explain it... ;-)
Comment 9 Remy Suen CLA 2007-09-02 09:09:24 EDT
Created attachment 77537 [details]
Updated patch to put the text description below the field as well as providing a title for the dialog.
Comment 10 Dani Megert CLA 2007-09-03 10:27:18 EDT
It would be easier to grasp if we replaced
  "Enter as substring:"
with something more specific like:
  "Commit comment filter:"

>On the topic of titles, the releng tools should probably migrate to using the
>NLS class instead of resource bundles. :)
There's a tool that does this (didn't check whether it works with 3.3 or 3.4):
http://dev.eclipse.org/viewcvs/index.cgi/platform-core-home/downloads/tools/message_bundles/com.ibm.zrh.eclipse.nls_1.0.0.zip?view=co
Comment 11 Remy Suen CLA 2007-09-03 10:51:53 EDT
Created attachment 77588 [details]
Updated dialog screenshot with an alternate text field label.

I'm not too sure about "...contains the filter above...". Maybe 'filter' should be replaced with 'text'. "prevent these files" also sounds weird to me, I think it should be 'those'. "copyright update" sounds out of place also as the action is 'Fix Copyrights...' and not 'Update Copyrights...'.

Note that while the screenshot doesn't display the dialog's title, it has currently been set as 'Fix Copyright'.

If no one has any comments I'll attach a new patch for what's displayed in this dialog.
Comment 12 Michael Valenta CLA 2007-09-07 12:36:13 EDT
I've released the patch to HEAD as it is a definite improvement over what was there before. If it is felt that the current text is still not adequate, please reopen.