Skip to content

Commit 7279409

Browse files
committed
Trim src/ README, bring back version_info everywhere
1 parent a30d61b commit 7279409

File tree

2 files changed

+14
-18
lines changed

2 files changed

+14
-18
lines changed

mk/docs.mk

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ CDOCS :=
1717
DOCS_L10N :=
1818
HTML_DEPS :=
1919

20-
BASE_DOC_OPTS := --from=markdown --standalone --toc --number-sections
20+
BASE_DOC_OPTS := --include-before-body=doc/version_info.html --standalone \
21+
--toc --number-sections
2122
HTML_OPTS = $(BASE_DOC_OPTS) --to=html5 --section-divs --css=rust.css \
22-
--include-before-body=doc/version_info.html \
2323
--include-in-header=doc/favicon.inc
2424
TEX_OPTS = $(BASE_DOC_OPTS) --to=latex
2525
EPUB_OPTS = $(BASE_DOC_OPTS) --to=epub

src/README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,38 @@ This is a preliminary version of the Rust compiler, libraries and tools.
22

33
Source layout:
44

5+
| Path | Description |
6+
| ------------------- | --------------------------------------------------------- |
57
| `librustc/` | The self-hosted compiler |
68
| `libstd/` | The standard library (imported and linked by default) |
79
| `libextra/` | The "extras" library (slightly more peripheral code) |
10+
| `libgreen/` | The M:N runtime library |
11+
| `libnative/` | The 1:1 runtime library |
812
| `libsyntax/` | The Rust parser and pretty-printer |
913
| ------------------- | --------------------------------------------------------- |
1014
| `rt/` | The runtime system |
11-
| `rt/rust_*.c` | - The majority of the runtime services |
12-
| `rt/isaac` | - The PRNG used for pseudo-random choices in the runtime |
13-
| `rt/bigint` | - The bigint library used for the 'big' type |
14-
| `rt/uthash` | - Small hashtable-and-list library for C, used in runtime |
15-
| `rt/sync` | - Concurrency utils |
16-
| `rt/util` | - Small utility classes for the runtime. |
15+
| `rt/rust_*.c` | - Some of the runtime services |
1716
| `rt/vg` | - Valgrind headers |
1817
| `rt/msvc` | - MSVC support |
18+
| `rt/sundown` | - The Markdown library used by rustdoc |
1919
| ------------------- | --------------------------------------------------------- |
20+
| `compiletest/` | The test runner |
2021
| `test/` | Testsuite |
22+
| `test/codegen` | - Tests for the LLVM IR infrastructure |
2123
| `test/compile-fail` | - Tests that should fail to compile |
24+
| `test/debug-info` | - Tests for the `debuginfo` tool |
2225
| `test/run-fail` | - Tests that should compile, run and fail |
26+
| `test/run-make` | - Tests that depend on a Makefile infrastructure |
2327
| `test/run-pass` | - Tests that should compile, run and succeed |
2428
| `test/bench` | - Benchmarks and miscellaneous |
2529
| `test/pretty` | - Pretty-printer tests |
2630
| `test/auxiliary` | - Dependencies of tests |
2731
| ------------------- | --------------------------------------------------------- |
28-
| `compiletest/` | The test runner |
29-
| ------------------- | --------------------------------------------------------- |
30-
| `librustpkg/` | The package manager and build system |
31-
| ------------------- | --------------------------------------------------------- |
3232
| `librustdoc/` | The Rust API documentation tool |
33-
| ------------------- | --------------------------------------------------------- |
34-
| `llvm/` | The LLVM submodule |
35-
| ------------------- | --------------------------------------------------------- |
33+
| `librustpkg/` | The package manager and build system |
3634
| `libuv/` | The libuv submodule |
3735
| ------------------- | --------------------------------------------------------- |
36+
| `llvm/` | The LLVM submodule |
3837
| `rustllvm/` | LLVM support code |
3938
| ------------------- | --------------------------------------------------------- |
40-
| `libfuzzer/` | A collection of fuzz testers |
41-
| ------------------- | --------------------------------------------------------- |
4239
| `etc/` | Scripts, editors support, misc |
43-

0 commit comments

Comments
 (0)