d1c584e41b
In summary these are some example transitions this change makes:
'a || => ||: 'a
proc:Send() => proc():Send
The intended syntax for closures is to put the lifetime bound not at the front
but rather in the list of bounds. Currently there is no official support in the
AST for bounds that are not 'static, so this case is currently specially handled
in the parser to desugar to what the AST is expecting. Additionally, this moves
the bounds on procedures to the correct position, which is after the argument
list.
The current grammar for closures and procedures is:
procedure := 'proc' [ '<' lifetime-list '>' ] '(' arg-list ')'
[ ':' bound-list ] [ '->' type ]
closure := [ 'unsafe' ] ['<' lifetime-list '>' ] '|' arg-list '|'
[ ':' bound-list ] [ '->' type ]
lifetime-list := lifetime | lifetime ',' lifetime-list
arg-list := ident ':' type | ident ':' type ',' arg-list
bound-list := bound | bound '+' bound-list
bound := path | lifetime
This does not currently handle the << ambiguity in `Option<<'a>||>`, I am
deferring that to a later patch. Additionally, this removes the support for the
obsolete syntaxes of ~fn and &fn.
Closes #10553
Closes #10767
Closes #11209
Closes #11210
Closes #11211
|
||
|---|---|---|
| .. | ||
| po/ja | ||
| complement-bugreport.md | ||
| complement-cheatsheet.md | ||
| complement-lang-faq.md | ||
| complement-project-faq.md | ||
| favicon.inc | ||
| footer.inc | ||
| full-toc.inc | ||
| guide-container.md | ||
| guide-ffi.md | ||
| guide-lifetimes.md | ||
| guide-macros.md | ||
| guide-pointers.md | ||
| guide-runtime.md | ||
| guide-tasks.md | ||
| guide-testing.md | ||
| guide-unsafe.md | ||
| index.md | ||
| po4a.conf | ||
| README.md | ||
| rust.css | ||
| rust.md | ||
| rustdoc.md | ||
| tutorial.md | ||
| version_info.html.template | ||
Dependencies
Pandoc, a universal document converter, is required to generate docs as HTML from Rust's source code.
po4a is required for generating translated docs from the master (English) docs.
GNU gettext is required for managing the translation data.
Building
To generate all the docs, just run make docs from the root of the repository.
This will convert the distributed Markdown docs to HTML and generate HTML doc
for the 'std' and 'extra' libraries.
To generate HTML documentation from one source file/crate, do something like:
rustdoc --output-dir html-doc/ --output-format html ../src/libstd/path.rs
(This, of course, requires a working build of the rustdoc tool.)
Additional notes
To generate an HTML version of a doc from Markdown manually, you can do something like:
pandoc --from=markdown --to=html5 --number-sections -o rust.html rust.md
(rust.md being the Rust Reference Manual.)
The syntax for pandoc flavored markdown can be found at: http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
A nice quick reference (for non-pandoc markdown) is at: http://kramdown.rubyforge.org/quickref.html
Notes for translators
Notice: The procedure described below is a work in progress. We are working on translation system but the procedure contains some manual operations for now.
To start the translation for a new language, see po4a.conf at first.
To generate .pot and .po files, do something like:
po4a --copyright-holder="The Rust Project Developers" \
--package-name="Rust" \
--package-version="0.11-pre" \
-M UTF-8 -L UTF-8 \
src/doc/po4a.conf
(the version number must be changed if it is not 0.11-pre now.)
Now you can translate documents with .po files, commonly used with gettext. If you are not familiar with gettext-based translation, please read the online manual linked from http://www.gnu.org/software/gettext/ . We use UTF-8 as the file encoding of .po files.
When you want to make a commit, do the command below before staging your change:
for f in src/doc/po/**/*.po; do
msgattrib --translated $f -o $f.strip
if [ -e $f.strip ]; then
mv $f.strip $f
else
rm $f
fi
done
This removes untranslated entries from .po files to save disk space.