bjartem / lancelot-eclipse Goto Github PK

- The options's scope is confusing. Add "for project" for clarity.
- Make the menu dynamically change between "add" and "remove".

RTT is sometimes reported for non-obvious cases, for instance
for checkcast instructions added during type erasure. Add a
clarifying message to RTT bug descriptions, and/or add a
FAQ entry concerning this point to the Wiki.

We've learnt that when Lancelot discovers one naming bug in an application, it
very often finds a family of similar bugs as well. Often there are actually n
bugs of the same kind present, but it might alternatively just be a family of
false positives.  The latter case is extremely annoying; it is irritating to
sift through the bug list, examining `new bugs' but finding that they all are
alike and uninteresting. Also, adding `SuppressWarnings' annotations to many
similar bugs is tiresome.

As a partial solution to this problem, we propose a `global ignore' feature
that could filter out various instances of `violation patterns' from the
analysis results. The details of the suggestion are given below:

1)
We define a violation pattern as a two-tuple
  (pattern, profile)
for a rule-book pattern and a semantic profile, such that profile is considered
violating with respect to pattern.

2)
Everytime Lancelot finds a buggy method, it adds a quick fix saying `Ignore all
naming bugs of this kind' to the method. If the user selects that option: 
  - The corresponding violation pattern is stored to project-specific meta data
    (possibly the '.project' file?).
  - All bugs matching the violation pattern are removed.

3)
There must be some way to remove violation patterns. The simplest solution is
probably a dialog box accessible from the Lancelot menu when invoked for a Java
project, that simply lists the `filtered violation patterns', and provides a
means to remove these. When a violation pattern is removed and Lancelot is in
automatic mode, analysis should run again, such that filtered bugs reappear.

"Creates custom objects" is rather unintuitive. Add a parenthesized 
remark stating what this attribute means.