Fix rustdoc argument error

[inashivb]

This is the fix is corresponding to #88756 mentored by @jyn514

[rust-highfive]

r? @GuillaumeGomez

(rust-highfive has picked a reviewer for you, use r? to override)

[inashivb]

r? @jyn514

[jyn514]

Please add a test for this - it would go somewhere in run-make, there should be existing rustdoc tests there you can use as examples.

[GuillaumeGomez]

Can you add a test in src/test/rustdoc-ui where you give no arguments to rustdoc please?

[inashivb]

Can you add a test in src/test/rustdoc-ui where you give no arguments to rustdoc please?

Thank you for the prompt review! :)
I'm observing many existing tests failing on x86_64-gnu-llvm-10, ubuntu-latest-xl which were not really failing on my system, could you please tell me how should I investigate these?

[GuillaumeGomez]

Just in case you don't know how to run tests:

$ x.py test src/test/rustdoc --stage 1
$ x.py test src/test/rustdoc-ui --stage 1

If one of the two doesn't work, it's very likely your change which broke them.

[inashivb]

Just in case you don't know how to run tests:

$ x.py test src/test/rustdoc --stage 1
$ x.py test src/test/rustdoc-ui --stage 1

If one of the two doesn't work, it's very likely your change which broke them.

Thank you. I indeed did not test the right way. I just ran x.py test and that seemed to work. I seem to have broken many things. I'll work on resolving them.

[GuillaumeGomez]

Looks good to me, thanks! Wanna take a last look @jyn514 ?

[jyn514]

Hi @inashivb do you know how to make progress here? Do you need help?

[inashivb]

Hi @inashivb do you know how to make progress here? Do you need help?

Hi @jyn514 ! Yes. Could you please tell where in rustc code can I find the cmdline arguments setting and rendering? I could not find any usage of crate::usage or the help strings for any option other than in the doc directory.

[inashivb]

Hi @Dylan-DPC ! thanks for tagging me. I must have missed the notifications for change in labels. Could you please take a look at the branch now?

[notriddle]

@bors r=GuillaumeGomez,notriddle rollup=never

[bors]

📌 Commit d532d36 has been approved by GuillaumeGomez,notriddle

[bors]

⌛ Testing commit d532d36 with merge 4f2debcec269b9b4f82c6afff01890547d2c07d1...

[bors]

💔 Test failed - checks-actions

[rust-log-analyzer]

The job x86_64-gnu-stable failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

error: make failed
status: exit status: 2
command: "make"
--- stdout -------------------------------
LD_LIBRARY_PATH="/checkout/obj/build/x86_64-unknown-linux-gnu/test/run-make/issue-88756-default-output/issue-88756-default-output:/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/lib:/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-bootstrap-tools/x86_64-unknown-linux-gnu/release/deps:/checkout/obj/build/x86_64-unknown-linux-gnu/stage0/lib" '/checkout/obj/build/x86_64-unknown-linux-gnu/stage2/bin/rustdoc' 2>&1 | diff - output-default.stdout
193c193
< More information available at https://doc.rust-lang.org/1.62.0/rustdoc/what-is-rustdoc.html
---
> More information available at https://doc.rust-lang.org/nightly/rustdoc/what-is-rustdoc.html
--- stderr -------------------------------
--- stderr -------------------------------
make: *** [Makefile:4: all] Error 1



failures:

[inashivb]

I see the cause of failure as

< More information available at https://doc.rust-lang.org/1.62.0/rustdoc/what-is-rustdoc.html
---
> More information available at https://doc.rust-lang.org/nightly/rustdoc/what-is-rustdoc.html

Is there a VERSION or something env var? I tried looking for version in small and caps but can't see rust specific version setting. Could you please assist here?

[notriddle]

Yeah, it's called $CHANNEL

[compiler-errors]

I did a bors resync and this seems to have gotten reapproved, sorry for the noise

@bors r-

[inashivb]

Yeah, it's called $CHANNEL

@notriddle could you please assist in how to use it? I cannot seem to make it work by setting it on Makefile or the main.rs file (that I saw some UI tests do) [not sure if I'm reading it right though 😓 ]

[notriddle]

It looks like $CHANNEL is usually done in tests as a normalization, done on a case-by-case basis. Look at the first line of this test case, for example.

However, since you aren’t using compiletest, you’ll need to implement the normalization yourself. For example, use a command like this one in the makefiles.

$(BARE_RUSTDOC) 2>&1 | sed 's@nightly|beta|1\.[0-9][0-9]\.[0-9]@$$CHANNEL@g' | diff - output-default.stdout

[bors]

☔ The latest upstream changes (presumably #97239) made this pull request unmergeable. Please resolve the merge conflicts.

[GuillaumeGomez]

I finished this PR in #98331.
Thanks @inashivb for working on this!