[jira] [Created] (HBASE-12408) Clarify ref guide findbugs section's use of "Apache licensed version of annotations"

["Sean Busbey (JIRA)" <ji...@apache.org>]

Sean Busbey created HBASE-12408:
-----------------------------------

             Summary: Clarify ref guide findbugs section's use of "Apache licensed version of annotations"
                 Key: HBASE-12408
                 URL: https://issues.apache.org/jira/browse/HBASE-12408
             Project: HBase
          Issue Type: Improvement
          Components: documentation
            Reporter: Sean Busbey
            Assignee: Sean Busbey
            Priority: Minor


The ref guide has a [findbugs section|http://hbase.apache.org/book.html#common.patch.feedback.findbugs] that ends with this line

{quote}
It is important to use the Apache-licensed version of the annotations.
{quote}

without any additional context, it's hard to figure out what we're talking about or why. The site for Findbugs itself only ever talks about its own license, which is LGPL.

I think what we're getting at is that we use the fully qualified SupressWarnings instead of the newer SuppressFBWarnings because we rely on the [cleanroom ASL reimplementation of findbugs annotations|https://github.com/stephenc/findbugs-annotations].

We should clarify that and provide some links.

* [findbugs project page|http://findbugs.sourceforge.net/]
* [cleanroom project page|https://github.com/stephenc/findbugs-annotations]
* [javadocs|http://stephenc.github.io/findbugs-annotations/apidocs/]



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)