OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document crate top-level and directory modules. Closes #1097

Browse Source
This commit is contained in:
Brian Anderson 2011-11-07 13:34:04 -08:00
parent 9375204461
commit 369fc5e480
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/rust.texi
View File

@ -1031,7 +1031,7 @@ and compiled crates have a 1:1 relationship.
The syntactic form of a crate is a sequence of @emph{directives}, some of The syntactic form of a crate is a sequence of @emph{directives}, some of
which have nested sub-directives. which have nested sub-directives.
A crate defines an implicit top-level anonymous module: within this module, A crate defines an implicit top-level module: within this module,
all members of the crate have canonical path names. @xref{Ref.Path}. The all members of the crate have canonical path names. @xref{Ref.Path}. The
@code{mod} directives within a crate file specify sub-modules to include in @code{mod} directives within a crate file specify sub-modules to include in
the crate: these are either directory modules, corresponding to directories in the crate: these are either directory modules, corresponding to directories in
@ -1040,6 +1040,13 @@ to Rust source files. The names given to such modules in @code{mod} directives
become prefixes of the paths of items defined within any included Rust source become prefixes of the paths of items defined within any included Rust source
files. files.
If a .rs file exists in the filesystem alongside the .rc crate file, then it
will be used to provide the top-level module of the crate. Similarly,
directory modules may be paired with .rs files of the same name as the
directory to provide the code for those modules. These source files are never
mentioned explicitly in the crate file; they are simply used if they are
present.
The @code{use} directives within the crate specify @emph{other crates} to scan The @code{use} directives within the crate specify @emph{other crates} to scan
for, locate, import into the crate's module namespace during compilation, and for, locate, import into the crate's module namespace during compilation, and
link against at runtime. Use directives may also occur independently in rust link against at runtime. Use directives may also occur independently in rust