rustdoc: add `--print` option by ShE3py · Pull Request #151618 · rust-lang/rust

ShE3py · 2026-01-24T21:01:37Z

Context: --print crate-root-lint-levels (#139180) is only available for rustc and clippy-driver, while it would make sense for it to also be available for rustdoc (à la #83895.)

Not too sure about the stability of rustdoc --print=any or if this needs a MCP; strictly speaking, only rustdoc +nightly -Z unstable-options --print=crate-root-lint-levels would be required (and the rustdoc --print would be stabilized together with crate-root-lint-levels), but I guess that makes sense to have all the --prints for consistency.

For regression tests, not sure if ui or run-make is preferable, as run-make would need some sort of trait to avoid duplicating code between rustc() and rustdoc() (or just test rustdoc as it delegates to rustc):

rust/tests/run-make/print-crate-root-lint-levels/rmake.rs

Lines 82 to 88 in 021fc25

    
           fn check(CrateRootLintLevels { args, contains }: CrateRootLintLevels) { 
        
               let output = rustc() 
        
                   .input("lib.rs") 
        
                   .arg("-Zunstable-options") 
        
                   .print("crate-root-lint-levels") 
        
                   .args(args) 
        
                   .run();

@rustbot label +A-CLI +A-print-requests

rustbot · 2026-01-24T21:01:42Z

r? @notriddle

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Urgau · 2026-01-24T22:01:58Z

I could indeed see the --print being useful in rustdoc, but I'm still a bit curious what your use-case.
Would you be able describe it?

ShE3py · 2026-01-25T00:14:46Z

I could indeed see the --print being useful in rustdoc, but I'm still a bit curious what your use-case. Would you be able describe it?

I'd like to diff the default lint-levels of two Rust versions in order to simplify updating the lints when I come back after a while (e.g. remove -W foo if foo was promoted to warn-by-default).

@rustbot author

rustbot · 2026-01-25T00:14:51Z

Reminder, once the PR becomes ready for a review, use @rustbot ready.

ShE3py · 2026-01-28T23:25:29Z

-    (option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
+    env!("CFG_COMPILER_HOST_TRIPLE")


That was changed from env! to option_env! in the first commit of #13724, but not sure why this change was made or if it's still relevant as CI is green.

(Was looking looking for a #[expect] reason as removing the extra parentheses triggers deny-by-default clippy::option_env_unwrap)

Urgau · 2026-07-25T10:19:36Z

@ShE3py still interested in driving this PR forward?

ShE3py · 2026-07-26T11:18:15Z

Yup, prolly next month when I have time.

rustbot · 2026-08-30T18:21:50Z

This PR was rebased onto a different main commit. Here's a range-diff highlighting what actually changed.

Rebasing is a normal part of keeping PRs up to date, so no action is needed—this note is just to help reviewers.

ShE3py · 2026-08-30T20:50:21Z

+        // -W help
+        if sess.opts.describe_lints {
+            rustc_driver::describe_lints(sess, registered_lints);
+            return Ok(None);
+        }


Fixes -W help when running doctests:

$ rustdoc +nightly -Whelp --test /dev/null error: couldn't find file ``

View changes since the review

ShE3py · 2026-08-30T21:01:41Z

Copied from tests/run-make/print-crate-root-lint-levels/, replaced unexpected_cfgs with rustdoc::private_doc_tests.

View changes since the review

ShE3py · 2026-08-30T21:29:02Z

I have grouped the --print=options into four groups: crate, target, codegen and linker. Only the first two groups makes sense for Rustdoc imo.

I can somewhat far-fetch someone using rustdoc --print=host-tuple, but it might be better to initially restricts the print set to actual use cases, and then add more as people request them, e.g. not trying to make it as big as possible right from the start?

For Markdown files and doctests, --print would probably mean having one entry per ```code block```, at least for the crate group. Could be made in a follow-up PR, for now I flat out error.

@rustbot review

rustdoc: add `--print` option try-job: test-various try-job: x86_64-msvc-*

rust-bors · 2026-08-31T23:00:12Z

💔 Test for 8facfe3 failed: CI. Failed job:

try - test-various (web logs, enhanced plaintext logs)

ShE3py · 2026-09-01T10:02:53Z

AUX is a reserved name in MS-DOS ;)

Added ignore directives based on another doctest test:

rust/tests/run-make/rustdoc/doctest/test-builder/rmake.rs

Lines 26 to 34 in 3cabe36

    
           // Some targets (for example wasm) cannot execute doctests directly even with a runner, 
        
           // so only exercise the success path when the target can run on the host. 
        
           if target().contains("wasm") 
        
               || target().contains("sgx") 
        
               || target().contains("pauthtest") 
        
               || std::env::var_os("REMOTE_TEST_CLIENT").is_some() 
        
           { 
        
               return; 
        
           }

@bors try jobs=test-various,armhf-gnu

rustdoc: add `--print` option try-job: test-various try-job: armhf-gnu

rust-bors · 2026-09-01T12:10:37Z

💔 Test for 6508b6f failed: CI. Failed job:

try - armhf-gnu (web logs, enhanced plaintext logs)

rust-bors · 2026-09-01T12:37:27Z

Unknown argument "armhf-gnu". Did you mean to use @bors jobs=<jobs>|parent=<parent>? Run @bors help or go to https://bors.rust-lang.org/help to see available commands.

ShE3py · 2026-09-01T12:42:44Z

@bors try jobs=armhf-gnu

rustdoc: add `--print` option try-job: armhf-gnu

rust-bors · 2026-09-01T14:14:54Z

☀️ Try build successful (CI)
Build commit: 82dc2e7 (82dc2e751b36ffa49fa36ba039a665ee362563b7)
Base parent: 7022271 (70222712809cd5cc1718ed8995914a1cbacb6b92)

ShE3py · 2026-09-01T16:21:56Z

@bors r=notriddle

rust-bors · 2026-09-01T16:21:59Z

📌 Commit bf27a5a has been approved by notriddle

It is now in the queue for this repository.

@rustbot

rustdoc: add `--print` option Context: `--print crate-root-lint-levels` (rust-lang#139180) is only available for `rustc` and `clippy-driver`, while it would make sense for it to also be available for `rustdoc` (à la rust-lang#83895.) Not too sure about the stability of `rustdoc --print=any` or if this needs a MCP; strictly speaking, only `rustdoc +nightly -Z unstable-options --print=crate-root-lint-levels` would be required (and the `rustdoc --print` would be stabilized together with `crate-root-lint-levels`), but I guess that makes sense to have all the `--print`s for consistency. For regression tests, not sure if ui or run-make is preferable, as run-make would need some sort of trait to avoid duplicating code between `rustc()` and `rustdoc()` (or just test `rustdoc` as it delegates to `rustc`): https://github.com/rust-lang/rust/blob/021fc25b7a48f6051bee1e1f06c7a277e4de1cc9/tests/run-make/print-crate-root-lint-levels/rmake.rs#L82-L88 @rustbot label +A-CLI +A-print-requests

@rustbot

rustdoc: add `--print` option Context: `--print crate-root-lint-levels` (rust-lang#139180) is only available for `rustc` and `clippy-driver`, while it would make sense for it to also be available for `rustdoc` (à la rust-lang#83895.) Not too sure about the stability of `rustdoc --print=any` or if this needs a MCP; strictly speaking, only `rustdoc +nightly -Z unstable-options --print=crate-root-lint-levels` would be required (and the `rustdoc --print` would be stabilized together with `crate-root-lint-levels`), but I guess that makes sense to have all the `--print`s for consistency. For regression tests, not sure if ui or run-make is preferable, as run-make would need some sort of trait to avoid duplicating code between `rustc()` and `rustdoc()` (or just test `rustdoc` as it delegates to `rustc`): https://github.com/rust-lang/rust/blob/021fc25b7a48f6051bee1e1f06c7a277e4de1cc9/tests/run-make/print-crate-root-lint-levels/rmake.rs#L82-L88 @rustbot label +A-CLI +A-print-requests

…uwer Rollup of 11 pull requests Successful merges: - #151618 (rustdoc: add `--print` option) - #161287 (Update `icu_list` dependency to 2.3) - #161767 (change DEFAULT_STACK_SIZE to be 32MB on s390x) - #161968 (Diverse offload fixes) - #161971 (Remove -Zsaturating-float-casts flag) - #162071 (Fix ICE of getting item name from RPITIT) - #161209 (Rework `next_power_of_two` to always be `1 << …`) - #162073 (Change some `Infallible` to `!` in std) - #162086 (Remove `gate_check` from `AttributeStability::Unstable`) - #162102 (`alloc` crate: shrink undocumented `unsafe` blocks) - #162110 (make it clear that Range cannot represent arbitrary ranges)

@rustbot

Rollup merge of #151618 - ShE3py:rustdoc-print, r=notriddle rustdoc: add `--print` option Context: `--print crate-root-lint-levels` (#139180) is only available for `rustc` and `clippy-driver`, while it would make sense for it to also be available for `rustdoc` (à la #83895.) Not too sure about the stability of `rustdoc --print=any` or if this needs a MCP; strictly speaking, only `rustdoc +nightly -Z unstable-options --print=crate-root-lint-levels` would be required (and the `rustdoc --print` would be stabilized together with `crate-root-lint-levels`), but I guess that makes sense to have all the `--print`s for consistency. For regression tests, not sure if ui or run-make is preferable, as run-make would need some sort of trait to avoid duplicating code between `rustc()` and `rustdoc()` (or just test `rustdoc` as it delegates to `rustc`): https://github.com/rust-lang/rust/blob/021fc25b7a48f6051bee1e1f06c7a277e4de1cc9/tests/run-make/print-crate-root-lint-levels/rmake.rs#L82-L88 @rustbot label +A-CLI +A-print-requests

rustbot assigned notriddle Jan 24, 2026

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels Jan 24, 2026

rustbot added A-CLI Area: Command-line interface (CLI) to the compiler A-print-requests Area: print requests (`--print=...`) labels Jan 24, 2026

This comment has been minimized.

Sign in to view

fmease reviewed Jan 24, 2026

View reviewed changes

Comment thread src/librustdoc/lib.rs Outdated

Comment thread src/librustdoc/lib.rs

Comment thread src/librustdoc/config.rs Outdated

rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 25, 2026

rustbot added the A-run-make Area: port run-make Makefiles to rmake.rs label Jan 28, 2026

This comment has been minimized.

Sign in to view

ShE3py commented Jan 28, 2026

View reviewed changes

fmease mentioned this pull request Feb 20, 2026

feat(rustdoc): stabilize --emit flag #146220

Merged

This comment has been minimized.

Sign in to view

ShE3py added 2 commits August 30, 2026 15:05

doc: PrintKind

938b233

rustdoc: cleanup main_args() markdown handling

2e7e5cb

ShE3py force-pushed the rustdoc-print branch from 475fcfc to ca3a5e6 Compare August 30, 2026 18:21

ShE3py commented Aug 30, 2026

View reviewed changes

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 30, 2026

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request Aug 31, 2026

Auto merge of #151618 - ShE3py:rustdoc-print, r=<try>

8facfe3

rustdoc: add `--print` option try-job: test-various try-job: x86_64-msvc-*

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request Sep 1, 2026

Auto merge of #151618 - ShE3py:rustdoc-print, r=<try>

6508b6f

rustdoc: add `--print` option try-job: test-various try-job: armhf-gnu

This comment has been minimized.

Sign in to view

rustdoc: add tests for Markdown files

bf27a5a

ShE3py force-pushed the rustdoc-print branch from 341679a to bf27a5a Compare September 1, 2026 12:28

This comment was marked as outdated.

Sign in to view

This comment has been minimized.

Sign in to view

rust-bors Bot pushed a commit that referenced this pull request Sep 1, 2026

Auto merge of #151618 - ShE3py:rustdoc-print, r=<try>

82dc2e7

rustdoc: add `--print` option try-job: armhf-gnu

rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 1, 2026

JonathanBrouwer mentioned this pull request Sep 1, 2026

Rollup of 7 pull requests #162136

Closed

This was referenced Sep 1, 2026

Rollup of 11 pull requests #162139

Closed

Rollup of 11 pull requests #162148

Merged

rust-bors Bot merged commit 549f475 into rust-lang:main Sep 1, 2026
14 checks passed

rustbot added this to the 1.100.0 milestone Sep 1, 2026

	fn check(CrateRootLintLevels { args, contains }: CrateRootLintLevels) {
	let output = rustc()
	.input("lib.rs")
	.arg("-Zunstable-options")
	.print("crate-root-lint-levels")
	.args(args)
	.run();

		(option_env!("CFG_COMPILER_HOST_TRIPLE")).expect("CFG_COMPILER_HOST_TRIPLE")
		env!("CFG_COMPILER_HOST_TRIPLE")

Uh oh!

Uh oh!

Conversation

ShE3py commented Jan 24, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rustbot commented Jan 24, 2026

Uh oh!

This comment has been minimized.

Urgau commented Jan 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ShE3py commented Jan 25, 2026

Uh oh!

rustbot commented Jan 25, 2026

Uh oh!

This comment has been minimized.

ShE3py Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Urgau commented Jul 25, 2026

Uh oh!

ShE3py commented Jul 26, 2026

Uh oh!

rustbot commented Aug 30, 2026

Uh oh!

ShE3py Aug 30, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShE3py Aug 30, 2026 • edited by rustbot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShE3py commented Aug 30, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors Bot commented Aug 31, 2026

Uh oh!

ShE3py commented Sep 1, 2026

Uh oh!

This comment has been minimized.

This comment has been minimized.

rust-bors Bot commented Sep 1, 2026

Uh oh!

This comment was marked as outdated.

rust-bors Bot commented Sep 1, 2026

Uh oh!

ShE3py commented Sep 1, 2026

Uh oh!

This comment has been minimized.

rust-bors Bot commented Sep 1, 2026

Uh oh!

ShE3py commented Sep 1, 2026

Uh oh!

rust-bors Bot commented Sep 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

ShE3py commented Jan 24, 2026 •

edited by rustbot

Loading

ShE3py Aug 30, 2026 •

edited by rustbot

Loading

ShE3py Aug 30, 2026 •

edited by rustbot

Loading