Clean up rustdoc source code #71900

GuillaumeGomez · 2020-05-04T21:37:23Z

cc @rust-lang/rustdoc

src/librustdoc/markdown.rs

kinnison

One concern I have is that we've now changed the CLI ABI-incompatibly in that we no longer have distinguished exit codes for the various error conditions. Is this going to be a problem for anyone?

src/librustdoc/markdown.rs

GuillaumeGomez · 2020-05-08T12:15:00Z

One concern I have is that we've now changed the CLI ABI-incompatibly in that we no longer have distinguished exit codes for the various error conditions. Is this going to be a problem for anyone?

No one uses rustdoc CLI ABI except rustdoc itself. So if there is a problem, the current tests will catch it.

GuillaumeGomez · 2020-05-08T13:08:58Z

Updated!

kinnison

Looks reasonable to me. If @ollie27 agrees then r+

ollie27 · 2020-05-09T00:49:00Z

src/librustdoc/docfs.rs

@@ -12,6 +12,7 @@
 use std::fs;
 use std::io;
 use std::path::Path;
+use std::string::ToString;


ToString is in the prelude so doesn't need to be imported.

@GuillaumeGomez did you miss this comment?

ollie27 · 2020-05-09T00:49:27Z

No one uses rustdoc CLI ABI except rustdoc itself.

I don't know what that means but this PR does change the exit codes of rustdoc which people could be relying on. I hope no one is because they don't seem to be documented so I think this is fine to change.

So if there is a problem, the current tests will catch it.

Do we even have any tests for these error cases?

Mark-Simulacrum · 2020-05-09T01:00:55Z

Please be more cautious about breakage like this :)

However in this case I agree that we should be free to change exit codes (so long as all errors still have nonzero exit status). However, we should be sure to mark as relnotes so that this can get recorded in compat notes.

@rustbot label relnotes

ollie27 · 2020-05-09T01:25:12Z

markdown::test also returns exit codes that aren't 0 or 1 so it will be worth changing that as well to keep things consistent:

rust/src/librustdoc/markdown.rs

Line 138 in 7ebd87a

Err(LoadStringError::BadUtf8) => return 2,

GuillaumeGomez · 2020-05-09T09:58:30Z

I'll make the change then!

GuillaumeGomez · 2020-05-09T11:38:01Z

Updated!

GuillaumeGomez · 2020-05-26T08:37:19Z

@bors: r=ollie27,kinnison

bors · 2020-05-26T08:37:20Z

📌 Commit c8fb0d7 has been approved by ollie27,kinnison

bors · 2020-05-26T10:42:46Z

⌛ Testing commit c8fb0d7 with merge aeca4d6...

bors · 2020-05-26T14:15:22Z

☀️ Test successful - checks-azure
Approved by: ollie27,kinnison
Pushing aeca4d6 to master...

While here clean up all pkglint warnings. Changes since 1.44.1: Version 1.45.2 (2020-08-03) ========================== * [Fix bindings in tuple struct patterns][74954] * [Fix track_caller integration with trait objects][74784] [74954]: rust-lang/rust#74954 [74784]: rust-lang/rust#74784 Version 1.45.1 (2020-07-30) ========================== * [Fix const propagation with references.][73613] * [rustfmt accepts rustfmt_skip in cfg_attr again.][73078] * [Avoid spurious implicit region bound.][74509] * [Install clippy on x.py install][74457] [73613]: rust-lang/rust#73613 [73078]: rust-lang/rust#73078 [74509]: rust-lang/rust#74509 [74457]: rust-lang/rust#74457 Version 1.45.0 (2020-07-16) ========================== Language -------- - [Out of range float to int conversions using `as` has been defined as a saturating conversion.][71269] This was previously undefined behaviour, but you can use the `{f64, f32}::to_int_unchecked` methods to continue using the current behaviour, which may be desirable in rare performance sensitive situations. - [`mem::Discriminant<T>` now uses `T`'s discriminant type instead of always using `u64`.][70705] - [Function like procedural macros can now be used in expression, pattern, and statement positions.][68717] This means you can now use a function-like procedural macro anywhere you can use a declarative (`macro_rules!`) macro. Compiler -------- - [You can now override individual target features through the `target-feature` flag.][72094] E.g. `-C target-feature=+avx2 -C target-feature=+fma` is now equivalent to `-C target-feature=+avx2,+fma`. - [Added the `force-unwind-tables` flag.][69984] This option allows rustc to always generate unwind tables regardless of panic strategy. - [Added the `embed-bitcode` flag.][71716] This codegen flag allows rustc to include LLVM bitcode into generated `rlib`s (this is on by default). - [Added the `tiny` value to the `code-model` codegen flag.][72397] - [Added tier 3 support\* for the `mipsel-sony-psp` target.][72062] - [Added tier 3 support for the `thumbv7a-uwp-windows-msvc` target.][72133] \* Refer to Rust's [platform support page][forge-platform-support] for more information on Rust's tiered platform support. Libraries --------- - [`net::{SocketAddr, SocketAddrV4, SocketAddrV6}` now implements `PartialOrd` and `Ord`.][72239] - [`proc_macro::TokenStream` now implements `Default`.][72234] - [You can now use `char` with `ops::{Range, RangeFrom, RangeFull, RangeInclusive, RangeTo}` to iterate over a range of codepoints.][72413] E.g. you can now write the following; ```rust for ch in 'a'..='z' { print!("{}", ch); } println!(); // Prints "abcdefghijklmnopqrstuvwxyz" ``` - [`OsString` now implements `FromStr`.][71662] - [The `saturating_neg` method as been added to all signed integer primitive types, and the `saturating_abs` method has been added for all integer primitive types.][71886] - [`Arc<T>`, `Rc<T>` now implement `From<Cow<'_, T>>`, and `Box` now implements `From<Cow>` when `T` is `[T: Copy]`, `str`, `CStr`, `OsStr`, or `Path`.][71447] - [`Box<[T]>` now implements `From<[T; N]>`.][71095] - [`BitOr` and `BitOrAssign` are implemented for all `NonZero` integer types.][69813] - [The `fetch_min`, and `fetch_max` methods have been added to all atomic integer types.][72324] - [The `fetch_update` method has been added to all atomic integer types.][71843] Stabilized APIs --------------- - [`Arc::as_ptr`] - [`BTreeMap::remove_entry`] - [`Rc::as_ptr`] - [`rc::Weak::as_ptr`] - [`rc::Weak::from_raw`] - [`rc::Weak::into_raw`] - [`str::strip_prefix`] - [`str::strip_suffix`] - [`sync::Weak::as_ptr`] - [`sync::Weak::from_raw`] - [`sync::Weak::into_raw`] - [`char::UNICODE_VERSION`] - [`Span::resolved_at`] - [`Span::located_at`] - [`Span::mixed_site`] - [`unix::process::CommandExt::arg0`] Cargo ----- Misc ---- - [Rustdoc now supports strikethrough text in Markdown.][71928] E.g. `~~outdated information~~` becomes "~~outdated information~~". - [Added an emoji to Rustdoc's deprecated API message.][72014] Compatibility Notes ------------------- - [Trying to self initialize a static value (that is creating a value using itself) is unsound and now causes a compile error.][71140] - [`{f32, f64}::powi` now returns a slightly different value on Windows.][73420] This is due to changes in LLVM's intrinsics which `{f32, f64}::powi` uses. - [Rustdoc's CLI's extra error exit codes have been removed.][71900] These were previously undocumented and not intended for public use. Rustdoc still provides a non-zero exit code on errors. Internals Only -------------- - [Make clippy a git subtree instead of a git submodule][70655] - [Unify the undo log of all snapshot types][69464] [73420]: rust-lang/rust#73420 [72324]: rust-lang/rust#72324 [71843]: rust-lang/rust#71843 [71886]: rust-lang/rust#71886 [72234]: rust-lang/rust#72234 [72239]: rust-lang/rust#72239 [72397]: rust-lang/rust#72397 [72413]: rust-lang/rust#72413 [72014]: rust-lang/rust#72014 [72062]: rust-lang/rust#72062 [72094]: rust-lang/rust#72094 [72133]: rust-lang/rust#72133 [71900]: rust-lang/rust#71900 [71928]: rust-lang/rust#71928 [71662]: rust-lang/rust#71662 [71716]: rust-lang/rust#71716 [71447]: rust-lang/rust#71447 [71269]: rust-lang/rust#71269 [71095]: rust-lang/rust#71095 [71140]: rust-lang/rust#71140 [70655]: rust-lang/rust#70655 [70705]: rust-lang/rust#70705 [69984]: rust-lang/rust#69984 [69813]: rust-lang/rust#69813 [69464]: rust-lang/rust#69464 [68717]: rust-lang/rust#68717 [`Arc::as_ptr`]: https://doc.rust-lang.org/stable/std/sync/struct.Arc.html#method.as_ptr [`BTreeMap::remove_entry`]: https://doc.rust-lang.org/stable/std/collections/struct.BTreeMap.html#method.remove_entry [`Rc::as_ptr`]: https://doc.rust-lang.org/stable/std/rc/struct.Rc.html#method.as_ptr [`rc::Weak::as_ptr`]: https://doc.rust-lang.org/stable/std/rc/struct.Weak.html#method.as_ptr [`rc::Weak::from_raw`]: https://doc.rust-lang.org/stable/std/rc/struct.Weak.html#method.from_raw [`rc::Weak::into_raw`]: https://doc.rust-lang.org/stable/std/rc/struct.Weak.html#method.into_raw [`sync::Weak::as_ptr`]: https://doc.rust-lang.org/stable/std/sync/struct.Weak.html#method.as_ptr [`sync::Weak::from_raw`]: https://doc.rust-lang.org/stable/std/sync/struct.Weak.html#method.from_raw [`sync::Weak::into_raw`]: https://doc.rust-lang.org/stable/std/sync/struct.Weak.html#method.into_raw [`str::strip_prefix`]: https://doc.rust-lang.org/stable/std/primitive.str.html#method.strip_prefix [`str::strip_suffix`]: https://doc.rust-lang.org/stable/std/primitive.str.html#method.strip_suffix [`char::UNICODE_VERSION`]: https://doc.rust-lang.org/stable/std/char/constant.UNICODE_VERSION.html [`Span::resolved_at`]: https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.resolved_at [`Span::located_at`]: https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.located_at [`Span::mixed_site`]: https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.mixed_site [`unix::process::CommandExt::arg0`]: https://doc.rust-lang.org/std/os/unix/process/trait.CommandExt.html#tymethod.arg0

