Add parameter to control warning about memory constraints

docs/CHANGELOG.md

@@ -6,6 +6,9 @@ Version 3.26.0 (October 4, 2022)
 Annotations are available for some new JDK 17 APIs (some of those
 introduced since JDK 11).
 
+Added `-AnoWarnMemoryConstraints` to change the "Memory constraints are impeding
+performance; please increase max heap size" message from a warning to a note.
+
 **Implementation details:**
 
 **Closed issues:**

docs/manual/contributors.tex

@@ -56,6 +56,7 @@
 Jugal Mistry,
 Junhao Hu,
 Kartikeya Goswami,
+Kenneth Knowles,
 Kivanc Muslu,
 Konstantin Weitz,
 Lazaro Clapp,

docs/manual/creating-a-checker.tex

@@ -1920,6 +1920,10 @@
 already reported the bug, and you want to continue using the checker on a
 large codebase without being inundated in stack traces.
 
+\item \code{-AnoWarnMemoryConstraints}: when memory constraints are
+impeding performance, issue a note rather than a warning.
+This prevents the message from being elevated to an error by \code{-Werror}.
+
 \item \code{-AdumpOnErrors}: Outputs a stack trace when reporting errors or warnings.
 
 \end{itemize}

framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java

@@ -296,6 +296,9 @@
   // org.checkerframework.framework.source.SourceChecker.logBugInCF
   "noPrintErrorStack",
 
+  // If true, issue a NOTE rather than a WARNING when performance is impeded by memory constraints.
+  "noWarnMemoryConstraints",
+
   // Only output error code, useful for testing framework
   // org.checkerframework.framework.source.SourceChecker.message(Kind, Object, String, Object...)
   "nomsgtext",
@@ -940,7 +943,12 @@ public void typeProcess(TypeElement e, TreePath p) {
     if (!warnedAboutGarbageCollection) {
       String gcUsageMessage = SystemPlume.gcUsageMessage(.25, 60);
       if (gcUsageMessage != null) {
-        messager.printMessage(Kind.WARNING, gcUsageMessage);
+        boolean noWarnMemoryConstraints =
+            (processingEnv != null
+                && processingEnv.getOptions() != null
+                && processingEnv.getOptions().containsKey("noWarnMemoryConstraints"));
+        Kind kind = noWarnMemoryConstraints ? Kind.NOTE : Kind.WARNING;
+        messager.printMessage(kind, gcUsageMessage);
         warnedAboutGarbageCollection = true;
       }
     }