about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2020-08-12 19:37:08 +0200
committerRalf Jung <post@ralfj.de>2020-08-12 19:40:29 +0200
commit0e26f9b994997e2c8256e04de66812e3db6cf37e (patch)
tree22b2215697662ab1dcdb95fd1408126c68de4b86
parentc94ed5ca91f1363b66970ce2cbd6e2773e3cb1d3 (diff)
downloadrust-0e26f9b994997e2c8256e04de66812e3db6cf37e.tar.gz
rust-0e26f9b994997e2c8256e04de66812e3db6cf37e.zip
fix LocalInfo doc comment
-rw-r--r--src/librustc_middle/mir/mod.rs9
1 files changed, 6 insertions, 3 deletions
diff --git a/src/librustc_middle/mir/mod.rs b/src/librustc_middle/mir/mod.rs
index 3b0c480f6d4..98fd68927f1 100644
--- a/src/librustc_middle/mir/mod.rs
+++ b/src/librustc_middle/mir/mod.rs
@@ -857,9 +857,12 @@ pub struct LocalDecl<'tcx> {
 #[cfg(target_arch = "x86_64")]
 static_assert_size!(LocalDecl<'_>, 56);
 
-/// Extra information about a some locals that's used for diagnostics. (Not
-/// used for non-StaticRef temporaries, the return place, or anonymous function
-/// parameters.)
+/// Extra information about a some locals that's used for diagnostics and for
+/// classifying variables into local variables, statics, etc, which is needed e.g.
+/// for unsafety checking.
+///
+/// Not used for non-StaticRef temporaries, the return place, or anonymous
+/// function parameters.
 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable, TypeFoldable)]
 pub enum LocalInfo<'tcx> {
     /// A user-defined local variable or function parameter