Commit Graph

150 Commits

Author SHA1 Message Date
Haitao Li 6168f8f15b tutorial: Fix typo in the test section 2011-11-25 08:03:47 +01:00
Haitao Li 3e303af86b rustc: Add a path attribute for crate directives
The path information was an optional "filename" component of crate
directive AST. It is now replaced by an attribute with metadata named
"path".

With this commit, a directive

  mod foo = "foo.rs";

should be written as:

  #[path = "foo.rs"]
  mod foo;

Closes issue #906.
2011-11-24 15:31:18 -08:00
Haitao Li 2ac63801d2 doc: Build keywords multitable automatically
Keywords are now listed in a plain text file. They're sorted in
column-major order and rendered as a texinfo multitable in rust.texi.

Fixes issue #1216.
2011-11-23 21:11:18 +01:00
Marijn Haverbeke a8dd52ed36 Remove last traces of auth keyword
The reference now has an empty hole where the auth keyword used to be.
Changing the keyword table seems to require manually sorting the
keywords and putting them back into some kind of arcane interleaved
order. I'll open an issue to actually fix this.

Closes #1211
2011-11-23 11:02:27 +01:00
Marijn Haverbeke fedb775fbb Add hacks to extract and compile tutorial code
Not included in the build by default, since it's fragile and kludgy. Do
something like this to run it:

    cd doc/tutorial
    RUSTC=../../build/stage2/bin/rustc bash test.sh

Closes #1143
2011-11-22 16:12:23 +01:00
Marijn Haverbeke 532642f425 Clarify escaped newlines in tutorial
Closes #1117
2011-11-22 12:47:07 +01:00
Marijn Haverbeke 8e2b5de90e Fix typo in tutorial 2011-11-21 13:20:02 +01:00
Marijn Haverbeke 12f6e868f7 Add explanation of kinds to tutorial 2011-11-21 12:07:41 +01:00
Haitao Li f4eb25e0d0 tutorial: Fix type mismatch in example FFI code
Compile error:
time.rs:13:23: 13:43 error: mismatched types: expected
*R[tv_sec=mMltv_usec=mMl] but found *R[tv_sec=Mltv_usec=Ml] (record
elements differ in mutability)
time.rs:13     libc::gettimeofday(std::ptr::addr_of(x),
std::ptr::null());
                                  ^~~~~~~~~~~~~~~~~~~~
