Skip to content

Commit b026181

Browse files
authored
Rollup merge of #75432 - camelid:intra-doc-links-for-std-process, r=jyn514
Switch to intra-doc links in `std::process` Part of #75080.
2 parents ad8c5e1 + d8f9614 commit b026181

File tree

1 file changed

+37
-58
lines changed

1 file changed

+37
-58
lines changed

library/std/src/process.rs

+37-58
Original file line numberDiff line numberDiff line change
@@ -84,25 +84,15 @@
8484
//! assert_eq!(b"test", output.stdout.as_slice());
8585
//! ```
8686
//!
87-
//! [`abort`]: fn.abort.html
88-
//! [`exit`]: fn.exit.html
87+
//! [`spawn`]: Command::spawn
88+
//! [`output`]: Command::output
8989
//!
90-
//! [`Command`]: struct.Command.html
91-
//! [`spawn`]: struct.Command.html#method.spawn
92-
//! [`output`]: struct.Command.html#method.output
90+
//! [`stdout`]: Command::stdout
91+
//! [`stdin`]: Command::stdin
92+
//! [`stderr`]: Command::stderr
9393
//!
94-
//! [`Child`]: struct.Child.html
95-
//! [`ChildStdin`]: struct.ChildStdin.html
96-
//! [`ChildStdout`]: struct.ChildStdout.html
97-
//! [`ChildStderr`]: struct.ChildStderr.html
98-
//! [`Stdio`]: struct.Stdio.html
99-
//!
100-
//! [`stdout`]: struct.Command.html#method.stdout
101-
//! [`stdin`]: struct.Command.html#method.stdin
102-
//! [`stderr`]: struct.Command.html#method.stderr
103-
//!
104-
//! [`Write`]: ../io/trait.Write.html
105-
//! [`Read`]: ../io/trait.Read.html
94+
//! [`Write`]: io::Write
95+
//! [`Read`]: io::Read
10696
10797
#![stable(feature = "process", since = "1.0.0")]
10898

