squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

talk about --sort-modules-by-appearance

Browse source
This commit is contained in:
QuietMisdreavus 2018-03-16 14:30:56 -05:00
parent 33ed787b49
commit cc4f97e883
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/doc/rustdoc/src/unstable-features.md
View file

@ -279,3 +279,16 @@ $ rustdoc --test README.md -Z unstable-options --linker foo
When `rustdoc` runs your documentation tests, it needs to compile and link the tests as executables
before running them. This flag can be used to change the linker used on these executables. It's
equivalent to passing `-C linker=foo` to `rustc`.
### `--sort-modules-by-appearance`: control how items on module pages are sorted
Using this flag looks like this:
```bash
$ rustdoc src/lib.rs -Z unstable-options --sort-modules-by-appearance
```
Ordinarily, when `rustdoc` prints items in module pages, it will sort them alphabetically (taking
some consideration for their stability, and names that end in a number). Giving this flag to
`rustdoc` will disable this sorting and instead make it print the items in the order they appear in
the source.