Commit Graph

382 Commits

Author SHA1 Message Date
Tim Chevalier
55e29ef4aa Mention lazy evaluation of log arguments in tutorial 2012-04-23 15:50:40 -07:00
Tim Chevalier
03d9d6287b Discuss (*) patterns in reference documentation 2012-04-23 15:50:16 -07:00
Brian Anderson
8be944e89e doc: Remove unused keywords.txt 2012-04-19 20:06:13 -07:00
Brian Anderson
594d22e7e2 doc: Update keyword list 2012-04-19 16:59:28 -07:00
Joshua Wise
e5f51bf5ef doc: Update keywords.txt with modern list of keywords derived from parser. 2012-04-19 00:05:55 -07:00
Marijn Haverbeke
73ea690016 Describe new for construct in the tutorial
Closes #2141
2012-04-18 17:21:39 +02:00
Niko Matsakis
35a93e61d4 rewrite region resolution so it takes place in typeck 2012-04-16 19:48:00 -07:00
Graydon Hoare
9e726b0461 Add description of by-move mode. 2012-04-11 10:20:52 -07:00
Tim Chevalier
9d274ec5f2 Re-rename option functions
get_with_default (nee from_maybe) => get_default
with_option (nee maybe) => map_default
with_option_do (nee may) => iter

As per discussion of 21be1379d5
2012-04-06 12:20:13 -07:00
Marijn Haverbeke
fc202ca034 Remove support for old-style for
Closes #1619
2012-04-06 20:38:23 +02:00
Tim Chevalier
fc7fc90adf Documentation only: update tutorial to mention --lib only for single source files
In the tutorial, use the crate_type attribute when discussing crate files that
are libraries, and only refer to the --lib files when talking about making a
single source file into a library.

Closes #2070.
2012-04-05 16:28:09 -07:00
Tim Chevalier
3ef620bf92 task_builder => builder in the docs
This example got left out for some reason.
2012-04-05 14:35:54 -07:00
Tim Chevalier
21be1379d5 Rename some core::option functions
from_maybe => get_with_default
maybe => with_option
may => with_option_do

I know these names are kind of ridiculous, but it's the best I could think of.
Feel free to bikeshed. Closes #2081
2012-04-02 16:12:49 -07:00
Brian Anderson
d0268cbe5f doc: Abbreviate Thursday as 'th', not 'do' 2012-04-02 14:17:33 -07:00
Brian Anderson
9ec21933f1 doc: Tutorial fixes
Thanks to Mohd. Bilal Husain
2012-04-01 15:36:56 -07:00
Graydon Hoare
2142c5ebbb Minor typo fixes. 2012-03-27 13:54:49 -07:00
Graydon Hoare
6e6798c4e1 Bulk-edit mutable -> mut. 2012-03-26 18:35:18 -07:00
Jacob Parker
82e5fe1d72 str::to_chars -> str::chars 2012-03-25 16:29:18 -04:00
Niko Matsakis
dc07280b08 make --enforce-mut-vars always on, add mut annotations to remaining files 2012-03-22 09:58:19 -07:00
Brian Anderson
8404ea0c8a doc: Fix more language ref tests 2012-03-20 21:11:13 -07:00
Brian Anderson
575692c3bc doc: Fix some language ref examples 2012-03-20 18:59:21 -07:00
Brian Anderson
089877f0c5 doc: tag->enum in codemirror-rust.js 2012-03-20 18:59:21 -07:00
Brian Anderson
0a347e760f doc: Run language ref through prep.js
This is so we can strip out support code needed to make the examples work,
and as a bonus it does syntax highlighting.
2012-03-20 18:59:21 -07:00
Brian Anderson
57281f52e5 test: Begin running the language ref examples. Mostly xfailed 2012-03-20 18:59:21 -07:00
Brian Anderson
a0cbf638ee doc: Switch the tutorial to pandoc's method of tagging code blocks
Instead of '## tag', it's '~~~ {.tag}'
2012-03-20 18:59:21 -07:00
Brian Anderson
f322dd1510 doc: Fix external links in tutorial 2012-03-20 17:19:53 -07:00
Brian Anderson
f5087aa64b doc: Remove unary move operator from language ref. Closes #2032 2012-03-20 15:20:37 -07:00
Brian Anderson
13bcc73625 core: Rename vec::position_elt to position_elem 2012-03-18 17:40:49 -07:00
Brian Anderson
b968c8e6cd Name types after their modules instead of 't' 2012-03-13 15:14:17 -07:00
Graydon Hoare
6f5853f5a1 Libc/os/run/rand/io reorganization. Close #1373. Close #1638.
- Move io, run and rand to core.
 - Remove incorrect ctypes module (use libc).
 - Remove os-specific modules for os and fs.
 - Split fs between core::path and core::os.