@@ -130,7 +120,7 @@ use crate::sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
130120
/// run, even after the `Child` handle to the child process has gone out of
131121
/// scope.
132122
///
133-
/// Calling [`wait`](#method.wait) (or other functions that wrap around it) will make
123+
/// Calling [`wait`] (or other functions that wrap around it) will make
134124
/// the parent process wait until the child has actually exited before
135125
/// continuing.
136126
///
@@ -162,9 +152,7 @@ use crate::sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
162152
/// assert!(ecode.success());
163153
/// ```
164154
///
165-
/// [`Command`]: struct.Command.html
166-
/// [`Drop`]: ../../core/ops/trait.Drop.html
167-
/// [`wait`]: #method.wait
155+
/// [`wait`]: Child::wait
168156
#[stable(feature = "process", since = "1.0.0")]
169157
pub struct Child {
170158
handle: imp::Process,
@@ -248,9 +236,8 @@ impl fmt::Debug for Child {
248236
/// file handle will be closed. If the child process was blocked on input prior
249237
/// to being dropped, it will become unblocked after dropping.
250238
///
251-
/// [`Child`]: struct.Child.html
252-
/// [`stdin`]: struct.Child.html#structfield.stdin
253-
/// [dropped]: ../ops/trait.Drop.html
239+
/// [`stdin`]: Child::stdin
240+
/// [dropped]: Drop
254241
#[stable(feature = "process", since = "1.0.0")]
255242
pub struct ChildStdin {
256243
inner: AnonPipe,
@@ -307,9 +294,8 @@ impl fmt::Debug for ChildStdin {
307294
/// When an instance of `ChildStdout` is [dropped], the `ChildStdout`'s
308295
/// underlying file handle will be closed.
309296
///
310-
/// [`Child`]: struct.Child.html
311-
/// [`stdout`]: struct.Child.html#structfield.stdout
312-
/// [dropped]: ../ops/trait.Drop.html
297+
/// [`stdout`]: Child::stdout
298+
/// [dropped]: Drop
313299
#[stable(feature = "process", since = "1.0.0")]
314300
pub struct ChildStdout {
315301
inner: AnonPipe,
@@ -368,9 +354,8 @@ impl fmt::Debug for ChildStdout {
368354
/// When an instance of `ChildStderr` is [dropped], the `ChildStderr`'s
369355
/// underlying file handle will be closed.
370356
///
371-
/// [`Child`]: struct.Child.html
372-
/// [`stderr`]: struct.Child.html#structfield.stderr
373-
/// [dropped]: ../ops/trait.Drop.html
357+
/// [`stderr`]: Child::stderr
358+
/// [dropped]: Drop
374359
#[stable(feature = "process", since = "1.0.0")]
375360
pub struct ChildStderr {
376361
inner: AnonPipe,
@@ -543,7 +528,7 @@ impl Command {
543528
///
544529
/// To pass multiple arguments see [`args`].
545530
///
546-
/// [`args`]: #method.args
531+
/// [`args`]: Command::args
547532
///
548533
/// # Examples
549534
///
@@ -568,7 +553,7 @@ impl Command {
568553
///
569554
/// To pass a single argument see [`arg`].
570555
///
571-
/// [`arg`]: #method.arg
556+
/// [`arg`]: Command::arg
572557
///
573558
/// # Examples
574559
///
@@ -721,7 +706,7 @@ impl Command {
721706
/// .expect("ls command failed to start");
722707
/// ```
723708
///
724-
/// [`canonicalize`]: ../fs/fn.canonicalize.html
709+
/// [`canonicalize`]: crate::fs::canonicalize
725710
#[stable(feature = "process", since = "1.0.0")]
726711
pub fn current_dir<P: AsRef<Path>>(&mut self, dir: P) -> &mut Command {
727712
self.inner.cwd(dir.as_ref().as_ref());
@@ -733,8 +718,8 @@ impl Command {
733718
/// Defaults to [`inherit`] when used with `spawn` or `status`, and
734719
/// defaults to [`piped`] when used with `output`.
735720
///
736-
/// [`inherit`]: struct.Stdio.html#method.inherit
737-
/// [`piped`]: struct.Stdio.html#method.piped
721+
/// [`inherit`]: Stdio::inherit
722+
/// [`piped`]: Stdio::piped
738723
///
739724
/// # Examples
740725
///
@@ -759,8 +744,8 @@ impl Command {
759744
/// Defaults to [`inherit`] when used with `spawn` or `status`, and
760745
/// defaults to [`piped`] when used with `output`.
761746
///
762-
/// [`inherit`]: struct.Stdio.html#method.inherit
763-
/// [`piped`]: struct.Stdio.html#method.piped
747+
/// [`inherit`]: Stdio::inherit
748+
/// [`piped`]: Stdio::piped
764749
///
765750
/// # Examples
766751
///
@@ -785,8 +770,8 @@ impl Command {
785770
/// Defaults to [`inherit`] when used with `spawn` or `status`, and
786771
/// defaults to [`piped`] when used with `output`.
787772
///
788-
/// [`inherit`]: struct.Stdio.html#method.inherit
789-
/// [`piped`]: struct.Stdio.html#method.piped
773+
/// [`inherit`]: Stdio::inherit
774+
/// [`piped`]: Stdio::piped
790775
///
791776
/// # Examples
792777
///
@@ -914,10 +899,8 @@ impl AsInnerMut<imp::Command> for Command {
914899
/// [`Command`], or the [`wait_with_output`] method of a [`Child`]
915900
/// process.
916901
///
917-
/// [`Command`]: struct.Command.html
918-
/// [`Child`]: struct.Child.html
919-
/// [`output`]: struct.Command.html#method.output
920-
/// [`wait_with_output`]: struct.Child.html#method.wait_with_output
902+
/// [`output`]: Command::output
903+
/// [`wait_with_output`]: Child::wait_with_output
921904
#[derive(PartialEq, Eq, Clone)]
922905
#[stable(feature = "process", since = "1.0.0")]
923906
pub struct Output {
@@ -960,10 +943,9 @@ impl fmt::Debug for Output {
960943
/// Describes what to do with a standard I/O stream for a child process when
961944
/// passed to the [`stdin`], [`stdout`], and [`stderr`] methods of [`Command`].
962945
///
963-
/// [`stdin`]: struct.Command.html#method.stdin
964-
/// [`stdout`]: struct.Command.html#method.stdout
965-
/// [`stderr`]: struct.Command.html#method.stderr
966-
/// [`Command`]: struct.Command.html
946+
/// [`stdin`]: Command::stdin
947+
/// [`stdout`]: Command::stdout
948+
/// [`stderr`]: Command::stderr
967949
#[stable(feature = "process", since = "1.0.0")]
968950
pub struct Stdio(imp::Stdio);
969951

@@ -1227,10 +1209,8 @@ impl From<fs::File> for Stdio {
12271209
/// status is exposed through the [`status`] method, or the [`wait`] method
12281210
/// of a [`Child`] process.
12291211
///
1230-
/// [`Command`]: struct.Command.html
1231-
/// [`Child`]: struct.Child.html
1232-
/// [`status`]: struct.Command.html#method.status
1233-
/// [`wait`]: struct.Child.html#method.wait
1212+
/// [`status`]: Command::status
1213+
/// [`wait`]: Child::wait
12341214
#[derive(PartialEq, Eq, Clone, Copy, Debug)]
12351215
#[stable(feature = "process", since = "1.0.0")]
12361216
pub struct ExitStatus(imp::ExitStatus);
@@ -1315,8 +1295,8 @@ impl fmt::Display for ExitStatus {
13151295
/// For the platform's canonical successful and unsuccessful codes, see
13161296
/// the [`SUCCESS`] and [`FAILURE`] associated items.
13171297
///
1318-
/// [`SUCCESS`]: #associatedconstant.SUCCESS
1319-
/// [`FAILURE`]: #associatedconstant.FAILURE
1298+
/// [`SUCCESS`]: ExitCode::SUCCESS
1299+
/// [`FAILURE`]: ExitCode::FAILURE
13201300
///
13211301
/// **Warning**: While various forms of this were discussed in [RFC #1937],
13221302
/// it was ultimately cut from that RFC, and thus this type is more subject
@@ -1370,9 +1350,9 @@ impl Child {
13701350
/// }
13711351
/// ```
13721352
///
1373-
/// [`ErrorKind`]: ../io/enum.ErrorKind.html
1374-
/// [`InvalidInput`]: ../io/enum.ErrorKind.html#variant.InvalidInput
1375-
/// [`Other`]: ../io/enum.ErrorKind.html#variant.Other
1353+
/// [`ErrorKind`]: io::ErrorKind
1354+
/// [`InvalidInput`]: io::ErrorKind::InvalidInput
1355+
/// [`Other`]: io::ErrorKind::Other
13761356
#[stable(feature = "process", since = "1.0.0")]
13771357
pub fn kill(&mut self) -> io::Result<()> {
13781358
self.handle.kill()
@@ -1637,8 +1617,7 @@ pub fn exit(code: i32) -> ! {
16371617
/// }
16381618
/// ```
16391619
///
1640-
/// [`panic!`]: ../../std/macro.panic.html
1641-
/// [panic hook]: ../../std/panic/fn.set_hook.html
1620+
/// [panic hook]: crate::panic::set_hook
16421621
#[stable(feature = "process_abort", since = "1.17.0")]
16431622
pub fn abort() -> ! {
16441623
crate::sys::abort_internal();

0 commit comments

Comments
 (0)