Trim src/ README, bring back version_info everywhere

rust-lang · Jan 11, 2014 · 7279409 · 7279409 · bors · Jan 11, 2014
1 parent a30d61b
commit 7279409
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 18 deletions.
diff --git a/mk/docs.mk b/mk/docs.mk
@@ -17,9 +17,9 @@ CDOCS :=
 DOCS_L10N :=
 HTML_DEPS :=
 
-BASE_DOC_OPTS := --from=markdown --standalone --toc --number-sections
+BASE_DOC_OPTS := --include-before-body=doc/version_info.html --standalone  \
+                                --toc --number-sections
 HTML_OPTS = $(BASE_DOC_OPTS) 	--to=html5  --section-divs --css=rust.css  \
-								--include-before-body=doc/version_info.html \
 								--include-in-header=doc/favicon.inc
 TEX_OPTS = $(BASE_DOC_OPTS) --to=latex
 EPUB_OPTS = $(BASE_DOC_OPTS) --to=epub

diff --git a/src/README.md b/src/README.md
@@ -2,42 +2,38 @@ This is a preliminary version of the Rust compiler, libraries and tools.
 
 Source layout:
 
+| Path                | Description                                               |
+| ------------------- | --------------------------------------------------------- |
 | `librustc/`         | The self-hosted compiler                                  |
 | `libstd/`           | The standard library (imported and linked by default)     |
 | `libextra/`         | The "extras" library (slightly more peripheral code)      |
+| `libgreen/`         | The M:N runtime library                                   |
+| `libnative/`        | The 1:1 runtime library                                   |
 | `libsyntax/`        | The Rust parser and pretty-printer                        |
 | ------------------- | --------------------------------------------------------- |
 | `rt/`               | The runtime system                                        |
-| `rt/rust_*.c`       | - The majority of the runtime services                    |
-| `rt/isaac`          | - The PRNG used for pseudo-random choices in the runtime  |
-| `rt/bigint`         | - The bigint library used for the 'big' type              |
-| `rt/uthash`         | - Small hashtable-and-list library for C, used in runtime |
-| `rt/sync`           | - Concurrency utils                                       |
-| `rt/util`           | - Small utility classes for the runtime.                  |
+| `rt/rust_*.c`       | - Some of the runtime services                            |
 | `rt/vg`             | - Valgrind headers                                        |
 | `rt/msvc`           | - MSVC support                                            |
+| `rt/sundown`        | - The Markdown library used by rustdoc                    |
 | ------------------- | --------------------------------------------------------- |
+| `compiletest/`      | The test runner                                           |
 | `test/`             | Testsuite                                                 |
+| `test/codegen`      | - Tests for the LLVM IR infrastructure                    |
 | `test/compile-fail` | - Tests that should fail to compile                       |
+| `test/debug-info`   | - Tests for the `debuginfo` tool                          |
 | `test/run-fail`     | - Tests that should compile, run and fail                 |
+| `test/run-make`     | - Tests that depend on a Makefile infrastructure          |
 | `test/run-pass`     | - Tests that should compile, run and succeed              |
 | `test/bench`        | - Benchmarks and miscellaneous                            |
 | `test/pretty`       | - Pretty-printer tests                                    |
 | `test/auxiliary`    | - Dependencies of tests                                   |
 | ------------------- | --------------------------------------------------------- |
-| `compiletest/`      | The test runner                                           |
-| ------------------- | --------------------------------------------------------- |
-| `librustpkg/`       | The package manager and build system                      |
-| ------------------- | --------------------------------------------------------- |
 | `librustdoc/`       | The Rust API documentation tool                           |
-| ------------------- | --------------------------------------------------------- |
-| `llvm/`             | The LLVM submodule                                        |
-| ------------------- | --------------------------------------------------------- |
+| `librustpkg/`       | The package manager and build system                      |
 | `libuv/`            | The libuv submodule                                       |
 | ------------------- | --------------------------------------------------------- |
+| `llvm/`             | The LLVM submodule                                        |
 | `rustllvm/`         | LLVM support code                                         |
 | ------------------- | --------------------------------------------------------- |
-| `libfuzzer/`        | A collection of fuzz testers                              |
-| ------------------- | --------------------------------------------------------- |
 | `etc/`              | Scripts, editors support, misc                            |
-