rust/doc
Alex Crichton e338a4154b Add generation of static libraries to rustc
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
2013-11-29 18:36:13 -08:00
..
lib Remove fail keyword from lexer & parser and clean up remaining calls to 2013-02-01 00:15:42 -08:00
po librustc: Remove remaining uses of `&fn()` in favor of `||`. 2013-11-26 08:20:58 -08:00
README doc: switch pandoc to html5 2013-10-19 20:29:34 +02:00
favicon.inc doc: add favicon to tutorial/manual 2013-11-13 09:32:50 +01:00
manual.inc doc: disable parser error highlighting + a few fixes 2013-11-13 09:32:29 +01:00
po4a.conf doc: Generate .po files for Japanse translations 2013-08-12 22:39:31 +09:00
prep.js fix escape 2012-10-05 12:41:00 -07:00
rust.css doc: disable parser error highlighting + a few fixes 2013-11-13 09:32:29 +01:00
rust.md Add generation of static libraries to rustc 2013-11-29 18:36:13 -08:00
rustpkg.md docs: Change "workspace" to "package directory" 2013-11-13 22:41:50 -08:00
tutorial-borrowed-ptr.md remove the `float` type 2013-10-01 14:54:10 -04:00
tutorial-conditions.md test: Remove all remaining non-procedure uses of `do`. 2013-11-26 08:25:27 -08:00
tutorial-container.md Forbid privacy in inner functions 2013-11-17 21:28:18 -08:00
tutorial-ffi.md doc: Fix example on Windows 2013-11-14 14:43:10 +09:00
tutorial-macros.md Forbid privacy in inner functions 2013-11-17 21:28:18 -08:00
tutorial-rustpkg.md doc: disable parser error highlighting + a few fixes 2013-11-13 09:32:29 +01:00
tutorial-tasks.md librustc: Make `||` lambdas not infer to `proc`s 2013-11-26 08:25:27 -08:00
tutorial.md Register new snapshots 2013-11-28 20:27:56 -08:00
version_info.html.template doc/rust.HTML: proper version box 2013-10-19 20:31:53 +02:00

README

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