---

yaml
---
r: 194333
b: refs/heads/tmp
c: 1c25aec
h: refs/heads/master
i:
  194331: deba24e
v: v3

Author: steveklabnik

[refs]

@@ -34,7 +34,7 @@ refs/heads/building: 126db549b038c84269a1e4fe46f051b2c15d6970
 refs/heads/beta: a3b13610c5b93d9ada072471a001a5613df6a960
 refs/heads/windistfix: 7608dbad651f02e837ed05eef3d74a6662a6e928
 refs/tags/1.0.0-alpha: e42bd6d93a1d3433c486200587f8f9e12590a4d7
-refs/heads/tmp: 71b9ba1e5b243e52b7c2828e35137eeba378d43f
+refs/heads/tmp: 1c25aecf675d731938951d048a45fb665105b441
 refs/tags/1.0.0-alpha.2: 4c705f6bc559886632d3871b04f58aab093bfa2f
 refs/tags/homu-tmp: 28a0b25f424090255966273994748a9f9901059f
 refs/heads/gate: 97c84447b65164731087ea82685580cc81424412

branches/tmp/src/libstd/io/mod.rs

@@ -558,6 +558,12 @@ pub trait BufRead: Read {
     /// This function does not perform any I/O, it simply informs this object
     /// that some amount of its buffer, returned from `fill_buf`, has been
     /// consumed and should no longer be returned.
+    ///
+    /// This function is used to tell the buffer how many bytes you've consumed
+    /// from the return value of `fill_buf`, and so may do odd things if
+    /// `fill_buf` isn't called before calling this.
+    ///
+    /// The `amt` must be `<=` the number of bytes in the buffer returned by `fill_buf`.
     #[stable(feature = "rust1", since = "1.0.0")]
     fn consume(&mut self, amt: usize);