From c8aadf4367aafb5e8231a20863139a35375c4b83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E8=AE=B8=E6=9D=B0=E5=8F=8B=20Jieyou=20Xu=20=28Joe=29?=
 <jieyouxu@outlook.com>
Date: Tue, 5 Mar 2024 08:14:47 +0000
Subject: [PATCH] Document that test names cannot contain dots

---
 src/tests/ui.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/tests/ui.md b/src/tests/ui.md
index cffecda82..3f8502640 100644
--- a/src/tests/ui.md
+++ b/src/tests/ui.md
@@ -64,6 +64,9 @@ The general form is:
 
 *test-name*`.`*revision*`.`*compare_mode*`.`*extension*
 
+* *test-name* cannot contain dots. This is so that the general form of test
+  output filenames have a predictable form we can pattern match on in order to
+  track stray test output files.
 * *revision* is the [revision](#cfg-revisions) name.
   This is not included when not using revisions.
 * *compare_mode* is the [compare mode](#compare-modes).