doc: deprecate smalloc module

Upcoming V8 changes will make it impossible to keep supporting the
smalloc module so deprecate it now and tell people to switch to
typed arrays.

PR-URL: https://github.com/iojs/io.js/pull/1566
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>

diff --git a/doc/api/smalloc.markdown b/doc/api/smalloc.markdown
index 80b4ce921d2eb2135615a5800aa0b54e4b61116a..69bef78f30c4390ad134c6d9180f166a563ebeca 100644 (file)
--- a/doc/api/smalloc.markdown
+++ b/doc/api/smalloc.markdown
@@ -1,6 +1,10 @@
 # Smalloc
 
-    Stability: 2 - Stable
+    Stability: 0 - Deprecated
+
+This module has been deprecated for technical reasons and will be removed when
+the V8 JavaScript engine is upgraded to version 4.3 or 4.4.  It is recommended
+that you start using [typed arrays][] instead.
 
 ## Class: smalloc
 
@@ -138,3 +142,5 @@ Enum of possible external array types. Contains:
 * `Float`
 * `Double`
 * `Uint8Clamped`
+
+[typed arrays]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Typed_arrays