From a389576d0f7e27ac094455978d64f28ed5aaa781 Mon Sep 17 00:00:00 2001
From: edef <edef@edef.eu>
Date: Thu, 16 Apr 2015 07:30:53 -0400
Subject: [PATCH] document os

---
 src/os/mod.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/os/mod.rs b/src/os/mod.rs
index 55c9ace..bdd45cf 100644
--- a/src/os/mod.rs
+++ b/src/os/mod.rs
@@ -1,5 +1,10 @@
 // Copyright (c) 2015, edef <edef@edef.eu>
 // See the LICENSE file included in this distribution.
+//! This module provides stacks using the operating system's
+//! anonymous memory mapping facility, usually `mmap`.
+//! The stacks it provides come with a guard page, which is not included
+//! in the stack limit.
+
 extern crate std;
 use core::prelude::*;
 use self::std::io::Error as IoError;