about summary refs log tree commit diff
path: root/src/libcollections/string.rs
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2016-07-19 05:12:51 -0700
committerGitHub <noreply@github.com>2016-07-19 05:12:51 -0700
commit27e766d7bc84be992c8ddef710affc92ef4a0adf (patch)
treef345cf9cdd68dfc339f34e09b7dd3229d1c7c825 /src/libcollections/string.rs
parent92400cf8dcf411ce7e70ab2960639977d46d5b01 (diff)
parent88b37b6d9cf8cbe12550c0ac5399e9cf08674ca9 (diff)
downloadrust-27e766d7bc84be992c8ddef710affc92ef4a0adf.tar.gz
rust-27e766d7bc84be992c8ddef710affc92ef4a0adf.zip
Auto merge of #34898 - sanxiyn:rollup, r=sanxiyn
Rollup of 5 pull requests

- Successful merges: #34807, #34853, #34875, #34884, #34889
- Failed merges:
Diffstat (limited to 'src/libcollections/string.rs')
-rw-r--r--src/libcollections/string.rs6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/libcollections/string.rs b/src/libcollections/string.rs
index eedf4c2c11f..8ba5c6ffbf2 100644
--- a/src/libcollections/string.rs
+++ b/src/libcollections/string.rs
@@ -701,6 +701,12 @@ impl String {
     /// Violating these may cause problems like corrupting the allocator's
     /// internal datastructures.
     ///
+    /// The ownership of `ptr` is effectively transferred to the
+    /// `String` which may then deallocate, reallocate or change the
+    /// contents of memory pointed to by the pointer at will. Ensure
+    /// that nothing else uses the pointer after calling this
+    /// function.
+    ///
     /// # Examples
     ///
     /// Basic usage: