Commit Graph

1333 Commits

Author SHA1 Message Date
a_m0d
c6268384a6 Update docs index to use lists
Also include a missing link to the rustdoc manual
2014-01-15 20:54:34 -05:00
a_m0d
8e5f068d69 Fix formatting in rust-guide document. 2014-01-15 07:20:04 -05:00
OGINO Masanori
006d169a2f Note that translation workflow is WIP now.
Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-14 21:30:15 +09:00
OGINO Masanori
1ba61b915b Add notes for translators.
Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-14 21:28:34 +09:00
OGINO Masanori
729715779a Update .po and strip down untranslated entries.
This work is done by execute these commands manually:

$ po4a --copyright-holder="The Rust Project Developers" \
    --package-name="Rust" \
    --package-version="0.10-pre" \
    -M UTF-8 -L UTF-8 \
    doc/po4a.conf
$ for f in doc/po/**/*.po; do
>   msgattrib --translated $f -o $f.strip
>   if [ -e $f.strip ]; then
>       mv $f.strip $f
>   else
>       rm $f
>   fi
> done

It should be managed by the build system automatically to use in our
translation workflow, but I've not yet done that.

Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-14 21:19:16 +09:00
bors
77eeddaa48 auto merge of #11501 : alexcrichton/rust/dox, r=brson
The official documentation sorely needs an explanation of the rust runtime and what it is exactly, and I want this guide to provide that information.

I'm unsure of whether I've been too light on some topics while too heavy on others. I also feel like a few things are still missing. As always, feedback is appreciated, especially about things you'd like to see written about!
2014-01-13 23:26:36 -08:00
Alex Crichton
289ba105ae dox: Write a guide to the rust runtime 2014-01-13 23:22:07 -08:00
Patrick Walton
119c6141f5 librustc: Remove @ pointer patterns from the language 2014-01-13 14:45:21 -08:00
bors
74258eaefa auto merge of #11491 : wting/rust/wting_7959_document_inline_attributes, r=alexcrichton
Closes #7959.
2014-01-11 23:16:27 -08:00
William Ting
826f24bdf1 Add inline attributes documentation.
Closes #7959.
2014-01-11 22:53:45 -06:00
Kevin Ballard
d76ce5f31e Add librustuv to doc/index.md 2014-01-11 19:16:25 -08:00
Kevin Ballard
de6f213927 Restore missing line breaks in doc/index.html
a30d61b05a removed all of the trailing whitespace in doc/index.md.
Unfortunately, that trailing whitespace was actually markdown syntax for
line breaks.
2014-01-11 19:15:05 -08:00
Kevin Ballard
110e5dd1ac doc: build the docs for librustpkg 2014-01-11 19:13:59 -08:00
Adrien Tétar
a30d61b05a Various READMEs and docs cleanup
Noticeably closes #11428.
2014-01-11 19:41:31 +01:00
Brendan Zabarauskas
4fc0452ace Remove re-exports of std::io::stdio::{print, println} in the prelude.
The `print!` and `println!` macros are now the preferred method of printing, and so there is no reason to export the `stdio` functions in the prelude. The functions have also been replaced by their macro counterparts in the tutorial and other documentation so that newcomers don't get confused about what they should be using.
2014-01-11 10:46:00 +11:00
kud1ing
aca705cae9 "As long an iterator" => "As long as an iterator" 2014-01-10 15:05:54 +01:00
OGINO Masanori
20ec0be779 Remove *.pot files and ignore them now.
The .pot files can be generated automatically and the files contain
timestamps in their content. They can cause huge conflicts and take huge
space even if you are not a translator.

