diff options
| author | Josh Stone <jistone@redhat.com> | 2020-10-09 20:12:26 -0700 |
|---|---|---|
| committer | Josh Stone <jistone@redhat.com> | 2020-10-09 20:12:26 -0700 |
| commit | f200c1e7afdd04b42c01c0108735e5b14ca07d93 (patch) | |
| tree | 2ca3c10cbd53c7b0ab34df9cd91d16044401d4b6 | |
| parent | be719d11e56817753d4196291bc427c2704dab3d (diff) | |
| download | rust-f200c1e7afdd04b42c01c0108735e5b14ca07d93.tar.gz rust-f200c1e7afdd04b42c01c0108735e5b14ca07d93.zip | |
doc: disambiguate stat in MetadataExt::as_raw_stat
A few architectures in `os::linux::raw` import `libc::stat`, rather than
defining that type directly. However, that also imports the _function_
called `stat`, which makes this doc link ambiguous:
error: `crate::os::linux::raw::stat` is both a struct and a function
--> library/std/src/os/linux/fs.rs:21:19
|
21 | /// [`stat`]: crate::os::linux::raw::stat
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ambiguous link
|
= note: `-D broken-intra-doc-links` implied by `-D warnings`
help: to link to the struct, prefix with the item type
|
21 | /// [`stat`]: struct@crate::os::linux::raw::stat
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
help: to link to the function, add parentheses
|
21 | /// [`stat`]: crate::os::linux::raw::stat()
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
We want the `struct`, so it's now prefixed accordingly.
| -rw-r--r-- | library/std/src/os/linux/fs.rs | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/library/std/src/os/linux/fs.rs b/library/std/src/os/linux/fs.rs index ff23c3d67e3..9b7af97616c 100644 --- a/library/std/src/os/linux/fs.rs +++ b/library/std/src/os/linux/fs.rs @@ -20,7 +20,7 @@ pub trait MetadataExt { /// Unix platforms. The `os::unix::fs::MetadataExt` trait contains the /// cross-Unix abstractions contained within the raw stat. /// - /// [`stat`]: crate::os::linux::raw::stat + /// [`stat`]: struct@crate::os::linux::raw::stat /// /// # Examples /// |