error: aborting due to previous errors
rust: upcall fail 'explicit failure', ../src/comp/driver/session.rs:70
rust: domain main @0x9dfd178 root task failed
2011-11-17 22:50:08 +08:00
Brian Anderson bfbaa3d1e1 tutorial: Close unmatched quote in anchor tag 2011-11-16 15:02:00 -08:00
Brian Anderson 9b89b0cffd Update tutorial for native mod changes 2011-11-16 12:16:36 -08:00
Haitao Li 5665308d8c tutorial: Update with native module syntax change 2011-11-16 11:35:14 -08:00
Marijn Haverbeke 73cd032df5 Fix small grammar mistake in tutorial 2011-11-16 08:51:59 +01:00
Marijn Haverbeke 0898d441cb Use libcrypto.so instead of libssl.so in the ffi part of tutorial 2011-11-15 13:53:03 +01:00
Brian Anderson 369fc5e480 Document crate top-level and directory modules. Closes #1097 2011-11-07 13:34:04 -08:00
Marijn Haverbeke ba57ec24ea Fix some more bugs in the tutorial
Tutorial code going out of date is going to be a recurring problem...
2011-11-07 09:55:25 +01:00
Matt Brubeck ce8c5b0340 Tutorial: 'import std;' should be 'use std;'. 2011-11-07 08:45:29 +01:00
Marijn Haverbeke 2c033f83ef Fill in the tutorial section on testing 2011-11-04 12:23:35 +01:00
Marijn Haverbeke 4ce6472c02 Clarify metadata syntax in manual
Closes #1119
2011-11-03 10:59:42 +01:00
Marijn Haverbeke eed782c778 Fix confusing sentence in tutorial. 2011-11-02 19:03:49 +01:00
Marijn Haverbeke d58a9c7346 Expand the tutorial section on functions 2011-11-02 13:49:37 +01:00
Marijn Haverbeke 769e9b669b Write briefly about syntax extension in the syntax section
The currently existing syntax extension facilities don't really merit
their own section.
2011-11-02 13:27:29 +01:00
Marijn Haverbeke 0a20eed2db Make ptr::addr_of return an immutable vec, add mut_addr_of 2011-11-02 12:20:12 +01:00
Marijn Haverbeke eaf9e05611 Make 'lambda(...) -> ...' parse as a type 2011-11-02 12:20:11 +01:00
Marijn Haverbeke eabc9f2295 Fix some typos in tutorial 2011-11-01 22:11:55 +01:00
Brian Anderson 4a2d277bbf Fix typo in syntax.md 2011-11-01 12:39:47 -07:00
Marijn Haverbeke 11999351e0 Fill in the foreign-function part of the tutorial 2011-11-01 17:35:18 +01:00
Marijn Haverbeke 4fec1798d0 Tie up some ends in the tutorial 2011-11-01 15:41:14 +01:00
Marijn Haverbeke a6d856c57c Improve syntax highlighting in tutorial 2011-11-01 15:16:50 +01:00
Marijn Haverbeke 59cc8636b7 Fix file timestamp extraction in tutorial builder 2011-11-01 14:47:13 +01:00
Marijn Haverbeke aa01876c95 Flesh out the module section of the tutorial 2011-11-01 14:38:55 +01:00
Marijn Haverbeke e8e2cd44f4 Add syntax highlighting to the code snippets in the tutorial
Using the CodeMirror Rust mode.
2011-11-01 12:46:46 +01:00
Marijn Haverbeke 8b57cb90e5 Clarify tutorial based on feedback, fix some Markdown errors 2011-11-01 09:42:24 +01:00
Haitao Li ca7d750eb8 doc: Sort keywords alphabetically 2011-11-01 09:25:39 +01:00
Haitao Li 2befca3966 doc: Add missing keywords block and lambda 2011-11-01 09:25:37 +01:00
Brian Anderson 151aaf84ce Add pattern guard docs to language ref 2011-10-31 15:37:40 -07:00
Marijn Haverbeke 0b4f0a4caa Add a first stab at a tutorial
You build it with `cd doc/tutorial; node build.js`, and then point
your browser at doc/tutorial/web/index.html. Not remotely ready for
publicity yet.
2011-10-31 16:21:39 +01:00
Matt Brubeck d5415a3973 Remove iter and 'for each' from the documentation 2011-10-28 20:33:58 -07:00
Brian Anderson 6864070b24 Document alt record patterns 2011-10-28 16:51:11 -07:00
Brian Anderson 6afecc37e3 Document the nullary-variant period in alt patterns 2011-10-28 16:18:16 -07:00
Matt Brubeck ba1df0eda9 More documentation for alt expressions 2011-10-28 16:03:27 -07:00
Brian Anderson fd095fbfa6 Document how RUST_LOG works 2011-10-28 15:47:20 -07:00
Matt Brubeck 5a0f18558e Add 'as' (cast) operator to the documentation 2011-10-27 13:37:35 -07:00
Brian Anderson 4d669036f3 Add more std documentation 2011-10-26 18:32:34 -07:00
Brian Anderson 1b75e5c315 Use web-style paragraphs in std docs 2011-10-26 11:55:28 -07:00
Brian Anderson 197c8543fe Add more std documentation 2011-10-26 11:47:42 -07:00
Brian Anderson 7ae757583a Begin documenting std and add doc generation using naturaldocs
Naturaldocs isn't really that great but it seems easier to get
something working than with doxygen, for which we would need to
convert rust code to something C++ish. We probably want to just
write a rustdoc utility at some point.
2011-10-25 18:01:52 -07:00
Matt Brubeck 5950ae3c0e doc: Fix parse errors in list examples in documentation 2011-10-17 22:50:46 -07:00
Matt Brubeck f400bfd8fd doc: Update 'alt' documentation to remove 'case' keyword 2011-10-17 22:50:46 -07:00
Matt Brubeck 1e5f163eec doc: 'alt' expressions no longer require parens 2011-10-17 22:21:31 -07:00