Skip to content

Docs are out of date for rustc_codegen_llvm #75342

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
camelid opened this issue Aug 9, 2020 · 4 comments · Fixed by #80323
Closed

Docs are out of date for rustc_codegen_llvm #75342

camelid opened this issue Aug 9, 2020 · 4 comments · Fixed by #80323
Labels
A-codegen Area: Code generation A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-help-wanted Call for participation: Help is requested to fix this issue.

Comments

@camelid
Copy link
Member

camelid commented Aug 9, 2020

The docs for rustc_codegen_llvm::base reference functions named codegen_expr and codegen_block, but those functions do not appear anywhere in rustc. It seems the docs for this module have not been updated in two years, so perhaps that is why?
@camelid

This comment has been minimized.

# to view
@rustbot rustbot added A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Aug 9, 2020
@camelid
Copy link
Member Author

camelid commented Aug 9, 2020 •
edited
Loading

It looks like rustc_codegen_ssa::base has the same docs.

@camelid

This comment has been minimized.

# to view
@rustbot rustbot added the A-codegen Area: Code generation label Sep 10, 2020
@camelid camelid added E-help-wanted Call for participation: Help is requested to fix this issue. C-bug Category: This is a bug. and removed C-enhancement Category: An issue proposing an enhancement or a PR with one. labels Oct 4, 2020
@camelid
Copy link
Member Author

camelid commented Dec 23, 2020

I finally have enough knowledge to fix these!

@camelid camelid mentioned this issue Dec 23, 2020
Merged
Dylan-DPC-zz pushed a commit to Dylan-DPC-zz/rust that referenced this issue Dec 31, 2020
@Dylan-DPC
Rollup merge of rust-lang#80323 - camelid:codegen-base-docs, r=nagisa
26b8c0d 
Update and improve `rustc_codegen_{llvm,ssa}` docs

Fixes rust-lang#75342.

These docs were very out of date and misleading. They even said that
they codegen'd the *AST*!

For some reason, the `rustc_codegen_ssa::base` docs were exactly
identical to the `rustc_codegen_llvm::base` docs. They didn't really
make sense, because they had LLVM-specific information even though
`rustc_codegen_ssa` is supposed to be somewhat generic. So I removed
them as they were misleading.

r? `@pnkfelix` maybe?
GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this issue Dec 31, 2020
@GuillaumeGomez
Rollup merge of rust-lang#80323 - camelid:codegen-base-docs, r=nagisa
0f286dc 
Update and improve `rustc_codegen_{llvm,ssa}` docs

Fixes rust-lang#75342.

These docs were very out of date and misleading. They even said that
they codegen'd the *AST*!

For some reason, the `rustc_codegen_ssa::base` docs were exactly
identical to the `rustc_codegen_llvm::base` docs. They didn't really
make sense, because they had LLVM-specific information even though
`rustc_codegen_ssa` is supposed to be somewhat generic. So I removed
them as they were misleading.

r? ```@pnkfelix``` maybe?
@bors bors closed this as completed in 55cfcd5 Jan 1, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
A-codegen Area: Code generation A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-bug Category: This is a bug. E-help-wanted Call for participation: Help is requested to fix this issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update and improve rustc_codegen_{llvm,ssa} docs camelid/rust
2 participants
@camelid @rustbot