Add support for documenting all members of the workspace with "doc --all" #3515

sdroege · 2017-01-08T12:00:41Z

rust-highfive · 2017-01-08T12:00:54Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @brson (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

…all" rust-lang#3491

These are basically the same as the ones from "test --all" and "build --all"

alexcrichton · 2017-01-09T04:29:41Z

tests/doc.rs

+                 .arg("--all"),
+                execs().with_stderr_contains("[..] Documenting bar v0.1.0 ([..])")
+                       .with_stderr_contains("[..] Compiling bar v0.1.0 ([..])")
+                       .with_stderr_contains("[..] Documenting foo v0.1.0 ([..])"));


Could you add .with_status(0) assertions to these as well to ensure we test that the process ran successfully?

Sure, but shouldn't this also be added to the "build --all" test? I'll send another pull request for the change of the other test then

I guess it would be "nice" but not necessary, as for building the test checks for the "finished successfully" line in the output

Ah yeah it's true I should have caught it on that PR! Want to send another PR for that?

Sure, will send something for that tomorrow :)

alexcrichton · 2017-01-09T04:30:43Z

src/cargo/ops/cargo_doc.rs

-                assert!(lib_names.insert(target.crate_name()));
-            } else {
-                assert!(bin_names.insert(target.crate_name()));
+    if specs.is_empty() {


I think this may actually work best if we remove this condition. I don't quite recall why it exists, but I think it's best if we execute the below logic for all packages, not just the root package.

I agree, I only kept it because I thought someone probably had a reason for having done that and I just don't understand the reason :)

This seems more consistent and generally should work better.

sdroege · 2017-01-09T10:55:07Z

Thanks for the review! Updated for both your comments

alexcrichton · 2017-01-09T21:45:52Z

@bors: r+

bors · 2017-01-09T21:45:53Z

📌 Commit b850c25 has been approved by alexcrichton

bors · 2017-01-09T21:45:58Z

⌛ Testing commit b850c25 with merge 05f1ded...

Add support for documenting all members of the workspace with "doc --all" #3491

bors · 2017-01-09T23:06:16Z

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing 05f1ded to master...

@alexcrichton

…xcrichton Check the exit code of all processes started in the build/test tests By not checking the exit codes, a failure in the build::crate_env_vars() test was ignored. As suggested by @alexcrichton in #3515 (comment)

Version 1.16.0 (2017-03-16) =========================== Language -------- * Lifetimes in statics and consts default to `'static`. [RFC 1623] * [The compiler's `dead_code` lint now accounts for type aliases][38051]. * [Uninhabitable enums (those without any variants) no longer permit wildcard match patterns][38069] * [Clean up semantics of `self` in an import list][38313] * [`Self` may appear in `impl` headers][38920] * [`Self` may appear in struct expressions][39282] Compiler -------- * [`rustc` now supports `--emit=metadata`, which causes rustc to emit a `.rmeta` file containing only crate metadata][38571]. This can be used by tools like the Rust Language Service to perform metadata-only builds. * [Levenshtein based typo suggestions now work in most places, while previously they worked only for fields and sometimes for local variables][38927]. Together with the overhaul of "no resolution"/"unexpected resolution" errors (#[38154]) they result in large and systematic improvement in resolution diagnostics. * [Fix `transmute::<T, U>` where `T` requires a bigger alignment than `U`][38670] * [rustc: use -Xlinker when specifying an rpath with ',' in it][38798] * [`rustc` no longer attempts to provide "consider using an explicit lifetime" suggestions][37057]. They were inaccurate. Stabilized APIs --------------- * [`VecDeque::truncate`] * [`VecDeque::resize`] * [`String::insert_str`] * [`Duration::checked_add`] * [`Duration::checked_sub`] * [`Duration::checked_div`] * [`Duration::checked_mul`] * [`str::replacen`] * [`str::repeat`] * [`SocketAddr::is_ipv4`] * [`SocketAddr::is_ipv6`] * [`IpAddr::is_ipv4`] * [`IpAddr::is_ipv6`] * [`Vec::dedup_by`] * [`Vec::dedup_by_key`] * [`Result::unwrap_or_default`] * [`<*const T>::wrapping_offset`] * [`<*mut T>::wrapping_offset`] * `CommandExt::creation_flags` * [`File::set_permissions`] * [`String::split_off`] Libraries --------- * [`[T]::binary_search` and `[T]::binary_search_by_key` now take their argument by `Borrow` parameter][37761] * [All public types in std implement `Debug`][38006] * [`IpAddr` implements `From<Ipv4Addr>` and `From<Ipv6Addr>`][38327] * [`Ipv6Addr` implements `From<[u16; 8]>`][38131] * [Ctrl-Z returns from `Stdin.read()` when reading from the console on Windows][38274] * [std: Fix partial writes in `LineWriter`][38062] * [std: Clamp max read/write sizes on Unix][38062] * [Use more specific panic message for `&str` slicing errors][38066] * [`TcpListener::set_only_v6` is deprecated][38304]. This functionality cannot be achieved in std currently. * [`writeln!`, like `println!`, now accepts a form with no string or formatting arguments, to just print a newline][38469] * [Implement `iter::Sum` and `iter::Product` for `Result`][38580] * [Reduce the size of static data in `std_unicode::tables`][38781] * [`char::EscapeDebug`, `EscapeDefault`, `EscapeUnicode`, `CaseMappingIter`, `ToLowercase`, `ToUppercase`, implement `Display`][38909] * [`Duration` implements `Sum`][38712] * [`String` implements `ToSocketAddrs`][39048] Cargo ----- * [The `cargo check` command does a type check of a project without building it][cargo/3296] * [crates.io will display CI badges from Travis and AppVeyor, if specified in Cargo.toml][cargo/3546] * [crates.io will display categories listed in Cargo.toml][cargo/3301] * [Compilation profiles accept integer values for `debug`, in addition to `true` and `false`. These are passed to `rustc` as the value to `-C debuginfo`][cargo/3534] * [Implement `cargo --version --verbose`][cargo/3604] * [All builds now output 'dep-info' build dependencies compatible with make and ninja][cargo/3557] * [Build all workspace members with `build --all`][cargo/3511] * [Document all workspace members with `doc --all`][cargo/3515] * [Path deps outside workspace are not members][cargo/3443] Misc ---- * [`rustdoc` has a `--sysroot` argument that, like `rustc`, specifies the path to the Rust implementation][38589] * [The `armv7-linux-androideabi` target no longer enables NEON extensions, per Google's ABI guide][38413] * [The stock standard library can be compiled for Redox OS][38401] * [Rust has initial SPARC support][38726]. Tier 3. No builds available. * [Rust has experimental support for Nvidia PTX][38559]. Tier 3. No builds available. * [Fix backtraces on i686-pc-windows-gnu by disabling FPO][39379] Compatibility Notes ------------------- * [Uninhabitable enums (those without any variants) no longer permit wildcard match patterns][38069] * In this release, references to uninhabited types can not be pattern-matched. This was accidentally allowed in 1.15. * [The compiler's `dead_code` lint now accounts for type aliases][38051]. * [Ctrl-Z returns from `Stdin.read()` when reading from the console on Windows][38274] * [Clean up semantics of `self` in an import list][38313] [37057]: rust-lang/rust#37057 [37761]: rust-lang/rust#37761 [38006]: rust-lang/rust#38006 [38051]: rust-lang/rust#38051 [38062]: rust-lang/rust#38062 [38062]: rust-lang/rust#38622 [38066]: rust-lang/rust#38066 [38069]: rust-lang/rust#38069 [38131]: rust-lang/rust#38131 [38154]: rust-lang/rust#38154 [38274]: rust-lang/rust#38274 [38304]: rust-lang/rust#38304 [38313]: rust-lang/rust#38313 [38314]: rust-lang/rust#38314 [38327]: rust-lang/rust#38327 [38401]: rust-lang/rust#38401 [38413]: rust-lang/rust#38413 [38469]: rust-lang/rust#38469 [38559]: rust-lang/rust#38559 [38571]: rust-lang/rust#38571 [38580]: rust-lang/rust#38580 [38589]: rust-lang/rust#38589 [38670]: rust-lang/rust#38670 [38712]: rust-lang/rust#38712 [38726]: rust-lang/rust#38726 [38781]: rust-lang/rust#38781 [38798]: rust-lang/rust#38798 [38909]: rust-lang/rust#38909 [38920]: rust-lang/rust#38920 [38927]: rust-lang/rust#38927 [39048]: rust-lang/rust#39048 [39282]: rust-lang/rust#39282 [39379]: rust-lang/rust#39379 [`<*const T>::wrapping_offset`]: https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_offset [`<*mut T>::wrapping_offset`]: https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_offset [`Duration::checked_add`]: https://doc.rust-lang.org/std/time/struct.Duration.html#method.checked_add [`Duration::checked_div`]: https://doc.rust-lang.org/std/time/struct.Duration.html#method.checked_div [`Duration::checked_mul`]: https://doc.rust-lang.org/std/time/struct.Duration.html#method.checked_mul [`Duration::checked_sub`]: https://doc.rust-lang.org/std/time/struct.Duration.html#method.checked_sub [`File::set_permissions`]: https://doc.rust-lang.org/std/fs/struct.File.html#method.set_permissions [`IpAddr::is_ipv4`]: https://doc.rust-lang.org/std/net/enum.IpAddr.html#method.is_ipv4 [`IpAddr::is_ipv6`]: https://doc.rust-lang.org/std/net/enum.IpAddr.html#method.is_ipv6 [`Result::unwrap_or_default`]: https://doc.rust-lang.org/std/result/enum.Result.html#method.unwrap_or_default [`SocketAddr::is_ipv4`]: https://doc.rust-lang.org/std/net/enum.SocketAddr.html#method.is_ipv4 [`SocketAddr::is_ipv6`]: https://doc.rust-lang.org/std/net/enum.SocketAddr.html#method.is_ipv6 [`String::insert_str`]: https://doc.rust-lang.org/std/string/struct.String.html#method.insert_str [`String::split_off`]: https://doc.rust-lang.org/std/string/struct.String.html#method.split_off [`Vec::dedup_by_key`]: https://doc.rust-lang.org/std/vec/struct.Vec.html#method.dedup_by_key [`Vec::dedup_by`]: https://doc.rust-lang.org/std/vec/struct.Vec.html#method.dedup_by [`VecDeque::resize`]: https://doc.rust-lang.org/std/collections/vec_deque/struct.VecDeque.html#method.resize [`VecDeque::truncate`]: https://doc.rust-lang.org/std/collections/vec_deque/struct.VecDeque.html#method.truncate [`str::repeat`]: https://doc.rust-lang.org/std/primitive.str.html#method.repeat [`str::replacen`]: https://doc.rust-lang.org/std/primitive.str.html#method.replacen [cargo/3296]: rust-lang/cargo#3296 [cargo/3301]: rust-lang/cargo#3301 [cargo/3443]: rust-lang/cargo#3443 [cargo/3511]: rust-lang/cargo#3511 [cargo/3515]: rust-lang/cargo#3515 [cargo/3534]: rust-lang/cargo#3534 [cargo/3546]: rust-lang/cargo#3546 [cargo/3557]: rust-lang/cargo#3557 [cargo/3604]: rust-lang/cargo#3604 [RFC 1623]: https://github.com/rust-lang/rfcs/blob/master/text/1623-static.md

rust-highfive assigned brson Jan 8, 2017

sdroege changed the title ~~Add support for building all members of the workspace with "doc --all"~~ Add support for documenting all members of the workspace with "doc --all" Jan 8, 2017

sdroege added 2 commits January 8, 2017 14:01

Add support for documenting all members of the workspace with "doc --…

067eb28

…all" rust-lang#3491

Add tests for "doc --all"

01e930f

These are basically the same as the ones from "test --all" and "build --all"

sdroege force-pushed the doc-all branch from b460f54 to 01e930f Compare January 8, 2017 12:01

alexcrichton reviewed Jan 9, 2017

View reviewed changes

sdroege added 2 commits January 9, 2017 12:49

Check if the "doc --all" tests exit with exit code 0

9576b31

Collect library/binary names when documenting even if a spec was given

b850c25

This seems more consistent and generally should work better.

sdroege mentioned this pull request Jan 9, 2017

workspaces: All building all members of the workspace #3491

Closed

alexcrichton added the relnotes Release-note worthy label Jan 9, 2017

bors added a commit that referenced this pull request Jan 9, 2017

Auto merge of #3515 - sdroege:doc-all, r=alexcrichton

05f1ded

Add support for documenting all members of the workspace with "doc --all" #3491

bors merged commit b850c25 into rust-lang:master Jan 9, 2017

sdroege mentioned this pull request Jan 10, 2017

Check the exit code of all processes started in the build/test tests #3524

Merged

sdroege mentioned this pull request Feb 2, 2017

Provide a way to run cargo subcommands on all crates in the workspace #2878

Closed

ehuss added this to the 1.16.0 milestone Feb 6, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for documenting all members of the workspace with "doc --all" #3515

Add support for documenting all members of the workspace with "doc --all" #3515

sdroege commented Jan 8, 2017

rust-highfive commented Jan 8, 2017

alexcrichton Jan 9, 2017

sdroege Jan 9, 2017

sdroege Jan 9, 2017

alexcrichton Jan 9, 2017

sdroege Jan 9, 2017

alexcrichton Jan 9, 2017

sdroege Jan 9, 2017

sdroege commented Jan 9, 2017

alexcrichton commented Jan 9, 2017

bors commented Jan 9, 2017

bors commented Jan 9, 2017

bors commented Jan 9, 2017

Add support for documenting all members of the workspace with "doc --all" #3515

Add support for documenting all members of the workspace with "doc --all" #3515

Conversation

sdroege commented Jan 8, 2017

rust-highfive commented Jan 8, 2017

alexcrichton Jan 9, 2017

Choose a reason for hiding this comment

sdroege Jan 9, 2017

Choose a reason for hiding this comment

sdroege Jan 9, 2017

Choose a reason for hiding this comment

alexcrichton Jan 9, 2017

Choose a reason for hiding this comment

sdroege Jan 9, 2017

Choose a reason for hiding this comment

alexcrichton Jan 9, 2017

Choose a reason for hiding this comment

sdroege Jan 9, 2017

Choose a reason for hiding this comment

sdroege commented Jan 9, 2017

alexcrichton commented Jan 9, 2017

bors commented Jan 9, 2017

bors commented Jan 9, 2017

bors commented Jan 9, 2017