2012-03-12 20:08:29 -07:00
Brian Anderson
772028acdb doc: Add some info about native mods and crust functions 2012-03-12 15:41:11 -07:00
Tim Chevalier
fde4c1efbb Document what the type of the main() function should be 2012-03-11 20:55:12 -07:00
Tim Chevalier
d7ae9f1370 Docs for infinite loops 2012-03-11 20:17:37 -07:00
Brian Anderson
a0a230de83 doc: Add 'crust' to keywords 2012-03-11 18:05:51 -07:00
Brian Anderson
57af1e9f67 doc: Update tutorial for task API changes 2012-03-10 15:30:51 -08:00
Brian Anderson
91b988ea45 doc: Indent preformatted text a little more 2012-03-10 15:26:41 -08:00
Brian Anderson
93a082149a build: Switch from naturaldocs to rustdoc 2012-03-09 22:56:53 -08:00
Brian Anderson
4220dcf1e9 core: New task API 2012-02-20 18:58:04 -08:00
Daniel Luz
06658b46b8 Duplicate keyword 2012-02-14 23:39:30 -02:00
Daniel Luz
039cc8d6c5 Fixed missing quote on bracket literal 2012-02-14 23:39:02 -02:00
Tomoki Aonuma
6d1d9a0236 Fix typos in the reference manual 2012-02-15 04:34:02 +09:00
Patrick Walton
d4d21b4279 tutorial: Mention how the destructor works in the section on resources. Closes #1615. 2012-02-14 09:28:39 -08:00
Marijn Haverbeke
87a488048d Make keyword table in reference reflect reality more closely
And remove the part about reserved words.
2012-02-06 22:03:17 +01:00
Brian Anderson
91b6dc5c8e Merge remote-tracking branch 'erickt/master'
Conflicts:
	src/libcore/vec.rs
	src/libstd/getopts.rs
2012-02-05 15:15:21 -08:00
Marijn Haverbeke
75c56e8494 Add missing 'use std' in tutorial example 2012-02-05 14:57:33 +01:00
Paul Woolcock
6ba3d24355 Remove ternary operator
`expr_ternary`, `ternary_to_if`, and all parses & lexer definitions have
been removed.
2012-01-30 18:21:19 +01:00
Erick Tryzelaar
259636a112 core: rename vec::position* functions
Almost all of the vec functions that predicates don't have a
corresponding function that takes a single element, so this
commit renames the common fn usecase to be the default.
2012-01-28 09:18:34 -08:00
Brian Anderson
6d360d2b02 tutorial: Fix types in gettimeofday example. Closes #1657 2012-01-26 15:45:02 -08:00
Tim Chevalier
746fa27988 In the tutorial install directions, mention that you may need to sudo make install 2012-01-25 13:49:32 -08:00
Joe Pletcher
edd86126f7 Added a small note to help explain tag's in older code. 2012-01-25 10:17:50 +01:00
Joe Pletcher
b02b65a547 Remove stale references to tags, replaced with enums. 2012-01-25 10:17:49 +01:00
Joe Pletcher
3b9a9fce49 Remove reference to tags, replace enums. 2012-01-25 10:16:32 +01:00
Tim Chevalier
2d84b481de Documentation only -- typos in section on swap expression
Closes #1595. Thanks to mikesamuel.
2012-01-24 16:46:22 -08:00
Tim Chevalier
cd9b344f7b Update docs to reflect new export forms 2012-01-23 16:35:39 -08:00
Brian Anderson
088e915fee Remove mention of Windows installer from tutorial
We don't want users to hurt themselves, since the installer has
a bug in 0.1 that could possibly corrupt %PATH%

