rust-lang / rust-lang/rust

compiletest directives docs for "ignore-" are incorrect or confusing

Open
#139,516 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-compiletest A-docs C-discussion
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

https://rustc-dev-guide.rust-lang.org/tests/directives.html states that I can write ignore-x wherex is "A full target triple: aarch64-apple-ios". However, that's not correct -- some target triples work, but not all of them. I realized this when my PR failed because ignore-i686-pc-windows-gnullvm dies not work, and neither does //@ ignore-i686-unknown-uefi.

CC @jieyouxu

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with rustc-dev-guide/tests/directives.html and compare its description of ignore- target triples with the reported i686-pc-windows-gnullvm and i686-unknown-uefi cases. Trace how compiletest handles these directives, then update the documentation so it accurately states which target forms work and verify the examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.