mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 14:55:26 +00:00
e338a4154b
This commit implements the support necessary for generating both intermediate and result static rust libraries. This is an implementation of my thoughts in https://mail.mozilla.org/pipermail/rust-dev/2013-November/006686.html. When compiling a library, we still retain the "lib" option, although now there are "rlib", "staticlib", and "dylib" as options for crate_type (and these are stackable). The idea of "lib" is to generate the "compiler default" instead of having too choose (although all are interchangeable). For now I have left the "complier default" to be a dynamic library for size reasons. Of the rust libraries, lib{std,extra,rustuv} will bootstrap with an rlib/dylib pair, but lib{rustc,syntax,rustdoc,rustpkg} will only be built as a dynamic object. I chose this for size reasons, but also because you're probably not going to be embedding the rustc compiler anywhere any time soon. Other than the options outlined above, there are a few defaults/preferences that are now opinionated in the compiler: * If both a .dylib and .rlib are found for a rust library, the compiler will prefer the .rlib variant. This is overridable via the -Z prefer-dynamic option * If generating a "lib", the compiler will generate a dynamic library. This is overridable by explicitly saying what flavor you'd like (rlib, staticlib, dylib). * If no options are passed to the command line, and no crate_type is found in the destination crate, then an executable is generated With this change, you can successfully build a rust program with 0 dynamic dependencies on rust libraries. There is still a dynamic dependency on librustrt, but I plan on removing that in a subsequent commit. This change includes no tests just yet. Our current testing infrastructure/harnesses aren't very amenable to doing flavorful things with linking, so I'm planning on adding a new mode of testing which I believe belongs as a separate commit. Closes #552 |
||
|---|---|---|
| .. | ||
| lib | ||
| po | ||
| favicon.inc | ||
| manual.inc | ||
| po4a.conf | ||
| prep.js | ||
| README | ||
| rust.css | ||
| rust.md | ||
| rustpkg.md | ||
| tutorial-borrowed-ptr.md | ||
| tutorial-conditions.md | ||
| tutorial-container.md | ||
| tutorial-ffi.md | ||
| tutorial-macros.md | ||
| tutorial-rustpkg.md | ||
| tutorial-tasks.md | ||
| tutorial.md | ||
| version_info.html.template | ||
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code. It's available for most platforms here: http://johnmacfarlane.net/pandoc/installing.html Node.js (http://nodejs.org/) is also required for generating HTML from the Markdown docs (reference manual, tutorials, etc.) distributed with this git repository. To generate all the docs, run `make docs` from the root of the repository. This will convert the distributed Markdown docs to HTML and generate HTML doc for the 'std' and 'extra' libraries. To generate HTML documentation from one source file/crate, do something like: rustdoc --output-dir html-doc/ --output-format html ../src/libstd/path.rs (This, of course, requires that you've built/installed the `rustdoc` tool.) To generate an HTML version of a doc from Markdown, without having Node.js installed, do something like: pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md The syntax for pandoc flavored markdown can be found at: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown A nice quick reference (for non-pandoc markdown) is at: http://kramdown.rubyforge.org/quickref.html