Conflicts:

	doc/tutorial.md
2012-01-23 14:09:21 -08:00
Brian Anderson
5cb725a890 tutorial: Remove mention of windows installer 2012-01-23 13:52:31 -08:00
Rick Waldron
c42b52b3fd Corrects order of identifier and type in arguments list in 7.3.3 Constraints example. Fixes #1613 2012-01-22 23:14:46 -05:00
Brian Anderson
98fd120ac1 tutorial: Make the comm examples pass 2012-01-21 15:25:14 -08:00
Brian Anderson
de150e02ae tutorial: Un-xfail some working examples 2012-01-21 15:06:06 -08:00
Taras Shpot
1bbd97c11f doc: Fix typo 2012-01-21 16:21:18 +02:00
Brian Anderson
2aabccc3ba doc: Remove extract-tests.js and run-tests.sh
The tutorial tests are run as part of the test suite now.
2012-01-20 19:57:47 -08:00
Brian Anderson
327c8bc733 build: Run tutorial tests 2012-01-20 19:56:06 -08:00
Lindsey Kuper
78c327559c Typo fixes. 2012-01-20 22:36:33 -05:00
Brian Anderson
63a1dcda29 doc: Translate extract-tests.js to python 2012-01-20 17:32:49 -08:00
Matt Brubeck
155601eefe Update the keyword lists in rust.md and syntax.vim
Add new keywords "enum" and "of", and remove old keywords "auth", "chan",
"log_err", "tag", and "task".

Also add reserved words to the syntax file, to help Vim users avoid using them
as identifiers.
2012-01-20 16:08:51 -08:00
Brian Anderson
4efdab0059 doc: Add MinGW instructions to tutorial 2012-01-20 15:27:14 -08:00
Brian Anderson
3401c50070 doc: Use commas to separate enums in tutorial 2012-01-20 15:14:18 -08:00
Niko Matsakis
1304e4e40f update tutorial to avoid block() syntax and to use term stack closure 2012-01-20 09:14:30 -08:00
Brian Anderson
20a9e317c9 doc: Fix mutant comma in tutorial 2012-01-20 02:16:11 -08:00
Brian Anderson
341540b694 doc: Mention 'debug' log level in tutorial. Closes #1579 2012-01-20 01:06:26 -08:00
Graydon Hoare
a4954eb6ce Couple typo fixes in tutorial. 2012-01-19 23:58:33 -08:00
Graydon Hoare
d8e750f1c6 Typo fix in tutorial. 2012-01-19 22:55:40 -08:00
Brian Anderson
b9d517296a doc: Update description of logging spec and ::rt module 2012-01-19 22:30:15 -08:00
Matt Brubeck
2eda013ea2 Add documentation about paretheses for grouping expressions 2012-01-19 21:54:17 -08:00
Matt Brubeck
3d9f50a186 Mention associativity of binary operators 2012-01-19 21:54:17 -08:00
Matt Brubeck
3276af7f24 "Rust task" should be "Rust program" in the intro to the Memory Model docs 2012-01-19 21:54:17 -08:00
Graydon Hoare
c470018240 Merge pull request #1573 from mbrubeck/master
Remove some stray texinfo syntax from a footnote
2012-01-19 21:36:13 -08:00
Ben Striegel
1a295096b1 tutorial.md: spelling corrections for sections 1-5 2012-01-20 00:22:05 -05:00
Matt Brubeck
cea9fbfab0 Remove some stray texinfo syntax from a footnote 2012-01-19 21:12:46 -08:00
Matt Brubeck
bed7e96022 Fix a broken link in doc/rust.md. 2012-01-19 20:55:36 -08:00
Graydon Hoare
6ffc36bb1b Move some doc text around. 2012-01-19 18:34:41 -08:00
Graydon Hoare
874390831a Fix a bunch of broken internal links in the docs. Add a hokey link checker. 2012-01-19 17:50:21 -08:00
Graydon Hoare
a5e1848906 Remove old ref.foo noise. 2012-01-19 17:11:05 -08:00
Graydon Hoare
5589ab16e0 Clarify immaturity of grammar, add a pile of half-baked grammar rules. 2012-01-19 17:05:35 -08:00
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