-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Document --show-type-layout
in the rustdoc book
#89164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
71a4add
57399e2
490a8cf
fcb837b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why do you say "for example"? Isn't that the only part of the layout it shows? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, it also shows the size of each variant. The things it displays could change later, so I'd rather not have an exhaustive list that needs to be updated. |
||
|
||
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), | ||
|
Uh oh!
There was an error while loading. Please reload this page.