Merge pull request #2288 from rust-lang/tshepang-known-bug-takes-args

mention that known-bug test directive takes arguments
2025-03-30 02:31:33 +08:00 · 2025-03-30 02:31:33 +08:00 · fdca2d3605
parent cfe28b52f9 6c1077e05d
commit fdca2d3605
1 changed files with 8 additions and 0 deletions
--- a/src/tests/ui.md
+++ b/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.