[annot] Update manual with sanitizers

Summary: Should have done this when sanitizers were introduced... Reviewed By: rgrig Differential Revision: D55480827 fbshipit-source-id: b2e56f03626c22a8c154e20c01ab719b3c588214
facebook · Apr 2, 2024 · 99bf9d9 · 99bf9d9
1 parent 508efc3
commit 99bf9d9
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 15 deletions.
diff --git a/infer/man/man1/infer-analyze.txt b/infer/man/man1/infer-analyze.txt
@@ -625,11 +625,12 @@ ERLANG OPTIONS
 
 JAVA OPTIONS
        --annotation-reachability-custom-pairs json
-           Specify custom sources/sinks for the annotation reachability
-           checker
+           Specify custom sources/sinks, and optionally sanitizers for the
+           annotation reachability checker
            Example format: for custom annotations
-           com.my.annotation.{Source1,Source2,Sink1}
-           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"] }
+           com.my.annotation.{Source1,Source2,Sink1,Sanitizer1}
+           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"],
+           "sanitizers": ["Sanitizer1"] }
 
        --annotation-reachability-expensive
            Activates: check if methods annotated with @PerformanceCritical

diff --git a/infer/man/man1/infer-full.txt b/infer/man/man1/infer-full.txt
@@ -71,11 +71,12 @@ OPTIONS
            See also infer-analyze(1).
 
        --annotation-reachability-custom-pairs json
-           Specify custom sources/sinks for the annotation reachability
-           checker
+           Specify custom sources/sinks, and optionally sanitizers for the
+           annotation reachability checker
            Example format: for custom annotations
-           com.my.annotation.{Source1,Source2,Sink1}
-           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"] }
+           com.my.annotation.{Source1,Source2,Sink1,Sanitizer1}
+           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"],
+           "sanitizers": ["Sanitizer1"] }
            See also infer-analyze(1).
 
        --annotation-reachability-cxx json

diff --git a/infer/man/man1/infer.txt b/infer/man/man1/infer.txt
@@ -71,11 +71,12 @@ OPTIONS
            See also infer-analyze(1).
 
        --annotation-reachability-custom-pairs json
-           Specify custom sources/sinks for the annotation reachability
-           checker
+           Specify custom sources/sinks, and optionally sanitizers for the
+           annotation reachability checker
            Example format: for custom annotations
-           com.my.annotation.{Source1,Source2,Sink1}
-           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"] }
+           com.my.annotation.{Source1,Source2,Sink1,Sanitizer1}
+           { "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"],
+           "sanitizers": ["Sanitizer1"] }
            See also infer-analyze(1).
 
        --annotation-reachability-cxx json

diff --git a/infer/src/base/Config.ml b/infer/src/base/Config.ml
@@ -604,9 +604,9 @@ and analysis_schedule_file =
 and annotation_reachability_custom_pairs =
   CLOpt.mk_json ~long:"annotation-reachability-custom-pairs"
     ~in_help:InferCommand.[(Analyze, manual_java)]
-    {|Specify custom sources/sinks for the annotation reachability checker
-Example format: for custom annotations com.my.annotation.{Source1,Source2,Sink1}
-{ "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"] }|}
+    {|Specify custom sources/sinks, and optionally sanitizers for the annotation reachability checker
+Example format: for custom annotations com.my.annotation.{Source1,Source2,Sink1,Sanitizer1}
+{ "sources" : ["Source1", "Source2"], "sinks" : ["Sink1"], "sanitizers": ["Sanitizer1"] }|}
 
 
 and annotation_reachability_cxx =