Vojtech Szocs has posted comments on this change.

Change subject: webadmin,userportal: @NotableWorkaround annotation
......................................................................


Patch Set 1:

Hi guys, I'm revisiting this patch and I generally agree that using a dedicated 
Java annotation might be an overkill here.

> We can always use a TODO comment instead and check the TODOs in the project 
> whenever upgrading to a new version

> We have the TODO mechanism to find work arounds like this if needed.

Cross-referencing TODOs for GWT(P)/browser-specific workarounds is a lot 
harder, compared to cross-referencing Java annotation in IDE. This was the main 
motivation behind this patch. We have tons of TODO comments in frontend 
projects, most of which are unrelated to workarounds. This makes the process of 
collecting important information about workarounds during migration (i.e. 
things to check out if still relevant for new library/environment) harder.

> Vojtech, I suggest to consider abandoning this patch

I think that workaround-related information shouldn't be lost with this patch.

If everyone agrees, I'll modify the patch, removing @NotableWorkaround and 
using plain Java comment like so:

 // WORKAROUND: description goes here

In Java IDE, people can add custom task tags to make cross-referencing 
"WORKAROUND" comments easier, in addition to existing task tags (such as 
"TODO", "FIXME" etc).

-- 
To view, visit http://gerrit.ovirt.org/24995
To unsubscribe, visit http://gerrit.ovirt.org/settings

Gerrit-MessageType: comment
Gerrit-Change-Id: I336da10b2931825a7b44c24b663e18593f489979
Gerrit-PatchSet: 1
Gerrit-Project: ovirt-engine
Gerrit-Branch: master
Gerrit-Owner: Vojtech Szocs <[email protected]>
Gerrit-Reviewer: Alexander Wels <[email protected]>
Gerrit-Reviewer: Daniel Erez <[email protected]>
Gerrit-Reviewer: Einav Cohen <[email protected]>
Gerrit-Reviewer: Itamar Heim <[email protected]>
Gerrit-Reviewer: Tal Nisan <[email protected]>
Gerrit-Reviewer: Tomas Jelinek <[email protected]>
Gerrit-Reviewer: Vojtech Szocs <[email protected]>
Gerrit-Reviewer: [email protected]
Gerrit-Reviewer: oVirt Jenkins CI Server
Gerrit-HasComments: No
_______________________________________________
Engine-patches mailing list
[email protected]
http://lists.ovirt.org/mailman/listinfo/engine-patches

Reply via email to