rust-highfive assigned kinnison May 4, 2020

ollie27 reviewed May 7, 2020

View reviewed changes

src/librustdoc/markdown.rs Outdated Show resolved Hide resolved

kinnison reviewed May 8, 2020

View reviewed changes

src/librustdoc/markdown.rs Outdated Show resolved Hide resolved

src/librustdoc/markdown.rs Outdated Show resolved Hide resolved

Clean up rustdoc source code

7e855b5

GuillaumeGomez force-pushed the clean-up-rustdoc branch from 992132b to 7e855b5 Compare May 8, 2020 13:08

kinnison approved these changes May 8, 2020

View reviewed changes

ollie27 reviewed May 9, 2020

View reviewed changes

Mark-Simulacrum added the relnotes Marks issues that should be documented in the release notes of the next release. label May 9, 2020

End unification of exit codes in librustdoc

c8fb0d7

crlf0710 added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 20, 2020

bors 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-review Status: Awaiting review from the assignee but also interested parties. labels May 26, 2020

bors added the merged-by-bors This PR was explicitly merged by bors. label May 26, 2020

bors merged commit aeca4d6 into rust-lang:master May 26, 2020

GuillaumeGomez deleted the clean-up-rustdoc branch May 29, 2020 09:02

matthiaskrgr mentioned this pull request Aug 9, 2023

ICE: unboxed closure but only with mir-opt-level=0 #114665

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up rustdoc source code #71900

Clean up rustdoc source code #71900

GuillaumeGomez commented May 4, 2020

kinnison left a comment

GuillaumeGomez commented May 8, 2020

GuillaumeGomez commented May 8, 2020

kinnison left a comment

ollie27 May 9, 2020

ollie27 May 27, 2020

ollie27 commented May 9, 2020

Mark-Simulacrum commented May 9, 2020

ollie27 commented May 9, 2020

GuillaumeGomez commented May 9, 2020

GuillaumeGomez commented May 9, 2020

GuillaumeGomez commented May 26, 2020

bors commented May 26, 2020

bors commented May 26, 2020

bors commented May 26, 2020

Clean up rustdoc source code #71900

Clean up rustdoc source code #71900

Conversation

GuillaumeGomez commented May 4, 2020

kinnison left a comment

Choose a reason for hiding this comment

GuillaumeGomez commented May 8, 2020

GuillaumeGomez commented May 8, 2020

kinnison left a comment

Choose a reason for hiding this comment

ollie27 May 9, 2020

Choose a reason for hiding this comment

ollie27 May 27, 2020

Choose a reason for hiding this comment

ollie27 commented May 9, 2020

Mark-Simulacrum commented May 9, 2020

ollie27 commented May 9, 2020

GuillaumeGomez commented May 9, 2020

GuillaumeGomez commented May 9, 2020

GuillaumeGomez commented May 26, 2020

bors commented May 26, 2020

bors commented May 26, 2020

bors commented May 26, 2020