This commit is a part of improvement discussed on
https://github.com/mozilla/rust/pull/11383 .

Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-10 07:21:32 +09:00
OGINO Masanori
d4051b6145 Update doc/po4a.conf for recent changes.
Signed-off-by: OGINO Masanori <masanori.ogino@gmail.com>
2014-01-10 07:21:32 +09:00
Brendan Zabarauskas
ceea85a148 Remove ApproxEq and assert_approx_eq!
This trait seems to stray too far from the mandate of a standard library as implementations may vary between use cases.
2014-01-09 15:41:46 +11:00
Huon Wilson
9dc44c7d86 Fix cheatsheet examples on 32-bit platforms.
0xDEADBEEF doesn't fit in an int = i32 (on 32-bit computers).
2014-01-09 02:16:36 +11:00
Brian Anderson
fee8c1d2c7 doc: Typos 2014-01-07 21:31:37 -08:00
Clinton Ryan
1fd4c3bb40 Fixed code snippets 2014-01-07 21:30:17 -08:00
Huon Wilson
7cfce50b24 Address some minor points in the pointer guide
cc #11364.
2014-01-07 21:24:48 -08:00
Brian Anderson
2d8dd6afd4 doc: Add rustc and syntax to the index 2014-01-07 21:23:26 -08:00
Brian Anderson
da43832034 doc: Add libgreen and libnative to the index 2014-01-07 20:49:13 -08:00
Brian Anderson
d323632669 'borrowed pointer' -> 'reference' 2014-01-07 18:49:13 -08:00
Brian Anderson
b65b4d6384 doc: Fix URL of libextra docs 2014-01-07 17:29:57 -08:00
Brian Anderson
6b7ffa4a8b doc: Title reference manual consistently 2014-01-07 17:28:15 -08:00
Brian Anderson
1ea02170bd doc: Highlight the testing guide correctly 2014-01-07 17:01:07 -08:00
Brian Anderson
77ec04487b mk: Start testing the cheatsheet 2014-01-07 17:01:07 -08:00
Brian Anderson
c2ef4e5372 doc: Title guides consistently 2014-01-07 17:01:06 -08:00
Brian Anderson
3100bb424c doc: Fix table format in cheatsheet 2014-01-07 17:01:06 -08:00
Brian Anderson
a61d7d6dbe doc: Syntax highlight the cheatsheet 2014-01-07 17:01:06 -08:00
bors
aa1839bd69 auto merge of #11364 : brson/rust/docs, r=alexcrichton
This reorganizes the documentation index to be more focused on the in-tree docs, and to clean up the style, and it also adds @steveklabnik's pointer guide.
2014-01-07 15:46:38 -08:00
bors
3912a8779e auto merge of #11350 : kchmck/rust/fix-pdf-glitches, r=alexcrichton
I was reading through the tutorial and manual pdfs and noticed some of the code blocks have glitches in their formatting:

![](http://i.imgur.com/9HXZ4dW.png)
![](http://i.imgur.com/Ds2By6j.png)

Putting empty lines around the blocks fixes this. I did a search through the other markdown files and made the change there as well.
2014-01-07 08:26:33 -08:00
Brian Anderson
280553c988 doc: Fix tests in pointer guide 2014-01-06 19:37:27 -08:00
Steve Klabnik
6f09d80f97 Add Pointer tutorial, rename borrowed pointer tutorial. 2014-01-06 19:37:26 -08:00
Brian Anderson
d4639ade00 doc: Update style of index, organization and trim out some excess. 2014-01-06 19:37:11 -08:00
bors
1f1838ea3e auto merge of #11123 : alan-andrade/rust/move_wiki_to_internal_docs, r=brson
This is not done yet but I'm posting it to get feedback.

The wiki has a ton of different tutorials/manuals/faq and so forth. Instead of migrating all of them right now, I just migrated the following:

* The general main wiki page
* Language FAQ
* Project FAQ

If this feels reasonable, please comment so that I can continue with confidence.
2014-01-06 14:26:38 -08:00
Alan Andrade
e53b5661a7 First phase of migrating the wiki to the internal docs #11078 2014-01-06 15:27:49 -06:00
bors
3afa0b97c4 auto merge of #11335 : rlane/rust/fix-vector-doc, r=alexcrichton 2014-01-06 11:56:37 -08:00
Mick Koch
5464d48e90 Fix formatting of some code blocks in pdf docs
Code blocks apparently need to be surrounded by whitespace to be output
correctly when generating pdfs
2014-01-06 12:56:41 -05:00
Rich Lane
8bd52024ae doc: update reference to new vector size syntax 2014-01-05 22:38:16 -08:00
bors
b6a1fde1c6 auto merge of #11106 : alan-andrade/rust/convert_tutorials_to_guides, r=cmr
* Moved every the tutorial-*.md into its own directory `/doc/guides/`
* Makefile is aware
2014-01-05 22:11:39 -08:00
Alan Andrade
eeafee4c9b Convert sub tutorials into Guides #10838
Ensure configure creates doc/guides directory

Fix configure makefile and tests

Remove old guides dir and configure option, convert testing to guide

Remove ignored files

Fix submodule issue

prepend dir in makefile so that bor knows how to build the docs

S to uppercase
2014-01-05 22:48:19 -06:00
Lindsey Kuper
8224816a34 tutorial: add missing line to make example build. 2014-01-05 22:03:13 -05:00
Lindsey Kuper
4f1ebef96a tutorial: remove duplicate words. 2014-01-05 22:03:13 -05:00
Lindsey Kuper
60e139409f tutorial: change float to f32 since float is no longer a type. 2014-01-05 22:03:13 -05:00
Lindsey Kuper
5681c711e1 Wording tweak suggested by @pcwalton. 2014-01-05 22:03:12 -05:00
Lindsey Kuper
62b74d9890 Write up default methods for the tutorial. 2014-01-05 22:03:12 -05:00