---

yaml
---
r: 114111
b: refs/heads/master
c: 57f3b6e
h: refs/heads/master
i:
  114109: a0d2ec3
  114107: c2f4ba3
  114103: 1ecd75e
  114095: 7cc842c
  114079: d21f282
  114047: 9c09d6a
v: v3

Author: alexcrichton

[refs]

@@ -1,5 +1,5 @@
 ---
-refs/heads/master: 325cc5150243c3ceeafc6b0b3d3c7cc68bb003ac
+refs/heads/master: 57f3b6ee5c7c3261592342118b05b93409e285ce
 refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
 refs/heads/snap-stage3: ec0258a381b88b5574e3f8ce72ae553ac3a574b7
 refs/heads/try: 7c6c492fb2af9a85f21ff952942df3523b22fd17

trunk/src/libcore/lib.rs

@@ -9,6 +9,27 @@
 // except according to those terms.
 
 //! The Rust core library
+//!
+//! This library is meant to represent the core functionality of rust that is
+//! maximally portable to other platforms. To that exent, this library has no
+//! knowledge of things like allocation, threads, I/O, etc. This library is
+//! built on the assumption of a few existing symbols:
+//!
+//! * `memcpy`, `memcmp`, `memset` - These are core memory routines which are
+//!   often generated by LLVM. Additionally, this library can make explicit
+//!   calls to these funcitons. Their signatures are the same as found in C.
+//!
+//! * `rust_begin_unwind` - This function takes three arguments, a
+//!   `&fmt::Arguments`, a `&str`, and a `uint. These three arguments dictate
+//!   the failure message, the file at which failure was invoked, and the line.
+//!   It is up to consumers of this core library to define this failure
+//!   function; it is only required to never return.
+//!
+//! Currently, it is *not* recommended to use the core library. The stable
+//! functionality of libcore is exported directly into the
+//! [standard library](../std/index.html). The composition of this library is
+//! subject to change over time, only the interface exposed through libstd is
+//! intended to be stable.
 
 #![crate_id = "core#0.11.0-pre"]
 #![license = "MIT/ASL2"]