Extend the man page description of --[no-]const-arg-checks

Brad pointed out that we didn't have documentation for the `const` and default argument intent indirect modification warning. Since the check is implementation-specific, it doesn't make sense to mention it in the spec. Brad suggested the man page as a place people are likely to encounter it in the steady state (and the entry didn't necessarily give sufficient context to begin with). ---- Signed-off-by: Lydia Duncan <[email protected]>
arezaii · Mar 12, 2024 · d5c0c7a · d5c0c7a
1 parent 0e44231
commit d5c0c7a
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/man/chpl.rst b/man/chpl.rst
@@ -390,8 +390,12 @@ OPTIONS
 
 **\--[no-]const-arg-checks**
 
-    Enable [disable] const argument checks (only when --warn-unstable is also
-    used)
+    Enable [disable] const argument checks (only when **--warn-unstable** is
+    also used).  These checks will warn when an argument is inferred to be
+    `const ref` and is indirectly modified over the course of the function.  To
+    silence the warning for a particular argument, give it a concrete argument
+    intent (such as `const ref` or `const in`, depending on if the indirect
+    modification behavior should be preserved or avoided).
 
 **\--[no-]div-by-zero-checks**