hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "stack (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (HBASE-12408) Clarify ref guide findbugs section's use of "Apache licensed version of annotations"
Date Sat, 28 Jan 2017 20:52:25 GMT

    [ https://issues.apache.org/jira/browse/HBASE-12408?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15844188#comment-15844188

stack commented on HBASE-12408:

This is great [~awked06] I'd suggest point at example usage in our source code either by referring
to it and/or by linking to an example in a class; e.g. https://git-wip-us.apache.org/repos/asf?p=hbase.git;a=blob;f=hbase-common/src/main/java/org/apache/hadoop/hbase/CellComparator.java;h=bb08d6ce1bf40a2cb332f47981c6d9e2c60e106d;hb=3693d1306d3f42d04298abf682112a6c21fcef74#l45

> 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
>            Priority: Trivial
>              Labels: beginner
>         Attachments: HBASE-12408.master.001.patch
> 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

View raw message