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
Matt Brubeck
16a5885555
doc: Fix typo (s/pay/may/)
2011-10-17 22:21:31 -07:00
Brian Anderson
4dafbcd992
doc: Don't merge function and concept index. There is no findex
...
This is causing errors on my windows install
2011-09-29 16:47:09 -07:00
Patrick Walton
199e4dee8d
doc: Remove case
from the list of keywords
2011-09-27 14:01:06 -07:00
Patrick Walton
f54e2699fb
doc: Remove tup
from the list of keywords
2011-09-27 13:57:54 -07:00
Erik Rose
dce9dfeefc
Fix some typos and grammar in the docs.
2011-09-25 22:25:15 -07:00
Graydon Hoare
390677ebcc
Switch URLs.
2011-09-20 16:27:08 -07:00
Marijn Haverbeke
d0d322ac93
Stop mentioning tail calls in reference
...
They don't work, and won't work in the near future.
2011-09-15 10:14:52 +02:00
Graydon Hoare
6dcd0a9b5e
Remove mention of port, chan and task *types*, as they're not just library-provided. Move some text about channels into the comm section.
2011-09-14 14:48:40 -07:00
Graydon Hoare
f13acbdbf1
Remove talk of 'sharing boxes between tasks', old GC layer, etc. Add description of unique boxes.
2011-09-14 14:38:52 -07:00
Graydon Hoare
4e93ea8b1e
Remove mention of the nonexistent (and no longer implementable) memory accounting model.
2011-09-14 14:22:27 -07:00
Graydon Hoare
c61f06fde9
Fix vector indexing notation, remove reference to 'slices'.
2011-09-14 14:13:47 -07:00
Graydon Hoare
7c782c10df
Fix description of tuples.
2011-09-14 14:11:31 -07:00
Brian Anderson
79751348b3
Remove more references to reflection from docs
2011-09-14 13:32:09 -07:00
Graydon Hoare
431a27f9a8
Remove description of nonexistent stuff (reflection, meta directives); add description of attributes and tidy up description of syntax extensions.
2011-09-14 12:35:26 -07:00
Graydon Hoare
ffeb175239
Remove stuff that's either unimplemented or misleading.
2011-09-14 12:35:26 -07:00
Graydon Hoare
2812f3cf24
Remove misleading details.
2011-09-14 12:35:26 -07:00
Graydon Hoare
71297a5e17
Remove redundant line.
2011-09-12 14:17:32 -07:00
Marijn Haverbeke
982a1a4783
Rename alias to reference in docs and error messages
...
Update docs to reflect new approach to aliases
2011-09-12 14:24:46 +02:00
Paul Stansifer
5815f4f1de
Update docs for macro-related stuff.
2011-08-26 15:13:57 -07:00
Tim Chevalier
63f9b43d36
Docs for pure fn and unchecked
2011-08-25 19:09:30 -07:00
Eric Holk
4d92cb5c63
Removing mention of domain, updating the communication examples.
2011-08-25 12:33:09 -07:00
Brian Anderson
556de425b3
Update docs for import/export
2011-08-17 11:33:34 -07:00
Graydon Hoare
ca82a690cf
Move task/comm stuff from exprs to task in manual, change typarams from [] to <>.
2011-08-16 17:39:25 -07:00
Lindsey Kuper
133b3d05b4
Update syntax for function arguments; tweak object system examples to
...
make mutable fields work.
2011-08-11 16:19:51 -07:00
Lindsey Kuper
5d0f9d92ff
Fix typo in docs that was causing makeinfo warning.
2011-08-11 16:19:51 -07:00
Graydon Hoare
c96f62a29d
Fiddle the comm operators in the docs, add swap and move symbols (no docs yet).
2011-08-11 14:58:01 -07:00
Lindsey Kuper
d2c1fbd218
Stub out docs for anon objs; update existing object system docs.
2011-08-10 19:00:59 -07:00
Graydon Hoare
6b756c4b4a
Update docs to describe kinds rather than layers, remove old terms.
2011-08-10 17:11:24 -07:00
Graydon Hoare
0daa4fb1c4
More decl fixes.
2011-08-10 17:11:24 -07:00
Graydon Hoare
a38a1b6c7a
Fix some more declarations in example code in docs.
2011-08-10 17:11:24 -07:00
Graydon Hoare
1dd9240e56
Update docs regarding path syntax.
2011-08-10 17:11:24 -07:00
Graydon Hoare
2f35f645c3
Update frontmatter.
2011-08-10 17:11:24 -07:00
Graydon Hoare
5b084e4e36
Update docs to new let syntax.
2011-08-10 15:47:11 -07:00
Graydon Hoare
c7f1c36f2b
Update docs on vector value syntax.
2011-08-10 15:16:45 -07:00
Graydon Hoare
c659ba4118
Update docs on record type and value syntax.
2011-08-10 14:50:01 -07:00
Graydon Hoare
8bc4291764
Some edits to introductory material in docs.
2011-08-10 14:50:01 -07:00
Tim Chevalier
8c757fcd40
Clarify docs about claim
2011-06-28 17:50:06 -07:00
Tim Chevalier
1d37118a00
Update docs for claim
2011-06-28 16:41:06 -07:00
Brian Anderson
eb0d56f8c5
Add a FIXME to the docs about literal suffixes
2011-06-25 19:28:19 -07:00
Brian Anderson
72f90f0f5f
Turn doc FIXMEs into comments
2011-06-21 06:17:54 -07:00
Brian Anderson
7d1979d024
Add FIXMEs to meta documentation
...
Issue #487
2011-06-18 20:23:05 -07:00
Tim Chevalier
7cefd86d41
missing word in docs
2011-06-16 14:08:48 -07:00
Tim Chevalier
11db05cf1a
Apparently my version of texinfo doesn't require curly braces to be escaped, but the buildbot's version does...
2011-05-23 10:41:47 -07:00
Tim Chevalier
ac3fd914b9
Update docs to talk about ! annotations
2011-05-23 10:33:14 -07:00
Graydon Hoare
48e0de22c1
Put out burning tinderbox.
2011-05-05 11:54:45 -07:00
Tim Chevalier
910a05d875
Update docs to reflect preds
2011-05-05 11:26:07 -07:00
Tim Chevalier
d9c9982f0a
Update docs to reflect assert vs. check
...
Also added the --batch flag to texi2pdf, as it doesn't really ever
seem useful to drop to the TeX prompt during a build.
2011-05-05 11:26:07 -07:00
Graydon Hoare
3d9cf15d0b
Remove half-baked 'opacity' layer qualifier.
2011-04-19 14:00:04 -07:00
Graydon Hoare
b7d680b57d
Remove mention of effect system from manual.
2011-04-19 13:39:57 -07:00
Lindsey Kuper
0c873993c9
'Type' renamed to 'type definition'.
...
This is basically so people don't confuse a Ref.Item.Type with a
Ref.Type.
2011-04-18 11:49:32 -07:00
Graydon Hoare
6909e7ca78
Fix busted texi from last night.
2011-04-13 09:59:00 -07:00
Graydon Hoare
d3409f6368
Finish the majority of statement -> expression rearrangement in manual.
2011-04-12 18:27:03 -07:00
Tim Chevalier
d64b72f6ec
More statement-to-expression edits
2011-04-04 17:35:10 -07:00
Lindsey Kuper
5de3f441d0
A trivial documentation commit.
2011-04-04 17:29:49 -07:00
Tim Chevalier
512bba264e
Change 'statement' to 'expression' in a bunch of places
2011-04-04 17:02:31 -07:00
Lindsey Kuper
db5c809c83
Add 'self' keyword.
2011-03-28 21:13:42 -07:00
Brian Anderson
d7c67fc6ac
Fix typo in Ref.Task.Comm
2011-03-25 08:43:10 -07:00
Graydon Hoare
29d853dd19
Remove obsolete Makefiles.
2011-03-24 14:56:51 -07:00
Brian Anderson
5d98f55fcf
Update docs for if statements
2011-03-22 08:11:36 -07:00
Brian Anderson
e2d36e00ce
Remove parens from nullary tag constructors in docs
2011-03-01 23:11:52 -05:00
Graydon Hoare
dabccadd32
Update manual to define identifiers using UAX 31 XID_Start / XID_Continue.
2011-02-25 15:43:50 -08:00
Sean Stangl
3339243254
Fix documentation: aliases may not be used in loop constructs.
2011-01-27 12:15:54 -08:00
benjaminjackman
7f4ec2c622
fixed typo in tuple menu label
2011-01-17 18:09:35 -08:00
Brian Anderson
74e6bb87d6
Update keyword list with 'const', 'thread'
2011-01-03 11:08:14 -08:00
Brian Anderson
c90d114d36
Use git log pretty printing arguments that are compatible with older versions of git
2011-01-03 11:06:52 -08:00
Graydon Hoare
3f227c71b2
Some terminology updates to talk about layers.
2010-12-14 13:41:19 -08:00
Ralph Giles
c038261762
Fix documentation: it's (&str s) not (str &s).
2010-11-03 15:37:56 -07:00
Ralph Giles
446932b5bc
Fix doc references to 'for each' syntax to match the compiler.
...
The rustboot compiler expects 'for each (type v in ...)' like 'for',
rather than 'for each (type v = ...)' as given in the documentation.
2010-11-03 15:37:55 -07:00