Skip to content

Commit 7201f70

Browse files
Rollup merge of #133557 - Monadic-Cat:small_doc_fixes, r=bjorn3
Small doc fixes in `rustc_codegen_ssa` I'm trying to make a toy codegen backend for `rustc`, and I got confused for a few minutes about what `codegen_backend` was referring to in the `CodegenBackend::join_codegen` docs. Experimentally, it looks like the result of `CodegenBackend::codegen_crate` is passed to `CodegenBackend::join_codegen`, so this updates the docs to refer to that. This time using intra-doc links to hopefully cause people to notice if that gets out of date again. Also, added another intra-doc link nearby, on `CodegenBackend::link`, for the same reason.
2 parents ca71c8f + ca55eee commit 7201f70

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

compiler/rustc_codegen_ssa/src/traits/backend.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,19 @@ pub trait CodegenBackend {
7171
need_metadata_module: bool,
7272
) -> Box<dyn Any>;
7373

74-
/// This is called on the returned `Box<dyn Any>` from `codegen_backend`
74+
/// This is called on the returned `Box<dyn Any>` from [`codegen_crate`](Self::codegen_crate)
7575
///
7676
/// # Panics
7777
///
78-
/// Panics when the passed `Box<dyn Any>` was not returned by `codegen_backend`.
78+
/// Panics when the passed `Box<dyn Any>` was not returned by [`codegen_crate`](Self::codegen_crate).
7979
fn join_codegen(
8080
&self,
8181
ongoing_codegen: Box<dyn Any>,
8282
sess: &Session,
8383
outputs: &OutputFilenames,
8484
) -> (CodegenResults, FxIndexMap<WorkProductId, WorkProduct>);
8585

86-
/// This is called on the returned `CodegenResults` from `join_codegen`
86+
/// This is called on the returned [`CodegenResults`] from [`join_codegen`](Self::join_codegen).
8787
fn link(
8888
&self,
8989
sess: &Session,

0 commit comments

Comments
 (0)