Graydon Hoare
997b29fa7e
Fix links.
2012-01-19 17:01:15 -08:00
Tim Chevalier
c500801f83
Fix typos in section 6; point out that prove expressions are unsupported
2012-01-19 16:59:25 -08:00
Tim Chevalier
704210ef7c
Typos, section 5
2012-01-19 16:31:42 -08:00
Tim Chevalier
bb54979b39
Fix typos
2012-01-19 16:23:38 -08:00
Tim Chevalier
64a0695fec
Fix typos
2012-01-19 16:05:55 -08:00
Tim Chevalier
93a816ab9d
Fix typo
2012-01-19 16:02:04 -08:00
Graydon Hoare
7e21be5304
Add 'getting started' text to tutorial, close #427 .
2012-01-19 14:49:00 -08:00
Graydon Hoare
cc2bd02827
Remove doc/rust.texi
2012-01-19 13:10:14 -08:00
Graydon Hoare
e0a4d47720
Copy section to docs on runtime services.
2012-01-19 13:10:14 -08:00
Brian Anderson
0c237254b3
doc: Copyedit task section
2012-01-19 12:23:35 -08:00
Brian Anderson
35f553dbd6
doc: Fix typo
2012-01-19 11:38:26 -08:00
Marijn Haverbeke
d54cc1cad4
Fix internal linking in the tutorial
2012-01-19 15:33:45 +01:00
Marijn Haverbeke
a4b77758f0
Move tutorial over to a format similar to the reference doc
...
And adjust highlighting/testing scripts to deal with this.
2012-01-19 13:34:10 +01:00
Tim Chevalier
90cd795b8b
Update docs to reflect pattern syntax change
2012-01-19 01:22:43 -08:00
Graydon Hoare
3074fd591d
Tidy tidy
2012-01-18 18:44:06 -08:00
Marijn Haverbeke
ba6c94e321
Add a stylesheet to make the reference HTML look a bit prettier
2012-01-18 16:28:31 +01:00
Marijn Haverbeke
861b8f0107
Fill out some parts of the reference docs
2012-01-18 16:28:31 +01:00
Marijn Haverbeke
e40cd654b9
Fix bug in tutorial render script
2012-01-18 16:28:31 +01:00
Marijn Haverbeke
94cd792b92
Fix poor markdown parsing in tutorial-building script
2012-01-18 09:39:19 +01:00
Graydon Hoare
711fc20d88
Merge pull request #1544 from kevina/issue-1393
...
Minor cleanups to custom discriminator code.
2012-01-17 12:45:09 -08:00
Kevin Atkinson
bdc8e8d222
Minor cleanups to custom discriminator code.
...
Mostly updates to the comments and docs from Pull Request #1537 .
2012-01-16 21:04:02 -07:00
Graydon Hoare
293678847b
Convert a bunch of material on items, statements, expressions and typestates.
2012-01-16 18:04:48 -08:00
Graydon Hoare
236b304f19
Convert some material covering items, view-items, types.
2012-01-16 16:13:34 -08:00
Marijn Haverbeke
498ad91d06
Upgrade CodeMirror mode used to highlight the tutorial code
2012-01-16 13:07:16 +01:00
Marijn Haverbeke
936c933fd8
Move emacs mode into tree
2012-01-16 12:44:24 +01:00
Kevin Atkinson
edf11ebf02
In the tutorial, document that C-like enums can have the discriminator
...
values set and that it is possible to cast them to scalar values.
2012-01-16 11:19:32 +01:00
Graydon Hoare
f535940bd5
Import task and memory-model docs.
2012-01-13 15:43:12 -08:00
Graydon Hoare
4f9e1ba80b
More doc porting.
2012-01-13 15:43:12 -08:00
Graydon Hoare
fefdb63c4c
Begin shift over to using pandoc, markdown and llnextgen for reference manual. Fix man page URL while at it.
2012-01-12 19:10:30 -08:00
Graham Fawcett
f4a3a3b878
tutorial: rework nolink description to remove mention of "empty string"
2012-01-12 22:02:41 +01:00
Marijn Haverbeke
ca72a8300b
Add tutorial chapter on interfaces
2012-01-12 14:24:36 +01:00
Marijn Haverbeke
0f72c53fdf
Go over the tutorial again
...
Edit some things, make sure all code runs.
2012-01-12 13:19:02 +01:00
Niko Matsakis
79d489cedf
discuss joinable tasks
2012-01-11 13:12:45 -08:00
Niko Matsakis
f3b867fd04
add section on spawn_connected to tutorial and pull test into file
2012-01-11 09:49:21 -08:00
Niko Matsakis
ef895b9632
update various parts of the tutorial
2012-01-10 19:57:00 -08:00
Austin Seipp
55edb4a04f
Replace all occurrences of 'when' with 'if' in documentation and tutorial.
...
Also update the naturaldocs keywords file.
Closes #1396
2012-01-09 19:27:06 -08:00
Graydon Hoare
8387896dda
Remove proto_sugar and 'lambda' as keyword, commit to fn@.
2012-01-09 16:12:48 -08:00
Brian Anderson
48019c5b0a
doc: typo
2012-01-07 17:04:30 -08:00
Marijn Haverbeke
7ea175f23f
Fix confusing information in tutorial chapter about argument modes
2012-01-02 10:23:04 +01:00
Erick Tryzelaar
eba891e989
tutorial: Mention by-value argument passing style.
2011-12-31 12:20:03 -08:00
Graydon Hoare
90ae3e3168
Document copy/move/swap/assign expressions more accurately. Fix up some drift on log docs.
2011-12-30 15:10:55 -08:00
Graydon Hoare
d6db9506f4
Purge some obsolete and/or not-implemented stuff from docs.
2011-12-29 18:02:39 -08:00
Graydon Hoare
36c55b20a8
Add support in lexer for utf8 identifiers. No NFKC logic in char yet.
2011-12-29 14:45:18 -08:00
Graydon Hoare
88d74993d8
Update docs on log expressions.
2011-12-23 11:43:36 -08:00
Graham Fawcett
7ddd353ef6
implement #[nolink]; deprecate #[link_name = ""]; note in stdlib to remove empty link_name.
...
Can't remove them from stdlib until the snapshotted compiler supports #[nolink].
2011-12-16 15:29:59 -08:00
Brian Anderson
89efb7d981
libstd: Update docs
2011-12-06 13:58:54 -08:00
Graydon Hoare
447414f007
Establish 'core' library separate from 'std'.
2011-12-06 12:13:04 -08:00
Stefan Plantikow
3ee2eb656e
doc: added definition of trivial casts to spec
...
(cf @ignored Expr.Be and #1215 for intended use)
2011-12-02 11:38:24 -08:00
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
Matt Brubeck
9e8076c88b
doc: 'if' expressions no longer require parens
2011-10-17 22:21:31 -07:00
Matt Brubeck
db84029268
doc: 'for' and 'for each' no longer use parens
2011-10-17 22:21:31 -07:00