From 5aa9b7d2348e33f8d6e16cace5387d046eb2f1e5 Mon Sep 17 00:00:00 2001 From: Ryan Levick Date: Fri, 2 Jul 2021 00:12:57 +0200 Subject: [PATCH 1/3] Create issues for many TODOs --- src/ast-validation.md | 2 +- src/backend/inline-asm.md | 5 +++-- src/crates-io.md | 4 +++- src/debugging-support-in-rustc.md | 3 +-- src/feature-gate-ck.md | 2 +- src/hir-debugging.md | 2 +- src/identifiers.md | 2 +- src/macro-expansion.md | 4 ++-- src/name-resolution.md | 2 +- src/type-checking.md | 2 +- 10 files changed, 15 insertions(+), 13 deletions(-) diff --git a/src/ast-validation.md b/src/ast-validation.md index 64e35bb93..ff549ca62 100644 --- a/src/ast-validation.md +++ b/src/ast-validation.md @@ -3,4 +3,4 @@ AST validation is the process of checking various correctness properties about the AST after macro expansion. -**TODO**: write this chapter. +**TODO**: write this chapter. [#656](https://github.com/rust-lang/rustc-dev-guide/issues/656) diff --git a/src/backend/inline-asm.md b/src/backend/inline-asm.md index 0cae01ef3..3190bf4a8 100644 --- a/src/backend/inline-asm.md +++ b/src/backend/inline-asm.md @@ -1,4 +1,5 @@ # Inline Assembly -**TODO: You can find more info in -https://github.com/rust-lang/rust/pull/69171#issue-375572066** +**TODO: You can find more info +[here](https://github.com/rust-lang/rust/pull/69171#issue-375572066**) +[#1162](https://github.com/rust-lang/rustc-dev-guide/issues/1162) diff --git a/src/crates-io.md b/src/crates-io.md index 6fbabdc91..fc6d64254 100644 --- a/src/crates-io.md +++ b/src/crates-io.md @@ -12,7 +12,9 @@ reasons: - The dependency may have transitive dependencies that have one of the above problems. -TODO: what is the vetting process? +As of July 2021, there is no official policy for vetting +new dependencies to the compiler. Generally, new dependencies are not added +to the compiler unless their is a good reason to do so. ## Permitted dependencies diff --git a/src/debugging-support-in-rustc.md b/src/debugging-support-in-rustc.md index 559031148..9d455084d 100644 --- a/src/debugging-support-in-rustc.md +++ b/src/debugging-support-in-rustc.md @@ -314,8 +314,7 @@ Clang always embeds an MD5 checksum, though this does not appear in documentatio * New demangler in `libiberty` (gcc source tree). * New demangler in LLVM or LLDB. -**TODO**: Check the location of the demangler source. -[Question on Github](https://github.com/rust-lang/rustc-dev-guide/pull/316#discussion_r283062536). +**TODO**: Check the location of the demangler source. [#1157](https://github.com/rust-lang/rustc-dev-guide/issues/1157) #### Reuse Rust compiler for expressions diff --git a/src/feature-gate-ck.md b/src/feature-gate-ck.md index 3b3a07a31..c17747a11 100644 --- a/src/feature-gate-ck.md +++ b/src/feature-gate-ck.md @@ -1,3 +1,3 @@ # Feature Gate Checking -**TODO**: this chapter +**TODO**: this chapter [#1158](https://github.com/rust-lang/rustc-dev-guide/issues/1158) diff --git a/src/hir-debugging.md b/src/hir-debugging.md index 519ff2667..8788ad4de 100644 --- a/src/hir-debugging.md +++ b/src/hir-debugging.md @@ -5,4 +5,4 @@ The `-Z unpretty=hir-tree` flag will dump out the HIR. If you are trying to correlate `NodeId`s or `DefId`s with source code, the `--pretty expanded,identified` flag may be useful. -TODO: anything else? +TODO: anything else? [#1159](https://github.com/rust-lang/rustc-dev-guide/issues/1159) diff --git a/src/identifiers.md b/src/identifiers.md index 50d0c76e2..18a3efefc 100644 --- a/src/identifiers.md +++ b/src/identifiers.md @@ -82,7 +82,7 @@ See the [HIR chapter][hir-map] for more detailed information. - [`Promoted`] identifies a promoted constant within another item (related to const evaluation). Note: it is unique only locally within the item, so it should be associated with a `DefId`. - [`GlobalId`] will give you a more specific identifier (TODO). + [`GlobalId`] will give you a more specific identifier. - [`GlobalId`] identifies a global variable: a `const`, a `static`, a `const fn` where all arguments are [zero-sized types], or a promoted constant. diff --git a/src/macro-expansion.md b/src/macro-expansion.md index 7385cefb3..ce8285283 100644 --- a/src/macro-expansion.md +++ b/src/macro-expansion.md @@ -608,10 +608,10 @@ Because the Rust ABI is unstable, we use the C ABI for this conversion. [pm]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_expand/proc_macro/index.html [pms]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_expand/proc_macro_server/index.html -TODO: more here. +TODO: more here. [#1160](https://github.com/rust-lang/rustc-dev-guide/issues/1160) ### Custom Derive Custom derives are a special type of proc macro. -TODO: more? +TODO: more? [#1160](https://github.com/rust-lang/rustc-dev-guide/issues/1160) diff --git a/src/name-resolution.md b/src/name-resolution.md index 2eb76384c..1cef7d08f 100644 --- a/src/name-resolution.md +++ b/src/name-resolution.md @@ -164,7 +164,7 @@ To tell the difference between speculative loads and loads initiated by the user, resolve passes around a `record_used` parameter, which is `false` when the load is speculative. -## TODO: +## TODO: [#16](https://github.com/rust-lang/rustc-dev-guide/issues/16) This is a result of the first pass of learning the code. It is definitely incomplete and not detailed enough. It also might be inaccurate in places. diff --git a/src/type-checking.md b/src/type-checking.md index 797cd9487..cd58faf22 100644 --- a/src/type-checking.md +++ b/src/type-checking.md @@ -41,4 +41,4 @@ For more details, see the [`collect`][collect] module. [queries]: ./query.md [collect]: https://doc.rust-lang.org/nightly/nightly-rustc/rustc_typeck/collect/ -**TODO**: actually talk about type checking... +**TODO**: actually talk about type checking... [#1161](https://github.com/rust-lang/rustc-dev-guide/issues/1161) From 93768fe2436f1e6e9c3ddf0847ac49b96035a03d Mon Sep 17 00:00:00 2001 From: Ryan Levick Date: Fri, 2 Jul 2021 10:41:52 +0200 Subject: [PATCH 2/3] Update src/crates-io.md Co-authored-by: Joshua Nelson --- src/crates-io.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/crates-io.md b/src/crates-io.md index fc6d64254..bc59bfeed 100644 --- a/src/crates-io.md +++ b/src/crates-io.md @@ -14,7 +14,7 @@ reasons: As of July 2021, there is no official policy for vetting new dependencies to the compiler. Generally, new dependencies are not added -to the compiler unless their is a good reason to do so. +to the compiler unless there is a good reason to do so. ## Permitted dependencies From 89305ea0b14c11fc468036479a1dd77f482b6bac Mon Sep 17 00:00:00 2001 From: Ryan Levick Date: Fri, 2 Jul 2021 10:41:57 +0200 Subject: [PATCH 3/3] Update src/backend/inline-asm.md Co-authored-by: Yuki Okushi --- src/backend/inline-asm.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/backend/inline-asm.md b/src/backend/inline-asm.md index 3190bf4a8..f1a64b5ee 100644 --- a/src/backend/inline-asm.md +++ b/src/backend/inline-asm.md @@ -1,5 +1,5 @@ # Inline Assembly -**TODO: You can find more info -[here](https://github.com/rust-lang/rust/pull/69171#issue-375572066**) +**TODO**: You can find more info +[here](https://github.com/rust-lang/rust/pull/69171#issue-375572066) [#1162](https://github.com/rust-lang/rustc-dev-guide/issues/1162)