[PATCH] D38787: [arm-llvm-patches] [FileCheck] doc update/fix

[Sjoerd Meijer via Phabricator via llvm-commits]

SjoerdMeijer created this revision.
Herald added subscribers: kristof.beyls, aemerson.

This adds to the documentation that the matcher supports/implements POSIX BRE and ERE.
It also fixes a minor issue in the regexp describing a variable name:  underscores are allowed too.


https://reviews.llvm.org/D38787

Files:
  docs/CommandGuide/FileCheck.rst


Index: docs/CommandGuide/FileCheck.rst
===================================================================
--- docs/CommandGuide/FileCheck.rst
+++ docs/CommandGuide/FileCheck.rst
@@ -397,10 +397,12 @@
 For most uses of FileCheck, fixed string matching is perfectly sufficient.  For
 some things, a more flexible form of matching is desired.  To support this,
 FileCheck allows you to specify regular expressions in matching strings,
-surrounded by double braces: ``{{yourregex}}``.  Because we want to use fixed
-string matching for a majority of what we do, FileCheck has been designed to
-support mixing and matching fixed string matching with regular expressions.
-This allows you to write things like this:
+surrounded by double braces: ``{{yourregex}}``. FileCheck implements a POSIX
+regular expression matcher. Both Basic (BRE) and Extended POSIX regular
+expressions (ERE) are supported.  Because we want to use fixed string matching
+for a majority of what we do, FileCheck has been designed to support mixing and
+matching fixed string matching with regular expressions.  This allows you to
+write things like this:
 
 .. code-block:: llvm
 
@@ -434,7 +436,7 @@
 variable ``REGISTER``.  The second line verifies that whatever is in
 ``REGISTER`` occurs later in the file after an "``andw``".  :program:`FileCheck`
 variable references are always contained in ``[[ ]]`` pairs, and their names can
-be formed with the regex ``[a-zA-Z][a-zA-Z0-9]*``.  If a colon follows the name,
+be formed with the regex ``[a-zA-Z_][a-zA-Z0-9_]*``.  If a colon follows the name,
 then it is a definition of the variable; otherwise, it is a use.
 
 :program:`FileCheck` variables can be defined multiple times, and uses always


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D38787.118559.patch
Type: text/x-patch
Size: 1719 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20171011/52ed6f71/attachment.bin>