[ovirt-devel] Small note on workarounds in UI code

[Vojtech Szocs]

Hi guys,

recently, we've merged a small patch [1] that adds some info on notable
(in this case, GWT-Platform framework related) workarounds via comments
that look like this:

  // TODO-GWT: description goes here

If you find yourself working around some GWT or GWT-Platform issue,
please add a comment like above with some brief description, i.e. link
to GWT(P) issue tracker and maybe also short summary of the workaround.

In future, when upgrading to newer GWT/P versions, this should aid us
in reviewing existing code and reducing the risk of potential issues
due to the upgrade. (Ideally, workarounds shouldn't be needed assuming
relevant issues are fixed in newer versions; in the worst case, those
workarounds might pass compilation but will actually not work or even
break stuff.)

[1] http://gerrit.ovirt.org/#/c/24995/

Thanks,
Vojtech