about summary refs log tree commit diff
path: root/src/etc/htmldocck.py
diff options
context:
space:
mode:
authorNoah Lev <camelidcamel@gmail.com>2022-08-09 21:52:04 -0700
committerNoah Lev <camelidcamel@gmail.com>2022-08-13 00:35:03 -0400
commit01408fc62762838b72dfb6ce090708d3e8303ed9 (patch)
treeeab295cb0a14c70a2cf2cbf51ce4de06abc9ca28 /src/etc/htmldocck.py
parent2787eb05d5018c6d8d3087a373d3ea758a9db9b9 (diff)
downloadrust-01408fc62762838b72dfb6ce090708d3e8303ed9.tar.gz
rust-01408fc62762838b72dfb6ce090708d3e8303ed9.zip
Rename `@{has,matches}-literal` to `...text`
Reasons:
1. It's shorter.
2. `@matches-literal` seems to contradict itself: a regex is
   intrinsically not a literal match, while it is still a textual match.
Diffstat (limited to 'src/etc/htmldocck.py')
-rw-r--r--src/etc/htmldocck.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/src/etc/htmldocck.py b/src/etc/htmldocck.py
index 1cc86c1a339..48a83a66957 100644
--- a/src/etc/htmldocck.py
+++ b/src/etc/htmldocck.py
@@ -41,15 +41,15 @@ There are a number of supported commands:
   `PATH` is relative to the output directory. It can be given as `-`
   which repeats the most recently used `PATH`.
 
-* `@has-literal PATH PATTERN` and `@matches-literal PATH PATTERN` checks
+* `@hastext PATH PATTERN` and `@matchestext PATH PATTERN` checks
   for the occurrence of the given pattern `PATTERN` in the specified file.
   Only one occurrence of the pattern is enough.
 
-  For `@has-literal`, `PATTERN` is a whitespace-normalized (every consecutive
+  For `@hastext`, `PATTERN` is a whitespace-normalized (every consecutive
   whitespace being replaced by one single space character) string.
   The entire file is also whitespace-normalized including newlines.
 
-  For `@matches-literal`, `PATTERN` is a Python-supported regular expression.
+  For `@matchestext`, `PATTERN` is a Python-supported regular expression.
   The file remains intact but the regexp is matched without the `MULTILINE`
   and `IGNORECASE` options. You can still use a prefix `(?m)` or `(?i)`
   to override them, and `\A` and `\Z` for definitely matching
@@ -542,19 +542,19 @@ ERR_COUNT = 0
 def check_command(c, cache):
     try:
         cerr = ""
-        if c.cmd in ['has', 'has-literal', 'matches', 'matches-literal']:  # string test
+        if c.cmd in ['has', 'hastext', 'matches', 'matchestext']:  # string test
             regexp = c.cmd.startswith('matches')
-            if len(c.args) == 1 and not regexp and 'literal' not in c.cmd:  # @has <path> = file existence
+            if len(c.args) == 1 and not regexp and 'text' not in c.cmd:  # @has <path> = file existence
                 try:
                     cache.get_file(c.args[0])
                     ret = True
                 except FailedCheck as err:
                     cerr = str(err)
                     ret = False
-            elif len(c.args) == 2 and 'literal' in c.cmd:  # @has-literal/matches-literal <path> <pat> = string test
+            elif len(c.args) == 2 and 'text' in c.cmd:  # @hastext/matchestext <path> <pat> = string test
                 cerr = "`PATTERN` did not match"
                 ret = check_string(cache.get_file(c.args[0]), c.args[1], regexp)
-            elif len(c.args) == 3 and 'literal' not in c.cmd:  # @has/matches <path> <pat> <match> = XML tree test
+            elif len(c.args) == 3 and 'text' not in c.cmd:  # @has/matches <path> <pat> <match> = XML tree test
                 cerr = "`XPATH PATTERN` did not match"
                 ret = get_nb_matching_elements(cache, c, regexp, True) != 0
             else: