Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit` #75214

chansuke · 2020-08-06T09:23:55Z

This is partial fixes for #75080.

rust-highfive · 2020-08-06T09:23:58Z

r? @cramertj

(rust_highfive has picked a reviewer for you, use r? to override)

jyn514

Looks good once links are fixed and CI is passing :)

jyn514 · 2020-08-06T20:30:41Z

library/core/src/mem/manually_drop.rs

@@ -56,8 +56,7 @@ use crate::ptr;
 /// working with [pinned] data, where reusing the memory without calling the destructor could lead
 /// to Undefined Behaviour.
 ///
-/// [`mem::zeroed`]: fn.zeroed.html
-/// [`MaybeUninit<T>`]: union.MaybeUninit.html
+/// [`mem::zeroed`]: MaybeUninit::<T>::zeroed


Rustdoc will not resolve this <T>: #62834. But also I think it was meant to link to mem::zeroed, not MaybeUnint::zeroed, so you can leave it out altogether and it will still be resolved.

Suggested change

/// [`mem::zeroed`]: MaybeUninit::<T>::zeroed

/// [`MaybeUninit<T>`]: MaybeUninit

Thank you for your suggestion.

/// [MaybeUninit]: MaybeUninit shows unresolved link error...

I fixed it with [MaybeUninit]: crate::mem::MaybeUninit

jyn514 · 2020-08-06T20:32:13Z

library/core/src/mem/maybe_uninit.rs

@@ -64,7 +64,7 @@ use crate::mem::ManuallyDrop;
 /// *immediate* undefined behavior, but will cause undefined behavior with most
 /// safe operations (including dropping it).
 ///
-/// [`Vec<T>`]: ../../std/vec/struct.Vec.html
+/// [`Vec<T>`]: std::vec::Vec<T>


This is in core and Vec is in alloc. So this link will not resolve: #74481.

Suggested change

/// [`Vec<T>`]: std::vec::Vec<T>

/// [`Vec<T>`]: ../../std/vec/struct.Vec.html

Thanks...I was misunderstanding. I will fix it and squash the commit

jyn514 · 2020-08-07T15:33:44Z

library/core/src/mem/manually_drop.rs

@@ -56,8 +56,7 @@ use crate::ptr;
 /// working with [pinned] data, where reusing the memory without calling the destructor could lead
 /// to Undefined Behaviour.
 ///
-/// [`mem::zeroed`]: fn.zeroed.html
-/// [`MaybeUninit<T>`]: union.MaybeUninit.html
+/// [`MaybeUninit<T>`]: MaybeUninit
 /// [pinned]: ../pin/index.html


Suggested change

/// [pinned]: ../pin/index.html

/// [pinned]: crate::pin

jyn514 · 2020-08-07T15:34:17Z

library/core/src/mem/manually_drop.rs

- /// [`ManuallyDrop::into_inner`]: #method.into_inner
- /// [`ptr::drop_in_place`]: ../ptr/fn.drop_in_place.html
+ /// [`into_inner`]: ManuallyDrop::into_inner
+ /// [`drop_in_place`]: ptr::drop_in_place


Is ptr in scope in this module? If so this is fine, but otherwise it needs to be crate::ptr or super::ptr.

I thought that ptr was in scope since it doesn't give me results in unresolved link error... but anyway I will add crate. Thanks

jyn514 · 2020-08-08T12:49:05Z

Broken links

  --> library/core/src/mem/manually_drop.rs:59:25
   |
59 | /// [`MaybeUninit<T>`]: MaybeUninit
   |                         ^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = note: `-D intra-doc-link-resolution-failure` implied by `-D warnings`
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: `[mem::zeroed]` cannot be resolved, ignoring it.
  --> library/core/src/mem/manually_drop.rs:10:11
   |
10 | /// with [`mem::zeroed`] is undefined behavior.
   |           ^^^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`

error: `[MaybeUninit]` cannot be resolved, ignoring it.
  --> library/core/src/mem/manually_drop.rs:59:25
   |
59 | /// [`MaybeUninit<T>`]: MaybeUninit
   |                         ^^^^^^^^^^^ cannot be resolved, ignoring
   |
   = help: to escape `[` and `]` characters, just add '\' before them like `\[` or `\]`
``

</details>

Let me know if you have trouble fixing them.

jyn514 · 2020-08-14T14:40:18Z

library/core/src/mem/manually_drop.rs

+ /// [`drop`]: ManuallyDrop::drop
+ /// [`into_inner`]: ManuallyDrop::into_inner


I don't see anything using drop or into_inner so you can remove these reference links :)

Suggested change

/// [`drop`]: ManuallyDrop::drop

/// [`into_inner`]: ManuallyDrop::into_inner

jyn514 · 2020-08-14T14:40:59Z

library/core/src/mem/manually_drop.rs

+ /// [`into_inner`]: ManuallyDrop::into_inner
+ /// [`drop_in_place`]: crate::ptr::drop_in_place


Same here, the links don't seem to be used.

Suggested change

/// [`into_inner`]: ManuallyDrop::into_inner

/// [`drop_in_place`]: crate::ptr::drop_in_place

jyn514 · 2020-08-14T14:42:38Z

library/core/src/mem/manually_drop.rs

