about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorChris Simpkins <git.simpkins@gmail.com>2020-05-28 16:16:34 -0400
committerWho? Me?! <mark-i-m@users.noreply.github.com>2020-05-28 19:57:59 -0500
commit6edb8366dd081529757aa0feac0c7bfa0f4a7a89 (patch)
treeaad4ea0078ee1c8d2d8361383b80e4a32f2d95c1 /src/doc/rustc-dev-guide
parent30a732758164b302176f10687856049618a633a6 (diff)
downloadrust-6edb8366dd081529757aa0feac0c7bfa0f4a7a89.tar.gz
rust-6edb8366dd081529757aa0feac0c7bfa0f4a7a89.zip
add documentation of UI test error annotation substring support
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/tests/adding.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/adding.md b/src/doc/rustc-dev-guide/src/tests/adding.md
index e2a397a5b6a..e20d7fdc1d7 100644
--- a/src/doc/rustc-dev-guide/src/tests/adding.md
+++ b/src/doc/rustc-dev-guide/src/tests/adding.md
@@ -194,7 +194,10 @@ source.
 Error annotations specify the errors that the compiler is expected to
 emit. They are "attached" to the line in source where the error is
 located. Error annotations are considered during tidy lints of line
-length and should be formatted according to tidy requirements. 
+length and should be formatted according to tidy requirements. You may
+use an error message prefix sub-string if necessary to meet line length 
+requirements.  Make sure that the text is long enough for the error 
+message to be self-documenting.
 
 The error annotation definition and source line definition association
 is defined with the following set of idioms: