diff options
| author | Tshepang Mbambo <tshepang@gmail.com> | 2025-03-29 20:02:01 +0200 |
|---|---|---|
| committer | Tshepang Mbambo <tshepang@gmail.com> | 2025-03-29 20:02:01 +0200 |
| commit | 865a5a7e164950cf728439d12efb762e29c46c2c (patch) | |
| tree | 40d867a188536f04aa30561aeb6bd3d8f808b7a8 | |
| parent | 34a340e85923dd0d327a08effe9bcf7701758079 (diff) | |
| download | rust-865a5a7e164950cf728439d12efb762e29c46c2c.tar.gz rust-865a5a7e164950cf728439d12efb762e29c46c2c.zip | |
mention that know-bug test directive takes arguments
| -rw-r--r-- | src/doc/rustc-dev-guide/src/tests/ui.md | 8 |
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. |