From ee71dc54765c161c51b2a8d860f9ebf95c6d7e12 Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Fri, 30 Sep 2016 23:56:28 +0000 Subject: Document sys_common and sys --- src/libstd/sys_common/mod.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'src/libstd/sys_common') diff --git a/src/libstd/sys_common/mod.rs b/src/libstd/sys_common/mod.rs index 2845f895f18..ac2b27844dc 100644 --- a/src/libstd/sys_common/mod.rs +++ b/src/libstd/sys_common/mod.rs @@ -8,6 +8,20 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! Platform-independent platform abstraction +//! +//! This is the platform-independent portion of the standard libraries +//! platform abstraction layer, whereas `std::sys` is the +//! platform-specific portion. +//! +//! The relationship between `std::sys_common`, `std::sys` and the +//! rest of `std` is complex, with dependencies going in all +//! directions: `std` depending on `sys_common`, `sys_common` +//! depending on `sys`, and `sys` depending on `sys_common` and `std`. +//! Ideally `sys_common` would be split into two and the dependencies +//! between them all would form a dag, facilitating the extraction of +//! `std::sys` from the standard library. + #![allow(missing_docs)] use sync::Once; -- cgit 1.4.1-3-g733a5