[starvation] document LOCKLESS_VIOLATION

Summary: As per title.

Reviewed By: jvillard

Differential Revision: D22019459

fbshipit-source-id: 87e5bed9d

infer/documentation/issues/LOCKLESS_VIOLATION.md

@@ -0,0 +1,18 @@
+A method implements an interface signature annotated with `@Lockless` but which transitively acquires a lock.
+
+Example:
+
+```java
+Interface I {
+    @Lockless
+    public void no_lock();
+}
+
+class C implements I {
+  private synchronized do_lock() {}
+
+  public void no_lock() { // this method should not acquire any locks
+    do_lock();
+  }
+}
+```

infer/src/base/IssueType.ml

@@ -661,7 +661,10 @@ let lock_consistency_violation =
     ~user_documentation:[%blob "../../documentation/issues/LOCK_CONSISTENCY_VIOLATION.md"]
 
 
-let lockless_violation = register_from_string ~id:"LOCKLESS_VIOLATION" Error Starvation
+let lockless_violation =
+  register_from_string ~id:"LOCKLESS_VIOLATION" Error Starvation
+    ~user_documentation:[%blob "../../documentation/issues/LOCKLESS_VIOLATION.md"]
+
 
 let logging_private_data = register_from_string ~id:"LOGGING_PRIVATE_DATA" Error Quandary