Add deprecation comments to folly::makeFuture.

[folly.git] / folly / docs / FBString.md

diff --git a/folly/docs/FBString.md b/folly/docs/FBString.md
index e6db45fe1ed5817eefdd5c6cec2834f12820e987..b41a63ed24f15e2cd1b653fa93c82865f63d4181 100644 (file)
--- a/folly/docs/FBString.md
+++ b/folly/docs/FBString.md
@@ -4,7 +4,7 @@
 `fbstring` is a drop-in replacement for `std::string`. The main
 benefit of `fbstring` is significantly increased performance on
 virtually all important primitives. This is achieved by using a
-two-tiered storage strategy and by cooperating with the memory
+three-tiered storage strategy and by cooperating with the memory
 allocator. In particular, `fbstring` is designed to detect use of
 jemalloc and cooperate with it to achieve significant improvements in
 speed and memory usage.
@@ -18,14 +18,20 @@ architectures.
 * Small strings (<= 23 chars) are stored in-situ without memory
   allocation.
 
-* Other strings (> 23 chars) are stored in malloc-allocated
+* Medium strings (24 - 255 chars) are stored in malloc-allocated
   memory and copied eagerly.
 
+* Large strings (> 255 chars) are stored in malloc-allocated memory and
+  copied lazily.
+
 ### Implementation highlights
 ***
 
 * 100% compatible with `std::string`.
 
+* Thread-safe reference counted copy-on-write for strings "large"
+  strings (> 255 chars).
+
 * Uses `malloc` instead of allocators.
 
 * Jemalloc-friendly. `fbstring` automatically detects if application