about summary refs log tree commit diff
path: root/src/librustc/mir
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2018-08-29 10:07:27 +0200
committerRalf Jung <post@ralfj.de>2018-08-29 10:09:53 +0200
commitb06a8db26e660505601b764e5d702fc17d7d73ee (patch)
tree60a60c4a536abfb4126a134f06593e0058567c35 /src/librustc/mir
parent365b90c6373336365e5464e22862ede0831117ae (diff)
downloadrust-b06a8db26e660505601b764e5d702fc17d7d73ee.tar.gz
rust-b06a8db26e660505601b764e5d702fc17d7d73ee.zip
audit the relocations code, and clean it up a little
Diffstat (limited to 'src/librustc/mir')
-rw-r--r--src/librustc/mir/interpret/mod.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/librustc/mir/interpret/mod.rs b/src/librustc/mir/interpret/mod.rs
index da5216bd1be..d40dbae09d2 100644
--- a/src/librustc/mir/interpret/mod.rs
+++ b/src/librustc/mir/interpret/mod.rs
@@ -496,7 +496,9 @@ pub struct Allocation {
     /// Note that the bytes of a pointer represent the offset of the pointer
     pub bytes: Vec<u8>,
     /// Maps from byte addresses to allocations.
-    /// Only the first byte of a pointer is inserted into the map.
+    /// Only the first byte of a pointer is inserted into the map; i.e.,
+    /// every entry in this map applies to `pointer_size` consecutive bytes starting
+    /// at the given offset.
     pub relocations: Relocations,
     /// Denotes undefined memory. Reading from undefined memory is forbidden in miri
     pub undef_mask: UndefMask,