Skip to content

Conversation

Monadic-Cat
Copy link
Contributor

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.

use intra-doc links so there'll be a doc gen fail next time this becomes
wrong
@rustbot
Copy link
Collaborator

rustbot commented Nov 28, 2024

r? @fee1-dead

rustbot has assigned @fee1-dead.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Nov 28, 2024
@jieyouxu
Copy link
Member

cc @bjorn3 as you may know if this description is accurate or not.

@fee1-dead
Copy link
Member

r? @bjorn3

@rustbot rustbot assigned bjorn3 and unassigned fee1-dead Nov 28, 2024
@bjorn3
Copy link
Member

bjorn3 commented Nov 28, 2024

Thanks!

@bors r+ rollup=always

@bors
Copy link
Collaborator

bors commented Nov 28, 2024

📌 Commit ca55eee has been approved by bjorn3

It is now in the queue for this repository.

@bors 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 Nov 28, 2024
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 28, 2024
…llaumeGomez

Rollup of 7 pull requests

Successful merges:

 - rust-lang#133358 (Don't type error if we fail to coerce `Pin<T>` because it doesnt contain a ref)
 - rust-lang#133422 (Fix clobber_abi in RV32E and RV64E inline assembly)
 - rust-lang#133452 (Support predicate registers (clobber-only) in Hexagon inline assembly)
 - rust-lang#133463 (Fix handling of x18 in AArch64 inline assembly on ohos/trusty or with -Zfixed-x18)
 - rust-lang#133487 (fix confusing diagnostic for reserved `##`)
 - rust-lang#133557 (Small doc fixes in `rustc_codegen_ssa`)
 - rust-lang#133560 (Trim extra space in 'repeated `mut`' diagnostic)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 7201f70 into rust-lang:master Nov 28, 2024
6 checks passed
@rustbot rustbot added this to the 1.85.0 milestone Nov 28, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Nov 28, 2024
Rollup merge of rust-lang#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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants