Skip to content
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit 70cbe19

Browse files
authored
Merge pull request rust-lang#2288 from rust-lang/tshepang-known-bug-takes-args
mention that known-bug test directive takes arguments
2 parents 1be4bb4 + 865a5a7 commit 70cbe19

File tree

1 file changed

+8
-0
lines changed
  • src/doc/rustc-dev-guide/src/tests

1 file changed

+8
-0
lines changed

src/doc/rustc-dev-guide/src/tests/ui.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,14 @@ reasons, including:
415415
can alert the developer so they know that the associated issue has been fixed
416416
and can possibly be closed.
417417

418+
This directive takes comma-separated issue numbers as arguments, or `"unknown"`:
419+
420+
- `//@ known-bug: #123, #456` (when the issues are on rust-lang/rust)
421+
- `//@ known-bug: rust-lang/chalk#123456`
422+
(allows arbitrary text before the `#`, which is useful when the issue is on another repo)
423+
- `//@ known-bug: unknown`
424+
(when there is no known issue yet; preferrably open one if it does not already exist)
425+
418426
Do not include [error annotations](#error-annotations) in a test with
419427
`known-bug`. The test should still include other normal directives and
420428
stdout/stderr files.

0 commit comments

Comments
 (0)