-/// [`mem::zeroed`]: fn.zeroed.html
-/// [`MaybeUninit<T>`]: union.MaybeUninit.html
-/// [pinned]: ../pin/index.html
+/// [`mem::zeroed`]: crate::mem::MaybeUninit::zeroed


Are you sure this didn't mean to link to crate::mem::zeroed?

Suggested change

/// [`mem::zeroed`]: crate::mem::MaybeUninit::zeroed

/// [`mem::zeroed`]: crate::mem::zeroed

jyn514 · 2020-08-14T17:41:54Z

@bors r+ rollup

bors · 2020-08-14T17:41:56Z

📌 Commit 61866bc has been approved by jyn514

@ghost

Rollup of 17 pull requests Successful merges: - rust-lang#73943 (Document the unsafe keyword) - rust-lang#74062 (deny(unsafe_op_in_unsafe_fn) in libstd/ffi/c_str.rs) - rust-lang#74185 (Remove liballoc unneeded explicit link) - rust-lang#74192 (Improve documentation on process::Child.std* fields) - rust-lang#74409 (Change Debug impl of SocketAddr and IpAddr to match their Display output) - rust-lang#75195 (BTreeMap: purge innocent use of into_kv_mut) - rust-lang#75214 (Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit`) - rust-lang#75432 (Switch to intra-doc links in `std::process`) - rust-lang#75482 (Clean up E0752 explanation) - rust-lang#75501 (Move to intra doc links in std::ffi) - rust-lang#75509 (Tweak suggestion for `this` -> `self`) - rust-lang#75511 (Do not emit E0228 when it is implied by E0106) - rust-lang#75515 (Bump std's libc version to 0.2.74) - rust-lang#75517 (Promotion and const interning comments) - rust-lang#75519 (BTreeMap: refactor splitpoint and move testing over to unit test) - rust-lang#75530 (Switch to intra-doc links in os/raw/*.md) - rust-lang#75531 (Migrate unit tests of btree collections to their native breeding ground) Failed merges: r? @ghost

rust-highfive assigned cramertj Aug 6, 2020

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Aug 6, 2020

jyn514 assigned jyn514 and unassigned cramertj Aug 6, 2020

jyn514 added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Aug 6, 2020

jyn514 reviewed Aug 6, 2020

View reviewed changes

jyn514 added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Aug 6, 2020

chansuke force-pushed the fix-intra-doc-links branch from 8276d39 to 288e9ba Compare August 7, 2020 15:02

jyn514 reviewed Aug 7, 2020

View reviewed changes

chansuke force-pushed the fix-intra-doc-links branch from 288e9ba to a296df0 Compare August 8, 2020 11:20

chansuke force-pushed the fix-intra-doc-links branch 2 times, most recently from 072a905 to d8536c3 Compare August 14, 2020 14:28

jyn514 reviewed Aug 14, 2020

View reviewed changes

Use intra-doc links in mem::manually_drop & mem::maybe_uninit

61866bc

chansuke force-pushed the fix-intra-doc-links branch from d8536c3 to 61866bc Compare August 14, 2020 17:37

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Aug 14, 2020

tmandry mentioned this pull request Aug 14, 2020

Rollup of 17 pull requests #75538

Merged

bors merged commit ad8c5e1 into rust-lang:master Aug 15, 2020

cuviper added this to the 1.47.0 milestone May 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit` #75214

Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit` #75214

chansuke commented Aug 6, 2020 •

edited by jyn514

Loading

rust-highfive commented Aug 6, 2020

jyn514 left a comment

jyn514 Aug 6, 2020

chansuke Aug 8, 2020

chansuke Aug 9, 2020

jyn514 Aug 6, 2020

chansuke Aug 7, 2020

jyn514 Aug 7, 2020

jyn514 Aug 7, 2020

chansuke Aug 8, 2020

jyn514 commented Aug 8, 2020 •

edited

Loading

jyn514 Aug 14, 2020

jyn514 Aug 14, 2020

jyn514 Aug 14, 2020

jyn514 commented Aug 14, 2020

bors commented Aug 14, 2020

	/// [`mem::zeroed`]: MaybeUninit::<T>::zeroed
	/// [`MaybeUninit<T>`]: MaybeUninit

	/// [`Vec<T>`]: std::vec::Vec<T>
	/// [`Vec<T>`]: ../../std/vec/struct.Vec.html

		/// [`drop`]: ManuallyDrop::drop
		/// [`into_inner`]: ManuallyDrop::into_inner

		/// [`into_inner`]: ManuallyDrop::into_inner
		/// [`drop_in_place`]: crate::ptr::drop_in_place

	/// [`mem::zeroed`]: crate::mem::MaybeUninit::zeroed
	/// [`mem::zeroed`]: crate::mem::zeroed

Use intra-doc links in mem::manually_drop & mem::maybe_uninit #75214

Use intra-doc links in mem::manually_drop & mem::maybe_uninit #75214

Conversation

chansuke commented Aug 6, 2020 • edited by jyn514 Loading

rust-highfive commented Aug 6, 2020

jyn514 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyn514 commented Aug 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyn514 commented Aug 14, 2020

bors commented Aug 14, 2020

Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit` #75214

Use intra-doc links in `mem::manually_drop` & `mem::maybe_uninit` #75214

chansuke commented Aug 6, 2020 •

edited by jyn514

Loading

jyn514 commented Aug 8, 2020 •

edited

Loading