user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add -C to the rustdoc book

Browse source
This commit is contained in:
QuietMisdreavus 2018-04-13 16:21:27 -05:00
parent 1a0d7a8207
commit a5456bdd87
1 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

25
src/doc/rustdoc/src/command-line-arguments.md
View file

@ -141,6 +141,31 @@ Similar to `--library-path`, `--extern` is about specifying the location
of a dependency. `--library-path` provides directories to search in, `--extern`
instead lets you specify exactly which dependency is located where.
## `-C`/`--codegen`: pass codegen options to rustc
Using this flag looks like this:
```bash
$ rustdoc src/lib.rs -C target_feature=+avx
$ rustdoc src/lib.rs --codegen target_feature=+avx
$ rustdoc --test src/lib.rs -C target_feature=+avx
$ rustdoc --test src/lib.rs --codegen target_feature=+avx
$ rustdoc --test README.md -C target_feature=+avx
$ rustdoc --test README.md --codegen target_feature=+avx
```
When rustdoc generates documentation, looks for documentation tests, or executes documentation
tests, it needs to compile some rust code, at least part-way. This flag allows you to tell rustdoc
to provide some extra codegen options to rustc when it runs these compilations. Most of the time,
these options won't affect a regular documentation run, but if something depends on target features
to be enabled, or documentation tests need to use some additional options, this flag allows you to
affect that.
The arguments to this flag are the same as those for the `-C` flag on rustc. Run `rustc -C help` to
get the full list.
## `--passes`: add more rustdoc passes
Using this flag looks like this: