[FileCheck] Added documentation for --allow-unused-prefixes
authorMircea Trofin <mtrofin@google.com>
Mon, 2 Nov 2020 16:46:53 +0000 (08:46 -0800)
committerMircea Trofin <mtrofin@google.com>
Mon, 2 Nov 2020 20:15:45 +0000 (12:15 -0800)
Differential Revision: https://reviews.llvm.org/D90621

llvm/docs/CommandGuide/FileCheck.rst

index ef5bb10..d76ad4d 100644 (file)
@@ -64,6 +64,16 @@ and from the command line.
  comment style. In that case, consider proposing a change to the default
  comment prefixes instead.
 
+.. option:: --allow-unused-prefixes
+
+ This option controls the behavior when using more than one prefix as specified
+ by :option:`--check-prefix` or :option:`--check-prefixes`, and some of these
+ prefixes are missing in the test file. If true, this is allowed, if false,
+ FileCheck will report error, listing the missing prefixes.
+
+ It is currently, temporarily, true by default, and will be subsequently
+ switched to false.
+
 .. option:: --input-file filename
 
   File to check (defaults to stdin).