[llvm] 2211334 - [FileCheck] Added documentation for --allow-unused-prefixes

[Mircea Trofin via llvm-commits]

Author: Mircea Trofin
Date: 2020-11-02T12:15:45-08:00
New Revision: 22113341d7470d5dc6245b623f84d27c46e2895a

URL: https://github.com/llvm/llvm-project/commit/22113341d7470d5dc6245b623f84d27c46e2895a
DIFF: https://github.com/llvm/llvm-project/commit/22113341d7470d5dc6245b623f84d27c46e2895a.diff

LOG: [FileCheck] Added documentation for --allow-unused-prefixes

Differential Revision: https://reviews.llvm.org/D90621

Added: 
    

Modified: 
    llvm/docs/CommandGuide/FileCheck.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CommandGuide/FileCheck.rst b/llvm/docs/CommandGuide/FileCheck.rst
index ef5bb10162d9..d76ad4dc75ad 100644
--- a/llvm/docs/CommandGuide/FileCheck.rst
+++ b/llvm/docs/CommandGuide/FileCheck.rst
@@ -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).