diff options
| author | the8472 <the8472@users.noreply.github.com> | 2021-09-22 19:03:26 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-22 19:03:26 +0200 |
| commit | 3cb28de23839f0dbe1088205a8bdc11170cec8bc (patch) | |
| tree | 8a21d2d1cdd249fe764cf047ab7861a0f990aed3 | |
| parent | 91af0003e8ba8c010f90c171d0e0e291c27e07aa (diff) | |
| parent | fcb837b163dce03f77573c5bb2202958fd6584aa (diff) | |
| download | rust-3cb28de23839f0dbe1088205a8bdc11170cec8bc.tar.gz rust-3cb28de23839f0dbe1088205a8bdc11170cec8bc.zip | |
Rollup merge of #89164 - camelid:show-type-layout-docs, r=jyn514
Document `--show-type-layout` in the rustdoc book I also made a few small, related changes as separate commits. r? `@jyn514`
| -rw-r--r-- | src/doc/rustdoc/src/unstable-features.md | 18 | ||||
| -rw-r--r-- | src/librustdoc/html/render/print_item.rs | 2 |
2 files changed, 18 insertions, 2 deletions
diff --git a/src/doc/rustdoc/src/unstable-features.md b/src/doc/rustdoc/src/unstable-features.md index b55db452f12..91795997641 100644 --- a/src/doc/rustdoc/src/unstable-features.md +++ b/src/doc/rustdoc/src/unstable-features.md @@ -209,6 +209,22 @@ some consideration for their stability, and names that end in a number). Giving `rustdoc` will disable this sorting and instead make it print the items in the order they appear in the source. +### `--show-type-layout`: add a section to each type's docs describing its memory layout + +Using this flag looks like this: + +```bash +$ rustdoc src/lib.rs -Z unstable-options --show-type-layout +``` + +When this flag is passed, rustdoc will add a "Layout" section at the bottom of +each type's docs page that includes a summary of the type's memory layout as +computed by rustc. For example, rustdoc will show the size in bytes that a value +of that type will take in memory. + +Note that most layout information is **completely unstable** and may even differ +between compilations. + ### `--resource-suffix`: modifying the name of CSS/JavaScript in crate docs Using this flag looks like this: @@ -333,7 +349,7 @@ Some methodology notes about what rustdoc counts in this metric: Public items that are not documented can be seen with the built-in `missing_docs` lint. Private items that are not documented can be seen with Clippy's `missing_docs_in_private_items` lint. -## `-w`/`--output-format`: output format +### `-w`/`--output-format`: output format When using [`--show-coverage`](https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#--show-coverage-get-statistics-about-code-documentation-coverage), diff --git a/src/librustdoc/html/render/print_item.rs b/src/librustdoc/html/render/print_item.rs index 52505f2d634..3104cb3a3dd 100644 --- a/src/librustdoc/html/render/print_item.rs +++ b/src/librustdoc/html/render/print_item.rs @@ -1663,7 +1663,7 @@ fn document_type_layout(w: &mut Buffer, cx: &Context<'_>, ty_def_id: DefId) { writeln!( w, "<div class=\"warning\"><p><strong>Note:</strong> Most layout information is \ - completely unstable and may be different between compiler versions and platforms. \ + <strong>completely unstable</strong> and may even differ between compilations. \ The only exception is types with certain <code>repr(...)</code> attributes. \ Please see the Rust Reference’s \ <a href=\"https://doc.rust-lang.org/reference/type-layout.html\">“Type Layout”</a> \ |
