Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable doctests in compiler/ crates #99324

Merged
merged 13 commits into from Oct 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 0 additions & 1 deletion compiler/rustc_ast/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
bitflags = "1.2.1"
Expand Down
6 changes: 3 additions & 3 deletions compiler/rustc_ast_lowering/src/expr.rs
Expand Up @@ -1609,11 +1609,11 @@ impl<'hir> LoweringContext<'_, 'hir> {
}

/// Desugar `ExprKind::Yeet` from: `do yeet <expr>` into:
/// ```rust
/// ```ignore(illustrative)
/// // If there is an enclosing `try {...}`:
/// break 'catch_target FromResidual::from_residual(Yeet(residual)),
/// break 'catch_target FromResidual::from_residual(Yeet(residual));
/// // Otherwise:
/// return FromResidual::from_residual(Yeet(residual)),
/// return FromResidual::from_residual(Yeet(residual));
/// ```
/// But to simplify this, there's a `from_yeet` lang item function which
/// handles the combined `FromResidual::from_residual(Yeet(residual))`.
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_ast_pretty/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_span = { path = "../rustc_span" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_attr/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_ast_pretty = { path = "../rustc_ast_pretty" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_borrowck/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
either = "1.5.0"
Expand Down
2 changes: 1 addition & 1 deletion compiler/rustc_borrowck/src/diagnostics/region_errors.rs
Expand Up @@ -341,7 +341,7 @@ impl<'a, 'tcx> MirBorrowckCtxt<'a, 'tcx> {
/// Report an error because the universal region `fr` was required to outlive
/// `outlived_fr` but it is not known to do so. For example:
///
/// ```compile_fail,E0312
/// ```compile_fail
/// fn foo<'a, 'b>(x: &'a u32) -> &'b u32 { x }
/// ```
///
Expand Down
4 changes: 2 additions & 2 deletions compiler/rustc_borrowck/src/region_infer/mod.rs
Expand Up @@ -1398,7 +1398,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
/// whether any of the constraints were too strong. In particular,
/// we want to check for a case where a universally quantified
/// region exceeded its bounds. Consider:
/// ```compile_fail,E0312
/// ```compile_fail
/// fn foo<'a, 'b>(x: &'a u32) -> &'b u32 { x }
/// ```
/// In this case, returning `x` requires `&'a u32 <: &'b u32`
Expand Down Expand Up @@ -1451,7 +1451,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
/// <https://smallcultfollowing.com/babysteps/blog/2019/01/17/polonius-and-region-errors/>
///
/// In the canonical example
/// ```compile_fail,E0312
/// ```compile_fail
/// fn foo<'a, 'b>(x: &'a u32) -> &'b u32 { x }
/// ```
/// returning `x` requires `&'a u32 <: &'b u32` and hence we establish (transitively) a
Expand Down
3 changes: 2 additions & 1 deletion compiler/rustc_builtin_macros/src/assert/context.rs
Expand Up @@ -58,6 +58,7 @@ impl<'cx, 'a> Context<'cx, 'a> {
/// Builds the whole `assert!` expression. For example, `let elem = 1; assert!(elem == 1);` expands to:
///
/// ```rust
/// #![feature(generic_assert_internals)]
/// let elem = 1;
/// {
/// #[allow(unused_imports)]
Expand All @@ -70,7 +71,7 @@ impl<'cx, 'a> Context<'cx, 'a> {
/// __local_bind0
/// } == 1
/// ) {
/// panic!("Assertion failed: elem == 1\nWith captures:\n elem = {}", __capture0)
/// panic!("Assertion failed: elem == 1\nWith captures:\n elem = {:?}", __capture0)
/// }
/// }
/// ```
Expand Down
5 changes: 5 additions & 0 deletions compiler/rustc_builtin_macros/src/deriving/generic/mod.rs
Expand Up @@ -1110,6 +1110,11 @@ impl<'a> MethodDef<'a> {
/// ```
/// is equivalent to:
/// ```
/// #![feature(core_intrinsics)]
/// enum A {
/// A1,
/// A2(i32)
/// }
/// impl ::core::cmp::PartialEq for A {
/// #[inline]
/// fn eq(&self, other: &A) -> bool {
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_codegen_llvm/Cargo.toml
Expand Up @@ -5,7 +5,6 @@ edition = "2021"

[lib]
test = false
doctest = false

[dependencies]
bitflags = "1.0"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_const_eval/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
tracing = "0.1"
Expand Down
6 changes: 3 additions & 3 deletions compiler/rustc_const_eval/src/interpret/validity.rs
Expand Up @@ -56,7 +56,7 @@ macro_rules! throw_validation_failure {
/// This lets you use the patterns as a kind of validation list, asserting which errors
/// can possibly happen:
///
/// ```
/// ```ignore(illustrative)
/// let v = try_validation!(some_fn(), some_path, {
/// Foo | Bar | Baz => { "some failure" },
/// });
Expand All @@ -65,7 +65,7 @@ macro_rules! throw_validation_failure {
/// The patterns must be of type `UndefinedBehaviorInfo`.
/// An additional expected parameter can also be added to the failure message:
///
/// ```
/// ```ignore(illustrative)
/// let v = try_validation!(some_fn(), some_path, {
/// Foo | Bar | Baz => { "some failure" } expected { "something that wasn't a failure" },
/// });
Expand All @@ -74,7 +74,7 @@ macro_rules! throw_validation_failure {
/// An additional nicety is that both parameters actually take format args, so you can just write
/// the format string in directly:
///
/// ```
/// ```ignore(illustrative)
/// let v = try_validation!(some_fn(), some_path, {
/// Foo | Bar | Baz => { "{:?}", some_failure } expected { "{}", expected_value },
/// });
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_data_structures/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
arrayvec = { version = "0.7", default-features = false }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_error_messages/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
fluent-bundle = "0.15.2"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_errors/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
tracing = "0.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_feature/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_data_structures = { path = "../rustc_data_structures" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_hir/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_arena = { path = "../rustc_arena" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_hir_pretty/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_ast_pretty = { path = "../rustc_ast_pretty" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_incremental/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_graphviz = { path = "../rustc_graphviz" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_index/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
arrayvec = { version = "0.7", default-features = false }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_interface/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
libloading = "0.7.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_lexer/Cargo.toml
Expand Up @@ -12,7 +12,6 @@ Rust lexer used by rustc. No stability guarantees are provided.
# Note: do not remove this blank `[lib]` section.
# This will be used when publishing this crate as `rustc-ap-rustc_lexer`.
[lib]
doctest = false

# Note that this crate purposefully does not depend on other rustc crates
[dependencies]
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_metadata/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
libloading = "0.7.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_mir_build/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_arena = { path = "../rustc_arena" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_mir_dataflow/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
polonius-engine = "0.13.0"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_mir_transform/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
itertools = "0.10.1"
Expand Down
Expand Up @@ -5,4 +5,3 @@ edition = "2021"

[lib]
proc-macro = true
doctest = false
1 change: 0 additions & 1 deletion compiler/rustc_monomorphize/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
smallvec = { version = "1.8.1", features = [ "union", "may_dangle" ] }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_parse/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
bitflags = "1.0"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_plugin_impl/Cargo.toml
Expand Up @@ -5,7 +5,6 @@ build = false
edition = "2021"

[lib]
doctest = false

[dependencies]
libloading = "0.7.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_query_system/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
parking_lot = "0.11"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_resolve/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
bitflags = "1.2.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_span/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_serialize = { path = "../rustc_serialize" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_symbol_mangling/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
bitflags = "1.2.1"
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_trait_selection/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
rustc_parse_format = { path = "../rustc_parse_format" }
Expand Down
1 change: 0 additions & 1 deletion compiler/rustc_type_ir/Cargo.toml
Expand Up @@ -4,7 +4,6 @@ version = "0.0.0"
edition = "2021"

[lib]
doctest = false

[dependencies]
bitflags = "1.2.1"
Expand Down