about summary refs log tree commit diff
diff options
context:
space:
mode:
author许杰友 Jieyou Xu (Joe) <39484203+jieyouxu@users.noreply.github.com>2025-03-30 02:31:33 +0800
committerGitHub <noreply@github.com>2025-03-30 02:31:33 +0800
commit70cbe19fe005166c4321b3fcfedd0010b7d69d9d (patch)
tree16ff2f5e09719525c58a9ac5f82d059f4151978e
parent1be4bb436addb47663a63b760455b641e4912da2 (diff)
parent865a5a7e164950cf728439d12efb762e29c46c2c (diff)
downloadrust-70cbe19fe005166c4321b3fcfedd0010b7d69d9d.tar.gz
rust-70cbe19fe005166c4321b3fcfedd0010b7d69d9d.zip
Merge pull request #2288 from rust-lang/tshepang-known-bug-takes-args
mention that known-bug test directive takes arguments
-rw-r--r--src/doc/rustc-dev-guide/src/tests/ui.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/doc/rustc-dev-guide/src/tests/ui.md b/src/doc/rustc-dev-guide/src/tests/ui.md
index c8536b0045c..728ea3de418 100644
--- a/src/doc/rustc-dev-guide/src/tests/ui.md
+++ b/src/doc/rustc-dev-guide/src/tests/ui.md
@@ -415,6 +415,14 @@ reasons, including:
    can alert the developer so they know that the associated issue has been fixed
    and can possibly be closed.
 
+This directive takes comma-separated issue numbers as arguments, or `"unknown"`:
+
+- `//@ known-bug: #123, #456` (when the issues are on rust-lang/rust)
+- `//@ known-bug: rust-lang/chalk#123456`
+  (allows arbitrary text before the `#`, which is useful when the issue is on another repo)
+- `//@ known-bug: unknown`
+  (when there is no known issue yet; preferrably open one if it does not already exist)
+
 Do not include [error annotations](#error-annotations) in a test with
 `known-bug`. The test should still include other normal directives and
 stdout/stderr files.