cutehmi/dev/id.workaround.target.cause.txt

0001 Problem:
0002
0003 Sometimes bug, missing component or another issue in an external software
0004 requires some sort of workaround to overcome an issue. The workaround approach
0005 may not be the best one. Implementation could be better if only such issue had
0006 not existed.
0007
0008 Workaround:
0009
0010 If workaround is applied to the code, wrap workaround code in
0011 <id.workaround target="target" cause="cause"></id.workaround> tag comment.
0012 Tag name is an identifier of a workaround. It can be composed of module name and
0013     consecutive number.
0014 Attribute "target" is a piece of software, which causes the problem.
0015 Attribute "cause" indicates a cause of a problem. Typical causes include:
0016         - bug - a bug in external piece of software. If bug has been reported an id
0017         of the bug should be provided (i.e. cause="QTBUG-47987").
0018         - design - software is designed in such way that a workaround is needeed to
0019         overcome some issue.
0020         - missing - missing functionality in external software.
0021
0022 Additionaly create id.workaround.target.cause.txt file in relevant "dev"
0023 directory and describe the workaround.
0024
0025 After the issue has been resolved in target software, it should be easier to
0026 find affected code and improve it.
0027
0028 Snippet:
0029
0030 //<id.workaround target="target" cause="cause">
0031 Optional code snippet.
0032 //</id.workaround>