Skip to content

Tracking issue for release notes of #149543: Reduce unreachable-code churn after todo!() #157767

Description

@rustbot

This issue tracks the release notes text for #149543.

cc @llogiq, @WaffleLapkin -- original issue/PR authors and assignees for drafting text

See the forge.rust-lang.org chapter about release notes for an overview of how the release team makes use of these tracking issues.

Release notes text

This section should be edited to specify the correct category(s) for the change, with succinct description(s) of what changed. Some things worth considering:

  • Does this need an additional compat notes section?
  • Was this a libs stabilization that should have additional headers to list new APIs under Stabilized APIs and Const Stabilized APIs?
# Language
- The `todo!()` macro will suppress the `unreachable_code` lint, so you no longer get a pile of warnings about unreachability for code in progress; instead, you'll get a single `todo_macro_calls` lint on the `todo!()` call itself. [Reduce `unreachable_code` churn after `todo!()`](https://github.com/rust-lang/rust/pull/149543)

Tip

Use the previous releases for inspiration on how to write the release notes text and which categories to pick.

Release blog section

If this change is notable enough for inclusion in the blog post then this section should be edited to contain a draft for the blog post. Otherwise leave it empty.

## Better handling of `todo!()`

When you're working on code, you can use the `todo!()` macro (since Rust 1.40) to document that you haven't written a piece of code yet. This acts as a runtime panic if actually reached, but unlike `panic!()` or `unreachable!()`, it specifically documents that the code is in progress. You can then compile and test the rest of the code.

However, because `todo!()` is an unconditional panic, previous versions of Rust would warn that any code occurring after it is unreachable. This can produce a lot of noise about the code you're currently working on.

Now, the `todo!()` macro will suppress the `unreachable_code` lint, so you no longer get a pile of warnings about unreachability for code in progress. Instead, you'll get a single `todo_macro_calls` lint on the `todo!()` call itself. You can control these lints independently.

Note

If a blog post section is required the release-blog-post label should be added (@rustbot label +release-blog-post) to this issue as otherwise it may be missed by the release team.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-run-makeArea: port run-make Makefiles to rmake.rsA-rustdoc-jsonArea: Rustdoc JSON backendF-explicit_tail_calls`#![feature(explicit_tail_calls)]`T-clippyRelevant to the Clippy team.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.T-langRelevant to the language teamWG-trait-system-refactorThe Rustc Trait System Refactor Initiative (-Znext-solver)needs-triageThis issue may need triage. Remove it if it has been sufficiently triaged.release-blog-postMarks issues tracking what text to put in the release blog post.relnotesMarks issues that should be documented in the release notes of the next release.relnotes-tracking-issueMarks issues tracking what text to put in release notes.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions