diff options
| author | QuietMisdreavus <grey@quietmisdreavus.net> | 2018-03-16 13:38:06 -0500 |
|---|---|---|
| committer | QuietMisdreavus <grey@quietmisdreavus.net> | 2018-03-16 13:38:06 -0500 |
| commit | f9d38451382017a6cd053e25011e4c096d545d17 (patch) | |
| tree | 1bcf022e6fda0affa8a9c72737281db8349d2ea3 /src/doc/rustdoc | |
| parent | 5d8443aeb1bf441897efddfc1246377f0d51149d (diff) | |
| download | rust-f9d38451382017a6cd053e25011e4c096d545d17.tar.gz rust-f9d38451382017a6cd053e25011e4c096d545d17.zip | |
talk about --crate-version
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index 9cb5760ec37..867e4585d9c 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -254,3 +254,15 @@ If both `--playground-url` and `--markdown-playground-url` are present when rend Markdown file, the URL given to `--markdown-playground-url` will take precedence. If both `--playground-url` and `#![doc(html_playground_url = "url")]` are present when rendering crate docs, the attribute will take precedence. + +### `--crate-version`: control the crate version + +Using this flag looks like this: + +```bash +$ rustdoc src/lib.rs -Z unstable-options --crate-version 1.3.37 +``` + +When `rustdoc` receives this flag, it will print an extra "Version (version)" into the sidebar of +the crate root's docs. You can use this flag to differentiate between different versions of your +library's documentation. |
