From 54abbda9b4f9ead316413d2ec5bef926c8bede18 Mon Sep 17 00:00:00 2001 From: George Papanikolaou Date: Mon, 24 Feb 2014 13:41:12 +0200 Subject: [PATCH] Update source code layout in src/ with the new modules that moved from extra, and with other undocumented folders. also add a note about potential changes. --- src/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/README.md b/src/README.md index cc67a3717faad..0ac310df1b866 100644 --- a/src/README.md +++ b/src/README.md @@ -10,6 +10,21 @@ Source layout: | `libgreen/` | The M:N runtime library | | `libnative/` | The 1:1 runtime library | | `libsyntax/` | The Rust parser and pretty-printer | +| `libcollections/` | A collection of useful data structures and containers | +| `libnum/` | Extended number support library (complex, rational, etc) | +| `libtest/` | Rust's test-runner code | +| ------------------- | --------------------------------------------------------- | +| `libarena/` | The arena (a fast but limited) memory allocator | +| `libflate/` | Simple compression library | +| `libfourcc/` | Data format identifier library | +| `libgetopts/` | Get command-line-options library | +| `libglob/` | Unix glob patterns library | +| `libsemver/` | Rust's semantic versioning library | +| `libserialize/` | Encode-Decode types library | +| `libsync/` | Concurrency mechanisms and primitives | +| `libterm/` | ANSI color library for terminals | +| `libtime/` | Time operations library | +| `libuuid/` | UUID's handling code | | ------------------- | --------------------------------------------------------- | | `rt/` | The runtime system | | `rt/rust_*.c` | - Some of the runtime services | @@ -31,8 +46,13 @@ Source layout: | ------------------- | --------------------------------------------------------- | | `librustdoc/` | The Rust API documentation tool | | `libuv/` | The libuv submodule | +| `librustuv/` | Rust libuv support code | | ------------------- | --------------------------------------------------------- | | `llvm/` | The LLVM submodule | | `rustllvm/` | LLVM support code | | ------------------- | --------------------------------------------------------- | | `etc/` | Scripts, editors support, misc | + + +NOTE: This list (especially the second part of the table which contains modules and libraries) +is highly volatile and subject to change.