mention that know-bug test directive takes arguments

This commit is contained in:
Tshepang Mbambo 2025-03-29 20:02:01 +02:00
parent ab762573ac
commit 6c1077e05d
1 changed files with 8 additions and 0 deletions

View File

@ -415,6 +415,14 @@ reasons, including:
can alert the developer so they know that the associated issue has been fixed can alert the developer so they know that the associated issue has been fixed
and can possibly be closed. 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 Do not include [error annotations](#error-annotations) in a test with
`known-bug`. The test should still include other normal directives and `known-bug`. The test should still include other normal directives and
stdout/stderr files. stdout/stderr files.