Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mention that known-bug test directive takes arguments #2288

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

mention that known-bug test directive takes arguments #2288

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/tests/ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,12 @@ 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,
each prefixed with a `#`.
Examples are `//@ known-bug: #12345` and `//@ known-bug: #123, #456`.
Arbitrary text before the `#` is also accepted,
example being `rust-lang/rust#12345`.
Comment on lines +418 to +422
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: probably sth like

The known-bug directive accepts issue numbers or "unknown". Valid forms:

  • //@ known-bug: #123456 (when the issue is on rust-lang/rust)
  • //@ known-bug: rust-lang/chalk#123456 (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.
Expand Down