about summary refs log tree commit diff
path: root/doc
AgeCommit message (Collapse)AuthorLines
2014-02-02Move doc/ to src/doc/Alex Crichton-20734/+0
We generate documentation into the doc/ directory, so we shouldn't be intermingling source files with generated files
2014-02-02doc: use backticks for code-in-comments.Marcel Rodrigues-35/+35
2014-02-02auto merge of #11988 : cmr/rust/11668-squash, r=alexcrichtonbors-5/+1
2014-02-02Change fmt! to format!Byron Williams-5/+1
2014-02-02Remove rustpkg.Corey Richardson-566/+5
I'm sorry :'( Closes #11859
2014-02-02rustc: update docs & propagate @[]/@str removal more.Huon Wilson-1/+1
Various functions can now be made specific to ~[], or just non-managed vectors.
2014-02-02doc: Remove references to `@str` from the documentationPatrick Walton-1/+1
2014-01-31mark the minimum supported Linux kernel versionDaniel Micay-1/+1
This is just taken from the binary itself. It would be nice to mark the minimum glibc version too, and the corresponding RHEL/CentOS version.
2014-01-31mark Windows 8 as supportedDaniel Micay-1/+1
2014-01-31bump minimum supported OS X version to 10.7Daniel Micay-1/+1
Closes #11927 Closes #10842 Closes #2024
2014-01-31auto merge of #11810 : Armavica/rust/issue-11645, r=alexcrichtonbors-3/+8
The doc-generating tool comments out the lines that match `/$# /` (note the space), which is not what is wanted here. And it lets live the lines matching `/$#[^ ]/`. But we still want to see a space. So I replaced the normal space by a non breakable one, which fools the parser into displaying the line.
2014-01-30Fix inconsistency in tutorial.mdKeshav Kini-1/+1
Text refers to "the type shown earlier", when the type in question was not in fact shown earlier. I assume this is an artifact of an earlier revision.
2014-01-29auto merge of #11877 : Armavica/rust/doc-pm-vector, r=alexcrichtonbors-13/+38
This feature already was in the tutorial, but I believe that the tutorial should be a strict subset of the manual. I also added an example.
2014-01-29auto merge of #11868 : bytbox/rust/remove-do, r=alexcrichtonbors-117/+38
Fixes #10815.
2014-01-29Removing usage of the do keyword from documentationScott Lawrence-117/+38
2014-01-29Document vector destructuring with wildcard '..'Virgile Andreani-13/+38
2014-01-29extra: move glob to libglobDavid Manescu-0/+1
In line with the dissolution of libextra - moves glob to its own library libglob. Changes based on PR #11787. Updates .gitignore to ignore doc/glob.
2014-01-29extra: move arena to libarenaDavid Manescu-0/+1
In line with the dissolution of libextra - #8784 - moves arena to its own library libarena. Changes based on PR #11787. Updates .gitignore to ignore doc/arena.
2014-01-28Update extract-tests.py to use same test directives as rustdoc.William Ting-137/+130
Closes #11362.
2014-01-27Minor fix to docs.xales-1/+1
2014-01-26auto merge of #11787 : alexcrichton/rust/refactor, r=brsonbors-2/+4
It was decided a long, long time ago that libextra should not exist, but rather its modules should be split out into smaller independent libraries maintained outside of the compiler itself. The theory was to use `rustpkg` to manage dependencies in order to move everything out of the compiler, but maintain an ease of usability. Sadly, the work on `rustpkg` isn't making progress as quickly as expected, but the need for dissolving libextra is becoming more and more pressing. Because of this, we've thought that a good interim solution would be to simply package more libraries with the rust distribution itself. Instead of dissolving libextra into libraries outside of the mozilla/rust repo, we can dissolve libraries into the mozilla/rust repo for now. Work on this has been excruciatingly painful in the past because the makefiles are completely opaque to all but a few. Adding a new library involved adding about 100 lines spread out across 8 files (incredibly error prone). The first commit of this pull request targets this pain point. It does not rewrite the build system, but rather refactors large portions of it. Afterwards, adding a new library is as simple as modifying 2 lines (easy, right?). The build system automatically keeps track of dependencies between crates (rust *and* native), promotes binaries between stages, tracks dependencies of installed tools, etc, etc. With this newfound buildsystem power, I chose the `extra::flate` module as the first candidate for removal from libextra. While a small module, this module is relative complex in that is has a C dependency and the compiler requires it (messing with the dependency graph a bit). Albeit I modified more than 2 lines of makefiles to accomodate libflate (the native dependency required 2 extra lines of modifications), but the removal process was easy to do and straightforward. --- Testing-wise, I've cross-compiled, run tests, built some docs, installed, uninstalled, etc. I'm still working out a few kinks, and I'm sure that there's gonna be built system issues after this, but it should be working well for basic use! cc #8784
2014-01-26Move extra::flate to libflateAlex Crichton-2/+4
This is hopefully the beginning of the long-awaited dissolution of libextra. Using the newly created build infrastructure for building libraries, I decided to move the first module out of libextra. While not being a particularly meaty module in and of itself, the flate module is required by rustc and additionally has a native C dependency. I was able to very easily split out the C dependency from rustrt, update librustc, and magically everything gets installed to the right locations and built automatically. This is meant to be a proof-of-concept commit to how easy it is to remove modules from libextra now. I didn't put any effort into modernizing the interface of libflate or updating it other than to remove the one glob import it had.
2014-01-26auto merge of #11817 : salemtalha/rust/master, r=brsonbors-1/+1
Fixes Issue #11815
2014-01-26Removed all instances of XXX in preparation for relaxing of FIXME ruleSalem Talha-1/+1
2014-01-26Fix privacy fallout from previous changeAlex Crichton-2/+2
2014-01-26Unhide lines in rustdoc's doc -- Closes #11645Virgile Andreani-3/+8
2014-01-25Grammatical fixes.comex-10/+10
2014-01-25Fix spacing in example comment.xales-1/+1
2014-01-25Fix some docs about rtDerek Chiang-1/+1
2014-01-24auto merge of #11764 : Armavica/rust/doc_patmatch, r=pcwaltonbors-2/+33
I also removed the obsolete '*' wildcard from the manual.
2014-01-24auto merge of #11753 : misfo/rust/patch-1, r=pcwaltonbors-1/+1
2014-01-24Add '@' subpattern binding and examples to manual and tutorialVirgile Andreani-0/+31
2014-01-24Replace '*' by '..' in the doc of pattern matchingVirgile Andreani-2/+2
2014-01-23Update flip() to be rev().Sean Chalmers-4/+4
Consensus leaned in favour of using rev instead of flip.
2014-01-23Rename Invert to Flip - Issue 10632Sean Chalmers-3/+3
Renamed the invert() function in iter.rs to flip(). Also renamed the Invert<T> type to Flip<T>. Some related code comments changed. Documentation that I could find has been updated, and all the instances I could locate where the function/type were called have been updated as well.
2014-01-23Fix typo in tutorialTrent Ogren-1/+1
2014-01-22libc: switch `free` to the proper signatureDaniel Micay-1/+1
This does not attempt to fully propagate the mutability everywhere, but gives new code a hint to avoid the same issues.
2014-01-22Typo in module tutorialBen Striegel-1/+2
2014-01-20auto merge of #11674 : indirect/rust/doc_file, r=alexcrichtonbors-0/+1
Found out about `file!` today from o11c in IRC.
2014-01-20auto merge of #11486 : Matthias247/rust/doc, r=cmrbors-0/+137
I wrote a chapter for the FFI tutorial that describes how to perform callbacks from C code to Rust and gives some hints about what to consider and synchronization. I just needed that for my own wrapper and thought it would be helpful for others.
2014-01-20Disabled the tests for the new code blocksMatthias Einwag-4/+4
2014-01-19auto merge of #11654 : korenchkin/rust/doc_guide-testing_format, r=cmrbors-9/+9
2014-01-19document file!Andre Arko-0/+1
2014-01-18auto merge of #11567 : divtxt/rust/master, r=cmrbors-4/+9
I found the boxes diagram in the tutorial misleading about how the enum worked. The current diagram makes it seem that there is a separate Cons struct when there is only one type of struct for the List type, and Nil is drawn almost as if it's not consuming memory. I'm aware of the optimization that happens for this enum which takes advantage of the fact that pointer cannot be null but this is an implementation detail and not the only one that applies here. I can add a note below the diagram mentioning this if you like.
2014-01-18Consistent formatting for args and attrskorenchkin-9/+9
2014-01-18auto merge of #11619 : adridu59/rust/patch-md, r=cmrbors-31/+50
Noticeably necroes #10892. Also closes #11559. r? @alexcrichton
2014-01-18doc: fix dangling links in rust.mdAdrien Tétar-12/+9
Fixes #11559 (not that the manual couldn't use a review).
2014-01-18auto merge of #11614 : remen/rust/patch-1, r=alexcrichtonbors-2/+2
#[cfg(test)] was being interpreted as starting a header
2014-01-17auto merge of #11503 : FlaPer87/rust/master, r=huonwbors-2/+2
The patch adds the missing pow method for all the implementations of the Integer trait. This is a small addition that will most likely be improved by the work happening in #10387. Fixes #11499
2014-01-17auto merge of #11598 : alexcrichton/rust/io-export, r=brsonbors-29/+22
* Reexport io::mem and io::buffered structs directly under io, make mem/buffered private modules * Remove with_mem_writer * Remove DEFAULT_CAPACITY and use DEFAULT_BUF_SIZE (in io::buffered) cc #11119