Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(85)

Unified Diff: docs/use_find_bugs_for_android.md

Issue 1309473002: WIP: Migrate Wiki content over to src/docs (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: documentation_best_practices.md Created 5 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: docs/use_find_bugs_for_android.md
diff --git a/docs/use_find_bugs_for_android.md b/docs/use_find_bugs_for_android.md
new file mode 100644
index 0000000000000000000000000000000000000000..862c14719cc8e63f753666d81174a14b17455967
--- /dev/null
+++ b/docs/use_find_bugs_for_android.md
@@ -0,0 +1,32 @@
+# Introduction
+
+[FindBugs](http://findbugs.sourceforge.net) is an open source static analysis tool from the University of Maryland that looks for potential bugs in Java class files. We have some scripts to run it over the Java code at build time.
+
+# How To Run
+
+For gyp builds, add `run_findbugs=1` to your `GYP_DEFINES`.
+
+For gn builds, add `run_findbugs=true` to the args you pass to `gn gen`:
+
+```
+gn gen --args='target_os="android" run_findbugs=true'
+```
+
+Note that running findbugs will add time to your build. The amount of additional time required depends on the number of targets on which findbugs runs, though it will usually be between 1-10 minutes.
+
+Some of the warnings are false positives. In general, they should be suppressed using [@SuppressFBWarnings](https://code.google.com/p/chromium/codesearch#chromium/src/base/android/java/src/org/chromium/base/annotations/SuppressFBWarnings.java). In the rare event that a warning should be suppressed across the entire code base, it should be added to the [exclusion file](https://code.google.com/p/chromium/codesearch#chromium/src/build/android/findbugs_filter/findbugs_exclude.xml) instead. If you modify this file:
+
+ * Include a comment that says what you're suppressing and why.
+ * The existing suppressions should give you an idea of the syntax. See also the FindBugs documentation. Note that the documentation doesn't seem totally accurate (there's probably some version skew between the online docs and the version of FindBugs we're using) so you may have to experiment a little.
+
+# Chromium's [FindBugs](http://findbugs.sourceforge.net) plugin
+
+We have [FindBugs plugin](https://code.google.com/p/chromium/codesearch#chromium/src/tools/android/findbugs_plugin/) to enforce chromium specific Java rules. It currently detects:
+ * Synchronized method
+ * Synchronized this
+
+# [FindBugs](http://findbugs.sourceforge.net) on the Bots
+
+[FindBugs](http://findbugs.sourceforge.net) is configured to run on:
+ * [android\_clang\_dbg\_recipe](http://build.chromium.org/p/tryserver.chromium.linux/builders/android_clang_dbg_recipe) on the commit queue
+ * [Android Clang Builder (dbg)](http://build.chromium.org/p/chromium.linux/builders/Android%20Clang%20Builder%20(dbg)) on the main waterfall

Powered by Google App Engine
This is Rietveld 408576698